xref: /openbmc/linux/arch/x86/kernel/kprobes/ftrace.c (revision 03ab8e6297acd1bc0eedaa050e2a1635c576fd11)
11a59d1b8SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-or-later
2f684199fSMasami Hiramatsu /*
3f684199fSMasami Hiramatsu  * Dynamic Ftrace based Kprobes Optimization
4f684199fSMasami Hiramatsu  *
5f684199fSMasami Hiramatsu  * Copyright (C) Hitachi Ltd., 2012
6f684199fSMasami Hiramatsu  */
7f684199fSMasami Hiramatsu #include <linux/kprobes.h>
8f684199fSMasami Hiramatsu #include <linux/ptrace.h>
9f684199fSMasami Hiramatsu #include <linux/hardirq.h>
10f684199fSMasami Hiramatsu #include <linux/preempt.h>
11f684199fSMasami Hiramatsu #include <linux/ftrace.h>
12f684199fSMasami Hiramatsu 
13f684199fSMasami Hiramatsu #include "common.h"
14f684199fSMasami Hiramatsu 
15*d9f6e12fSIngo Molnar /* Ftrace callback handler for kprobes -- called under preempt disabled */
kprobe_ftrace_handler(unsigned long ip,unsigned long parent_ip,struct ftrace_ops * ops,struct ftrace_regs * fregs)169326638cSMasami Hiramatsu void kprobe_ftrace_handler(unsigned long ip, unsigned long parent_ip,
17d19ad077SSteven Rostedt (VMware) 			   struct ftrace_ops *ops, struct ftrace_regs *fregs)
18f684199fSMasami Hiramatsu {
19d19ad077SSteven Rostedt (VMware) 	struct pt_regs *regs = ftrace_get_regs(fregs);
20f684199fSMasami Hiramatsu 	struct kprobe *p;
21f684199fSMasami Hiramatsu 	struct kprobe_ctlblk *kcb;
22c536aa1cSSteven Rostedt (VMware) 	int bit;
23f684199fSMasami Hiramatsu 
24773c1670SSteven Rostedt (VMware) 	if (unlikely(kprobe_ftrace_disabled))
25c536aa1cSSteven Rostedt (VMware) 		return;
26c536aa1cSSteven Rostedt (VMware) 
27c536aa1cSSteven Rostedt (VMware) 	bit = ftrace_test_recursion_trylock(ip, parent_ip);
28f684199fSMasami Hiramatsu 	if (bit < 0)
29f684199fSMasami Hiramatsu 		return;
30c536aa1cSSteven Rostedt (VMware) 
31f684199fSMasami Hiramatsu 	p = get_kprobe((kprobe_opcode_t *)ip);
32f684199fSMasami Hiramatsu 	if (unlikely(!p) || kprobe_disabled(p))
33f684199fSMasami Hiramatsu 		goto out;
34f684199fSMasami Hiramatsu 
35f684199fSMasami Hiramatsu 	kcb = get_kprobe_ctlblk();
36a017784fSMasami Hiramatsu 	if (kprobe_running()) {
37f684199fSMasami Hiramatsu 		kprobes_inc_nmissed_count(p);
38f684199fSMasami Hiramatsu 	} else {
39f684199fSMasami Hiramatsu 		unsigned long orig_ip = regs->ip;
40f684199fSMasami Hiramatsu 		/* Kprobe handler expects regs->ip = ip + 1 as breakpoint hit */
41f684199fSMasami Hiramatsu 		regs->ip = ip + sizeof(kprobe_opcode_t);
425bb4fc2dSMasami Hiramatsu 
43e704e34cSMasami Hiramatsu 		__this_cpu_write(current_kprobe, p);
44e704e34cSMasami Hiramatsu 		kcb->kprobe_status = KPROBE_HIT_ACTIVE;
45e704e34cSMasami Hiramatsu 		if (!p->pre_handler || !p->pre_handler(p, regs)) {
46e704e34cSMasami Hiramatsu 			/*
47e704e34cSMasami Hiramatsu 			 * Emulate singlestep (and also recover regs->ip)
48e704e34cSMasami Hiramatsu 			 * as if there is a 5byte nop
49e704e34cSMasami Hiramatsu 			 */
50e704e34cSMasami Hiramatsu 			regs->ip = (unsigned long)p->addr + MCOUNT_INSN_SIZE;
51e704e34cSMasami Hiramatsu 			if (unlikely(p->post_handler)) {
52e704e34cSMasami Hiramatsu 				kcb->kprobe_status = KPROBE_HIT_SSDONE;
535bb4fc2dSMasami Hiramatsu 				p->post_handler(p, regs, 0);
54f684199fSMasami Hiramatsu 			}
55cce188bdSMasami Hiramatsu 			regs->ip = orig_ip;
56cce188bdSMasami Hiramatsu 		}
57f684199fSMasami Hiramatsu 		/*
58cce188bdSMasami Hiramatsu 		 * If pre_handler returns !0, it changes regs->ip. We have to
59f684199fSMasami Hiramatsu 		 * skip emulating post_handler.
60c536aa1cSSteven Rostedt (VMware) 		 */
61c536aa1cSSteven Rostedt (VMware) 		__this_cpu_write(current_kprobe, NULL);
62f684199fSMasami Hiramatsu 	}
639326638cSMasami Hiramatsu out:
64f684199fSMasami Hiramatsu 	ftrace_test_recursion_unlock(bit);
657ec8a97aSMasami Hiramatsu }
66f684199fSMasami Hiramatsu NOKPROBE_SYMBOL(kprobe_ftrace_handler);
67f684199fSMasami Hiramatsu 
arch_prepare_kprobe_ftrace(struct kprobe * p)68490154bcSMasami Hiramatsu int arch_prepare_kprobe_ftrace(struct kprobe *p)
69f684199fSMasami Hiramatsu {
70f684199fSMasami Hiramatsu 	p->ainsn.insn = NULL;
71 	p->ainsn.boostable = false;
72 	return 0;
73 }
74