xref: /OK3568_Linux_fs/kernel/arch/x86/include/asm/kprobes.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-or-later */
2*4882a593Smuzhiyun #ifndef _ASM_X86_KPROBES_H
3*4882a593Smuzhiyun #define _ASM_X86_KPROBES_H
4*4882a593Smuzhiyun /*
5*4882a593Smuzhiyun  *  Kernel Probes (KProbes)
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  * Copyright (C) IBM Corporation, 2002, 2004
8*4882a593Smuzhiyun  *
9*4882a593Smuzhiyun  * See arch/x86/kernel/kprobes.c for x86 kprobes history.
10*4882a593Smuzhiyun  */
11*4882a593Smuzhiyun 
12*4882a593Smuzhiyun #include <asm-generic/kprobes.h>
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun #ifdef CONFIG_KPROBES
15*4882a593Smuzhiyun #include <linux/types.h>
16*4882a593Smuzhiyun #include <linux/ptrace.h>
17*4882a593Smuzhiyun #include <linux/percpu.h>
18*4882a593Smuzhiyun #include <asm/text-patching.h>
19*4882a593Smuzhiyun #include <asm/insn.h>
20*4882a593Smuzhiyun 
21*4882a593Smuzhiyun #define  __ARCH_WANT_KPROBES_INSN_SLOT
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun struct pt_regs;
24*4882a593Smuzhiyun struct kprobe;
25*4882a593Smuzhiyun 
26*4882a593Smuzhiyun typedef u8 kprobe_opcode_t;
27*4882a593Smuzhiyun 
28*4882a593Smuzhiyun #define MAX_STACK_SIZE 64
29*4882a593Smuzhiyun #define CUR_STACK_SIZE(ADDR) \
30*4882a593Smuzhiyun 	(current_top_of_stack() - (unsigned long)(ADDR))
31*4882a593Smuzhiyun #define MIN_STACK_SIZE(ADDR)				\
32*4882a593Smuzhiyun 	(MAX_STACK_SIZE < CUR_STACK_SIZE(ADDR) ?	\
33*4882a593Smuzhiyun 	 MAX_STACK_SIZE : CUR_STACK_SIZE(ADDR))
34*4882a593Smuzhiyun 
35*4882a593Smuzhiyun #define flush_insn_slot(p)	do { } while (0)
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun /* optinsn template addresses */
38*4882a593Smuzhiyun extern __visible kprobe_opcode_t optprobe_template_entry[];
39*4882a593Smuzhiyun extern __visible kprobe_opcode_t optprobe_template_clac[];
40*4882a593Smuzhiyun extern __visible kprobe_opcode_t optprobe_template_val[];
41*4882a593Smuzhiyun extern __visible kprobe_opcode_t optprobe_template_call[];
42*4882a593Smuzhiyun extern __visible kprobe_opcode_t optprobe_template_end[];
43*4882a593Smuzhiyun #define MAX_OPTIMIZED_LENGTH (MAX_INSN_SIZE + DISP32_SIZE)
44*4882a593Smuzhiyun #define MAX_OPTINSN_SIZE 				\
45*4882a593Smuzhiyun 	(((unsigned long)optprobe_template_end -	\
46*4882a593Smuzhiyun 	  (unsigned long)optprobe_template_entry) +	\
47*4882a593Smuzhiyun 	 MAX_OPTIMIZED_LENGTH + JMP32_INSN_SIZE)
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun extern const int kretprobe_blacklist_size;
50*4882a593Smuzhiyun 
51*4882a593Smuzhiyun void arch_remove_kprobe(struct kprobe *p);
52*4882a593Smuzhiyun asmlinkage void kretprobe_trampoline(void);
53*4882a593Smuzhiyun 
54*4882a593Smuzhiyun extern void arch_kprobe_override_function(struct pt_regs *regs);
55*4882a593Smuzhiyun 
56*4882a593Smuzhiyun /* Architecture specific copy of original instruction*/
57*4882a593Smuzhiyun struct arch_specific_insn {
58*4882a593Smuzhiyun 	/* copy of the original instruction */
59*4882a593Smuzhiyun 	kprobe_opcode_t *insn;
60*4882a593Smuzhiyun 	/*
61*4882a593Smuzhiyun 	 * boostable = false: This instruction type is not boostable.
62*4882a593Smuzhiyun 	 * boostable = true: This instruction has been boosted: we have
63*4882a593Smuzhiyun 	 * added a relative jump after the instruction copy in insn,
64*4882a593Smuzhiyun 	 * so no single-step and fixup are needed (unless there's
65*4882a593Smuzhiyun 	 * a post_handler).
66*4882a593Smuzhiyun 	 */
67*4882a593Smuzhiyun 	bool boostable;
68*4882a593Smuzhiyun 	bool if_modifier;
69*4882a593Smuzhiyun 	/* Number of bytes of text poked */
70*4882a593Smuzhiyun 	int tp_len;
71*4882a593Smuzhiyun };
72*4882a593Smuzhiyun 
73*4882a593Smuzhiyun struct arch_optimized_insn {
74*4882a593Smuzhiyun 	/* copy of the original instructions */
75*4882a593Smuzhiyun 	kprobe_opcode_t copied_insn[DISP32_SIZE];
76*4882a593Smuzhiyun 	/* detour code buffer */
77*4882a593Smuzhiyun 	kprobe_opcode_t *insn;
78*4882a593Smuzhiyun 	/* the size of instructions copied to detour code buffer */
79*4882a593Smuzhiyun 	size_t size;
80*4882a593Smuzhiyun };
81*4882a593Smuzhiyun 
82*4882a593Smuzhiyun /* Return true (!0) if optinsn is prepared for optimization. */
arch_prepared_optinsn(struct arch_optimized_insn * optinsn)83*4882a593Smuzhiyun static inline int arch_prepared_optinsn(struct arch_optimized_insn *optinsn)
84*4882a593Smuzhiyun {
85*4882a593Smuzhiyun 	return optinsn->size;
86*4882a593Smuzhiyun }
87*4882a593Smuzhiyun 
88*4882a593Smuzhiyun struct prev_kprobe {
89*4882a593Smuzhiyun 	struct kprobe *kp;
90*4882a593Smuzhiyun 	unsigned long status;
91*4882a593Smuzhiyun 	unsigned long old_flags;
92*4882a593Smuzhiyun 	unsigned long saved_flags;
93*4882a593Smuzhiyun };
94*4882a593Smuzhiyun 
95*4882a593Smuzhiyun /* per-cpu kprobe control block */
96*4882a593Smuzhiyun struct kprobe_ctlblk {
97*4882a593Smuzhiyun 	unsigned long kprobe_status;
98*4882a593Smuzhiyun 	unsigned long kprobe_old_flags;
99*4882a593Smuzhiyun 	unsigned long kprobe_saved_flags;
100*4882a593Smuzhiyun 	struct prev_kprobe prev_kprobe;
101*4882a593Smuzhiyun };
102*4882a593Smuzhiyun 
103*4882a593Smuzhiyun extern int kprobe_fault_handler(struct pt_regs *regs, int trapnr);
104*4882a593Smuzhiyun extern int kprobe_exceptions_notify(struct notifier_block *self,
105*4882a593Smuzhiyun 				    unsigned long val, void *data);
106*4882a593Smuzhiyun extern int kprobe_int3_handler(struct pt_regs *regs);
107*4882a593Smuzhiyun extern int kprobe_debug_handler(struct pt_regs *regs);
108*4882a593Smuzhiyun 
109*4882a593Smuzhiyun #else
110*4882a593Smuzhiyun 
kprobe_debug_handler(struct pt_regs * regs)111*4882a593Smuzhiyun static inline int kprobe_debug_handler(struct pt_regs *regs) { return 0; }
112*4882a593Smuzhiyun 
113*4882a593Smuzhiyun #endif /* CONFIG_KPROBES */
114*4882a593Smuzhiyun #endif /* _ASM_X86_KPROBES_H */
115