mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
synced 2026-04-26 18:03:46 -04:00
Use a temporary register to reduce the size of detour code from 16 bytes to 8 bytes. The previous implementation is from 'commitafc76b8b80("riscv: Using PATCHABLE_FUNCTION_ENTRY instead of MCOUNT")'. Before the patch: <func_prolog>: 0: REG_S ra, -SZREG(sp) 4: auipc ra, ? 8: jalr ?(ra) 12: REG_L ra, -SZREG(sp) (func_boddy) After the patch: <func_prolog>: 0: auipc t0, ? 4: jalr t0, ?(t0) (func_boddy) This patch not just reduces the size of detour code, but also fixes an important issue: An Ftrace callback registered with FTRACE_OPS_FL_IPMODIFY flag can actually change the instruction pointer, e.g. to "replace" the given kernel function with a new one, which is needed for livepatching, etc. In this case, the trampoline (ftrace_regs_caller) would not return to <func_prolog+12> but would rather jump to the new function. So, "REG_L ra, -SZREG(sp)" would not run and the original return address would not be restored. The kernel is likely to hang or crash as a result. This can be easily demonstrated if one tries to "replace", say, cmdline_proc_show() with a new function with the same signature using instruction_pointer_set(&fregs->regs, new_func_addr) in the Ftrace callback. Link: https://lore.kernel.org/linux-riscv/20221122075440.1165172-1-suagrfillet@gmail.com/ Link: https://lore.kernel.org/linux-riscv/d7d5730b-ebef-68e5-5046-e763e1ee6164@yadro.com/ Co-developed-by: Song Shuai <suagrfillet@gmail.com> Signed-off-by: Song Shuai <suagrfillet@gmail.com> Signed-off-by: Guo Ren <guoren@linux.alibaba.com> Signed-off-by: Guo Ren <guoren@kernel.org> Cc: Evgenii Shatokhin <e.shatokhin@yadro.com> Reviewed-by: Evgenii Shatokhin <e.shatokhin@yadro.com> Link: https://lore.kernel.org/r/20230112090603.1295340-4-guoren@kernel.org Cc: stable@vger.kernel.org Fixes:10626c32e3("riscv/ftrace: Add basic support") Signed-off-by: Palmer Dabbelt <palmer@rivosinc.com>
115 lines
3.0 KiB
C
115 lines
3.0 KiB
C
/* SPDX-License-Identifier: GPL-2.0 */
|
|
/* Copyright (C) 2017 Andes Technology Corporation */
|
|
|
|
#ifndef _ASM_RISCV_FTRACE_H
|
|
#define _ASM_RISCV_FTRACE_H
|
|
|
|
/*
|
|
* The graph frame test is not possible if CONFIG_FRAME_POINTER is not enabled.
|
|
* Check arch/riscv/kernel/mcount.S for detail.
|
|
*/
|
|
#if defined(CONFIG_FUNCTION_GRAPH_TRACER) && defined(CONFIG_FRAME_POINTER)
|
|
#define HAVE_FUNCTION_GRAPH_FP_TEST
|
|
#endif
|
|
#define HAVE_FUNCTION_GRAPH_RET_ADDR_PTR
|
|
|
|
/*
|
|
* Clang prior to 13 had "mcount" instead of "_mcount":
|
|
* https://reviews.llvm.org/D98881
|
|
*/
|
|
#if defined(CONFIG_CC_IS_GCC) || CONFIG_CLANG_VERSION >= 130000
|
|
#define MCOUNT_NAME _mcount
|
|
#else
|
|
#define MCOUNT_NAME mcount
|
|
#endif
|
|
|
|
#define ARCH_SUPPORTS_FTRACE_OPS 1
|
|
#ifndef __ASSEMBLY__
|
|
void MCOUNT_NAME(void);
|
|
static inline unsigned long ftrace_call_adjust(unsigned long addr)
|
|
{
|
|
return addr;
|
|
}
|
|
|
|
struct dyn_arch_ftrace {
|
|
};
|
|
#endif
|
|
|
|
#ifdef CONFIG_DYNAMIC_FTRACE
|
|
/*
|
|
* A general call in RISC-V is a pair of insts:
|
|
* 1) auipc: setting high-20 pc-related bits to ra register
|
|
* 2) jalr: setting low-12 offset to ra, jump to ra, and set ra to
|
|
* return address (original pc + 4)
|
|
*
|
|
*<ftrace enable>:
|
|
* 0: auipc t0/ra, 0x?
|
|
* 4: jalr t0/ra, ?(t0/ra)
|
|
*
|
|
*<ftrace disable>:
|
|
* 0: nop
|
|
* 4: nop
|
|
*
|
|
* Dynamic ftrace generates probes to call sites, so we must deal with
|
|
* both auipc and jalr at the same time.
|
|
*/
|
|
|
|
#define MCOUNT_ADDR ((unsigned long)MCOUNT_NAME)
|
|
#define JALR_SIGN_MASK (0x00000800)
|
|
#define JALR_OFFSET_MASK (0x00000fff)
|
|
#define AUIPC_OFFSET_MASK (0xfffff000)
|
|
#define AUIPC_PAD (0x00001000)
|
|
#define JALR_SHIFT 20
|
|
#define JALR_RA (0x000080e7)
|
|
#define AUIPC_RA (0x00000097)
|
|
#define JALR_T0 (0x000282e7)
|
|
#define AUIPC_T0 (0x00000297)
|
|
#define NOP4 (0x00000013)
|
|
|
|
#define to_jalr_t0(offset) \
|
|
(((offset & JALR_OFFSET_MASK) << JALR_SHIFT) | JALR_T0)
|
|
|
|
#define to_auipc_t0(offset) \
|
|
((offset & JALR_SIGN_MASK) ? \
|
|
(((offset & AUIPC_OFFSET_MASK) + AUIPC_PAD) | AUIPC_T0) : \
|
|
((offset & AUIPC_OFFSET_MASK) | AUIPC_T0))
|
|
|
|
#define make_call_t0(caller, callee, call) \
|
|
do { \
|
|
unsigned int offset = \
|
|
(unsigned long) callee - (unsigned long) caller; \
|
|
call[0] = to_auipc_t0(offset); \
|
|
call[1] = to_jalr_t0(offset); \
|
|
} while (0)
|
|
|
|
#define to_jalr_ra(offset) \
|
|
(((offset & JALR_OFFSET_MASK) << JALR_SHIFT) | JALR_RA)
|
|
|
|
#define to_auipc_ra(offset) \
|
|
((offset & JALR_SIGN_MASK) ? \
|
|
(((offset & AUIPC_OFFSET_MASK) + AUIPC_PAD) | AUIPC_RA) : \
|
|
((offset & AUIPC_OFFSET_MASK) | AUIPC_RA))
|
|
|
|
#define make_call_ra(caller, callee, call) \
|
|
do { \
|
|
unsigned int offset = \
|
|
(unsigned long) callee - (unsigned long) caller; \
|
|
call[0] = to_auipc_ra(offset); \
|
|
call[1] = to_jalr_ra(offset); \
|
|
} while (0)
|
|
|
|
/*
|
|
* Let auipc+jalr be the basic *mcount unit*, so we make it 8 bytes here.
|
|
*/
|
|
#define MCOUNT_INSN_SIZE 8
|
|
|
|
#ifndef __ASSEMBLY__
|
|
struct dyn_ftrace;
|
|
int ftrace_init_nop(struct module *mod, struct dyn_ftrace *rec);
|
|
#define ftrace_init_nop ftrace_init_nop
|
|
#endif
|
|
|
|
#endif
|
|
|
|
#endif /* _ASM_RISCV_FTRACE_H */
|