Unverified Commit edde5584 authored by Vincent Chen's avatar Vincent Chen Committed by Palmer Dabbelt
Browse files

riscv: Add SW single-step support for KDB 



In KGDB, the GDB in the host is responsible for the single-step operation
of the software. In other words, KGDB does not need to derive the next pc
address when performing a software single-step operation. KGDB just inserts
the break instruction at the indicated address according to the GDB
instructions. This approach does not work in KDB because the GDB does not
involve the KDB process. Therefore, this patch provides KDB a software
single-step mechanism to use.

Signed-off-by: default avatarVincent Chen <vincent.chen@sifive.com>
Signed-off-by: default avatarPalmer Dabbelt <palmerdabbelt@google.com>
parent d9657570

arch/riscv/include/asm/parse_asm.h

0 → 100644
+219 −0
Original line number Diff line number Diff line 
/* SPDX-License-Identifier: GPL-2.0-only */

/*

 * Copyright (C) 2020 SiFive

 */



#include <linux/bits.h>



/* The bit field of immediate value in I-type instruction */

#define I_IMM_SIGN_OPOFF	31

#define I_IMM_11_0_OPOFF	20

#define I_IMM_SIGN_OFF		12

#define I_IMM_11_0_OFF		0

#define I_IMM_11_0_MASK		GENMASK(11, 0)



/* The bit field of immediate value in J-type instruction */

#define J_IMM_SIGN_OPOFF	31

#define J_IMM_10_1_OPOFF	21

#define J_IMM_11_OPOFF		20

#define J_IMM_19_12_OPOFF	12

#define J_IMM_SIGN_OFF		20

#define J_IMM_10_1_OFF		1

#define J_IMM_11_OFF		11

#define J_IMM_19_12_OFF		12

#define J_IMM_10_1_MASK		GENMASK(9, 0)

#define J_IMM_11_MASK		GENMASK(0, 0)

#define J_IMM_19_12_MASK	GENMASK(7, 0)



/* The bit field of immediate value in B-type instruction */

#define B_IMM_SIGN_OPOFF	31

#define B_IMM_10_5_OPOFF	25

#define B_IMM_4_1_OPOFF		8

#define B_IMM_11_OPOFF		7

#define B_IMM_SIGN_OFF		12

#define B_IMM_10_5_OFF		5

#define B_IMM_4_1_OFF		1

#define B_IMM_11_OFF		11

#define B_IMM_10_5_MASK		GENMASK(5, 0)

#define B_IMM_4_1_MASK		GENMASK(3, 0)

#define B_IMM_11_MASK		GENMASK(0, 0)



/* The register offset in RVG instruction */

#define RVG_RS1_OPOFF		15

#define RVG_RS2_OPOFF		20

#define RVG_RD_OPOFF		7



/* The bit field of immediate value in RVC J instruction */

#define RVC_J_IMM_SIGN_OPOFF	12

#define RVC_J_IMM_4_OPOFF	11

#define RVC_J_IMM_9_8_OPOFF	9

#define RVC_J_IMM_10_OPOFF	8

#define RVC_J_IMM_6_OPOFF	7

#define RVC_J_IMM_7_OPOFF	6

#define RVC_J_IMM_3_1_OPOFF	3

#define RVC_J_IMM_5_OPOFF	2

#define RVC_J_IMM_SIGN_OFF	11

#define RVC_J_IMM_4_OFF		4

#define RVC_J_IMM_9_8_OFF	8

#define RVC_J_IMM_10_OFF	10

#define RVC_J_IMM_6_OFF		6

#define RVC_J_IMM_7_OFF		7

#define RVC_J_IMM_3_1_OFF	1

#define RVC_J_IMM_5_OFF		5

#define RVC_J_IMM_4_MASK	GENMASK(0, 0)

#define RVC_J_IMM_9_8_MASK	GENMASK(1, 0)

#define RVC_J_IMM_10_MASK	GENMASK(0, 0)

#define RVC_J_IMM_6_MASK	GENMASK(0, 0)

#define RVC_J_IMM_7_MASK	GENMASK(0, 0)

#define RVC_J_IMM_3_1_MASK	GENMASK(2, 0)

#define RVC_J_IMM_5_MASK	GENMASK(0, 0)



/* The bit field of immediate value in RVC B instruction */

#define RVC_B_IMM_SIGN_OPOFF	12

#define RVC_B_IMM_4_3_OPOFF	10

#define RVC_B_IMM_7_6_OPOFF	5

#define RVC_B_IMM_2_1_OPOFF	3

#define RVC_B_IMM_5_OPOFF	2

