16ae9610f6ffb51b1d47180360da71c0ba0fd33a
[linux-2.6.git] / arch / x86 / kernel / kprobes.c
1 /*
2  *  Kernel Probes (KProbes)
3  *
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.
25  * 2004-Oct     Jim Keniston <jkenisto@us.ibm.com> and Prasanna S Panchamukhi
26  *              <prasanna@in.ibm.com> adapted for x86_64 from i386.
27  * 2005-Mar     Roland McGrath <roland@redhat.com>
28  *              Fixed to handle %rip-relative addressing mode correctly.
29  * 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.
36  * 2007-Dec     Masami Hiramatsu <mhiramat@redhat.com> added kprobe-booster
37  *              and kretprobe-booster for x86-64
38  * 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.
41  */
42
43 #include <linux/kprobes.h>
44 #include <linux/ptrace.h>
45 #include <linux/string.h>
46 #include <linux/slab.h>
47 #include <linux/hardirq.h>
48 #include <linux/preempt.h>
49 #include <linux/module.h>
50 #include <linux/kdebug.h>
51 #include <linux/kallsyms.h>
52
53 #include <asm/cacheflush.h>
54 #include <asm/desc.h>
55 #include <asm/pgtable.h>
56 #include <asm/uaccess.h>
57 #include <asm/alternative.h>
58 #include <asm/insn.h>
59
60 void jprobe_return_end(void);
61
62 DEFINE_PER_CPU(struct kprobe *, current_kprobe) = NULL;
63 DEFINE_PER_CPU(struct kprobe_ctlblk, kprobe_ctlblk);
64
65 #ifdef CONFIG_X86_64
66 #define stack_addr(regs) ((unsigned long *)regs->sp)
67 #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
78
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          */
89 static 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 };
111 #undef W
112
113 struct 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 };
118 const int kretprobe_blacklist_size = ARRAY_SIZE(kretprobe_blacklist);
119
120 /* Insert a jump instruction at address 'from', which jumps to address 'to'.*/
121 static void __kprobes set_jmp_op(void *from, void *to)
122 {
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 /*
133  * Check for the REX prefix which can only exist on X86_64
134  * X86_32 always returns 0
135  */
136 static 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 /*
146  * Returns non-zero if opcode is boostable.
147  * RIP relative instructions are adjusted at copying time in 64 bits mode
148  */
149 static int __kprobes can_boost(kprobe_opcode_t *opcodes)
150 {
151         kprobe_opcode_t opcode;
152         kprobe_opcode_t *orig_opcodes = opcodes;
153
154         if (search_exception_tables((unsigned long)opcodes))
155                 return 0;       /* Page fault may occur on this address. */
156
157 retry:
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;
166                 return test_bit(*opcodes,
167                                 (unsigned long *)twobyte_is_boostable);
168         }
169
170         switch (opcode & 0xf0) {
171 #ifdef CONFIG_X86_64
172         case 0x40:
173                 goto retry; /* REX prefix is boostable */
174 #endif
175         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
205 /* Recover the probed instruction at addr for further analysis. */
206 static 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 */
232 static char __dummy_buf[KSYM_NAME_LEN];
233
234 /* Check if paddr is at an instruction boundary */
235 static 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
274 /*
275  * Returns non-zero if opcode modifies the interrupt flag.
276  */
277 static int __kprobes is_IF_modifier(kprobe_opcode_t *insn)
278 {
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         }
286
287         /*
288          * on X86_64, 0x40-0x4f are REX prefixes so we need to look
289          * at the next byte instead.. but of course not recurse infinitely
290          */
291         if (is_REX_prefix(insn))
292                 return is_IF_modifier(++insn);
293
294         return 0;
295 }
296
297 /*
298  * Adjust the displacement if the instruction uses the %rip-relative
299  * addressing mode.
300  * If it does, Return the address of the 32-bit displacement word.
301  * If not, return null.
302  * Only applicable to 64-bit x86.
303  */
304 static void __kprobes fix_riprel(struct kprobe *p)
305 {
306 #ifdef CONFIG_X86_64
307         struct insn insn;
308         kernel_insn_init(&insn, p->ainsn.insn);
309
310         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;
331         }
332 #endif
333 }
334
335 static void __kprobes arch_copy_kprobe(struct kprobe *p)
336 {
337         memcpy(p->ainsn.insn, p->addr, MAX_INSN_SIZE * sizeof(kprobe_opcode_t));
338
339         fix_riprel(p);
340
341         if (can_boost(p->addr))
342                 p->ainsn.boostable = 0;
343         else
344                 p->ainsn.boostable = -1;
345
346         p->opcode = *p->addr;
347 }
348
349 int __kprobes arch_prepare_kprobe(struct kprobe *p)
350 {
351         if (!can_probe((unsigned long)p->addr))
352                 return -EILSEQ;
353         /* 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
361 void __kprobes arch_arm_kprobe(struct kprobe *p)
362 {
363         text_poke(p->addr, ((unsigned char []){BREAKPOINT_INSTRUCTION}), 1);
364 }
365
366 void __kprobes arch_disarm_kprobe(struct kprobe *p)
367 {
368         text_poke(p->addr, &p->opcode, 1);
369 }
370
371 void __kprobes arch_remove_kprobe(struct kprobe *p)
372 {
373         if (p->ainsn.insn) {
374                 free_insn_slot(p->ainsn.insn, (p->ainsn.boostable == 1));
375                 p->ainsn.insn = NULL;
376         }
377 }
378
379 static void __kprobes save_previous_kprobe(struct kprobe_ctlblk *kcb)
380 {
381         kcb->prev_kprobe.kp = kprobe_running();
382         kcb->prev_kprobe.status = kcb->kprobe_status;
383         kcb->prev_kprobe.old_flags = kcb->kprobe_old_flags;
384         kcb->prev_kprobe.saved_flags = kcb->kprobe_saved_flags;
385 }
386
387 static void __kprobes restore_previous_kprobe(struct kprobe_ctlblk *kcb)
388 {
389         __get_cpu_var(current_kprobe) = kcb->prev_kprobe.kp;
390         kcb->kprobe_status = kcb->prev_kprobe.status;
391         kcb->kprobe_old_flags = kcb->prev_kprobe.old_flags;
392         kcb->kprobe_saved_flags = kcb->prev_kprobe.saved_flags;
393 }
394
395 static void __kprobes set_current_kprobe(struct kprobe *p, struct pt_regs *regs,
396                                 struct kprobe_ctlblk *kcb)
397 {
398         __get_cpu_var(current_kprobe) = p;
399         kcb->kprobe_saved_flags = kcb->kprobe_old_flags
400                 = (regs->flags & (X86_EFLAGS_TF | X86_EFLAGS_IF));
401         if (is_IF_modifier(p->ainsn.insn))
402                 kcb->kprobe_saved_flags &= ~X86_EFLAGS_IF;
403 }
404
405 static void __kprobes clear_btf(void)
406 {
407         if (test_thread_flag(TIF_DEBUGCTLMSR))
408                 update_debugctlmsr(0);
409 }
410
411 static void __kprobes restore_btf(void)
412 {
413         if (test_thread_flag(TIF_DEBUGCTLMSR))
414                 update_debugctlmsr(current->thread.debugctlmsr);
415 }
416
417 static void __kprobes prepare_singlestep(struct kprobe *p, struct pt_regs *regs)
418 {
419         clear_btf();
420         regs->flags |= X86_EFLAGS_TF;
421         regs->flags &= ~X86_EFLAGS_IF;
422         /* single step inline if the instruction is an int3 */
423         if (p->opcode == BREAKPOINT_INSTRUCTION)
424                 regs->ip = (unsigned long)p->addr;
425         else
426                 regs->ip = (unsigned long)p->ainsn.insn;
427 }
428
429 void __kprobes arch_prepare_kretprobe(struct kretprobe_instance *ri,
430                                       struct pt_regs *regs)
431 {
432         unsigned long *sara = stack_addr(regs);
433
434         ri->ret_addr = (kprobe_opcode_t *) *sara;
435
436         /* Replace the return addr with trampoline addr */
437         *sara = (unsigned long) &kretprobe_trampoline;
438 }
439
440 static void __kprobes setup_singlestep(struct kprobe *p, struct pt_regs *regs,
441                                        struct kprobe_ctlblk *kcb)
442 {
443 #if !defined(CONFIG_PREEMPT) || defined(CONFIG_FREEZER)
444         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
456 /*
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  */
461 static int __kprobes reenter_kprobe(struct kprobe *p, struct pt_regs *regs,
462                                     struct kprobe_ctlblk *kcb)
463 {
464         switch (kcb->kprobe_status) {
465         case KPROBE_HIT_SSDONE:
466 #ifdef CONFIG_X86_64
467                 /* 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();
474                 preempt_enable_no_resched();
475                 break;
476 #endif
477         case KPROBE_HIT_ACTIVE:
478                 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;
483                 break;
484         case KPROBE_HIT_SS:
485                 if (p == kprobe_running()) {
486                         regs->flags &= ~X86_EFLAGS_TF;
487                         regs->flags |= kcb->kprobe_saved_flags;
488                         return 0;
489                 } else {
490                         /* A probe has been hit in the codepath leading up
491                          * to, or just after, single-stepping of a probed
492                          * instruction. This entire codepath should strictly
493                          * reside in .kprobes.text section. Raise a warning
494                          * to highlight this peculiar case.
495                          */
496                 }
497         default:
498                 /* impossible cases */
499                 WARN_ON(1);
500                 return 0;
501         }
502
503         return 1;
504 }
505
506 /*
507  * Interrupts are disabled on entry as trap3 is an interrupt gate and they
508  * remain disabled thorough out this function.
509  */
510 static int __kprobes kprobe_handler(struct pt_regs *regs)
511 {
512         kprobe_opcode_t *addr;
513         struct kprobe *p;
514         struct kprobe_ctlblk *kcb;
515
516         addr = (kprobe_opcode_t *)(regs->ip - sizeof(kprobe_opcode_t));
517         if (*addr != BREAKPOINT_INSTRUCTION) {
518                 /*
519                  * The breakpoint instruction was removed right
520                  * after we hit it.  Another cpu has removed
521                  * either a probepoint or a debugger breakpoint
522                  * at this address.  In either case, no further
523                  * handling of this interrupt is appropriate.
524                  * Back up over the (now missing) int3 and run
525                  * the original instruction.
526                  */
527                 regs->ip = (unsigned long)addr;
528                 return 1;
529         }
530
531         /*
532          * We don't want to be preempted for the entire
533          * duration of kprobe processing. We conditionally
534          * re-enable preemption at the end of this function,
535          * and also in reenter_kprobe() and setup_singlestep().
536          */
537         preempt_disable();
538
539         kcb = get_kprobe_ctlblk();
540         p = get_kprobe(addr);
541
542         if (p) {
543                 if (kprobe_running()) {
544                         if (reenter_kprobe(p, regs, kcb))
545                                 return 1;
546                 } else {
547                         set_current_kprobe(p, regs, kcb);
548                         kcb->kprobe_status = KPROBE_HIT_ACTIVE;
549
550                         /*
551                          * If we have no pre-handler or it returned 0, we
552                          * continue with normal processing.  If we have a
553                          * pre-handler and it returned non-zero, it prepped
554                          * for calling the break_handler below on re-entry
555                          * for jprobe processing, so get out doing nothing
556                          * more here.
557                          */
558                         if (!p->pre_handler || !p->pre_handler(p, regs))
559                                 setup_singlestep(p, regs, kcb);
560                         return 1;
561                 }
562         } else if (kprobe_running()) {
563                 p = __get_cpu_var(current_kprobe);
564                 if (p->break_handler && p->break_handler(p, regs)) {
565                         setup_singlestep(p, regs, kcb);
566                         return 1;
567                 }
568         } /* else: not a kprobe fault; let the kernel handle it */
569
570         preempt_enable_no_resched();
571         return 0;
572 }
573
574 /*
575  * When a retprobed function returns, this code saves registers and
576  * calls trampoline_handler() runs, which calls the kretprobe's handler.
577  */
578 static void __used __kprobes kretprobe_trampoline_holder(void)
579 {
580         asm volatile (
581                         ".global kretprobe_trampoline\n"
582                         "kretprobe_trampoline: \n"
583 #ifdef CONFIG_X86_64
584                         /* We don't bother saving the ss register */
585                         "       pushq %rsp\n"
586                         "       pushfq\n"
587                         /*
588                          * Skip cs, ip, orig_ax.
589                          * trampoline_handler() will plug in these values
590                          */
591                         "       subq $24, %rsp\n"
592                         "       pushq %rdi\n"
593                         "       pushq %rsi\n"
594                         "       pushq %rdx\n"
595                         "       pushq %rcx\n"
596                         "       pushq %rax\n"
597                         "       pushq %r8\n"
598                         "       pushq %r9\n"
599                         "       pushq %r10\n"
600                         "       pushq %r11\n"
601                         "       pushq %rbx\n"
602                         "       pushq %rbp\n"
603                         "       pushq %r12\n"
604                         "       pushq %r13\n"
605                         "       pushq %r14\n"
606                         "       pushq %r15\n"
607                         "       movq %rsp, %rdi\n"
608                         "       call trampoline_handler\n"
609                         /* Replace saved sp with true return address. */
610                         "       movq %rax, 152(%rsp)\n"
611                         "       popq %r15\n"
612                         "       popq %r14\n"
613                         "       popq %r13\n"
614                         "       popq %r12\n"
615                         "       popq %rbp\n"
616                         "       popq %rbx\n"
617                         "       popq %r11\n"
618                         "       popq %r10\n"
619                         "       popq %r9\n"
620                         "       popq %r8\n"
621                         "       popq %rax\n"
622                         "       popq %rcx\n"
623                         "       popq %rdx\n"
624                         "       popq %rsi\n"
625                         "       popq %rdi\n"
626                         /* Skip orig_ax, ip, cs */
627                         "       addq $24, %rsp\n"
628                         "       popfq\n"
629 #else
630                         "       pushf\n"
631                         /*
632                          * Skip cs, ip, orig_ax and gs.
633                          * trampoline_handler() will plug in these values
634                          */
635                         "       subl $16, %esp\n"
636                         "       pushl %fs\n"
637                         "       pushl %es\n"
638                         "       pushl %ds\n"
639                         "       pushl %eax\n"
640                         "       pushl %ebp\n"
641                         "       pushl %edi\n"
642                         "       pushl %esi\n"
643                         "       pushl %edx\n"
644                         "       pushl %ecx\n"
645                         "       pushl %ebx\n"
646                         "       movl %esp, %eax\n"
647                         "       call trampoline_handler\n"
648                         /* Move flags to cs */
649                         "       movl 56(%esp), %edx\n"
650                         "       movl %edx, 52(%esp)\n"
651                         /* Replace saved flags with true return address. */
652                         "       movl %eax, 56(%esp)\n"
653                         "       popl %ebx\n"
654                         "       popl %ecx\n"
655                         "       popl %edx\n"
656                         "       popl %esi\n"
657                         "       popl %edi\n"
658                         "       popl %ebp\n"
659                         "       popl %eax\n"
660                         /* Skip ds, es, fs, gs, orig_ax and ip */
661                         "       addl $24, %esp\n"
662                         "       popf\n"
663 #endif
664                         "       ret\n");
665 }
666
667 /*
668  * Called from kretprobe_trampoline
669  */
670 static __used __kprobes void *trampoline_handler(struct pt_regs *regs)
671 {
672         struct kretprobe_instance *ri = NULL;
673         struct hlist_head *head, empty_rp;
674         struct hlist_node *node, *tmp;
675         unsigned long flags, orig_ret_address = 0;
676         unsigned long trampoline_address = (unsigned long)&kretprobe_trampoline;
677
678         INIT_HLIST_HEAD(&empty_rp);
679         kretprobe_hash_lock(current, &head, &flags);
680         /* fixup registers */
681 #ifdef CONFIG_X86_64
682         regs->cs = __KERNEL_CS;
683 #else
684         regs->cs = __KERNEL_CS | get_kernel_rpl();
685         regs->gs = 0;
686 #endif
687         regs->ip = trampoline_address;
688         regs->orig_ax = ~0UL;
689
690         /*
691          * It is possible to have multiple instances associated with a given
692          * task either because multiple functions in the call path have
693          * return probes installed on them, and/or more than one
694          * return probe was registered for a target function.
695          *
696          * We can handle this because:
697          *     - instances are always pushed into the head of the list
698          *     - when multiple return probes are registered for the same
699          *       function, the (chronologically) first instance's ret_addr
700          *       will be the real return address, and all the rest will
701          *       point to kretprobe_trampoline.
702          */
703         hlist_for_each_entry_safe(ri, node, tmp, head, hlist) {
704                 if (ri->task != current)
705                         /* another task is sharing our hash bucket */
706                         continue;
707
708                 if (ri->rp && ri->rp->handler) {
709                         __get_cpu_var(current_kprobe) = &ri->rp->kp;
710                         get_kprobe_ctlblk()->kprobe_status = KPROBE_HIT_ACTIVE;
711                         ri->rp->handler(ri, regs);
712                         __get_cpu_var(current_kprobe) = NULL;
713                 }
714
715                 orig_ret_address = (unsigned long)ri->ret_addr;
716                 recycle_rp_inst(ri, &empty_rp);
717
718                 if (orig_ret_address != trampoline_address)
719                         /*
720                          * This is the real return address. Any other
721                          * instances associated with this task are for
722                          * other calls deeper on the call stack
723                          */
724                         break;
725         }
726
727         kretprobe_assert(ri, orig_ret_address, trampoline_address);
728
729         kretprobe_hash_unlock(current, &flags);
730
731         hlist_for_each_entry_safe(ri, node, tmp, &empty_rp, hlist) {
732                 hlist_del(&ri->hlist);
733                 kfree(ri);
734         }
735         return (void *)orig_ret_address;
736 }
737
738 /*
739  * Called after single-stepping.  p->addr is the address of the
740  * instruction whose first byte has been replaced by the "int 3"
741  * instruction.  To avoid the SMP problems that can occur when we
742  * temporarily put back the original opcode to single-step, we
743  * single-stepped a copy of the instruction.  The address of this
744  * copy is p->ainsn.insn.
745  *
746  * This function prepares to return from the post-single-step
747  * interrupt.  We have to fix up the stack as follows:
748  *
749  * 0) Except in the case of absolute or indirect jump or call instructions,
750  * the new ip is relative to the copied instruction.  We need to make
751  * it relative to the original instruction.
752  *
753  * 1) If the single-stepped instruction was pushfl, then the TF and IF
754  * flags are set in the just-pushed flags, and may need to be cleared.
755  *
756  * 2) If the single-stepped instruction was a call, the return address
757  * that is atop the stack is the address following the copied instruction.
758  * We need to make it the address following the original instruction.
759  *
760  * If this is the first time we've single-stepped the instruction at
761  * this probepoint, and the instruction is boostable, boost it: add a
762  * jump instruction after the copied instruction, that jumps to the next
763  * instruction after the probepoint.
764  */
765 static void __kprobes resume_execution(struct kprobe *p,
766                 struct pt_regs *regs, struct kprobe_ctlblk *kcb)
767 {
768         unsigned long *tos = stack_addr(regs);
769         unsigned long copy_ip = (unsigned long)p->ainsn.insn;
770         unsigned long orig_ip = (unsigned long)p->addr;
771         kprobe_opcode_t *insn = p->ainsn.insn;
772
773         /*skip the REX prefix*/
774         if (is_REX_prefix(insn))
775                 insn++;
776
777         regs->flags &= ~X86_EFLAGS_TF;
778         switch (*insn) {
779         case 0x9c:      /* pushfl */
780                 *tos &= ~(X86_EFLAGS_TF | X86_EFLAGS_IF);
781                 *tos |= kcb->kprobe_old_flags;
782                 break;
783         case 0xc2:      /* iret/ret/lret */
784         case 0xc3:
785         case 0xca:
786         case 0xcb:
787         case 0xcf:
788         case 0xea:      /* jmp absolute -- ip is correct */
789                 /* ip is already adjusted, no more changes required */
790                 p->ainsn.boostable = 1;
791                 goto no_change;
792         case 0xe8:      /* call relative - Fix return addr */
793                 *tos = orig_ip + (*tos - copy_ip);
794                 break;
795 #ifdef CONFIG_X86_32
796         case 0x9a:      /* call absolute -- same as call absolute, indirect */
797                 *tos = orig_ip + (*tos - copy_ip);
798                 goto no_change;
799 #endif
800         case 0xff:
801                 if ((insn[1] & 0x30) == 0x10) {
802                         /*
803                          * call absolute, indirect
804                          * Fix return addr; ip is correct.
805                          * But this is not boostable
806                          */
807                         *tos = orig_ip + (*tos - copy_ip);
808                         goto no_change;
809                 } else if (((insn[1] & 0x31) == 0x20) ||
810                            ((insn[1] & 0x31) == 0x21)) {
811                         /*
812                          * jmp near and far, absolute indirect
813                          * ip is correct. And this is boostable
814                          */
815                         p->ainsn.boostable = 1;
816                         goto no_change;
817                 }
818         default:
819                 break;
820         }
821
822         if (p->ainsn.boostable == 0) {
823                 if ((regs->ip > copy_ip) &&
824                     (regs->ip - copy_ip) + 5 < MAX_INSN_SIZE) {
825                         /*
826                          * These instructions can be executed directly if it
827                          * jumps back to correct address.
828                          */
829                         set_jmp_op((void *)regs->ip,
830                                    (void *)orig_ip + (regs->ip - copy_ip));
831                         p->ainsn.boostable = 1;
832                 } else {
833                         p->ainsn.boostable = -1;
834                 }
835         }
836
837         regs->ip += orig_ip - copy_ip;
838
839 no_change:
840         restore_btf();
841 }
842
843 /*
844  * Interrupts are disabled on entry as trap1 is an interrupt gate and they
845  * remain disabled thoroughout this function.
846  */
847 static int __kprobes post_kprobe_handler(struct pt_regs *regs)
848 {
849         struct kprobe *cur = kprobe_running();
850         struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
851
852         if (!cur)
853                 return 0;
854
855         resume_execution(cur, regs, kcb);
856         regs->flags |= kcb->kprobe_saved_flags;
857
858         if ((kcb->kprobe_status != KPROBE_REENTER) && cur->post_handler) {
859                 kcb->kprobe_status = KPROBE_HIT_SSDONE;
860                 cur->post_handler(cur, regs, 0);
861         }
862
863         /* Restore back the original saved kprobes variables and continue. */
864         if (kcb->kprobe_status == KPROBE_REENTER) {
865                 restore_previous_kprobe(kcb);
866                 goto out;
867         }
868         reset_current_kprobe();
869 out:
870         preempt_enable_no_resched();
871
872         /*
873          * if somebody else is singlestepping across a probe point, flags
874          * will have TF set, in which case, continue the remaining processing
875          * of do_debug, as if this is not a probe hit.
876          */
877         if (regs->flags & X86_EFLAGS_TF)
878                 return 0;
879
880         return 1;
881 }
882
883 int __kprobes kprobe_fault_handler(struct pt_regs *regs, int trapnr)
884 {
885         struct kprobe *cur = kprobe_running();
886         struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
887
888         switch (kcb->kprobe_status) {
889         case KPROBE_HIT_SS:
890         case KPROBE_REENTER:
891                 /*
892                  * We are here because the instruction being single
893                  * stepped caused a page fault. We reset the current
894                  * kprobe and the ip points back to the probe address
895                  * and allow the page fault handler to continue as a
896                  * normal page fault.
897                  */
898                 regs->ip = (unsigned long)cur->addr;
899                 regs->flags |= kcb->kprobe_old_flags;
900                 if (kcb->kprobe_status == KPROBE_REENTER)
901                         restore_previous_kprobe(kcb);
902                 else
903                         reset_current_kprobe();
904                 preempt_enable_no_resched();
905                 break;
906         case KPROBE_HIT_ACTIVE:
907         case KPROBE_HIT_SSDONE:
908                 /*
909                  * We increment the nmissed count for accounting,
910                  * we can also use npre/npostfault count for accounting
911                  * these specific fault cases.
912                  */
913                 kprobes_inc_nmissed_count(cur);
914
915                 /*
916                  * We come here because instructions in the pre/post
917                  * handler caused the page_fault, this could happen
918                  * if handler tries to access user space by
919                  * copy_from_user(), get_user() etc. Let the
920                  * user-specified handler try to fix it first.
921                  */
922                 if (cur->fault_handler && cur->fault_handler(cur, regs, trapnr))
923                         return 1;
924
925                 /*
926                  * In case the user-specified fault handler returned
927                  * zero, try to fix up.
928                  */
929                 if (fixup_exception(regs))
930                         return 1;
931
932                 /*
933                  * fixup routine could not handle it,
934                  * Let do_page_fault() fix it.
935                  */
936                 break;
937         default:
938                 break;
939         }
940         return 0;
941 }
942
943 /*
944  * Wrapper routine for handling exceptions.
945  */
946 int __kprobes kprobe_exceptions_notify(struct notifier_block *self,
947                                        unsigned long val, void *data)
948 {
949         struct die_args *args = data;
950         int ret = NOTIFY_DONE;
951
952         if (args->regs && user_mode_vm(args->regs))
953                 return ret;
954
955         switch (val) {
956         case DIE_INT3:
957                 if (kprobe_handler(args->regs))
958                         ret = NOTIFY_STOP;
959                 break;
960         case DIE_DEBUG:
961                 if (post_kprobe_handler(args->regs))
962                         ret = NOTIFY_STOP;
963                 break;
964         case DIE_GPF:
965                 /*
966                  * To be potentially processing a kprobe fault and to
967                  * trust the result from kprobe_running(), we have
968                  * be non-preemptible.
969                  */
970                 if (!preemptible() && kprobe_running() &&
971                     kprobe_fault_handler(args->regs, args->trapnr))
972                         ret = NOTIFY_STOP;
973                 break;
974         default:
975                 break;
976         }
977         return ret;
978 }
979
980 int __kprobes setjmp_pre_handler(struct kprobe *p, struct pt_regs *regs)
981 {
982         struct jprobe *jp = container_of(p, struct jprobe, kp);
983         unsigned long addr;
984         struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
985
986         kcb->jprobe_saved_regs = *regs;
987         kcb->jprobe_saved_sp = stack_addr(regs);
988         addr = (unsigned long)(kcb->jprobe_saved_sp);
989
990         /*
991          * As Linus pointed out, gcc assumes that the callee
992          * owns the argument space and could overwrite it, e.g.
993          * tailcall optimization. So, to be absolutely safe
994          * we also save and restore enough stack bytes to cover
995          * the argument area.
996          */
997         memcpy(kcb->jprobes_stack, (kprobe_opcode_t *)addr,
998                MIN_STACK_SIZE(addr));
999         regs->flags &= ~X86_EFLAGS_IF;
1000         trace_hardirqs_off();
1001         regs->ip = (unsigned long)(jp->entry);
1002         return 1;
1003 }
1004
1005 void __kprobes jprobe_return(void)
1006 {
1007         struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
1008
1009         asm volatile (
1010 #ifdef CONFIG_X86_64
1011                         "       xchg   %%rbx,%%rsp      \n"
1012 #else
1013                         "       xchgl   %%ebx,%%esp     \n"
1014 #endif
1015                         "       int3                    \n"
1016                         "       .globl jprobe_return_end\n"
1017                         "       jprobe_return_end:      \n"
1018                         "       nop                     \n"::"b"
1019                         (kcb->jprobe_saved_sp):"memory");
1020 }
1021
1022 int __kprobes longjmp_break_handler(struct kprobe *p, struct pt_regs *regs)
1023 {
1024         struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
1025         u8 *addr = (u8 *) (regs->ip - 1);
1026         struct jprobe *jp = container_of(p, struct jprobe, kp);
1027
1028         if ((addr > (u8 *) jprobe_return) &&
1029             (addr < (u8 *) jprobe_return_end)) {
1030                 if (stack_addr(regs) != kcb->jprobe_saved_sp) {
1031                         struct pt_regs *saved_regs = &kcb->jprobe_saved_regs;
1032                         printk(KERN_ERR
1033                                "current sp %p does not match saved sp %p\n",
1034                                stack_addr(regs), kcb->jprobe_saved_sp);
1035                         printk(KERN_ERR "Saved registers for jprobe %p\n", jp);
1036                         show_registers(saved_regs);
1037                         printk(KERN_ERR "Current registers\n");
1038                         show_registers(regs);
1039                         BUG();
1040                 }
1041                 *regs = kcb->jprobe_saved_regs;
1042                 memcpy((kprobe_opcode_t *)(kcb->jprobe_saved_sp),
1043                        kcb->jprobes_stack,
1044                        MIN_STACK_SIZE(kcb->jprobe_saved_sp));
1045                 preempt_enable_no_resched();
1046                 return 1;
1047         }
1048         return 0;
1049 }
1050
1051 int __init arch_init_kprobes(void)
1052 {
1053         return 0;
1054 }
1055
1056 int __kprobes arch_trampoline_kprobe(struct kprobe *p)
1057 {
1058         return 0;
1059 }