blob: ffc73ac72485f666befc9e7b13c730930fd6681b [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Kernel Probes (KProbes)
3 * arch/x86_64/kernel/kprobes.c
4 *
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.
9 *
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.
14 *
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.
18 *
19 * Copyright (C) IBM Corporation, 2002, 2004
20 *
21 * 2002-Oct Created by Vamsi Krishna S <vamsi_krishna@in.ibm.com> Kernel
22 * Probes initial implementation ( includes contributions from
23 * Rusty Russell).
24 * 2004-July Suparna Bhattacharya <suparna@in.ibm.com> added jumper probes
25 * interface to access function arguments.
26 * 2004-Oct Jim Keniston <kenistoj@us.ibm.com> and Prasanna S Panchamukhi
27 * <prasanna@in.ibm.com> adapted for x86_64
28 * 2005-Mar Roland McGrath <roland@redhat.com>
29 * Fixed to handle %rip-relative addressing mode correctly.
Rusty Lynch73649da2005-06-23 00:09:23 -070030 * 2005-May Rusty Lynch <rusty.lynch@intel.com>
31 * Added function return probes functionality
Linus Torvalds1da177e2005-04-16 15:20:36 -070032 */
33
Linus Torvalds1da177e2005-04-16 15:20:36 -070034#include <linux/kprobes.h>
35#include <linux/ptrace.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070036#include <linux/string.h>
37#include <linux/slab.h>
38#include <linux/preempt.h>
Prasanna S Panchamukhic28f8962006-03-26 01:38:23 -080039#include <linux/module.h>
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070040
Rusty Lynch7e1048b2005-06-23 00:09:25 -070041#include <asm/cacheflush.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070042#include <asm/pgtable.h>
43#include <asm/kdebug.h>
Prasanna S Panchamukhic28f8962006-03-26 01:38:23 -080044#include <asm/uaccess.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
Linus Torvalds1da177e2005-04-16 15:20:36 -070046void jprobe_return_end(void);
Keshavamurthy Anil Sf709b122006-01-09 20:52:44 -080047static void __kprobes arch_copy_kprobe(struct kprobe *p);
Linus Torvalds1da177e2005-04-16 15:20:36 -070048
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -080049DEFINE_PER_CPU(struct kprobe *, current_kprobe) = NULL;
50DEFINE_PER_CPU(struct kprobe_ctlblk, kprobe_ctlblk);
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
52/*
53 * returns non-zero if opcode modifies the interrupt flag.
54 */
Prasanna S Panchamukhi3b602112006-04-18 22:22:00 -070055static __always_inline int is_IF_modifier(kprobe_opcode_t *insn)
Linus Torvalds1da177e2005-04-16 15:20:36 -070056{
57 switch (*insn) {
58 case 0xfa: /* cli */
59 case 0xfb: /* sti */
60 case 0xcf: /* iret/iretd */
61 case 0x9d: /* popf/popfd */
62 return 1;
63 }
64
65 if (*insn >= 0x40 && *insn <= 0x4f && *++insn == 0xcf)
66 return 1;
67 return 0;
68}
69
Prasanna S Panchamukhi0f2fbdc2005-09-06 15:19:28 -070070int __kprobes arch_prepare_kprobe(struct kprobe *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -070071{
72 /* insn: must be on special executable page on x86_64. */
Zhang, Yanmin2dd960d2005-09-30 11:59:20 -070073 p->ainsn.insn = get_insn_slot();
Linus Torvalds1da177e2005-04-16 15:20:36 -070074 if (!p->ainsn.insn) {
75 return -ENOMEM;
76 }
Anil S Keshavamurthy49a2a1b2006-01-09 20:52:43 -080077 arch_copy_kprobe(p);
Linus Torvalds1da177e2005-04-16 15:20:36 -070078 return 0;
79}
80
81/*
82 * Determine if the instruction uses the %rip-relative addressing mode.
83 * If it does, return the address of the 32-bit displacement word.
84 * If not, return null.
85 */
Prasanna S Panchamukhi3b602112006-04-18 22:22:00 -070086static s32 __kprobes *is_riprel(u8 *insn)
Linus Torvalds1da177e2005-04-16 15:20:36 -070087{
88#define W(row,b0,b1,b2,b3,b4,b5,b6,b7,b8,b9,ba,bb,bc,bd,be,bf) \
89 (((b0##UL << 0x0)|(b1##UL << 0x1)|(b2##UL << 0x2)|(b3##UL << 0x3) | \
90 (b4##UL << 0x4)|(b5##UL << 0x5)|(b6##UL << 0x6)|(b7##UL << 0x7) | \
91 (b8##UL << 0x8)|(b9##UL << 0x9)|(ba##UL << 0xa)|(bb##UL << 0xb) | \
92 (bc##UL << 0xc)|(bd##UL << 0xd)|(be##UL << 0xe)|(bf##UL << 0xf)) \
93 << (row % 64))
94 static const u64 onebyte_has_modrm[256 / 64] = {
95 /* 0 1 2 3 4 5 6 7 8 9 a b c d e f */
96 /* ------------------------------- */
97 W(0x00, 1,1,1,1,0,0,0,0,1,1,1,1,0,0,0,0)| /* 00 */
98 W(0x10, 1,1,1,1,0,0,0,0,1,1,1,1,0,0,0,0)| /* 10 */
99 W(0x20, 1,1,1,1,0,0,0,0,1,1,1,1,0,0,0,0)| /* 20 */
100 W(0x30, 1,1,1,1,0,0,0,0,1,1,1,1,0,0,0,0), /* 30 */
101 W(0x40, 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0)| /* 40 */
102 W(0x50, 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0)| /* 50 */
103 W(0x60, 0,0,1,1,0,0,0,0,0,1,0,1,0,0,0,0)| /* 60 */
104 W(0x70, 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0), /* 70 */
105 W(0x80, 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1)| /* 80 */
106 W(0x90, 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0)| /* 90 */
107 W(0xa0, 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0)| /* a0 */
108 W(0xb0, 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0), /* b0 */
109 W(0xc0, 1,1,0,0,1,1,1,1,0,0,0,0,0,0,0,0)| /* c0 */
110 W(0xd0, 1,1,1,1,0,0,0,0,1,1,1,1,1,1,1,1)| /* d0 */
111 W(0xe0, 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0)| /* e0 */
112 W(0xf0, 0,0,0,0,0,0,1,1,0,0,0,0,0,0,1,1) /* f0 */
113 /* ------------------------------- */
114 /* 0 1 2 3 4 5 6 7 8 9 a b c d e f */
115 };
116 static const u64 twobyte_has_modrm[256 / 64] = {
117 /* 0 1 2 3 4 5 6 7 8 9 a b c d e f */
118 /* ------------------------------- */
119 W(0x00, 1,1,1,1,0,0,0,0,0,0,0,0,0,1,0,1)| /* 0f */
120 W(0x10, 1,1,1,1,1,1,1,1,1,0,0,0,0,0,0,0)| /* 1f */
121 W(0x20, 1,1,1,1,1,0,1,0,1,1,1,1,1,1,1,1)| /* 2f */
122 W(0x30, 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0), /* 3f */
123 W(0x40, 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1)| /* 4f */
124 W(0x50, 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1)| /* 5f */
125 W(0x60, 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1)| /* 6f */
126 W(0x70, 1,1,1,1,1,1,1,0,0,0,0,0,1,1,1,1), /* 7f */
127 W(0x80, 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0)| /* 8f */
128 W(0x90, 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1)| /* 9f */
129 W(0xa0, 0,0,0,1,1,1,1,1,0,0,0,1,1,1,1,1)| /* af */
130 W(0xb0, 1,1,1,1,1,1,1,1,0,0,1,1,1,1,1,1), /* bf */
131 W(0xc0, 1,1,1,1,1,1,1,1,0,0,0,0,0,0,0,0)| /* cf */
132 W(0xd0, 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1)| /* df */
133 W(0xe0, 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1)| /* ef */
134 W(0xf0, 1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,0) /* ff */
135 /* ------------------------------- */
136 /* 0 1 2 3 4 5 6 7 8 9 a b c d e f */
137 };
138#undef W
139 int need_modrm;
140
141 /* Skip legacy instruction prefixes. */
142 while (1) {
143 switch (*insn) {
144 case 0x66:
145 case 0x67:
146 case 0x2e:
147 case 0x3e:
148 case 0x26:
149 case 0x64:
150 case 0x65:
151 case 0x36:
152 case 0xf0:
153 case 0xf3:
154 case 0xf2:
155 ++insn;
156 continue;
157 }
158 break;
159 }
160
161 /* Skip REX instruction prefix. */
162 if ((*insn & 0xf0) == 0x40)
163 ++insn;
164
165 if (*insn == 0x0f) { /* Two-byte opcode. */
166 ++insn;
167 need_modrm = test_bit(*insn, twobyte_has_modrm);
168 } else { /* One-byte opcode. */
169 need_modrm = test_bit(*insn, onebyte_has_modrm);
170 }
171
172 if (need_modrm) {
173 u8 modrm = *++insn;
174 if ((modrm & 0xc7) == 0x05) { /* %rip+disp32 addressing mode */
175 /* Displacement follows ModRM byte. */
176 return (s32 *) ++insn;
177 }
178 }
179
180 /* No %rip-relative addressing mode here. */
181 return NULL;
182}
183
Keshavamurthy Anil Sf709b122006-01-09 20:52:44 -0800184static void __kprobes arch_copy_kprobe(struct kprobe *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185{
186 s32 *ripdisp;
187 memcpy(p->ainsn.insn, p->addr, MAX_INSN_SIZE);
188 ripdisp = is_riprel(p->ainsn.insn);
189 if (ripdisp) {
190 /*
191 * The copied instruction uses the %rip-relative
192 * addressing mode. Adjust the displacement for the
193 * difference between the original location of this
194 * instruction and the location of the copy that will
195 * actually be run. The tricky bit here is making sure
196 * that the sign extension happens correctly in this
197 * calculation, since we need a signed 32-bit result to
198 * be sign-extended to 64 bits when it's added to the
199 * %rip value and yield the same 64-bit result that the
200 * sign-extension of the original signed 32-bit
201 * displacement would have given.
202 */
203 s64 disp = (u8 *) p->addr + *ripdisp - (u8 *) p->ainsn.insn;
204 BUG_ON((s64) (s32) disp != disp); /* Sanity check. */
205 *ripdisp = disp;
206 }
Rusty Lynch7e1048b2005-06-23 00:09:25 -0700207 p->opcode = *p->addr;
208}
209
Prasanna S Panchamukhi0f2fbdc2005-09-06 15:19:28 -0700210void __kprobes arch_arm_kprobe(struct kprobe *p)
Rusty Lynch7e1048b2005-06-23 00:09:25 -0700211{
212 *p->addr = BREAKPOINT_INSTRUCTION;
213 flush_icache_range((unsigned long) p->addr,
214 (unsigned long) p->addr + sizeof(kprobe_opcode_t));
215}
216
Prasanna S Panchamukhi0f2fbdc2005-09-06 15:19:28 -0700217void __kprobes arch_disarm_kprobe(struct kprobe *p)
Rusty Lynch7e1048b2005-06-23 00:09:25 -0700218{
219 *p->addr = p->opcode;
220 flush_icache_range((unsigned long) p->addr,
221 (unsigned long) p->addr + sizeof(kprobe_opcode_t));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222}
223
Ananth N Mavinakayanahalli0498b632006-01-09 20:52:46 -0800224void __kprobes arch_remove_kprobe(struct kprobe *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225{
Ingo Molnar7a7d1cf2006-03-23 03:00:35 -0800226 mutex_lock(&kprobe_mutex);
Zhang, Yanmin2dd960d2005-09-30 11:59:20 -0700227 free_insn_slot(p->ainsn.insn);
Ingo Molnar7a7d1cf2006-03-23 03:00:35 -0800228 mutex_unlock(&kprobe_mutex);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229}
230
Prasanna S Panchamukhi3b602112006-04-18 22:22:00 -0700231static void __kprobes save_previous_kprobe(struct kprobe_ctlblk *kcb)
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700232{
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800233 kcb->prev_kprobe.kp = kprobe_running();
234 kcb->prev_kprobe.status = kcb->kprobe_status;
235 kcb->prev_kprobe.old_rflags = kcb->kprobe_old_rflags;
236 kcb->prev_kprobe.saved_rflags = kcb->kprobe_saved_rflags;
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700237}
238
Prasanna S Panchamukhi3b602112006-04-18 22:22:00 -0700239static void __kprobes restore_previous_kprobe(struct kprobe_ctlblk *kcb)
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700240{
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800241 __get_cpu_var(current_kprobe) = kcb->prev_kprobe.kp;
242 kcb->kprobe_status = kcb->prev_kprobe.status;
243 kcb->kprobe_old_rflags = kcb->prev_kprobe.old_rflags;
244 kcb->kprobe_saved_rflags = kcb->prev_kprobe.saved_rflags;
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700245}
246
Prasanna S Panchamukhi3b602112006-04-18 22:22:00 -0700247static void __kprobes set_current_kprobe(struct kprobe *p, struct pt_regs *regs,
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800248 struct kprobe_ctlblk *kcb)
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700249{
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800250 __get_cpu_var(current_kprobe) = p;
251 kcb->kprobe_saved_rflags = kcb->kprobe_old_rflags
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700252 = (regs->eflags & (TF_MASK | IF_MASK));
253 if (is_IF_modifier(p->ainsn.insn))
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800254 kcb->kprobe_saved_rflags &= ~IF_MASK;
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700255}
256
Prasanna S Panchamukhi0f2fbdc2005-09-06 15:19:28 -0700257static void __kprobes prepare_singlestep(struct kprobe *p, struct pt_regs *regs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258{
259 regs->eflags |= TF_MASK;
260 regs->eflags &= ~IF_MASK;
261 /*single step inline if the instruction is an int3*/
262 if (p->opcode == BREAKPOINT_INSTRUCTION)
263 regs->rip = (unsigned long)p->addr;
264 else
265 regs->rip = (unsigned long)p->ainsn.insn;
266}
267
Ananth N Mavinakayanahalli991a51d2005-11-07 01:00:14 -0800268/* Called with kretprobe_lock held */
Prasanna S Panchamukhi0f2fbdc2005-09-06 15:19:28 -0700269void __kprobes arch_prepare_kretprobe(struct kretprobe *rp,
270 struct pt_regs *regs)
Rusty Lynch73649da2005-06-23 00:09:23 -0700271{
272 unsigned long *sara = (unsigned long *)regs->rsp;
Rusty Lynchba8af122005-06-27 15:17:10 -0700273 struct kretprobe_instance *ri;
Rusty Lynch73649da2005-06-23 00:09:23 -0700274
Rusty Lynchba8af122005-06-27 15:17:10 -0700275 if ((ri = get_free_rp_inst(rp)) != NULL) {
276 ri->rp = rp;
277 ri->task = current;
278 ri->ret_addr = (kprobe_opcode_t *) *sara;
Rusty Lynch73649da2005-06-23 00:09:23 -0700279
Rusty Lynch73649da2005-06-23 00:09:23 -0700280 /* Replace the return addr with trampoline addr */
281 *sara = (unsigned long) &kretprobe_trampoline;
Rusty Lynch73649da2005-06-23 00:09:23 -0700282
Rusty Lynchba8af122005-06-27 15:17:10 -0700283 add_rp_inst(ri);
284 } else {
285 rp->nmissed++;
286 }
Rusty Lynch73649da2005-06-23 00:09:23 -0700287}
288
Prasanna S Panchamukhi0f2fbdc2005-09-06 15:19:28 -0700289int __kprobes kprobe_handler(struct pt_regs *regs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290{
291 struct kprobe *p;
292 int ret = 0;
293 kprobe_opcode_t *addr = (kprobe_opcode_t *)(regs->rip - sizeof(kprobe_opcode_t));
Ananth N Mavinakayanahallid217d542005-11-07 01:00:14 -0800294 struct kprobe_ctlblk *kcb;
295
296 /*
297 * We don't want to be preempted for the entire
298 * duration of kprobe processing
299 */
300 preempt_disable();
301 kcb = get_kprobe_ctlblk();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 /* Check we're not actually recursing */
304 if (kprobe_running()) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305 p = get_kprobe(addr);
306 if (p) {
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800307 if (kcb->kprobe_status == KPROBE_HIT_SS &&
Keshavamurthy Anil Sdeac66a2005-09-06 15:19:35 -0700308 *p->ainsn.insn == BREAKPOINT_INSTRUCTION) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309 regs->eflags &= ~TF_MASK;
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800310 regs->eflags |= kcb->kprobe_saved_rflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 goto no_kprobe;
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800312 } else if (kcb->kprobe_status == KPROBE_HIT_SSDONE) {
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700313 /* TODO: Provide re-entrancy from
314 * post_kprobes_handler() and avoid exception
315 * stack corruption while single-stepping on
316 * the instruction of the new probe.
317 */
318 arch_disarm_kprobe(p);
319 regs->rip = (unsigned long)p->addr;
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800320 reset_current_kprobe();
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700321 ret = 1;
322 } else {
323 /* We have reentered the kprobe_handler(), since
324 * another probe was hit while within the
325 * handler. We here save the original kprobe
326 * variables and just single step on instruction
327 * of the new probe without calling any user
328 * handlers.
329 */
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800330 save_previous_kprobe(kcb);
331 set_current_kprobe(p, regs, kcb);
Keshavamurthy Anil Sbf8d5c52005-12-12 00:37:34 -0800332 kprobes_inc_nmissed_count(p);
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700333 prepare_singlestep(p, regs);
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800334 kcb->kprobe_status = KPROBE_REENTER;
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700335 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337 } else {
Keshavamurthy Anil Seb3a7292006-01-11 12:17:42 -0800338 if (*addr != BREAKPOINT_INSTRUCTION) {
339 /* The breakpoint instruction was removed by
340 * another cpu right after we hit, no further
341 * handling of this interrupt is appropriate
342 */
343 regs->rip = (unsigned long)addr;
344 ret = 1;
345 goto no_kprobe;
346 }
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800347 p = __get_cpu_var(current_kprobe);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 if (p->break_handler && p->break_handler(p, regs)) {
349 goto ss_probe;
350 }
351 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 goto no_kprobe;
353 }
354
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 p = get_kprobe(addr);
356 if (!p) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 if (*addr != BREAKPOINT_INSTRUCTION) {
358 /*
359 * The breakpoint instruction was removed right
360 * after we hit it. Another cpu has removed
361 * either a probepoint or a debugger breakpoint
362 * at this address. In either case, no further
363 * handling of this interrupt is appropriate.
Jim Kenistonbce06492005-09-06 15:19:34 -0700364 * Back up over the (now missing) int3 and run
365 * the original instruction.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366 */
Jim Kenistonbce06492005-09-06 15:19:34 -0700367 regs->rip = (unsigned long)addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700368 ret = 1;
369 }
370 /* Not one of ours: let kernel handle it */
371 goto no_kprobe;
372 }
373
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800374 set_current_kprobe(p, regs, kcb);
375 kcb->kprobe_status = KPROBE_HIT_ACTIVE;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700376
377 if (p->pre_handler && p->pre_handler(p, regs))
378 /* handler has already set things up, so skip ss setup */
379 return 1;
380
381ss_probe:
382 prepare_singlestep(p, regs);
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800383 kcb->kprobe_status = KPROBE_HIT_SS;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 return 1;
385
386no_kprobe:
Ananth N Mavinakayanahallid217d542005-11-07 01:00:14 -0800387 preempt_enable_no_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 return ret;
389}
390
391/*
Rusty Lynch73649da2005-06-23 00:09:23 -0700392 * For function-return probes, init_kprobes() establishes a probepoint
393 * here. When a retprobed function returns, this probe is hit and
394 * trampoline_probe_handler() runs, calling the kretprobe's handler.
395 */
396 void kretprobe_trampoline_holder(void)
397 {
398 asm volatile ( ".global kretprobe_trampoline\n"
399 "kretprobe_trampoline: \n"
400 "nop\n");
401 }
402
403/*
404 * Called when we hit the probe point at kretprobe_trampoline
405 */
Prasanna S Panchamukhi0f2fbdc2005-09-06 15:19:28 -0700406int __kprobes trampoline_probe_handler(struct kprobe *p, struct pt_regs *regs)
Rusty Lynch73649da2005-06-23 00:09:23 -0700407{
Rusty Lynchba8af122005-06-27 15:17:10 -0700408 struct kretprobe_instance *ri = NULL;
409 struct hlist_head *head;
410 struct hlist_node *node, *tmp;
Ananth N Mavinakayanahalli991a51d2005-11-07 01:00:14 -0800411 unsigned long flags, orig_ret_address = 0;
Rusty Lynchba8af122005-06-27 15:17:10 -0700412 unsigned long trampoline_address =(unsigned long)&kretprobe_trampoline;
Rusty Lynch73649da2005-06-23 00:09:23 -0700413
Ananth N Mavinakayanahalli991a51d2005-11-07 01:00:14 -0800414 spin_lock_irqsave(&kretprobe_lock, flags);
Rusty Lynchba8af122005-06-27 15:17:10 -0700415 head = kretprobe_inst_table_head(current);
Rusty Lynch73649da2005-06-23 00:09:23 -0700416
Rusty Lynchba8af122005-06-27 15:17:10 -0700417 /*
418 * It is possible to have multiple instances associated with a given
419 * task either because an multiple functions in the call path
420 * have a return probe installed on them, and/or more then one return
421 * return probe was registered for a target function.
422 *
423 * We can handle this because:
424 * - instances are always inserted at the head of the list
425 * - when multiple return probes are registered for the same
426 * function, the first instance's ret_addr will point to the
427 * real return address, and all the rest will point to
428 * kretprobe_trampoline
429 */
430 hlist_for_each_entry_safe(ri, node, tmp, head, hlist) {
431 if (ri->task != current)
432 /* another task is sharing our hash bucket */
433 continue;
Rusty Lynch73649da2005-06-23 00:09:23 -0700434
Rusty Lynchba8af122005-06-27 15:17:10 -0700435 if (ri->rp && ri->rp->handler)
436 ri->rp->handler(ri, regs);
Rusty Lynch73649da2005-06-23 00:09:23 -0700437
Rusty Lynchba8af122005-06-27 15:17:10 -0700438 orig_ret_address = (unsigned long)ri->ret_addr;
Rusty Lynch73649da2005-06-23 00:09:23 -0700439 recycle_rp_inst(ri);
Rusty Lynchba8af122005-06-27 15:17:10 -0700440
441 if (orig_ret_address != trampoline_address)
442 /*
443 * This is the real return address. Any other
444 * instances associated with this task are for
445 * other calls deeper on the call stack
446 */
447 break;
Rusty Lynch73649da2005-06-23 00:09:23 -0700448 }
Rusty Lynchba8af122005-06-27 15:17:10 -0700449
450 BUG_ON(!orig_ret_address || (orig_ret_address == trampoline_address));
451 regs->rip = orig_ret_address;
452
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800453 reset_current_kprobe();
Ananth N Mavinakayanahalli991a51d2005-11-07 01:00:14 -0800454 spin_unlock_irqrestore(&kretprobe_lock, flags);
Rusty Lynchba8af122005-06-27 15:17:10 -0700455 preempt_enable_no_resched();
456
457 /*
458 * By returning a non-zero value, we are telling
Ananth N Mavinakayanahallid217d542005-11-07 01:00:14 -0800459 * kprobe_handler() that we don't want the post_handler
460 * to run (and have re-enabled preemption)
Rusty Lynchba8af122005-06-27 15:17:10 -0700461 */
462 return 1;
Rusty Lynch73649da2005-06-23 00:09:23 -0700463}
464
465/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 * Called after single-stepping. p->addr is the address of the
467 * instruction whose first byte has been replaced by the "int 3"
468 * instruction. To avoid the SMP problems that can occur when we
469 * temporarily put back the original opcode to single-step, we
470 * single-stepped a copy of the instruction. The address of this
471 * copy is p->ainsn.insn.
472 *
473 * This function prepares to return from the post-single-step
474 * interrupt. We have to fix up the stack as follows:
475 *
476 * 0) Except in the case of absolute or indirect jump or call instructions,
477 * the new rip is relative to the copied instruction. We need to make
478 * it relative to the original instruction.
479 *
480 * 1) If the single-stepped instruction was pushfl, then the TF and IF
481 * flags are set in the just-pushed eflags, and may need to be cleared.
482 *
483 * 2) If the single-stepped instruction was a call, the return address
484 * that is atop the stack is the address following the copied instruction.
485 * We need to make it the address following the original instruction.
486 */
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800487static void __kprobes resume_execution(struct kprobe *p,
488 struct pt_regs *regs, struct kprobe_ctlblk *kcb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700489{
490 unsigned long *tos = (unsigned long *)regs->rsp;
491 unsigned long next_rip = 0;
492 unsigned long copy_rip = (unsigned long)p->ainsn.insn;
493 unsigned long orig_rip = (unsigned long)p->addr;
494 kprobe_opcode_t *insn = p->ainsn.insn;
495
496 /*skip the REX prefix*/
497 if (*insn >= 0x40 && *insn <= 0x4f)
498 insn++;
499
500 switch (*insn) {
501 case 0x9c: /* pushfl */
502 *tos &= ~(TF_MASK | IF_MASK);
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800503 *tos |= kcb->kprobe_old_rflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 break;
Prasanna S Panchamukhi0b9e2ca2005-05-05 16:15:40 -0700505 case 0xc3: /* ret/lret */
506 case 0xcb:
507 case 0xc2:
508 case 0xca:
509 regs->eflags &= ~TF_MASK;
510 /* rip is already adjusted, no more changes required*/
511 return;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 case 0xe8: /* call relative - Fix return addr */
513 *tos = orig_rip + (*tos - copy_rip);
514 break;
515 case 0xff:
Satoshi Oshimadc49e342006-05-20 15:00:21 -0700516 if ((insn[1] & 0x30) == 0x10) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517 /* call absolute, indirect */
518 /* Fix return addr; rip is correct. */
519 next_rip = regs->rip;
520 *tos = orig_rip + (*tos - copy_rip);
Satoshi Oshimadc49e342006-05-20 15:00:21 -0700521 } else if (((insn[1] & 0x31) == 0x20) || /* jmp near, absolute indirect */
522 ((insn[1] & 0x31) == 0x21)) { /* jmp far, absolute indirect */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523 /* rip is correct. */
524 next_rip = regs->rip;
525 }
526 break;
527 case 0xea: /* jmp absolute -- rip is correct */
528 next_rip = regs->rip;
529 break;
530 default:
531 break;
532 }
533
534 regs->eflags &= ~TF_MASK;
535 if (next_rip) {
536 regs->rip = next_rip;
537 } else {
538 regs->rip = orig_rip + (regs->rip - copy_rip);
539 }
540}
541
Prasanna S Panchamukhi0f2fbdc2005-09-06 15:19:28 -0700542int __kprobes post_kprobe_handler(struct pt_regs *regs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543{
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800544 struct kprobe *cur = kprobe_running();
545 struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
546
547 if (!cur)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 return 0;
549
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800550 if ((kcb->kprobe_status != KPROBE_REENTER) && cur->post_handler) {
551 kcb->kprobe_status = KPROBE_HIT_SSDONE;
552 cur->post_handler(cur, regs, 0);
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700553 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800555 resume_execution(cur, regs, kcb);
556 regs->eflags |= kcb->kprobe_saved_rflags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700558 /* Restore the original saved kprobes variables and continue. */
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800559 if (kcb->kprobe_status == KPROBE_REENTER) {
560 restore_previous_kprobe(kcb);
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700561 goto out;
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700562 }
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800563 reset_current_kprobe();
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700564out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 preempt_enable_no_resched();
566
567 /*
568 * if somebody else is singlestepping across a probe point, eflags
569 * will have TF set, in which case, continue the remaining processing
570 * of do_debug, as if this is not a probe hit.
571 */
572 if (regs->eflags & TF_MASK)
573 return 0;
574
575 return 1;
576}
577
Prasanna S Panchamukhi0f2fbdc2005-09-06 15:19:28 -0700578int __kprobes kprobe_fault_handler(struct pt_regs *regs, int trapnr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579{
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800580 struct kprobe *cur = kprobe_running();
581 struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
Prasanna S Panchamukhic28f8962006-03-26 01:38:23 -0800582 const struct exception_table_entry *fixup;
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800583
Prasanna S Panchamukhic28f8962006-03-26 01:38:23 -0800584 switch(kcb->kprobe_status) {
585 case KPROBE_HIT_SS:
586 case KPROBE_REENTER:
587 /*
588 * We are here because the instruction being single
589 * stepped caused a page fault. We reset the current
590 * kprobe and the rip points back to the probe address
591 * and allow the page fault handler to continue as a
592 * normal page fault.
593 */
594 regs->rip = (unsigned long)cur->addr;
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800595 regs->eflags |= kcb->kprobe_old_rflags;
Prasanna S Panchamukhic28f8962006-03-26 01:38:23 -0800596 if (kcb->kprobe_status == KPROBE_REENTER)
597 restore_previous_kprobe(kcb);
598 else
599 reset_current_kprobe();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600 preempt_enable_no_resched();
Prasanna S Panchamukhic28f8962006-03-26 01:38:23 -0800601 break;
602 case KPROBE_HIT_ACTIVE:
603 case KPROBE_HIT_SSDONE:
604 /*
605 * We increment the nmissed count for accounting,
606 * we can also use npre/npostfault count for accouting
607 * these specific fault cases.
608 */
609 kprobes_inc_nmissed_count(cur);
610
611 /*
612 * We come here because instructions in the pre/post
613 * handler caused the page_fault, this could happen
614 * if handler tries to access user space by
615 * copy_from_user(), get_user() etc. Let the
616 * user-specified handler try to fix it first.
617 */
618 if (cur->fault_handler && cur->fault_handler(cur, regs, trapnr))
619 return 1;
620
621 /*
622 * In case the user-specified fault handler returned
623 * zero, try to fix up.
624 */
625 fixup = search_exception_tables(regs->rip);
626 if (fixup) {
627 regs->rip = fixup->fixup;
628 return 1;
629 }
630
631 /*
632 * fixup() could not handle it,
633 * Let do_page_fault() fix it.
634 */
635 break;
636 default:
637 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 }
639 return 0;
640}
641
642/*
643 * Wrapper routine for handling exceptions.
644 */
Prasanna S Panchamukhi0f2fbdc2005-09-06 15:19:28 -0700645int __kprobes kprobe_exceptions_notify(struct notifier_block *self,
646 unsigned long val, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647{
648 struct die_args *args = (struct die_args *)data;
Ananth N Mavinakayanahalli66ff2d02005-11-07 01:00:07 -0800649 int ret = NOTIFY_DONE;
650
bibo,mao2326c772006-03-26 01:38:21 -0800651 if (args->regs && user_mode(args->regs))
652 return ret;
653
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 switch (val) {
655 case DIE_INT3:
656 if (kprobe_handler(args->regs))
Ananth N Mavinakayanahalli66ff2d02005-11-07 01:00:07 -0800657 ret = NOTIFY_STOP;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658 break;
659 case DIE_DEBUG:
660 if (post_kprobe_handler(args->regs))
Ananth N Mavinakayanahalli66ff2d02005-11-07 01:00:07 -0800661 ret = NOTIFY_STOP;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662 break;
663 case DIE_GPF:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 case DIE_PAGE_FAULT:
Ananth N Mavinakayanahallid217d542005-11-07 01:00:14 -0800665 /* kprobe_running() needs smp_processor_id() */
666 preempt_disable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667 if (kprobe_running() &&
668 kprobe_fault_handler(args->regs, args->trapnr))
Ananth N Mavinakayanahalli66ff2d02005-11-07 01:00:07 -0800669 ret = NOTIFY_STOP;
Ananth N Mavinakayanahallid217d542005-11-07 01:00:14 -0800670 preempt_enable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671 break;
672 default:
673 break;
674 }
Ananth N Mavinakayanahalli66ff2d02005-11-07 01:00:07 -0800675 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676}
677
Prasanna S Panchamukhi0f2fbdc2005-09-06 15:19:28 -0700678int __kprobes setjmp_pre_handler(struct kprobe *p, struct pt_regs *regs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679{
680 struct jprobe *jp = container_of(p, struct jprobe, kp);
681 unsigned long addr;
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800682 struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800684 kcb->jprobe_saved_regs = *regs;
685 kcb->jprobe_saved_rsp = (long *) regs->rsp;
686 addr = (unsigned long)(kcb->jprobe_saved_rsp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 /*
688 * As Linus pointed out, gcc assumes that the callee
689 * owns the argument space and could overwrite it, e.g.
690 * tailcall optimization. So, to be absolutely safe
691 * we also save and restore enough stack bytes to cover
692 * the argument area.
693 */
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800694 memcpy(kcb->jprobes_stack, (kprobe_opcode_t *)addr,
695 MIN_STACK_SIZE(addr));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 regs->eflags &= ~IF_MASK;
697 regs->rip = (unsigned long)(jp->entry);
698 return 1;
699}
700
Prasanna S Panchamukhi0f2fbdc2005-09-06 15:19:28 -0700701void __kprobes jprobe_return(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702{
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800703 struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
704
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705 asm volatile (" xchg %%rbx,%%rsp \n"
706 " int3 \n"
707 " .globl jprobe_return_end \n"
708 " jprobe_return_end: \n"
709 " nop \n"::"b"
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800710 (kcb->jprobe_saved_rsp):"memory");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711}
712
Prasanna S Panchamukhi0f2fbdc2005-09-06 15:19:28 -0700713int __kprobes longjmp_break_handler(struct kprobe *p, struct pt_regs *regs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714{
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800715 struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 u8 *addr = (u8 *) (regs->rip - 1);
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800717 unsigned long stack_addr = (unsigned long)(kcb->jprobe_saved_rsp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 struct jprobe *jp = container_of(p, struct jprobe, kp);
719
720 if ((addr > (u8 *) jprobe_return) && (addr < (u8 *) jprobe_return_end)) {
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800721 if ((long *)regs->rsp != kcb->jprobe_saved_rsp) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 struct pt_regs *saved_regs =
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800723 container_of(kcb->jprobe_saved_rsp,
724 struct pt_regs, rsp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725 printk("current rsp %p does not match saved rsp %p\n",
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800726 (long *)regs->rsp, kcb->jprobe_saved_rsp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 printk("Saved registers for jprobe %p\n", jp);
728 show_registers(saved_regs);
729 printk("Current registers\n");
730 show_registers(regs);
731 BUG();
732 }
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800733 *regs = kcb->jprobe_saved_regs;
734 memcpy((kprobe_opcode_t *) stack_addr, kcb->jprobes_stack,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 MIN_STACK_SIZE(stack_addr));
Ananth N Mavinakayanahallid217d542005-11-07 01:00:14 -0800736 preempt_enable_no_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 return 1;
738 }
739 return 0;
740}
Rusty Lynchba8af122005-06-27 15:17:10 -0700741
742static struct kprobe trampoline_p = {
743 .addr = (kprobe_opcode_t *) &kretprobe_trampoline,
744 .pre_handler = trampoline_probe_handler
745};
746
Rusty Lynch67729262005-07-05 18:54:50 -0700747int __init arch_init_kprobes(void)
Rusty Lynchba8af122005-06-27 15:17:10 -0700748{
749 return register_kprobe(&trampoline_p);
750}