#define RVC_B_IMM_SIGN_OFF	8

#define RVC_B_IMM_4_3_OFF	3

#define RVC_B_IMM_7_6_OFF	6

#define RVC_B_IMM_2_1_OFF	1

#define RVC_B_IMM_5_OFF		5

#define RVC_B_IMM_4_3_MASK	GENMASK(1, 0)

#define RVC_B_IMM_7_6_MASK	GENMASK(1, 0)

#define RVC_B_IMM_2_1_MASK	GENMASK(1, 0)

#define RVC_B_IMM_5_MASK	GENMASK(0, 0)



/* The register offset in RVC op=C0 instruction */

#define RVC_C0_RS1_OPOFF	7

#define RVC_C0_RS2_OPOFF	2

#define RVC_C0_RD_OPOFF		2



/* The register offset in RVC op=C1 instruction */

#define RVC_C1_RS1_OPOFF	7

#define RVC_C1_RS2_OPOFF	2

#define RVC_C1_RD_OPOFF		7



/* The register offset in RVC op=C2 instruction */

#define RVC_C2_RS1_OPOFF	7

#define RVC_C2_RS2_OPOFF	2

#define RVC_C2_RD_OPOFF		7



/* parts of opcode for RVG*/

#define OPCODE_BRANCH		0x63

#define OPCODE_JALR		0x67

#define OPCODE_JAL		0x6f

#define OPCODE_SYSTEM		0x73



/* parts of opcode for RVC*/

#define OPCODE_C_0		0x0

#define OPCODE_C_1		0x1

#define OPCODE_C_2		0x2



/* parts of funct3 code for I, M, A extension*/

#define FUNCT3_JALR		0x0

#define FUNCT3_BEQ		0x0

#define FUNCT3_BNE		0x1000

#define FUNCT3_BLT		0x4000

#define FUNCT3_BGE		0x5000

#define FUNCT3_BLTU		0x6000

#define FUNCT3_BGEU		0x7000



/* parts of funct3 code for C extension*/

#define FUNCT3_C_BEQZ		0xc000

#define FUNCT3_C_BNEZ		0xe000

#define FUNCT3_C_J		0xa000

#define FUNCT3_C_JAL		0x2000

#define FUNCT4_C_JR		0x8000

#define FUNCT4_C_JALR		0xf000



#define FUNCT12_SRET		0x10200000



#define MATCH_JALR		(FUNCT3_JALR | OPCODE_JALR)

#define MATCH_JAL		(OPCODE_JAL)

#define MATCH_BEQ		(FUNCT3_BEQ | OPCODE_BRANCH)

#define MATCH_BNE		(FUNCT3_BNE | OPCODE_BRANCH)

#define MATCH_BLT		(FUNCT3_BLT | OPCODE_BRANCH)

#define MATCH_BGE		(FUNCT3_BGE | OPCODE_BRANCH)

#define MATCH_BLTU		(FUNCT3_BLTU | OPCODE_BRANCH)

#define MATCH_BGEU		(FUNCT3_BGEU | OPCODE_BRANCH)

#define MATCH_SRET		(FUNCT12_SRET | OPCODE_SYSTEM)

#define MATCH_C_BEQZ		(FUNCT3_C_BEQZ | OPCODE_C_1)

#define MATCH_C_BNEZ		(FUNCT3_C_BNEZ | OPCODE_C_1)

#define MATCH_C_J		(FUNCT3_C_J | OPCODE_C_1)

#define MATCH_C_JAL		(FUNCT3_C_JAL | OPCODE_C_1)

#define MATCH_C_JR		(FUNCT4_C_JR | OPCODE_C_2)

#define MATCH_C_JALR		(FUNCT4_C_JALR | OPCODE_C_2)



#define MASK_JALR		0x707f

#define MASK_JAL		0x7f

#define MASK_C_JALR		0xf07f

#define MASK_C_JR		0xf07f

#define MASK_C_JAL		0xe003

#define MASK_C_J		0xe003

#define MASK_BEQ		0x707f

#define MASK_BNE		0x707f

#define MASK_BLT		0x707f

#define MASK_BGE		0x707f

#define MASK_BLTU		0x707f

#define MASK_BGEU		0x707f

#define MASK_C_BEQZ		0xe003

#define MASK_C_BNEZ		0xe003

#define MASK_SRET		0xffffffff



#define __INSN_LENGTH_MASK	_UL(0x3)

#define __INSN_LENGTH_GE_32	_UL(0x3)

#define __INSN_OPCODE_MASK	_UL(0x7F)

