2 * Kernel Probes (KProbes)
3 * arch/ppc64/kernel/kprobes.c
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
19 * Copyright (C) IBM Corporation, 2002, 2004
21 * 2002-Oct Created by Vamsi Krishna S <vamsi_krishna@in.ibm.com> Kernel
22 * Probes initial implementation ( includes contributions from
24 * 2004-July Suparna Bhattacharya <suparna@in.ibm.com> added jumper probes
25 * interface to access function arguments.
26 * 2004-Nov Ananth N Mavinakayanahalli <ananth@in.ibm.com> kprobes port
30 #include <linux/config.h>
31 #include <linux/kprobes.h>
32 #include <linux/ptrace.h>
33 #include <linux/spinlock.h>
34 #include <linux/preempt.h>
35 #include <asm/kdebug.h>
36 #include <asm/sstep.h>
38 /* kprobe_status settings */
39 #define KPROBE_HIT_ACTIVE 0x00000001
40 #define KPROBE_HIT_SS 0x00000002
42 static struct kprobe *current_kprobe;
43 static unsigned long kprobe_status, kprobe_saved_msr;
44 static struct pt_regs jprobe_saved_regs;
46 int arch_prepare_kprobe(struct kprobe *p)
49 kprobe_opcode_t insn = *p->addr;
51 if ((unsigned long)p->addr & 0x03) {
52 printk("Attempt to register kprobe at an unaligned address\n");
54 } else if (IS_MTMSRD(insn) || IS_RFID(insn)) {
55 printk("Cannot register a kprobe on rfid or mtmsrd\n");
61 void arch_copy_kprobe(struct kprobe *p)
63 memcpy(p->ainsn.insn, p->addr, MAX_INSN_SIZE * sizeof(kprobe_opcode_t));
66 void arch_remove_kprobe(struct kprobe *p)
70 static inline void disarm_kprobe(struct kprobe *p, struct pt_regs *regs)
73 regs->nip = (unsigned long)p->addr;
76 static inline void prepare_singlestep(struct kprobe *p, struct pt_regs *regs)
79 /*single step inline if it a breakpoint instruction*/
80 if (p->opcode == BREAKPOINT_INSTRUCTION)
81 regs->nip = (unsigned long)p->addr;
83 regs->nip = (unsigned long)&p->ainsn.insn;
86 static inline int kprobe_handler(struct pt_regs *regs)
90 unsigned int *addr = (unsigned int *)regs->nip;
92 /* Check we're not actually recursing */
93 if (kprobe_running()) {
94 /* We *are* holding lock here, so this is safe.
95 Disarm the probe we just hit, and ignore it. */
98 if (kprobe_status == KPROBE_HIT_SS) {
100 regs->msr |= kprobe_saved_msr;
104 disarm_kprobe(p, regs);
108 if (p->break_handler && p->break_handler(p, regs)) {
112 /* If it's not ours, can't be delete race, (we hold lock). */
117 p = get_kprobe(addr);
120 if (*addr != BREAKPOINT_INSTRUCTION) {
122 * PowerPC has multiple variants of the "trap"
123 * instruction. If the current instruction is a
124 * trap variant, it could belong to someone else
126 kprobe_opcode_t cur_insn = *addr;
127 if (IS_TW(cur_insn) || IS_TD(cur_insn) ||
128 IS_TWI(cur_insn) || IS_TDI(cur_insn))
131 * The breakpoint instruction was removed right
132 * after we hit it. Another cpu has removed
133 * either a probepoint or a debugger breakpoint
134 * at this address. In either case, no further
135 * handling of this interrupt is appropriate.
139 /* Not one of ours: let kernel handle it */
143 kprobe_status = KPROBE_HIT_ACTIVE;
145 kprobe_saved_msr = regs->msr;
146 if (p->pre_handler && p->pre_handler(p, regs))
147 /* handler has already set things up, so skip ss setup */
151 prepare_singlestep(p, regs);
152 kprobe_status = KPROBE_HIT_SS;
154 * This preempt_disable() matches the preempt_enable_no_resched()
155 * in post_kprobe_handler().
165 * Called after single-stepping. p->addr is the address of the
166 * instruction whose first byte has been replaced by the "breakpoint"
167 * instruction. To avoid the SMP problems that can occur when we
168 * temporarily put back the original opcode to single-step, we
169 * single-stepped a copy of the instruction. The address of this
170 * copy is p->ainsn.insn.
172 static void resume_execution(struct kprobe *p, struct pt_regs *regs)
176 regs->nip = (unsigned long)p->addr;
177 ret = emulate_step(regs, p->ainsn.insn[0]);
179 regs->nip = (unsigned long)p->addr + 4;
182 static inline int post_kprobe_handler(struct pt_regs *regs)
184 if (!kprobe_running())
187 if (current_kprobe->post_handler)
188 current_kprobe->post_handler(current_kprobe, regs, 0);
190 resume_execution(current_kprobe, regs);
191 regs->msr |= kprobe_saved_msr;
194 preempt_enable_no_resched();
197 * if somebody else is singlestepping across a probe point, msr
198 * will have SE set, in which case, continue the remaining processing
199 * of do_debug, as if this is not a probe hit.
201 if (regs->msr & MSR_SE)
207 /* Interrupts disabled, kprobe_lock held. */
208 static inline int kprobe_fault_handler(struct pt_regs *regs, int trapnr)
210 if (current_kprobe->fault_handler
211 && current_kprobe->fault_handler(current_kprobe, regs, trapnr))
214 if (kprobe_status & KPROBE_HIT_SS) {
215 resume_execution(current_kprobe, regs);
216 regs->msr &= ~MSR_SE;
217 regs->msr |= kprobe_saved_msr;
220 preempt_enable_no_resched();
226 * Wrapper routine to for handling exceptions.
228 int kprobe_exceptions_notify(struct notifier_block *self, unsigned long val,
231 struct die_args *args = (struct die_args *)data;
232 int ret = NOTIFY_DONE;
235 * Interrupts are not disabled here. We need to disable
236 * preemption, because kprobe_running() uses smp_processor_id().
241 if (kprobe_handler(args->regs))
245 if (post_kprobe_handler(args->regs))
250 if (kprobe_running() &&
251 kprobe_fault_handler(args->regs, args->trapnr))
261 int setjmp_pre_handler(struct kprobe *p, struct pt_regs *regs)
263 struct jprobe *jp = container_of(p, struct jprobe, kp);
265 memcpy(&jprobe_saved_regs, regs, sizeof(struct pt_regs));
267 /* setup return addr to the jprobe handler routine */
268 regs->nip = (unsigned long)(((func_descr_t *)jp->entry)->entry);
269 regs->gpr[2] = (unsigned long)(((func_descr_t *)jp->entry)->toc);
274 void jprobe_return(void)
276 asm volatile("trap" ::: "memory");
279 void jprobe_return_end(void)
283 int longjmp_break_handler(struct kprobe *p, struct pt_regs *regs)
286 * FIXME - we should ideally be validating that we got here 'cos
287 * of the "trap" in jprobe_return() above, before restoring the
290 memcpy(regs, &jprobe_saved_regs, sizeof(struct pt_regs));