blob: e0fb615ba1e9bdde540be7bff8453275778a841d [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
2 * Kernel Probes (KProbes)
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17 *
18 * Copyright (C) IBM Corporation, 2002, 2004
19 *
20 * 2002-Oct Created by Vamsi Krishna S <vamsi_krishna@in.ibm.com> Kernel
21 * Probes initial implementation ( includes contributions from
22 * Rusty Russell).
23 * 2004-July Suparna Bhattacharya <suparna@in.ibm.com> added jumper probes
24 * interface to access function arguments.
Masami Hiramatsud6be29b2008-01-30 13:31:21 +010025 * 2004-Oct Jim Keniston <jkenisto@us.ibm.com> and Prasanna S Panchamukhi
26 * <prasanna@in.ibm.com> adapted for x86_64 from i386.
Linus Torvalds1da177e2005-04-16 15:20:36 -070027 * 2005-Mar Roland McGrath <roland@redhat.com>
28 * Fixed to handle %rip-relative addressing mode correctly.
Masami Hiramatsud6be29b2008-01-30 13:31:21 +010029 * 2005-May Hien Nguyen <hien@us.ibm.com>, Jim Keniston
30 * <jkenisto@us.ibm.com> and Prasanna S Panchamukhi
31 * <prasanna@in.ibm.com> added function-return probes.
32 * 2005-May Rusty Lynch <rusty.lynch@intel.com>
33 * Added function return probes functionality
34 * 2006-Feb Masami Hiramatsu <hiramatu@sdl.hitachi.co.jp> added
35 * kprobe-booster and kretprobe-booster for i386.
Masami Hiramatsuda07ab02008-01-30 13:31:21 +010036 * 2007-Dec Masami Hiramatsu <mhiramat@redhat.com> added kprobe-booster
37 * and kretprobe-booster for x86-64
Masami Hiramatsud6be29b2008-01-30 13:31:21 +010038 * 2007-Dec Masami Hiramatsu <mhiramat@redhat.com>, Arjan van de Ven
39 * <arjan@infradead.org> and Jim Keniston <jkenisto@us.ibm.com>
40 * unified x86 kprobes code.
Linus Torvalds1da177e2005-04-16 15:20:36 -070041 */
42
Linus Torvalds1da177e2005-04-16 15:20:36 -070043#include <linux/kprobes.h>
44#include <linux/ptrace.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#include <linux/string.h>
46#include <linux/slab.h>
Quentin Barnesb506a9d2008-01-30 13:32:32 +010047#include <linux/hardirq.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070048#include <linux/preempt.h>
Prasanna S Panchamukhic28f8962006-03-26 01:38:23 -080049#include <linux/module.h>
Christoph Hellwig1eeb66a2007-05-08 00:27:03 -070050#include <linux/kdebug.h>
Masami Hiramatsub46b3d72009-08-13 16:34:28 -040051#include <linux/kallsyms.h>
Ananth N Mavinakayanahalli9ec4b1f2005-06-27 15:17:01 -070052
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +010053#include <asm/cacheflush.h>
54#include <asm/desc.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070055#include <asm/pgtable.h>
Prasanna S Panchamukhic28f8962006-03-26 01:38:23 -080056#include <asm/uaccess.h>
Andi Kleen19d36cc2007-07-22 11:12:31 +020057#include <asm/alternative.h>
Masami Hiramatsub46b3d72009-08-13 16:34:28 -040058#include <asm/insn.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
Linus Torvalds1da177e2005-04-16 15:20:36 -070060void jprobe_return_end(void);
61
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -080062DEFINE_PER_CPU(struct kprobe *, current_kprobe) = NULL;
63DEFINE_PER_CPU(struct kprobe_ctlblk, kprobe_ctlblk);
Linus Torvalds1da177e2005-04-16 15:20:36 -070064
Masami Hiramatsud6be29b2008-01-30 13:31:21 +010065#ifdef CONFIG_X86_64
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +010066#define stack_addr(regs) ((unsigned long *)regs->sp)
Masami Hiramatsud6be29b2008-01-30 13:31:21 +010067#else
68/*
69 * "&regs->sp" looks wrong, but it's correct for x86_32. x86_32 CPUs
70 * don't save the ss and esp registers if the CPU is already in kernel
71 * mode when it traps. So for kprobes, regs->sp and regs->ss are not
72 * the [nonexistent] saved stack pointer and ss register, but rather
73 * the top 8 bytes of the pre-int3 stack. So &regs->sp happens to
74 * point to the top of the pre-int3 stack.
75 */
76#define stack_addr(regs) ((unsigned long *)&regs->sp)
77#endif
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +010078
79#define W(row, b0, b1, b2, b3, b4, b5, b6, b7, b8, b9, ba, bb, bc, bd, be, bf)\
80 (((b0##UL << 0x0)|(b1##UL << 0x1)|(b2##UL << 0x2)|(b3##UL << 0x3) | \
81 (b4##UL << 0x4)|(b5##UL << 0x5)|(b6##UL << 0x6)|(b7##UL << 0x7) | \
82 (b8##UL << 0x8)|(b9##UL << 0x9)|(ba##UL << 0xa)|(bb##UL << 0xb) | \
83 (bc##UL << 0xc)|(bd##UL << 0xd)|(be##UL << 0xe)|(bf##UL << 0xf)) \
84 << (row % 32))
85 /*
86 * Undefined/reserved opcodes, conditional jump, Opcode Extension
87 * Groups, and some special opcodes can not boost.
88 */
89static const u32 twobyte_is_boostable[256 / 32] = {
90 /* 0 1 2 3 4 5 6 7 8 9 a b c d e f */
91 /* ---------------------------------------------- */
92 W(0x00, 0, 0, 1, 1, 0, 0, 1, 0, 1, 1, 0, 0, 0, 0, 0, 0) | /* 00 */
93 W(0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) , /* 10 */
94 W(0x20, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) | /* 20 */
95 W(0x30, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) , /* 30 */
96 W(0x40, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) | /* 40 */
97 W(0x50, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) , /* 50 */
98 W(0x60, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 1, 1) | /* 60 */
99 W(0x70, 0, 0, 0, 0, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 1, 1) , /* 70 */
100 W(0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) | /* 80 */
101 W(0x90, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) , /* 90 */
102 W(0xa0, 1, 1, 0, 1, 1, 1, 0, 0, 1, 1, 0, 1, 1, 1, 0, 1) | /* a0 */
103 W(0xb0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 1, 1, 1, 1, 1) , /* b0 */
104 W(0xc0, 1, 1, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1) | /* c0 */
105 W(0xd0, 0, 1, 1, 1, 0, 1, 0, 0, 1, 1, 0, 1, 1, 1, 0, 1) , /* d0 */
106 W(0xe0, 0, 1, 1, 0, 0, 1, 0, 0, 1, 1, 0, 1, 1, 1, 0, 1) | /* e0 */
107 W(0xf0, 0, 1, 1, 1, 0, 1, 0, 0, 1, 1, 1, 0, 1, 1, 1, 0) /* f0 */
108 /* ----------------------------------------------- */
109 /* 0 1 2 3 4 5 6 7 8 9 a b c d e f */
110};
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100111#undef W
112
Masami Hiramatsuf438d912007-10-16 01:27:49 -0700113struct kretprobe_blackpoint kretprobe_blacklist[] = {
114 {"__switch_to", }, /* This function switches only current task, but
115 doesn't switch kernel stack.*/
116 {NULL, NULL} /* Terminator */
117};
118const int kretprobe_blacklist_size = ARRAY_SIZE(kretprobe_blacklist);
119
Masami Hiramatsuaa470142008-01-30 13:31:21 +0100120/* Insert a jump instruction at address 'from', which jumps to address 'to'.*/
Harvey Harrisone7b5e112008-01-30 13:31:43 +0100121static void __kprobes set_jmp_op(void *from, void *to)
Masami Hiramatsuaa470142008-01-30 13:31:21 +0100122{
123 struct __arch_jmp_op {
124 char op;
125 s32 raddr;
126 } __attribute__((packed)) * jop;
127 jop = (struct __arch_jmp_op *)from;
128 jop->raddr = (s32)((long)(to) - ((long)(from) + 5));
129 jop->op = RELATIVEJUMP_INSTRUCTION;
130}
131
132/*
Harvey Harrison99309272008-01-30 13:32:14 +0100133 * Check for the REX prefix which can only exist on X86_64
134 * X86_32 always returns 0
135 */
136static int __kprobes is_REX_prefix(kprobe_opcode_t *insn)
137{
138#ifdef CONFIG_X86_64
139 if ((*insn & 0xf0) == 0x40)
140 return 1;
141#endif
142 return 0;
143}
144
145/*
Masami Hiramatsud6be29b2008-01-30 13:31:21 +0100146 * Returns non-zero if opcode is boostable.
147 * RIP relative instructions are adjusted at copying time in 64 bits mode
Masami Hiramatsuaa470142008-01-30 13:31:21 +0100148 */
Harvey Harrisone7b5e112008-01-30 13:31:43 +0100149static int __kprobes can_boost(kprobe_opcode_t *opcodes)
Masami Hiramatsuaa470142008-01-30 13:31:21 +0100150{
Masami Hiramatsuaa470142008-01-30 13:31:21 +0100151 kprobe_opcode_t opcode;
152 kprobe_opcode_t *orig_opcodes = opcodes;
153
Jaswinder Singh Rajputcde5edb2009-03-18 17:37:45 +0530154 if (search_exception_tables((unsigned long)opcodes))
Masami Hiramatsu30390882009-03-16 18:57:22 -0400155 return 0; /* Page fault may occur on this address. */
156
Masami Hiramatsuaa470142008-01-30 13:31:21 +0100157retry:
158 if (opcodes - orig_opcodes > MAX_INSN_SIZE - 1)
159 return 0;
160 opcode = *(opcodes++);
161
162 /* 2nd-byte opcode */
163 if (opcode == 0x0f) {
164 if (opcodes - orig_opcodes > MAX_INSN_SIZE - 1)
165 return 0;
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100166 return test_bit(*opcodes,
167 (unsigned long *)twobyte_is_boostable);
Masami Hiramatsuaa470142008-01-30 13:31:21 +0100168 }
169
170 switch (opcode & 0xf0) {
Masami Hiramatsud6be29b2008-01-30 13:31:21 +0100171#ifdef CONFIG_X86_64
Masami Hiramatsuaa470142008-01-30 13:31:21 +0100172 case 0x40:
173 goto retry; /* REX prefix is boostable */
Masami Hiramatsud6be29b2008-01-30 13:31:21 +0100174#endif
Masami Hiramatsuaa470142008-01-30 13:31:21 +0100175 case 0x60:
176 if (0x63 < opcode && opcode < 0x67)
177 goto retry; /* prefixes */
178 /* can't boost Address-size override and bound */
179 return (opcode != 0x62 && opcode != 0x67);
180 case 0x70:
181 return 0; /* can't boost conditional jump */
182 case 0xc0:
183 /* can't boost software-interruptions */
184 return (0xc1 < opcode && opcode < 0xcc) || opcode == 0xcf;
185 case 0xd0:
186 /* can boost AA* and XLAT */
187 return (opcode == 0xd4 || opcode == 0xd5 || opcode == 0xd7);
188 case 0xe0:
189 /* can boost in/out and absolute jmps */
190 return ((opcode & 0x04) || opcode == 0xea);
191 case 0xf0:
192 if ((opcode & 0x0c) == 0 && opcode != 0xf1)
193 goto retry; /* lock/rep(ne) prefix */
194 /* clear and set flags are boostable */
195 return (opcode == 0xf5 || (0xf7 < opcode && opcode < 0xfe));
196 default:
197 /* segment override prefixes are boostable */
198 if (opcode == 0x26 || opcode == 0x36 || opcode == 0x3e)
199 goto retry; /* prefixes */
200 /* CS override prefix and call are not boostable */
201 return (opcode != 0x2e && opcode != 0x9a);
202 }
203}
204
Masami Hiramatsub46b3d72009-08-13 16:34:28 -0400205/* Recover the probed instruction at addr for further analysis. */
206static int recover_probed_instruction(kprobe_opcode_t *buf, unsigned long addr)
207{
208 struct kprobe *kp;
209 kp = get_kprobe((void *)addr);
210 if (!kp)
211 return -EINVAL;
212
213 /*
214 * Basically, kp->ainsn.insn has an original instruction.
215 * However, RIP-relative instruction can not do single-stepping
216 * at different place, fix_riprel() tweaks the displacement of
217 * that instruction. In that case, we can't recover the instruction
218 * from the kp->ainsn.insn.
219 *
220 * On the other hand, kp->opcode has a copy of the first byte of
221 * the probed instruction, which is overwritten by int3. And
222 * the instruction at kp->addr is not modified by kprobes except
223 * for the first byte, we can recover the original instruction
224 * from it and kp->opcode.
225 */
226 memcpy(buf, kp->addr, MAX_INSN_SIZE * sizeof(kprobe_opcode_t));
227 buf[0] = kp->opcode;
228 return 0;
229}
230
231/* Dummy buffers for kallsyms_lookup */
232static char __dummy_buf[KSYM_NAME_LEN];
233
234/* Check if paddr is at an instruction boundary */
235static int __kprobes can_probe(unsigned long paddr)
236{
237 int ret;
238 unsigned long addr, offset = 0;
239 struct insn insn;
240 kprobe_opcode_t buf[MAX_INSN_SIZE];
241
242 if (!kallsyms_lookup(paddr, NULL, &offset, NULL, __dummy_buf))
243 return 0;
244
245 /* Decode instructions */
246 addr = paddr - offset;
247 while (addr < paddr) {
248 kernel_insn_init(&insn, (void *)addr);
249 insn_get_opcode(&insn);
250
251 /*
252 * Check if the instruction has been modified by another
253 * kprobe, in which case we replace the breakpoint by the
254 * original instruction in our buffer.
255 */
256 if (insn.opcode.bytes[0] == BREAKPOINT_INSTRUCTION) {
257 ret = recover_probed_instruction(buf, addr);
258 if (ret)
259 /*
260 * Another debugging subsystem might insert
261 * this breakpoint. In that case, we can't
262 * recover it.
263 */
264 return 0;
265 kernel_insn_init(&insn, buf);
266 }
267 insn_get_length(&insn);
268 addr += insn.length;
269 }
270
271 return (addr == paddr);
272}
273
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274/*
Masami Hiramatsud6be29b2008-01-30 13:31:21 +0100275 * Returns non-zero if opcode modifies the interrupt flag.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 */
Andrew Morton86454192007-11-26 20:42:19 +0100277static int __kprobes is_IF_modifier(kprobe_opcode_t *insn)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278{
279 switch (*insn) {
280 case 0xfa: /* cli */
281 case 0xfb: /* sti */
282 case 0xcf: /* iret/iretd */
283 case 0x9d: /* popf/popfd */
284 return 1;
285 }
Harvey Harrison99309272008-01-30 13:32:14 +0100286
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100287 /*
Harvey Harrison99309272008-01-30 13:32:14 +0100288 * on X86_64, 0x40-0x4f are REX prefixes so we need to look
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100289 * at the next byte instead.. but of course not recurse infinitely
290 */
Harvey Harrison99309272008-01-30 13:32:14 +0100291 if (is_REX_prefix(insn))
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100292 return is_IF_modifier(++insn);
Harvey Harrison99309272008-01-30 13:32:14 +0100293
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 return 0;
295}
296
297/*
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100298 * Adjust the displacement if the instruction uses the %rip-relative
299 * addressing mode.
Masami Hiramatsuaa470142008-01-30 13:31:21 +0100300 * If it does, Return the address of the 32-bit displacement word.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 * If not, return null.
Harvey Harrison31f80e42008-01-30 13:32:16 +0100302 * Only applicable to 64-bit x86.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 */
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100304static void __kprobes fix_riprel(struct kprobe *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305{
Harvey Harrison31f80e42008-01-30 13:32:16 +0100306#ifdef CONFIG_X86_64
Masami Hiramatsu89ae4652009-08-13 16:34:36 -0400307 struct insn insn;
308 kernel_insn_init(&insn, p->ainsn.insn);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309
Masami Hiramatsu89ae4652009-08-13 16:34:36 -0400310 if (insn_rip_relative(&insn)) {
311 s64 newdisp;
312 u8 *disp;
313 insn_get_displacement(&insn);
314 /*
315 * The copied instruction uses the %rip-relative addressing
316 * mode. Adjust the displacement for the difference between
317 * the original location of this instruction and the location
318 * of the copy that will actually be run. The tricky bit here
319 * is making sure that the sign extension happens correctly in
320 * this calculation, since we need a signed 32-bit result to
321 * be sign-extended to 64 bits when it's added to the %rip
322 * value and yield the same 64-bit result that the sign-
323 * extension of the original signed 32-bit displacement would
324 * have given.
325 */
326 newdisp = (u8 *) p->addr + (s64) insn.displacement.value -
327 (u8 *) p->ainsn.insn;
328 BUG_ON((s64) (s32) newdisp != newdisp); /* Sanity check. */
329 disp = (u8 *) p->ainsn.insn + insn_offset_displacement(&insn);
330 *(s32 *) disp = (s32) newdisp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 }
Masami Hiramatsud6be29b2008-01-30 13:31:21 +0100332#endif
Harvey Harrison31f80e42008-01-30 13:32:16 +0100333}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700334
Keshavamurthy Anil Sf709b122006-01-09 20:52:44 -0800335static void __kprobes arch_copy_kprobe(struct kprobe *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336{
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100337 memcpy(p->ainsn.insn, p->addr, MAX_INSN_SIZE * sizeof(kprobe_opcode_t));
Harvey Harrison31f80e42008-01-30 13:32:16 +0100338
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100339 fix_riprel(p);
Harvey Harrison31f80e42008-01-30 13:32:16 +0100340
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100341 if (can_boost(p->addr))
Masami Hiramatsuaa470142008-01-30 13:31:21 +0100342 p->ainsn.boostable = 0;
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100343 else
Masami Hiramatsuaa470142008-01-30 13:31:21 +0100344 p->ainsn.boostable = -1;
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100345
Rusty Lynch7e1048b2005-06-23 00:09:25 -0700346 p->opcode = *p->addr;
347}
348
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100349int __kprobes arch_prepare_kprobe(struct kprobe *p)
350{
Masami Hiramatsub46b3d72009-08-13 16:34:28 -0400351 if (!can_probe((unsigned long)p->addr))
352 return -EILSEQ;
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100353 /* insn: must be on special executable page on x86. */
354 p->ainsn.insn = get_insn_slot();
355 if (!p->ainsn.insn)
356 return -ENOMEM;
357 arch_copy_kprobe(p);
358 return 0;
359}
360
Prasanna S Panchamukhi0f2fbdc2005-09-06 15:19:28 -0700361void __kprobes arch_arm_kprobe(struct kprobe *p)
Rusty Lynch7e1048b2005-06-23 00:09:25 -0700362{
Andi Kleen19d36cc2007-07-22 11:12:31 +0200363 text_poke(p->addr, ((unsigned char []){BREAKPOINT_INSTRUCTION}), 1);
Rusty Lynch7e1048b2005-06-23 00:09:25 -0700364}
365
Prasanna S Panchamukhi0f2fbdc2005-09-06 15:19:28 -0700366void __kprobes arch_disarm_kprobe(struct kprobe *p)
Rusty Lynch7e1048b2005-06-23 00:09:25 -0700367{
Andi Kleen19d36cc2007-07-22 11:12:31 +0200368 text_poke(p->addr, &p->opcode, 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369}
370
Ananth N Mavinakayanahalli0498b632006-01-09 20:52:46 -0800371void __kprobes arch_remove_kprobe(struct kprobe *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372{
Masami Hiramatsu12941562009-01-06 14:41:50 -0800373 if (p->ainsn.insn) {
374 free_insn_slot(p->ainsn.insn, (p->ainsn.boostable == 1));
375 p->ainsn.insn = NULL;
376 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377}
378
Prasanna S Panchamukhi3b602112006-04-18 22:22:00 -0700379static void __kprobes save_previous_kprobe(struct kprobe_ctlblk *kcb)
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700380{
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800381 kcb->prev_kprobe.kp = kprobe_running();
382 kcb->prev_kprobe.status = kcb->kprobe_status;
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100383 kcb->prev_kprobe.old_flags = kcb->kprobe_old_flags;
384 kcb->prev_kprobe.saved_flags = kcb->kprobe_saved_flags;
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700385}
386
Prasanna S Panchamukhi3b602112006-04-18 22:22:00 -0700387static void __kprobes restore_previous_kprobe(struct kprobe_ctlblk *kcb)
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700388{
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800389 __get_cpu_var(current_kprobe) = kcb->prev_kprobe.kp;
390 kcb->kprobe_status = kcb->prev_kprobe.status;
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100391 kcb->kprobe_old_flags = kcb->prev_kprobe.old_flags;
392 kcb->kprobe_saved_flags = kcb->prev_kprobe.saved_flags;
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700393}
394
Prasanna S Panchamukhi3b602112006-04-18 22:22:00 -0700395static void __kprobes set_current_kprobe(struct kprobe *p, struct pt_regs *regs,
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800396 struct kprobe_ctlblk *kcb)
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700397{
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800398 __get_cpu_var(current_kprobe) = p;
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100399 kcb->kprobe_saved_flags = kcb->kprobe_old_flags
Glauber de Oliveira Costa053de042008-01-30 13:31:27 +0100400 = (regs->flags & (X86_EFLAGS_TF | X86_EFLAGS_IF));
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700401 if (is_IF_modifier(p->ainsn.insn))
Glauber de Oliveira Costa053de042008-01-30 13:31:27 +0100402 kcb->kprobe_saved_flags &= ~X86_EFLAGS_IF;
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700403}
404
Harvey Harrisone7b5e112008-01-30 13:31:43 +0100405static void __kprobes clear_btf(void)
Roland McGrath1ecc7982008-01-30 13:30:54 +0100406{
407 if (test_thread_flag(TIF_DEBUGCTLMSR))
Jan Beulich5b0e5082008-03-10 13:11:17 +0000408 update_debugctlmsr(0);
Roland McGrath1ecc7982008-01-30 13:30:54 +0100409}
410
Harvey Harrisone7b5e112008-01-30 13:31:43 +0100411static void __kprobes restore_btf(void)
Roland McGrath1ecc7982008-01-30 13:30:54 +0100412{
413 if (test_thread_flag(TIF_DEBUGCTLMSR))
Jan Beulich5b0e5082008-03-10 13:11:17 +0000414 update_debugctlmsr(current->thread.debugctlmsr);
Roland McGrath1ecc7982008-01-30 13:30:54 +0100415}
416
Prasanna S Panchamukhi0f2fbdc2005-09-06 15:19:28 -0700417static void __kprobes prepare_singlestep(struct kprobe *p, struct pt_regs *regs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418{
Roland McGrath1ecc7982008-01-30 13:30:54 +0100419 clear_btf();
Glauber de Oliveira Costa053de042008-01-30 13:31:27 +0100420 regs->flags |= X86_EFLAGS_TF;
421 regs->flags &= ~X86_EFLAGS_IF;
Harvey Harrisone7b5e112008-01-30 13:31:43 +0100422 /* single step inline if the instruction is an int3 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423 if (p->opcode == BREAKPOINT_INSTRUCTION)
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100424 regs->ip = (unsigned long)p->addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 else
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100426 regs->ip = (unsigned long)p->ainsn.insn;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427}
428
Christoph Hellwig4c4308c2007-05-08 00:34:14 -0700429void __kprobes arch_prepare_kretprobe(struct kretprobe_instance *ri,
Prasanna S Panchamukhi0f2fbdc2005-09-06 15:19:28 -0700430 struct pt_regs *regs)
Rusty Lynch73649da2005-06-23 00:09:23 -0700431{
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100432 unsigned long *sara = stack_addr(regs);
Rusty Lynch73649da2005-06-23 00:09:23 -0700433
Christoph Hellwig4c4308c2007-05-08 00:34:14 -0700434 ri->ret_addr = (kprobe_opcode_t *) *sara;
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100435
Christoph Hellwig4c4308c2007-05-08 00:34:14 -0700436 /* Replace the return addr with trampoline addr */
437 *sara = (unsigned long) &kretprobe_trampoline;
Rusty Lynch73649da2005-06-23 00:09:23 -0700438}
Abhishek Sagarf315dec2008-01-30 13:32:50 +0100439
Abhishek Sagarf315dec2008-01-30 13:32:50 +0100440static void __kprobes setup_singlestep(struct kprobe *p, struct pt_regs *regs,
441 struct kprobe_ctlblk *kcb)
442{
Masami Hiramatsu5a4ccaf2009-01-06 21:15:32 +0100443#if !defined(CONFIG_PREEMPT) || defined(CONFIG_FREEZER)
Abhishek Sagarf315dec2008-01-30 13:32:50 +0100444 if (p->ainsn.boostable == 1 && !p->post_handler) {
445 /* Boost up -- we can execute copied instructions directly */
446 reset_current_kprobe();
447 regs->ip = (unsigned long)p->ainsn.insn;
448 preempt_enable_no_resched();
449 return;
450 }
451#endif
452 prepare_singlestep(p, regs);
453 kcb->kprobe_status = KPROBE_HIT_SS;
454}
455
Harvey Harrison40102d42008-01-30 13:32:02 +0100456/*
457 * We have reentered the kprobe_handler(), since another probe was hit while
458 * within the handler. We save the original kprobes variables and just single
459 * step on the instruction of the new probe without calling any user handlers.
460 */
Masami Hiramatsu59e87cd2008-01-30 13:32:02 +0100461static int __kprobes reenter_kprobe(struct kprobe *p, struct pt_regs *regs,
462 struct kprobe_ctlblk *kcb)
Harvey Harrison40102d42008-01-30 13:32:02 +0100463{
Abhishek Sagarf315dec2008-01-30 13:32:50 +0100464 switch (kcb->kprobe_status) {
465 case KPROBE_HIT_SSDONE:
Masami Hiramatsu59e87cd2008-01-30 13:32:02 +0100466#ifdef CONFIG_X86_64
Masami Hiramatsu59e87cd2008-01-30 13:32:02 +0100467 /* TODO: Provide re-entrancy from post_kprobes_handler() and
468 * avoid exception stack corruption while single-stepping on
469 * the instruction of the new probe.
470 */
471 arch_disarm_kprobe(p);
472 regs->ip = (unsigned long)p->addr;
473 reset_current_kprobe();
Abhishek Sagarf315dec2008-01-30 13:32:50 +0100474 preempt_enable_no_resched();
475 break;
Masami Hiramatsu59e87cd2008-01-30 13:32:02 +0100476#endif
Abhishek Sagarf315dec2008-01-30 13:32:50 +0100477 case KPROBE_HIT_ACTIVE:
Abhishek Sagarfb8830e2008-01-30 13:33:13 +0100478 save_previous_kprobe(kcb);
479 set_current_kprobe(p, regs, kcb);
480 kprobes_inc_nmissed_count(p);
481 prepare_singlestep(p, regs);
482 kcb->kprobe_status = KPROBE_REENTER;
Abhishek Sagarf315dec2008-01-30 13:32:50 +0100483 break;
484 case KPROBE_HIT_SS:
Masami Hiramatsue9afe9e2009-08-27 13:22:58 -0400485 /* A probe has been hit in the codepath leading up to, or just
486 * after, single-stepping of a probed instruction. This entire
487 * codepath should strictly reside in .kprobes.text section.
488 * Raise a BUG or we'll continue in an endless reentering loop
489 * and eventually a stack overflow.
490 */
491 printk(KERN_WARNING "Unrecoverable kprobe detected at %p.\n",
492 p->addr);
493 dump_kprobe(p);
494 BUG();
Abhishek Sagarf315dec2008-01-30 13:32:50 +0100495 default:
496 /* impossible cases */
497 WARN_ON(1);
Abhishek Sagarfb8830e2008-01-30 13:33:13 +0100498 return 0;
Masami Hiramatsu59e87cd2008-01-30 13:32:02 +0100499 }
Abhishek Sagarf315dec2008-01-30 13:32:50 +0100500
Masami Hiramatsu59e87cd2008-01-30 13:32:02 +0100501 return 1;
Harvey Harrison40102d42008-01-30 13:32:02 +0100502}
Rusty Lynch73649da2005-06-23 00:09:23 -0700503
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100504/*
505 * Interrupts are disabled on entry as trap3 is an interrupt gate and they
506 * remain disabled thorough out this function.
507 */
508static int __kprobes kprobe_handler(struct pt_regs *regs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509{
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100510 kprobe_opcode_t *addr;
Abhishek Sagarf315dec2008-01-30 13:32:50 +0100511 struct kprobe *p;
Ananth N Mavinakayanahallid217d542005-11-07 01:00:14 -0800512 struct kprobe_ctlblk *kcb;
513
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100514 addr = (kprobe_opcode_t *)(regs->ip - sizeof(kprobe_opcode_t));
Abhishek Sagarf315dec2008-01-30 13:32:50 +0100515 if (*addr != BREAKPOINT_INSTRUCTION) {
516 /*
517 * The breakpoint instruction was removed right
518 * after we hit it. Another cpu has removed
519 * either a probepoint or a debugger breakpoint
520 * at this address. In either case, no further
521 * handling of this interrupt is appropriate.
522 * Back up over the (now missing) int3 and run
523 * the original instruction.
524 */
525 regs->ip = (unsigned long)addr;
526 return 1;
527 }
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100528
Ananth N Mavinakayanahallid217d542005-11-07 01:00:14 -0800529 /*
530 * We don't want to be preempted for the entire
Abhishek Sagarf315dec2008-01-30 13:32:50 +0100531 * duration of kprobe processing. We conditionally
532 * re-enable preemption at the end of this function,
533 * and also in reenter_kprobe() and setup_singlestep().
Ananth N Mavinakayanahallid217d542005-11-07 01:00:14 -0800534 */
535 preempt_disable();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536
Abhishek Sagarf315dec2008-01-30 13:32:50 +0100537 kcb = get_kprobe_ctlblk();
Harvey Harrisonb9760152008-01-30 13:32:19 +0100538 p = get_kprobe(addr);
Abhishek Sagarf315dec2008-01-30 13:32:50 +0100539
Harvey Harrisonb9760152008-01-30 13:32:19 +0100540 if (p) {
Harvey Harrisonb9760152008-01-30 13:32:19 +0100541 if (kprobe_running()) {
Abhishek Sagarf315dec2008-01-30 13:32:50 +0100542 if (reenter_kprobe(p, regs, kcb))
543 return 1;
Harvey Harrisonb9760152008-01-30 13:32:19 +0100544 } else {
545 set_current_kprobe(p, regs, kcb);
546 kcb->kprobe_status = KPROBE_HIT_ACTIVE;
Abhishek Sagarf315dec2008-01-30 13:32:50 +0100547
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 /*
Abhishek Sagarf315dec2008-01-30 13:32:50 +0100549 * If we have no pre-handler or it returned 0, we
550 * continue with normal processing. If we have a
551 * pre-handler and it returned non-zero, it prepped
552 * for calling the break_handler below on re-entry
553 * for jprobe processing, so get out doing nothing
554 * more here.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 */
Abhishek Sagarf315dec2008-01-30 13:32:50 +0100556 if (!p->pre_handler || !p->pre_handler(p, regs))
557 setup_singlestep(p, regs, kcb);
558 return 1;
Harvey Harrisonb9760152008-01-30 13:32:19 +0100559 }
Abhishek Sagarf315dec2008-01-30 13:32:50 +0100560 } else if (kprobe_running()) {
561 p = __get_cpu_var(current_kprobe);
562 if (p->break_handler && p->break_handler(p, regs)) {
563 setup_singlestep(p, regs, kcb);
564 return 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 }
Abhishek Sagarf315dec2008-01-30 13:32:50 +0100566 } /* else: not a kprobe fault; let the kernel handle it */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567
Ananth N Mavinakayanahallid217d542005-11-07 01:00:14 -0800568 preempt_enable_no_resched();
Abhishek Sagarf315dec2008-01-30 13:32:50 +0100569 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570}
571
572/*
Masami Hiramatsuda07ab02008-01-30 13:31:21 +0100573 * When a retprobed function returns, this code saves registers and
574 * calls trampoline_handler() runs, which calls the kretprobe's handler.
Rusty Lynch73649da2005-06-23 00:09:23 -0700575 */
Harvey Harrisonf1452d42008-02-14 15:23:53 -0800576static void __used __kprobes kretprobe_trampoline_holder(void)
Harvey Harrison10175792008-01-30 13:33:01 +0100577{
Masami Hiramatsud6be29b2008-01-30 13:31:21 +0100578 asm volatile (
579 ".global kretprobe_trampoline\n"
Masami Hiramatsuda07ab02008-01-30 13:31:21 +0100580 "kretprobe_trampoline: \n"
Masami Hiramatsud6be29b2008-01-30 13:31:21 +0100581#ifdef CONFIG_X86_64
Masami Hiramatsuda07ab02008-01-30 13:31:21 +0100582 /* We don't bother saving the ss register */
583 " pushq %rsp\n"
584 " pushfq\n"
585 /*
586 * Skip cs, ip, orig_ax.
587 * trampoline_handler() will plug in these values
588 */
589 " subq $24, %rsp\n"
590 " pushq %rdi\n"
591 " pushq %rsi\n"
592 " pushq %rdx\n"
593 " pushq %rcx\n"
594 " pushq %rax\n"
595 " pushq %r8\n"
596 " pushq %r9\n"
597 " pushq %r10\n"
598 " pushq %r11\n"
599 " pushq %rbx\n"
600 " pushq %rbp\n"
601 " pushq %r12\n"
602 " pushq %r13\n"
603 " pushq %r14\n"
604 " pushq %r15\n"
605 " movq %rsp, %rdi\n"
606 " call trampoline_handler\n"
607 /* Replace saved sp with true return address. */
608 " movq %rax, 152(%rsp)\n"
609 " popq %r15\n"
610 " popq %r14\n"
611 " popq %r13\n"
612 " popq %r12\n"
613 " popq %rbp\n"
614 " popq %rbx\n"
615 " popq %r11\n"
616 " popq %r10\n"
617 " popq %r9\n"
618 " popq %r8\n"
619 " popq %rax\n"
620 " popq %rcx\n"
621 " popq %rdx\n"
622 " popq %rsi\n"
623 " popq %rdi\n"
624 /* Skip orig_ax, ip, cs */
625 " addq $24, %rsp\n"
626 " popfq\n"
Masami Hiramatsud6be29b2008-01-30 13:31:21 +0100627#else
628 " pushf\n"
629 /*
Masami Hiramatsufee039a2009-03-23 10:14:52 -0400630 * Skip cs, ip, orig_ax and gs.
Masami Hiramatsud6be29b2008-01-30 13:31:21 +0100631 * trampoline_handler() will plug in these values
632 */
Masami Hiramatsufee039a2009-03-23 10:14:52 -0400633 " subl $16, %esp\n"
Masami Hiramatsud6be29b2008-01-30 13:31:21 +0100634 " pushl %fs\n"
Masami Hiramatsud6be29b2008-01-30 13:31:21 +0100635 " pushl %es\n"
Masami Hiramatsufee039a2009-03-23 10:14:52 -0400636 " pushl %ds\n"
Masami Hiramatsud6be29b2008-01-30 13:31:21 +0100637 " pushl %eax\n"
638 " pushl %ebp\n"
639 " pushl %edi\n"
640 " pushl %esi\n"
641 " pushl %edx\n"
642 " pushl %ecx\n"
643 " pushl %ebx\n"
644 " movl %esp, %eax\n"
645 " call trampoline_handler\n"
646 /* Move flags to cs */
Masami Hiramatsufee039a2009-03-23 10:14:52 -0400647 " movl 56(%esp), %edx\n"
648 " movl %edx, 52(%esp)\n"
Masami Hiramatsud6be29b2008-01-30 13:31:21 +0100649 /* Replace saved flags with true return address. */
Masami Hiramatsufee039a2009-03-23 10:14:52 -0400650 " movl %eax, 56(%esp)\n"
Masami Hiramatsud6be29b2008-01-30 13:31:21 +0100651 " popl %ebx\n"
652 " popl %ecx\n"
653 " popl %edx\n"
654 " popl %esi\n"
655 " popl %edi\n"
656 " popl %ebp\n"
657 " popl %eax\n"
Masami Hiramatsufee039a2009-03-23 10:14:52 -0400658 /* Skip ds, es, fs, gs, orig_ax and ip */
659 " addl $24, %esp\n"
Masami Hiramatsud6be29b2008-01-30 13:31:21 +0100660 " popf\n"
661#endif
Masami Hiramatsuda07ab02008-01-30 13:31:21 +0100662 " ret\n");
Harvey Harrison10175792008-01-30 13:33:01 +0100663}
Rusty Lynch73649da2005-06-23 00:09:23 -0700664
665/*
Masami Hiramatsuda07ab02008-01-30 13:31:21 +0100666 * Called from kretprobe_trampoline
Rusty Lynch73649da2005-06-23 00:09:23 -0700667 */
Harvey Harrisonf1452d42008-02-14 15:23:53 -0800668static __used __kprobes void *trampoline_handler(struct pt_regs *regs)
Rusty Lynch73649da2005-06-23 00:09:23 -0700669{
bibo,mao62c27be2006-10-02 02:17:33 -0700670 struct kretprobe_instance *ri = NULL;
bibo,mao99219a32006-10-02 02:17:35 -0700671 struct hlist_head *head, empty_rp;
bibo,mao62c27be2006-10-02 02:17:33 -0700672 struct hlist_node *node, *tmp;
Ananth N Mavinakayanahalli991a51d2005-11-07 01:00:14 -0800673 unsigned long flags, orig_ret_address = 0;
Masami Hiramatsud6be29b2008-01-30 13:31:21 +0100674 unsigned long trampoline_address = (unsigned long)&kretprobe_trampoline;
Rusty Lynch73649da2005-06-23 00:09:23 -0700675
bibo,mao99219a32006-10-02 02:17:35 -0700676 INIT_HLIST_HEAD(&empty_rp);
Srinivasa D Sef53d9c2008-07-25 01:46:04 -0700677 kretprobe_hash_lock(current, &head, &flags);
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100678 /* fixup registers */
Masami Hiramatsud6be29b2008-01-30 13:31:21 +0100679#ifdef CONFIG_X86_64
Masami Hiramatsuda07ab02008-01-30 13:31:21 +0100680 regs->cs = __KERNEL_CS;
Masami Hiramatsud6be29b2008-01-30 13:31:21 +0100681#else
682 regs->cs = __KERNEL_CS | get_kernel_rpl();
Masami Hiramatsufee039a2009-03-23 10:14:52 -0400683 regs->gs = 0;
Masami Hiramatsud6be29b2008-01-30 13:31:21 +0100684#endif
Masami Hiramatsuda07ab02008-01-30 13:31:21 +0100685 regs->ip = trampoline_address;
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100686 regs->orig_ax = ~0UL;
Rusty Lynch73649da2005-06-23 00:09:23 -0700687
Rusty Lynchba8af122005-06-27 15:17:10 -0700688 /*
689 * It is possible to have multiple instances associated with a given
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100690 * task either because multiple functions in the call path have
Frederik Schwarzer025dfda2008-10-16 19:02:37 +0200691 * return probes installed on them, and/or more than one
Rusty Lynchba8af122005-06-27 15:17:10 -0700692 * return probe was registered for a target function.
693 *
694 * We can handle this because:
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100695 * - instances are always pushed into the head of the list
Rusty Lynchba8af122005-06-27 15:17:10 -0700696 * - when multiple return probes are registered for the same
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100697 * function, the (chronologically) first instance's ret_addr
698 * will be the real return address, and all the rest will
699 * point to kretprobe_trampoline.
Rusty Lynchba8af122005-06-27 15:17:10 -0700700 */
701 hlist_for_each_entry_safe(ri, node, tmp, head, hlist) {
bibo,mao62c27be2006-10-02 02:17:33 -0700702 if (ri->task != current)
Rusty Lynchba8af122005-06-27 15:17:10 -0700703 /* another task is sharing our hash bucket */
bibo,mao62c27be2006-10-02 02:17:33 -0700704 continue;
Rusty Lynch73649da2005-06-23 00:09:23 -0700705
Masami Hiramatsuda07ab02008-01-30 13:31:21 +0100706 if (ri->rp && ri->rp->handler) {
707 __get_cpu_var(current_kprobe) = &ri->rp->kp;
708 get_kprobe_ctlblk()->kprobe_status = KPROBE_HIT_ACTIVE;
Rusty Lynchba8af122005-06-27 15:17:10 -0700709 ri->rp->handler(ri, regs);
Masami Hiramatsuda07ab02008-01-30 13:31:21 +0100710 __get_cpu_var(current_kprobe) = NULL;
711 }
Rusty Lynch73649da2005-06-23 00:09:23 -0700712
Rusty Lynchba8af122005-06-27 15:17:10 -0700713 orig_ret_address = (unsigned long)ri->ret_addr;
bibo,mao99219a32006-10-02 02:17:35 -0700714 recycle_rp_inst(ri, &empty_rp);
Rusty Lynchba8af122005-06-27 15:17:10 -0700715
716 if (orig_ret_address != trampoline_address)
717 /*
718 * This is the real return address. Any other
719 * instances associated with this task are for
720 * other calls deeper on the call stack
721 */
722 break;
Rusty Lynch73649da2005-06-23 00:09:23 -0700723 }
Rusty Lynchba8af122005-06-27 15:17:10 -0700724
Ananth N Mavinakayanahalli0f95b7f2007-05-08 00:28:27 -0700725 kretprobe_assert(ri, orig_ret_address, trampoline_address);
Rusty Lynchba8af122005-06-27 15:17:10 -0700726
Srinivasa D Sef53d9c2008-07-25 01:46:04 -0700727 kretprobe_hash_unlock(current, &flags);
Rusty Lynchba8af122005-06-27 15:17:10 -0700728
bibo,mao99219a32006-10-02 02:17:35 -0700729 hlist_for_each_entry_safe(ri, node, tmp, &empty_rp, hlist) {
730 hlist_del(&ri->hlist);
731 kfree(ri);
732 }
Masami Hiramatsuda07ab02008-01-30 13:31:21 +0100733 return (void *)orig_ret_address;
Rusty Lynch73649da2005-06-23 00:09:23 -0700734}
735
736/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 * Called after single-stepping. p->addr is the address of the
738 * instruction whose first byte has been replaced by the "int 3"
739 * instruction. To avoid the SMP problems that can occur when we
740 * temporarily put back the original opcode to single-step, we
741 * single-stepped a copy of the instruction. The address of this
742 * copy is p->ainsn.insn.
743 *
744 * This function prepares to return from the post-single-step
745 * interrupt. We have to fix up the stack as follows:
746 *
747 * 0) Except in the case of absolute or indirect jump or call instructions,
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100748 * the new ip is relative to the copied instruction. We need to make
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 * it relative to the original instruction.
750 *
751 * 1) If the single-stepped instruction was pushfl, then the TF and IF
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100752 * flags are set in the just-pushed flags, and may need to be cleared.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753 *
754 * 2) If the single-stepped instruction was a call, the return address
755 * that is atop the stack is the address following the copied instruction.
756 * We need to make it the address following the original instruction.
Masami Hiramatsuaa470142008-01-30 13:31:21 +0100757 *
758 * If this is the first time we've single-stepped the instruction at
759 * this probepoint, and the instruction is boostable, boost it: add a
760 * jump instruction after the copied instruction, that jumps to the next
761 * instruction after the probepoint.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 */
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800763static void __kprobes resume_execution(struct kprobe *p,
764 struct pt_regs *regs, struct kprobe_ctlblk *kcb)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700765{
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100766 unsigned long *tos = stack_addr(regs);
767 unsigned long copy_ip = (unsigned long)p->ainsn.insn;
768 unsigned long orig_ip = (unsigned long)p->addr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 kprobe_opcode_t *insn = p->ainsn.insn;
770
771 /*skip the REX prefix*/
Harvey Harrison99309272008-01-30 13:32:14 +0100772 if (is_REX_prefix(insn))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 insn++;
774
Glauber de Oliveira Costa053de042008-01-30 13:31:27 +0100775 regs->flags &= ~X86_EFLAGS_TF;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 switch (*insn) {
Masami Hiramatsu0b0122f2007-12-18 18:05:58 +0100777 case 0x9c: /* pushfl */
Glauber de Oliveira Costa053de042008-01-30 13:31:27 +0100778 *tos &= ~(X86_EFLAGS_TF | X86_EFLAGS_IF);
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100779 *tos |= kcb->kprobe_old_flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 break;
Masami Hiramatsu0b0122f2007-12-18 18:05:58 +0100781 case 0xc2: /* iret/ret/lret */
782 case 0xc3:
Prasanna S Panchamukhi0b9e2ca2005-05-05 16:15:40 -0700783 case 0xca:
Masami Hiramatsu0b0122f2007-12-18 18:05:58 +0100784 case 0xcb:
785 case 0xcf:
786 case 0xea: /* jmp absolute -- ip is correct */
787 /* ip is already adjusted, no more changes required */
Masami Hiramatsuaa470142008-01-30 13:31:21 +0100788 p->ainsn.boostable = 1;
Masami Hiramatsu0b0122f2007-12-18 18:05:58 +0100789 goto no_change;
790 case 0xe8: /* call relative - Fix return addr */
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100791 *tos = orig_ip + (*tos - copy_ip);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 break;
Harvey Harrisone7b5e112008-01-30 13:31:43 +0100793#ifdef CONFIG_X86_32
Masami Hiramatsud6be29b2008-01-30 13:31:21 +0100794 case 0x9a: /* call absolute -- same as call absolute, indirect */
795 *tos = orig_ip + (*tos - copy_ip);
796 goto no_change;
797#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 case 0xff:
Satoshi Oshimadc49e342006-05-20 15:00:21 -0700799 if ((insn[1] & 0x30) == 0x10) {
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100800 /*
801 * call absolute, indirect
802 * Fix return addr; ip is correct.
803 * But this is not boostable
804 */
805 *tos = orig_ip + (*tos - copy_ip);
Masami Hiramatsu0b0122f2007-12-18 18:05:58 +0100806 goto no_change;
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100807 } else if (((insn[1] & 0x31) == 0x20) ||
808 ((insn[1] & 0x31) == 0x21)) {
809 /*
810 * jmp near and far, absolute indirect
811 * ip is correct. And this is boostable
812 */
Masami Hiramatsuaa470142008-01-30 13:31:21 +0100813 p->ainsn.boostable = 1;
Masami Hiramatsu0b0122f2007-12-18 18:05:58 +0100814 goto no_change;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700815 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 default:
817 break;
818 }
819
Masami Hiramatsuaa470142008-01-30 13:31:21 +0100820 if (p->ainsn.boostable == 0) {
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100821 if ((regs->ip > copy_ip) &&
822 (regs->ip - copy_ip) + 5 < MAX_INSN_SIZE) {
Masami Hiramatsuaa470142008-01-30 13:31:21 +0100823 /*
824 * These instructions can be executed directly if it
825 * jumps back to correct address.
826 */
827 set_jmp_op((void *)regs->ip,
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100828 (void *)orig_ip + (regs->ip - copy_ip));
Masami Hiramatsuaa470142008-01-30 13:31:21 +0100829 p->ainsn.boostable = 1;
830 } else {
831 p->ainsn.boostable = -1;
832 }
833 }
834
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100835 regs->ip += orig_ip - copy_ip;
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100836
Masami Hiramatsu0b0122f2007-12-18 18:05:58 +0100837no_change:
Roland McGrath1ecc7982008-01-30 13:30:54 +0100838 restore_btf();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839}
840
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100841/*
842 * Interrupts are disabled on entry as trap1 is an interrupt gate and they
843 * remain disabled thoroughout this function.
844 */
845static int __kprobes post_kprobe_handler(struct pt_regs *regs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846{
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800847 struct kprobe *cur = kprobe_running();
848 struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
849
850 if (!cur)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700851 return 0;
852
Yakov Lerneracb5b8a2008-03-16 03:21:21 -0500853 resume_execution(cur, regs, kcb);
854 regs->flags |= kcb->kprobe_saved_flags;
Yakov Lerneracb5b8a2008-03-16 03:21:21 -0500855
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800856 if ((kcb->kprobe_status != KPROBE_REENTER) && cur->post_handler) {
857 kcb->kprobe_status = KPROBE_HIT_SSDONE;
858 cur->post_handler(cur, regs, 0);
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700859 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100861 /* Restore back the original saved kprobes variables and continue. */
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800862 if (kcb->kprobe_status == KPROBE_REENTER) {
863 restore_previous_kprobe(kcb);
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700864 goto out;
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700865 }
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800866 reset_current_kprobe();
Prasanna S Panchamukhiaa3d7e32005-06-23 00:09:37 -0700867out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 preempt_enable_no_resched();
869
870 /*
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100871 * if somebody else is singlestepping across a probe point, flags
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872 * will have TF set, in which case, continue the remaining processing
873 * of do_debug, as if this is not a probe hit.
874 */
Glauber de Oliveira Costa053de042008-01-30 13:31:27 +0100875 if (regs->flags & X86_EFLAGS_TF)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876 return 0;
877
878 return 1;
879}
880
Prasanna S Panchamukhi0f2fbdc2005-09-06 15:19:28 -0700881int __kprobes kprobe_fault_handler(struct pt_regs *regs, int trapnr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882{
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800883 struct kprobe *cur = kprobe_running();
884 struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
885
Masami Hiramatsud6be29b2008-01-30 13:31:21 +0100886 switch (kcb->kprobe_status) {
Prasanna S Panchamukhic28f8962006-03-26 01:38:23 -0800887 case KPROBE_HIT_SS:
888 case KPROBE_REENTER:
889 /*
890 * We are here because the instruction being single
891 * stepped caused a page fault. We reset the current
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100892 * kprobe and the ip points back to the probe address
Prasanna S Panchamukhic28f8962006-03-26 01:38:23 -0800893 * and allow the page fault handler to continue as a
894 * normal page fault.
895 */
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100896 regs->ip = (unsigned long)cur->addr;
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100897 regs->flags |= kcb->kprobe_old_flags;
Prasanna S Panchamukhic28f8962006-03-26 01:38:23 -0800898 if (kcb->kprobe_status == KPROBE_REENTER)
899 restore_previous_kprobe(kcb);
900 else
901 reset_current_kprobe();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902 preempt_enable_no_resched();
Prasanna S Panchamukhic28f8962006-03-26 01:38:23 -0800903 break;
904 case KPROBE_HIT_ACTIVE:
905 case KPROBE_HIT_SSDONE:
906 /*
907 * We increment the nmissed count for accounting,
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100908 * we can also use npre/npostfault count for accounting
Prasanna S Panchamukhic28f8962006-03-26 01:38:23 -0800909 * these specific fault cases.
910 */
911 kprobes_inc_nmissed_count(cur);
912
913 /*
914 * We come here because instructions in the pre/post
915 * handler caused the page_fault, this could happen
916 * if handler tries to access user space by
917 * copy_from_user(), get_user() etc. Let the
918 * user-specified handler try to fix it first.
919 */
920 if (cur->fault_handler && cur->fault_handler(cur, regs, trapnr))
921 return 1;
922
923 /*
924 * In case the user-specified fault handler returned
925 * zero, try to fix up.
926 */
Masami Hiramatsud6be29b2008-01-30 13:31:21 +0100927 if (fixup_exception(regs))
928 return 1;
Harvey Harrison6d485832008-01-30 13:31:41 +0100929
Prasanna S Panchamukhic28f8962006-03-26 01:38:23 -0800930 /*
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100931 * fixup routine could not handle it,
Prasanna S Panchamukhic28f8962006-03-26 01:38:23 -0800932 * Let do_page_fault() fix it.
933 */
934 break;
935 default:
936 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 }
938 return 0;
939}
940
941/*
942 * Wrapper routine for handling exceptions.
943 */
Prasanna S Panchamukhi0f2fbdc2005-09-06 15:19:28 -0700944int __kprobes kprobe_exceptions_notify(struct notifier_block *self,
945 unsigned long val, void *data)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946{
Jan Engelhardtade1af72008-01-30 13:33:23 +0100947 struct die_args *args = data;
Ananth N Mavinakayanahalli66ff2d02005-11-07 01:00:07 -0800948 int ret = NOTIFY_DONE;
949
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100950 if (args->regs && user_mode_vm(args->regs))
bibo,mao2326c772006-03-26 01:38:21 -0800951 return ret;
952
Linus Torvalds1da177e2005-04-16 15:20:36 -0700953 switch (val) {
954 case DIE_INT3:
955 if (kprobe_handler(args->regs))
Ananth N Mavinakayanahalli66ff2d02005-11-07 01:00:07 -0800956 ret = NOTIFY_STOP;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 break;
958 case DIE_DEBUG:
959 if (post_kprobe_handler(args->regs))
Ananth N Mavinakayanahalli66ff2d02005-11-07 01:00:07 -0800960 ret = NOTIFY_STOP;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 break;
962 case DIE_GPF:
Quentin Barnesb506a9d2008-01-30 13:32:32 +0100963 /*
964 * To be potentially processing a kprobe fault and to
965 * trust the result from kprobe_running(), we have
966 * be non-preemptible.
967 */
968 if (!preemptible() && kprobe_running() &&
Linus Torvalds1da177e2005-04-16 15:20:36 -0700969 kprobe_fault_handler(args->regs, args->trapnr))
Ananth N Mavinakayanahalli66ff2d02005-11-07 01:00:07 -0800970 ret = NOTIFY_STOP;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700971 break;
972 default:
973 break;
974 }
Ananth N Mavinakayanahalli66ff2d02005-11-07 01:00:07 -0800975 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976}
977
Prasanna S Panchamukhi0f2fbdc2005-09-06 15:19:28 -0700978int __kprobes setjmp_pre_handler(struct kprobe *p, struct pt_regs *regs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700979{
980 struct jprobe *jp = container_of(p, struct jprobe, kp);
981 unsigned long addr;
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800982 struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800984 kcb->jprobe_saved_regs = *regs;
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +0100985 kcb->jprobe_saved_sp = stack_addr(regs);
986 addr = (unsigned long)(kcb->jprobe_saved_sp);
987
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988 /*
989 * As Linus pointed out, gcc assumes that the callee
990 * owns the argument space and could overwrite it, e.g.
991 * tailcall optimization. So, to be absolutely safe
992 * we also save and restore enough stack bytes to cover
993 * the argument area.
994 */
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -0800995 memcpy(kcb->jprobes_stack, (kprobe_opcode_t *)addr,
Masami Hiramatsud6be29b2008-01-30 13:31:21 +0100996 MIN_STACK_SIZE(addr));
Glauber de Oliveira Costa053de042008-01-30 13:31:27 +0100997 regs->flags &= ~X86_EFLAGS_IF;
Peter Zijlstra58dfe882007-10-11 22:25:25 +0200998 trace_hardirqs_off();
H. Peter Anvin65ea5b02008-01-30 13:30:56 +0100999 regs->ip = (unsigned long)(jp->entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000 return 1;
1001}
1002
Prasanna S Panchamukhi0f2fbdc2005-09-06 15:19:28 -07001003void __kprobes jprobe_return(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004{
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -08001005 struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
1006
Masami Hiramatsud6be29b2008-01-30 13:31:21 +01001007 asm volatile (
1008#ifdef CONFIG_X86_64
1009 " xchg %%rbx,%%rsp \n"
1010#else
1011 " xchgl %%ebx,%%esp \n"
1012#endif
1013 " int3 \n"
1014 " .globl jprobe_return_end\n"
1015 " jprobe_return_end: \n"
1016 " nop \n"::"b"
1017 (kcb->jprobe_saved_sp):"memory");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001018}
1019
Prasanna S Panchamukhi0f2fbdc2005-09-06 15:19:28 -07001020int __kprobes longjmp_break_handler(struct kprobe *p, struct pt_regs *regs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001021{
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -08001022 struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
H. Peter Anvin65ea5b02008-01-30 13:30:56 +01001023 u8 *addr = (u8 *) (regs->ip - 1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001024 struct jprobe *jp = container_of(p, struct jprobe, kp);
1025
Masami Hiramatsud6be29b2008-01-30 13:31:21 +01001026 if ((addr > (u8 *) jprobe_return) &&
1027 (addr < (u8 *) jprobe_return_end)) {
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +01001028 if (stack_addr(regs) != kcb->jprobe_saved_sp) {
Masami Hiramatsu29b6cd72007-12-18 18:05:58 +01001029 struct pt_regs *saved_regs = &kcb->jprobe_saved_regs;
Masami Hiramatsud6be29b2008-01-30 13:31:21 +01001030 printk(KERN_ERR
1031 "current sp %p does not match saved sp %p\n",
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +01001032 stack_addr(regs), kcb->jprobe_saved_sp);
Masami Hiramatsud6be29b2008-01-30 13:31:21 +01001033 printk(KERN_ERR "Saved registers for jprobe %p\n", jp);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001034 show_registers(saved_regs);
Masami Hiramatsud6be29b2008-01-30 13:31:21 +01001035 printk(KERN_ERR "Current registers\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001036 show_registers(regs);
1037 BUG();
1038 }
Ananth N Mavinakayanahallie7a510f2005-11-07 01:00:12 -08001039 *regs = kcb->jprobe_saved_regs;
Masami Hiramatsu8533bbe2008-01-30 13:31:21 +01001040 memcpy((kprobe_opcode_t *)(kcb->jprobe_saved_sp),
1041 kcb->jprobes_stack,
1042 MIN_STACK_SIZE(kcb->jprobe_saved_sp));
Ananth N Mavinakayanahallid217d542005-11-07 01:00:14 -08001043 preempt_enable_no_resched();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001044 return 1;
1045 }
1046 return 0;
1047}
Rusty Lynchba8af122005-06-27 15:17:10 -07001048
Rusty Lynch67729262005-07-05 18:54:50 -07001049int __init arch_init_kprobes(void)
Rusty Lynchba8af122005-06-27 15:17:10 -07001050{
Masami Hiramatsuda07ab02008-01-30 13:31:21 +01001051 return 0;
Rusty Lynchba8af122005-06-27 15:17:10 -07001052}
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001053
1054int __kprobes arch_trampoline_kprobe(struct kprobe *p)
1055{
Ananth N Mavinakayanahallibf8f6e5b2007-05-08 00:34:16 -07001056 return 0;
1057}