#define __INSN_BRANCH_OPCODE	_UL(OPCODE_BRANCH)



/* Define a series of is_XXX_insn functions to check if the value INSN

 * is an instance of instruction XXX.

 */

#define DECLARE_INSN(INSN_NAME, INSN_MATCH, INSN_MASK) \

static inline bool is_ ## INSN_NAME ## _insn(long insn) \

{ \

	return (insn & (INSN_MASK)) == (INSN_MATCH); \

}



#define RV_IMM_SIGN(x) (-(((x) >> 31) & 1))

#define RVC_IMM_SIGN(x) (-(((x) >> 12) & 1))

#define RV_X(X, s, mask)  (((X) >> (s)) & (mask))

#define RVC_X(X, s, mask) RV_X(X, s, mask)



#define EXTRACT_JTYPE_IMM(x) \

	({typeof(x) x_ = (x); \

	(RV_X(x_, J_IMM_10_1_OPOFF, J_IMM_10_1_MASK) << J_IMM_10_1_OFF) | \

	(RV_X(x_, J_IMM_11_OPOFF, J_IMM_11_MASK) << J_IMM_11_OFF) | \

	(RV_X(x_, J_IMM_19_12_OPOFF, J_IMM_19_12_MASK) << J_IMM_19_12_OFF) | \

	(RV_IMM_SIGN(x_) << J_IMM_SIGN_OFF); })



#define EXTRACT_ITYPE_IMM(x) \

	({typeof(x) x_ = (x); \

	(RV_X(x_, I_IMM_11_0_OPOFF, I_IMM_11_0_MASK)) | \

	(RV_IMM_SIGN(x_) << I_IMM_SIGN_OFF); })



#define EXTRACT_BTYPE_IMM(x) \

	({typeof(x) x_ = (x); \

	(RV_X(x_, B_IMM_4_1_OPOFF, B_IMM_4_1_MASK) << B_IMM_4_1_OFF) | \

	(RV_X(x_, B_IMM_10_5_OPOFF, B_IMM_10_5_MASK) << B_IMM_10_5_OFF) | \

	(RV_X(x_, B_IMM_11_OPOFF, B_IMM_11_MASK) << B_IMM_11_OFF) | \

	(RV_IMM_SIGN(x_) << B_IMM_SIGN_OFF); })



#define EXTRACT_RVC_J_IMM(x) \

	({typeof(x) x_ = (x); \

	(RVC_X(x_, RVC_J_IMM_3_1_OPOFF, RVC_J_IMM_3_1_MASK) << RVC_J_IMM_3_1_OFF) | \

	(RVC_X(x_, RVC_J_IMM_4_OPOFF, RVC_J_IMM_4_MASK) << RVC_J_IMM_4_OFF) | \

	(RVC_X(x_, RVC_J_IMM_5_OPOFF, RVC_J_IMM_5_MASK) << RVC_J_IMM_5_OFF) | \

	(RVC_X(x_, RVC_J_IMM_6_OPOFF, RVC_J_IMM_6_MASK) << RVC_J_IMM_6_OFF) | \

	(RVC_X(x_, RVC_J_IMM_7_OPOFF, RVC_J_IMM_7_MASK) << RVC_J_IMM_7_OFF) | \

	(RVC_X(x_, RVC_J_IMM_9_8_OPOFF, RVC_J_IMM_9_8_MASK) << RVC_J_IMM_9_8_OFF) | \

	(RVC_X(x_, RVC_J_IMM_10_OPOFF, RVC_J_IMM_10_MASK) << RVC_J_IMM_10_OFF) | \

	(RVC_IMM_SIGN(x_) << RVC_J_IMM_SIGN_OFF); })



#define EXTRACT_RVC_B_IMM(x) \

	({typeof(x) x_ = (x); \

	(RVC_X(x_, RVC_B_IMM_2_1_OPOFF, RVC_B_IMM_2_1_MASK) << RVC_B_IMM_2_1_OFF) | \

	(RVC_X(x_, RVC_B_IMM_4_3_OPOFF, RVC_B_IMM_4_3_MASK) << RVC_B_IMM_4_3_OFF) | \

	(RVC_X(x_, RVC_B_IMM_5_OPOFF, RVC_B_IMM_5_MASK) << RVC_B_IMM_5_OFF) | \

	(RVC_X(x_, RVC_B_IMM_7_6_OPOFF, RVC_B_IMM_7_6_MASK) << RVC_B_IMM_7_6_OFF) | \

	(RVC_IMM_SIGN(x_) << RVC_B_IMM_SIGN_OFF); })

arch/riscv/kernel/kgdb.c

+177 −2
Original line number Diff line number Diff line
@@ -11,13 +11,179 @@ 
#include <linux/string.h>

#include <asm/cacheflush.h>

#include <asm/gdb_xml.h>

#include <asm/parse_asm.h>



enum {

	NOT_KGDB_BREAK = 0,

	KGDB_SW_BREAK,

	KGDB_COMPILED_BREAK,

	KGDB_SW_SINGLE_STEP

};



static unsigned long stepped_address;

static unsigned int stepped_opcode;



#if __riscv_xlen == 32

/* C.JAL is an RV32C-only instruction */

DECLARE_INSN(c_jal, MATCH_C_JAL, MASK_C_JAL)

#else

#define is_c_jal_insn(opcode) 0

#endif

DECLARE_INSN(jalr, MATCH_JALR, MASK_JALR)

DECLARE_INSN(jal, MATCH_JAL, MASK_JAL)

DECLARE_INSN(c_jr, MATCH_C_JR, MASK_C_JR)

DECLARE_INSN(c_jalr, MATCH_C_JALR, MASK_C_JALR)

DECLARE_INSN(c_j, MATCH_C_J, MASK_C_J)

DECLARE_INSN(beq, MATCH_BEQ, MASK_BEQ)

DECLARE_INSN(bne, MATCH_BNE, MASK_BNE)

DECLARE_INSN(blt, MATCH_BLT, MASK_BLT)

DECLARE_INSN(bge, MATCH_BGE, MASK_BGE)

DECLARE_INSN(bltu, MATCH_BLTU, MASK_BLTU)

DECLARE_INSN(bgeu, MATCH_BGEU, MASK_BGEU)

DECLARE_INSN(c_beqz, MATCH_C_BEQZ, MASK_C_BEQZ)

DECLARE_INSN(c_bnez, MATCH_C_BNEZ, MASK_C_BNEZ)

DECLARE_INSN(sret, MATCH_SRET, MASK_SRET)



int decode_register_index(unsigned long opcode, int offset)

{

	return (opcode >> offset) & 0x1F;

}



int decode_register_index_short(unsigned long opcode, int offset)

{

	return ((opcode >> offset) & 0x7) + 8;

}



/* Calculate the new address for after a step */

int get_step_address(struct pt_regs *regs, unsigned long *next_addr)

{

	unsigned long pc = regs->epc;

	unsigned long *regs_ptr = (unsigned long *)regs;

	unsigned int rs1_num, rs2_num;

	int op_code;



	if (probe_kernel_address((void *)pc, op_code))

		return -EINVAL;

	if ((op_code & __INSN_LENGTH_MASK) != __INSN_LENGTH_GE_32) {

		if (is_c_jalr_insn(op_code) || is_c_jr_insn(op_code)) {

			rs1_num = decode_register_index(op_code, RVC_C2_RS1_OPOFF);

			*next_addr = regs_ptr[rs1_num];

		} else if (is_c_j_insn(op_code) || is_c_jal_insn(op_code)) {

			*next_addr = EXTRACT_RVC_J_IMM(op_code) + pc;

		} else if (is_c_beqz_insn(op_code)) {

			rs1_num = decode_register_index_short(op_code,

							      RVC_C1_RS1_OPOFF);

			if (!rs1_num || regs_ptr[rs1_num] == 0)

				*next_addr = EXTRACT_RVC_B_IMM(op_code) + pc;

			else

				*next_addr = pc + 2;

		} else if (is_c_bnez_insn(op_code)) {

			rs1_num =

			    decode_register_index_short(op_code, RVC_C1_RS1_OPOFF);

			if (rs1_num && regs_ptr[rs1_num] != 0)

				*next_addr = EXTRACT_RVC_B_IMM(op_code) + pc;

			else

				*next_addr = pc + 2;

		} else {

			*next_addr = pc + 2;

		}

	} else {

		if ((op_code & __INSN_OPCODE_MASK) == __INSN_BRANCH_OPCODE) {

			bool result = false;

			long imm = EXTRACT_BTYPE_IMM(op_code);

			unsigned long rs1_val = 0, rs2_val = 0;



			rs1_num = decode_register_index(op_code, RVG_RS1_OPOFF);

			rs2_num = decode_register_index(op_code, RVG_RS2_OPOFF);

			if (rs1_num)

				rs1_val = regs_ptr[rs1_num];

			if (rs2_num)

				rs2_val = regs_ptr[rs2_num];



			if (is_beq_insn(op_code))

				result = (rs1_val == rs2_val) ? true : false;

			else if (is_bne_insn(op_code))

				result = (rs1_val != rs2_val) ? true : false;

			else if (is_blt_insn(op_code))

				result =

				    ((long)rs1_val <

				     (long)rs2_val) ? true : false;

			else if (is_bge_insn(op_code))

				result =

				    ((long)rs1_val >=

				     (long)rs2_val) ? true : false;

			else if (is_bltu_insn(op_code))

				result = (rs1_val < rs2_val) ? true : false;

			else if (is_bgeu_insn(op_code))

				result = (rs1_val >= rs2_val) ? true : false;

			if (result)

				*next_addr = imm + pc;

			else

				*next_addr = pc + 4;

		} else if (is_jal_insn(op_code)) {

			*next_addr = EXTRACT_JTYPE_IMM(op_code) + pc;

		} else if (is_jalr_insn(op_code)) {

			rs1_num = decode_register_index(op_code, RVG_RS1_OPOFF);

			if (rs1_num)

				*next_addr = ((unsigned long *)regs)[rs1_num];

			*next_addr += EXTRACT_ITYPE_IMM(op_code);

		} else if (is_sret_insn(op_code)) {

			*next_addr = pc;

		} else {

			*next_addr = pc + 4;

		}

	}

	return 0;

}



int do_single_step(struct pt_regs *regs)

{

	/* Determine where the target instruction will send us to */

	unsigned long addr = 0;

	int error = get_step_address(regs, &addr);



	if (error)

		return error;



	/* Store the op code in the stepped address */

	error = probe_kernel_address((void *)addr, stepped_opcode);

	if (error)

		return error;



	stepped_address = addr;



	/* Replace the op code with the break instruction */

	error = probe_kernel_write((void *)stepped_address,

				   arch_kgdb_ops.gdb_bpt_instr,

				   BREAK_INSTR_SIZE);

	/* Flush and return */

	if (!error) {

		flush_icache_range(addr, addr + BREAK_INSTR_SIZE);

		kgdb_single_step = 1;

		atomic_set(&kgdb_cpu_doing_single_step,

			   raw_smp_processor_id());

	} else {

		stepped_address = 0;

		stepped_opcode = 0;

	}

	return error;

}



/* Undo a single step */

static void undo_single_step(struct pt_regs *regs)

{

	if (stepped_opcode != 0) {

		probe_kernel_write((void *)stepped_address,

				   (void *)&stepped_opcode, BREAK_INSTR_SIZE);

		flush_icache_range(stepped_address,

				   stepped_address + BREAK_INSTR_SIZE);

	}

	stepped_address = 0;

	stepped_opcode = 0;

	kgdb_single_step = 0;

	atomic_set(&kgdb_cpu_doing_single_step, -1);

}



struct dbg_reg_def_t dbg_reg_def[DBG_MAX_REG_NUM] = {

	{DBG_REG_ZERO, GDB_SIZEOF_REG, -1},

	{DBG_REG_RA, GDB_SIZEOF_REG, offsetof(struct pt_regs, ra)},
@@ -135,6 +301,8 @@ int kgdb_arch_handle_exception(int vector, int signo, int err_code, 
{

	int err = 0;



	undo_single_step(regs);



	switch (remcom_in_buffer[0]) {

	case 'c':

	case 'D':
@@ -142,15 +310,20 @@ int kgdb_arch_handle_exception(int vector, int signo, int err_code, 
		if (remcom_in_buffer[0] == 'c')

			kgdb_arch_update_addr(regs, remcom_in_buffer);

		break;

	case 's':

		kgdb_arch_update_addr(regs, remcom_in_buffer);

		err = do_single_step(regs);

		break;

	default:

		err = -1;

	}



	return err;

}



int kgdb_riscv_kgdbbreak(unsigned long addr)

{

	if (stepped_address == addr)

		return KGDB_SW_SINGLE_STEP;

	if (atomic_read(&kgdb_setting_breakpoint))

		if (addr == (unsigned long)&kgdb_compiled_break)

			return KGDB_COMPILED_BREAK;
@@ -174,7 +347,9 @@ static int kgdb_riscv_notify(struct notifier_block *self, unsigned long cmd, 
		return NOTIFY_DONE;



	local_irq_save(flags);

	if (kgdb_handle_exception(1, args->signr, cmd, regs))



	if (kgdb_handle_exception(type == KGDB_SW_SINGLE_STEP ? 0 : 1,

				  args->signr, cmd, regs))

		return NOTIFY_DONE;



	if (type == KGDB_COMPILED_BREAK)

CRA Git | Maintained and supported by SUSTech CRA and CCSE