kprobes: add kprobe_insn_mutex and cleanup arch_remove_kprobe()
[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
52 #include <asm/cacheflush.h>
53 #include <asm/desc.h>
54 #include <asm/pgtable.h>
55 #include <asm/uaccess.h>
56 #include <asm/alternative.h>
57
58 void jprobe_return_end(void);
59
60 DEFINE_PER_CPU(struct kprobe *, current_kprobe) = NULL;
61 DEFINE_PER_CPU(struct kprobe_ctlblk, kprobe_ctlblk);
62
63 #ifdef CONFIG_X86_64
64 #define stack_addr(regs) ((unsigned long *)regs->sp)
65 #else
66 /*
67  * "&regs->sp" looks wrong, but it's correct for x86_32.  x86_32 CPUs
68  * don't save the ss and esp registers if the CPU is already in kernel
69  * mode when it traps.  So for kprobes, regs->sp and regs->ss are not
70  * the [nonexistent] saved stack pointer and ss register, but rather
71  * the top 8 bytes of the pre-int3 stack.  So &regs->sp happens to
72  * point to the top of the pre-int3 stack.
73  */
74 #define stack_addr(regs) ((unsigned long *)&regs->sp)
75 #endif
76
77 #define W(row, b0, b1, b2, b3, b4, b5, b6, b7, b8, b9, ba, bb, bc, bd, be, bf)\
78         (((b0##UL << 0x0)|(b1##UL << 0x1)|(b2##UL << 0x2)|(b3##UL << 0x3) |   \
79           (b4##UL << 0x4)|(b5##UL << 0x5)|(b6##UL << 0x6)|(b7##UL << 0x7) |   \
80           (b8##UL << 0x8)|(b9##UL << 0x9)|(ba##UL << 0xa)|(bb##UL << 0xb) |   \
81           (bc##UL << 0xc)|(bd##UL << 0xd)|(be##UL << 0xe)|(bf##UL << 0xf))    \
82          << (row % 32))
83         /*
84          * Undefined/reserved opcodes, conditional jump, Opcode Extension
85          * Groups, and some special opcodes can not boost.
86          */
87 static const u32 twobyte_is_boostable[256 / 32] = {
88         /*      0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f          */
89         /*      ----------------------------------------------          */
90         W(0x00, 0, 0, 1, 1, 0, 0, 1, 0, 1, 1, 0, 0, 0, 0, 0, 0) | /* 00 */
91         W(0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) , /* 10 */
92         W(0x20, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) | /* 20 */
93         W(0x30, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) , /* 30 */
94         W(0x40, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) | /* 40 */
95         W(0x50, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) , /* 50 */
96         W(0x60, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 1, 1) | /* 60 */
97         W(0x70, 0, 0, 0, 0, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 1, 1) , /* 70 */
98         W(0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) | /* 80 */
99         W(0x90, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) , /* 90 */
100         W(0xa0, 1, 1, 0, 1, 1, 1, 0, 0, 1, 1, 0, 1, 1, 1, 0, 1) | /* a0 */
101         W(0xb0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 1, 1, 1, 1, 1) , /* b0 */
102         W(0xc0, 1, 1, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1) | /* c0 */
103         W(0xd0, 0, 1, 1, 1, 0, 1, 0, 0, 1, 1, 0, 1, 1, 1, 0, 1) , /* d0 */
104         W(0xe0, 0, 1, 1, 0, 0, 1, 0, 0, 1, 1, 0, 1, 1, 1, 0, 1) | /* e0 */
105         W(0xf0, 0, 1, 1, 1, 0, 1, 0, 0, 1, 1, 1, 0, 1, 1, 1, 0)   /* f0 */
106         /*      -----------------------------------------------         */
107         /*      0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f          */
108 };
109 static const u32 onebyte_has_modrm[256 / 32] = {
110         /*      0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f          */
111         /*      -----------------------------------------------         */
112         W(0x00, 1, 1, 1, 1, 0, 0, 0, 0, 1, 1, 1, 1, 0, 0, 0, 0) | /* 00 */
113         W(0x10, 1, 1, 1, 1, 0, 0, 0, 0, 1, 1, 1, 1, 0, 0, 0, 0) , /* 10 */
114         W(0x20, 1, 1, 1, 1, 0, 0, 0, 0, 1, 1, 1, 1, 0, 0, 0, 0) | /* 20 */
115         W(0x30, 1, 1, 1, 1, 0, 0, 0, 0, 1, 1, 1, 1, 0, 0, 0, 0) , /* 30 */
116         W(0x40, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) | /* 40 */
117         W(0x50, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) , /* 50 */
118         W(0x60, 0, 0, 1, 1, 0, 0, 0, 0, 0, 1, 0, 1, 0, 0, 0, 0) | /* 60 */
119         W(0x70, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) , /* 70 */
120         W(0x80, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) | /* 80 */
121         W(0x90, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) , /* 90 */
122         W(0xa0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) | /* a0 */
123         W(0xb0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) , /* b0 */
124         W(0xc0, 1, 1, 0, 0, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0) | /* c0 */
125         W(0xd0, 1, 1, 1, 1, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1) , /* d0 */
126         W(0xe0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) | /* e0 */
127         W(0xf0, 0, 0, 0, 0, 0, 0, 1, 1, 0, 0, 0, 0, 0, 0, 1, 1)   /* f0 */
128         /*      -----------------------------------------------         */
129         /*      0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f          */
130 };
131 static const u32 twobyte_has_modrm[256 / 32] = {
132         /*      0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f          */
133         /*      -----------------------------------------------         */
134         W(0x00, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 1) | /* 0f */
135         W(0x10, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0) , /* 1f */
136         W(0x20, 1, 1, 1, 1, 1, 0, 1, 0, 1, 1, 1, 1, 1, 1, 1, 1) | /* 2f */
137         W(0x30, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) , /* 3f */
138         W(0x40, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) | /* 4f */
139         W(0x50, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) , /* 5f */
140         W(0x60, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) | /* 6f */
141         W(0x70, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 1, 1, 1, 1) , /* 7f */
142         W(0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) | /* 8f */
143         W(0x90, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) , /* 9f */
144         W(0xa0, 0, 0, 0, 1, 1, 1, 1, 1, 0, 0, 0, 1, 1, 1, 1, 1) | /* af */
145         W(0xb0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 1, 1, 1, 1, 1, 1) , /* bf */
146         W(0xc0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0) | /* cf */
147         W(0xd0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) , /* df */
148         W(0xe0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) | /* ef */
149         W(0xf0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0)   /* ff */
150         /*      -----------------------------------------------         */
151         /*      0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f          */
152 };
153 #undef W
154
155 struct kretprobe_blackpoint kretprobe_blacklist[] = {
156         {"__switch_to", }, /* This function switches only current task, but
157                               doesn't switch kernel stack.*/
158         {NULL, NULL}    /* Terminator */
159 };
160 const int kretprobe_blacklist_size = ARRAY_SIZE(kretprobe_blacklist);
161
162 /* Insert a jump instruction at address 'from', which jumps to address 'to'.*/
163 static void __kprobes set_jmp_op(void *from, void *to)
164 {
165         struct __arch_jmp_op {
166                 char op;
167                 s32 raddr;
168         } __attribute__((packed)) * jop;
169         jop = (struct __arch_jmp_op *)from;
170         jop->raddr = (s32)((long)(to) - ((long)(from) + 5));
171         jop->op = RELATIVEJUMP_INSTRUCTION;
172 }
173
174 /*
175  * Check for the REX prefix which can only exist on X86_64
176  * X86_32 always returns 0
177  */
178 static int __kprobes is_REX_prefix(kprobe_opcode_t *insn)
179 {
180 #ifdef CONFIG_X86_64
181         if ((*insn & 0xf0) == 0x40)
182                 return 1;
183 #endif
184         return 0;
185 }
186
187 /*
188  * Returns non-zero if opcode is boostable.
189  * RIP relative instructions are adjusted at copying time in 64 bits mode
190  */
191 static int __kprobes can_boost(kprobe_opcode_t *opcodes)
192 {
193         kprobe_opcode_t opcode;
194         kprobe_opcode_t *orig_opcodes = opcodes;
195
196 retry:
197         if (opcodes - orig_opcodes > MAX_INSN_SIZE - 1)
198                 return 0;
199         opcode = *(opcodes++);
200
201         /* 2nd-byte opcode */
202         if (opcode == 0x0f) {
203                 if (opcodes - orig_opcodes > MAX_INSN_SIZE - 1)
204                         return 0;
205                 return test_bit(*opcodes,
206                                 (unsigned long *)twobyte_is_boostable);
207         }
208
209         switch (opcode & 0xf0) {
210 #ifdef CONFIG_X86_64
211         case 0x40:
212                 goto retry; /* REX prefix is boostable */
213 #endif
214         case 0x60:
215                 if (0x63 < opcode && opcode < 0x67)
216                         goto retry; /* prefixes */
217                 /* can't boost Address-size override and bound */
218                 return (opcode != 0x62 && opcode != 0x67);
219         case 0x70:
220                 return 0; /* can't boost conditional jump */
221         case 0xc0:
222                 /* can't boost software-interruptions */
223                 return (0xc1 < opcode && opcode < 0xcc) || opcode == 0xcf;
224         case 0xd0:
225                 /* can boost AA* and XLAT */
226                 return (opcode == 0xd4 || opcode == 0xd5 || opcode == 0xd7);
227         case 0xe0:
228                 /* can boost in/out and absolute jmps */
229                 return ((opcode & 0x04) || opcode == 0xea);
230         case 0xf0:
231                 if ((opcode & 0x0c) == 0 && opcode != 0xf1)
232                         goto retry; /* lock/rep(ne) prefix */
233                 /* clear and set flags are boostable */
234                 return (opcode == 0xf5 || (0xf7 < opcode && opcode < 0xfe));
235         default:
236                 /* segment override prefixes are boostable */
237                 if (opcode == 0x26 || opcode == 0x36 || opcode == 0x3e)
238                         goto retry; /* prefixes */
239                 /* CS override prefix and call are not boostable */
240                 return (opcode != 0x2e && opcode != 0x9a);
241         }
242 }
243
244 /*
245  * Returns non-zero if opcode modifies the interrupt flag.
246  */
247 static int __kprobes is_IF_modifier(kprobe_opcode_t *insn)
248 {
249         switch (*insn) {
250         case 0xfa:              /* cli */
251         case 0xfb:              /* sti */
252         case 0xcf:              /* iret/iretd */
253         case 0x9d:              /* popf/popfd */
254                 return 1;
255         }
256
257         /*
258          * on X86_64, 0x40-0x4f are REX prefixes so we need to look
259          * at the next byte instead.. but of course not recurse infinitely
260          */
261         if (is_REX_prefix(insn))
262                 return is_IF_modifier(++insn);
263
264         return 0;
265 }
266
267 /*
268  * Adjust the displacement if the instruction uses the %rip-relative
269  * addressing mode.
270  * If it does, Return the address of the 32-bit displacement word.
271  * If not, return null.
272  * Only applicable to 64-bit x86.
273  */
274 static void __kprobes fix_riprel(struct kprobe *p)
275 {
276 #ifdef CONFIG_X86_64
277         u8 *insn = p->ainsn.insn;
278         s64 disp;
279         int need_modrm;
280
281         /* Skip legacy instruction prefixes.  */
282         while (1) {
283                 switch (*insn) {
284                 case 0x66:
285                 case 0x67:
286                 case 0x2e:
287                 case 0x3e:
288                 case 0x26:
289                 case 0x64:
290                 case 0x65:
291                 case 0x36:
292                 case 0xf0:
293                 case 0xf3:
294                 case 0xf2:
295                         ++insn;
296                         continue;
297                 }
298                 break;
299         }
300
301         /* Skip REX instruction prefix.  */
302         if (is_REX_prefix(insn))
303                 ++insn;
304
305         if (*insn == 0x0f) {
306                 /* Two-byte opcode.  */
307                 ++insn;
308                 need_modrm = test_bit(*insn,
309                                       (unsigned long *)twobyte_has_modrm);
310         } else
311                 /* One-byte opcode.  */
312                 need_modrm = test_bit(*insn,
313                                       (unsigned long *)onebyte_has_modrm);
314
315         if (need_modrm) {
316                 u8 modrm = *++insn;
317                 if ((modrm & 0xc7) == 0x05) {
318                         /* %rip+disp32 addressing mode */
319                         /* Displacement follows ModRM byte.  */
320                         ++insn;
321                         /*
322                          * The copied instruction uses the %rip-relative
323                          * addressing mode.  Adjust the displacement for the
324                          * difference between the original location of this
325                          * instruction and the location of the copy that will
326                          * actually be run.  The tricky bit here is making sure
327                          * that the sign extension happens correctly in this
328                          * calculation, since we need a signed 32-bit result to
329                          * be sign-extended to 64 bits when it's added to the
330                          * %rip value and yield the same 64-bit result that the
331                          * sign-extension of the original signed 32-bit
332                          * displacement would have given.
333                          */
334                         disp = (u8 *) p->addr + *((s32 *) insn) -
335                                (u8 *) p->ainsn.insn;
336                         BUG_ON((s64) (s32) disp != disp); /* Sanity check.  */
337                         *(s32 *)insn = (s32) disp;
338                 }
339         }
340 #endif
341 }
342
343 static void __kprobes arch_copy_kprobe(struct kprobe *p)
344 {
345         memcpy(p->ainsn.insn, p->addr, MAX_INSN_SIZE * sizeof(kprobe_opcode_t));
346
347         fix_riprel(p);
348
349         if (can_boost(p->addr))
350                 p->ainsn.boostable = 0;
351         else
352                 p->ainsn.boostable = -1;
353
354         p->opcode = *p->addr;
355 }
356
357 int __kprobes arch_prepare_kprobe(struct kprobe *p)
358 {
359         /* insn: must be on special executable page on x86. */
360         p->ainsn.insn = get_insn_slot();
361         if (!p->ainsn.insn)
362                 return -ENOMEM;
363         arch_copy_kprobe(p);
364         return 0;
365 }
366
367 void __kprobes arch_arm_kprobe(struct kprobe *p)
368 {
369         text_poke(p->addr, ((unsigned char []){BREAKPOINT_INSTRUCTION}), 1);
370 }
371
372 void __kprobes arch_disarm_kprobe(struct kprobe *p)
373 {
374         text_poke(p->addr, &p->opcode, 1);
375 }
376
377 void __kprobes arch_remove_kprobe(struct kprobe *p)
378 {
379         if (p->ainsn.insn) {
380                 free_insn_slot(p->ainsn.insn, (p->ainsn.boostable == 1));
381                 p->ainsn.insn = NULL;
382         }
383 }
384
385 static void __kprobes save_previous_kprobe(struct kprobe_ctlblk *kcb)
386 {
387         kcb->prev_kprobe.kp = kprobe_running();
388         kcb->prev_kprobe.status = kcb->kprobe_status;
389         kcb->prev_kprobe.old_flags = kcb->kprobe_old_flags;
390         kcb->prev_kprobe.saved_flags = kcb->kprobe_saved_flags;
391 }
392
393 static void __kprobes restore_previous_kprobe(struct kprobe_ctlblk *kcb)
394 {
395         __get_cpu_var(current_kprobe) = kcb->prev_kprobe.kp;
396         kcb->kprobe_status = kcb->prev_kprobe.status;
397         kcb->kprobe_old_flags = kcb->prev_kprobe.old_flags;
398         kcb->kprobe_saved_flags = kcb->prev_kprobe.saved_flags;
399 }
400
401 static void __kprobes set_current_kprobe(struct kprobe *p, struct pt_regs *regs,
402                                 struct kprobe_ctlblk *kcb)
403 {
404         __get_cpu_var(current_kprobe) = p;
405         kcb->kprobe_saved_flags = kcb->kprobe_old_flags
406                 = (regs->flags & (X86_EFLAGS_TF | X86_EFLAGS_IF));
407         if (is_IF_modifier(p->ainsn.insn))
408                 kcb->kprobe_saved_flags &= ~X86_EFLAGS_IF;
409 }
410
411 static void __kprobes clear_btf(void)
412 {
413         if (test_thread_flag(TIF_DEBUGCTLMSR))
414                 update_debugctlmsr(0);
415 }
416
417 static void __kprobes restore_btf(void)
418 {
419         if (test_thread_flag(TIF_DEBUGCTLMSR))
420                 update_debugctlmsr(current->thread.debugctlmsr);
421 }
422
423 static void __kprobes prepare_singlestep(struct kprobe *p, struct pt_regs *regs)
424 {
425         clear_btf();
426         regs->flags |= X86_EFLAGS_TF;
427         regs->flags &= ~X86_EFLAGS_IF;
428         /* single step inline if the instruction is an int3 */
429         if (p->opcode == BREAKPOINT_INSTRUCTION)
430                 regs->ip = (unsigned long)p->addr;
431         else
432                 regs->ip = (unsigned long)p->ainsn.insn;
433 }
434
435 void __kprobes arch_prepare_kretprobe(struct kretprobe_instance *ri,
436                                       struct pt_regs *regs)
437 {
438         unsigned long *sara = stack_addr(regs);
439
440         ri->ret_addr = (kprobe_opcode_t *) *sara;
441
442         /* Replace the return addr with trampoline addr */
443         *sara = (unsigned long) &kretprobe_trampoline;
444 }
445
446 static void __kprobes setup_singlestep(struct kprobe *p, struct pt_regs *regs,
447                                        struct kprobe_ctlblk *kcb)
448 {
449 #if !defined(CONFIG_PREEMPT) || defined(CONFIG_PM)
450         if (p->ainsn.boostable == 1 && !p->post_handler) {
451                 /* Boost up -- we can execute copied instructions directly */
452                 reset_current_kprobe();
453                 regs->ip = (unsigned long)p->ainsn.insn;
454                 preempt_enable_no_resched();
455                 return;
456         }
457 #endif
458         prepare_singlestep(p, regs);
459         kcb->kprobe_status = KPROBE_HIT_SS;
460 }
461
462 /*
463  * We have reentered the kprobe_handler(), since another probe was hit while
464  * within the handler. We save the original kprobes variables and just single
465  * step on the instruction of the new probe without calling any user handlers.
466  */
467 static int __kprobes reenter_kprobe(struct kprobe *p, struct pt_regs *regs,
468                                     struct kprobe_ctlblk *kcb)
469 {
470         switch (kcb->kprobe_status) {
471         case KPROBE_HIT_SSDONE:
472 #ifdef CONFIG_X86_64
473                 /* TODO: Provide re-entrancy from post_kprobes_handler() and
474                  * avoid exception stack corruption while single-stepping on
475                  * the instruction of the new probe.
476                  */
477                 arch_disarm_kprobe(p);
478                 regs->ip = (unsigned long)p->addr;
479                 reset_current_kprobe();
480                 preempt_enable_no_resched();
481                 break;
482 #endif
483         case KPROBE_HIT_ACTIVE:
484                 save_previous_kprobe(kcb);
485                 set_current_kprobe(p, regs, kcb);
486                 kprobes_inc_nmissed_count(p);
487                 prepare_singlestep(p, regs);
488                 kcb->kprobe_status = KPROBE_REENTER;
489                 break;
490         case KPROBE_HIT_SS:
491                 if (p == kprobe_running()) {
492                         regs->flags &= ~X86_EFLAGS_TF;
493                         regs->flags |= kcb->kprobe_saved_flags;
494                         return 0;
495                 } else {
496                         /* A probe has been hit in the codepath leading up
497                          * to, or just after, single-stepping of a probed
498                          * instruction. This entire codepath should strictly
499                          * reside in .kprobes.text section. Raise a warning
500                          * to highlight this peculiar case.
501                          */
502                 }
503         default:
504                 /* impossible cases */
505                 WARN_ON(1);
506                 return 0;
507         }
508
509         return 1;
510 }
511
512 /*
513  * Interrupts are disabled on entry as trap3 is an interrupt gate and they
514  * remain disabled thorough out this function.
515  */
516 static int __kprobes kprobe_handler(struct pt_regs *regs)
517 {
518         kprobe_opcode_t *addr;
519         struct kprobe *p;
520         struct kprobe_ctlblk *kcb;
521
522         addr = (kprobe_opcode_t *)(regs->ip - sizeof(kprobe_opcode_t));
523         if (*addr != BREAKPOINT_INSTRUCTION) {
524                 /*
525                  * The breakpoint instruction was removed right
526                  * after we hit it.  Another cpu has removed
527                  * either a probepoint or a debugger breakpoint
528                  * at this address.  In either case, no further
529                  * handling of this interrupt is appropriate.
530                  * Back up over the (now missing) int3 and run
531                  * the original instruction.
532                  */
533                 regs->ip = (unsigned long)addr;
534                 return 1;
535         }
536
537         /*
538          * We don't want to be preempted for the entire
539          * duration of kprobe processing. We conditionally
540          * re-enable preemption at the end of this function,
541          * and also in reenter_kprobe() and setup_singlestep().
542          */
543         preempt_disable();
544
545         kcb = get_kprobe_ctlblk();
546         p = get_kprobe(addr);
547
548         if (p) {
549                 if (kprobe_running()) {
550                         if (reenter_kprobe(p, regs, kcb))
551                                 return 1;
552                 } else {
553                         set_current_kprobe(p, regs, kcb);
554                         kcb->kprobe_status = KPROBE_HIT_ACTIVE;
555
556                         /*
557                          * If we have no pre-handler or it returned 0, we
558                          * continue with normal processing.  If we have a
559                          * pre-handler and it returned non-zero, it prepped
560                          * for calling the break_handler below on re-entry
561                          * for jprobe processing, so get out doing nothing
562                          * more here.
563                          */
564                         if (!p->pre_handler || !p->pre_handler(p, regs))
565                                 setup_singlestep(p, regs, kcb);
566                         return 1;
567                 }
568         } else if (kprobe_running()) {
569                 p = __get_cpu_var(current_kprobe);
570                 if (p->break_handler && p->break_handler(p, regs)) {
571                         setup_singlestep(p, regs, kcb);
572                         return 1;
573                 }
574         } /* else: not a kprobe fault; let the kernel handle it */
575
576         preempt_enable_no_resched();
577         return 0;
578 }
579
580 /*
581  * When a retprobed function returns, this code saves registers and
582  * calls trampoline_handler() runs, which calls the kretprobe's handler.
583  */
584 static void __used __kprobes kretprobe_trampoline_holder(void)
585 {
586         asm volatile (
587                         ".global kretprobe_trampoline\n"
588                         "kretprobe_trampoline: \n"
589 #ifdef CONFIG_X86_64
590                         /* We don't bother saving the ss register */
591                         "       pushq %rsp\n"
592                         "       pushfq\n"
593                         /*
594                          * Skip cs, ip, orig_ax.
595                          * trampoline_handler() will plug in these values
596                          */
597                         "       subq $24, %rsp\n"
598                         "       pushq %rdi\n"
599                         "       pushq %rsi\n"
600                         "       pushq %rdx\n"
601                         "       pushq %rcx\n"
602                         "       pushq %rax\n"
603                         "       pushq %r8\n"
604                         "       pushq %r9\n"
605                         "       pushq %r10\n"
606                         "       pushq %r11\n"
607                         "       pushq %rbx\n"
608                         "       pushq %rbp\n"
609                         "       pushq %r12\n"
610                         "       pushq %r13\n"
611                         "       pushq %r14\n"
612                         "       pushq %r15\n"
613                         "       movq %rsp, %rdi\n"
614                         "       call trampoline_handler\n"
615                         /* Replace saved sp with true return address. */
616                         "       movq %rax, 152(%rsp)\n"
617                         "       popq %r15\n"
618                         "       popq %r14\n"
619                         "       popq %r13\n"
620                         "       popq %r12\n"
621                         "       popq %rbp\n"
622                         "       popq %rbx\n"
623                         "       popq %r11\n"
624                         "       popq %r10\n"
625                         "       popq %r9\n"
626                         "       popq %r8\n"
627                         "       popq %rax\n"
628                         "       popq %rcx\n"
629                         "       popq %rdx\n"
630                         "       popq %rsi\n"
631                         "       popq %rdi\n"
632                         /* Skip orig_ax, ip, cs */
633                         "       addq $24, %rsp\n"
634                         "       popfq\n"
635 #else
636                         "       pushf\n"
637                         /*
638                          * Skip cs, ip, orig_ax.
639                          * trampoline_handler() will plug in these values
640                          */
641                         "       subl $12, %esp\n"
642                         "       pushl %fs\n"
643                         "       pushl %ds\n"
644                         "       pushl %es\n"
645                         "       pushl %eax\n"
646                         "       pushl %ebp\n"
647                         "       pushl %edi\n"
648                         "       pushl %esi\n"
649                         "       pushl %edx\n"
650                         "       pushl %ecx\n"
651                         "       pushl %ebx\n"
652                         "       movl %esp, %eax\n"
653                         "       call trampoline_handler\n"
654                         /* Move flags to cs */
655                         "       movl 52(%esp), %edx\n"
656                         "       movl %edx, 48(%esp)\n"
657                         /* Replace saved flags with true return address. */
658                         "       movl %eax, 52(%esp)\n"
659                         "       popl %ebx\n"
660                         "       popl %ecx\n"
661                         "       popl %edx\n"
662                         "       popl %esi\n"
663                         "       popl %edi\n"
664                         "       popl %ebp\n"
665                         "       popl %eax\n"
666                         /* Skip ip, orig_ax, es, ds, fs */
667                         "       addl $20, %esp\n"
668                         "       popf\n"
669 #endif
670                         "       ret\n");
671 }
672
673 /*
674  * Called from kretprobe_trampoline
675  */
676 static __used __kprobes void *trampoline_handler(struct pt_regs *regs)
677 {
678         struct kretprobe_instance *ri = NULL;
679         struct hlist_head *head, empty_rp;
680         struct hlist_node *node, *tmp;
681         unsigned long flags, orig_ret_address = 0;
682         unsigned long trampoline_address = (unsigned long)&kretprobe_trampoline;
683
684         INIT_HLIST_HEAD(&empty_rp);
685         kretprobe_hash_lock(current, &head, &flags);
686         /* fixup registers */
687 #ifdef CONFIG_X86_64
688         regs->cs = __KERNEL_CS;
689 #else
690         regs->cs = __KERNEL_CS | get_kernel_rpl();
691 #endif
692         regs->ip = trampoline_address;
693         regs->orig_ax = ~0UL;
694
695         /*
696          * It is possible to have multiple instances associated with a given
697          * task either because multiple functions in the call path have
698          * return probes installed on them, and/or more then one
699          * return probe was registered for a target function.
700          *
701          * We can handle this because:
702          *     - instances are always pushed into the head of the list
703          *     - when multiple return probes are registered for the same
704          *       function, the (chronologically) first instance's ret_addr
705          *       will be the real return address, and all the rest will
706          *       point to kretprobe_trampoline.
707          */
708         hlist_for_each_entry_safe(ri, node, tmp, head, hlist) {
709                 if (ri->task != current)
710                         /* another task is sharing our hash bucket */
711                         continue;
712
713                 if (ri->rp && ri->rp->handler) {
714                         __get_cpu_var(current_kprobe) = &ri->rp->kp;
715                         get_kprobe_ctlblk()->kprobe_status = KPROBE_HIT_ACTIVE;
716                         ri->rp->handler(ri, regs);
717                         __get_cpu_var(current_kprobe) = NULL;
718                 }
719
720                 orig_ret_address = (unsigned long)ri->ret_addr;
721                 recycle_rp_inst(ri, &empty_rp);
722
723                 if (orig_ret_address != trampoline_address)
724                         /*
725                          * This is the real return address. Any other
726                          * instances associated with this task are for
727                          * other calls deeper on the call stack
728                          */
729                         break;
730         }
731
732         kretprobe_assert(ri, orig_ret_address, trampoline_address);
733
734         kretprobe_hash_unlock(current, &flags);
735
736         hlist_for_each_entry_safe(ri, node, tmp, &empty_rp, hlist) {
737                 hlist_del(&ri->hlist);
738                 kfree(ri);
739         }
740         return (void *)orig_ret_address;
741 }
742
743 /*
744  * Called after single-stepping.  p->addr is the address of the
745  * instruction whose first byte has been replaced by the "int 3"
746  * instruction.  To avoid the SMP problems that can occur when we
747  * temporarily put back the original opcode to single-step, we
748  * single-stepped a copy of the instruction.  The address of this
749  * copy is p->ainsn.insn.
750  *
751  * This function prepares to return from the post-single-step
752  * interrupt.  We have to fix up the stack as follows:
753  *
754  * 0) Except in the case of absolute or indirect jump or call instructions,
755  * the new ip is relative to the copied instruction.  We need to make
756  * it relative to the original instruction.
757  *
758  * 1) If the single-stepped instruction was pushfl, then the TF and IF
759  * flags are set in the just-pushed flags, and may need to be cleared.
760  *
761  * 2) If the single-stepped instruction was a call, the return address
762  * that is atop the stack is the address following the copied instruction.
763  * We need to make it the address following the original instruction.
764  *
765  * If this is the first time we've single-stepped the instruction at
766  * this probepoint, and the instruction is boostable, boost it: add a
767  * jump instruction after the copied instruction, that jumps to the next
768  * instruction after the probepoint.
769  */
770 static void __kprobes resume_execution(struct kprobe *p,
771                 struct pt_regs *regs, struct kprobe_ctlblk *kcb)
772 {
773         unsigned long *tos = stack_addr(regs);
774         unsigned long copy_ip = (unsigned long)p->ainsn.insn;
775         unsigned long orig_ip = (unsigned long)p->addr;
776         kprobe_opcode_t *insn = p->ainsn.insn;
777
778         /*skip the REX prefix*/
779         if (is_REX_prefix(insn))
780                 insn++;
781
782         regs->flags &= ~X86_EFLAGS_TF;
783         switch (*insn) {
784         case 0x9c:      /* pushfl */
785                 *tos &= ~(X86_EFLAGS_TF | X86_EFLAGS_IF);
786                 *tos |= kcb->kprobe_old_flags;
787                 break;
788         case 0xc2:      /* iret/ret/lret */
789         case 0xc3:
790         case 0xca:
791         case 0xcb:
792         case 0xcf:
793         case 0xea:      /* jmp absolute -- ip is correct */
794                 /* ip is already adjusted, no more changes required */
795                 p->ainsn.boostable = 1;
796                 goto no_change;
797         case 0xe8:      /* call relative - Fix return addr */
798                 *tos = orig_ip + (*tos - copy_ip);
799                 break;
800 #ifdef CONFIG_X86_32
801         case 0x9a:      /* call absolute -- same as call absolute, indirect */
802                 *tos = orig_ip + (*tos - copy_ip);
803                 goto no_change;
804 #endif
805         case 0xff:
806                 if ((insn[1] & 0x30) == 0x10) {
807                         /*
808                          * call absolute, indirect
809                          * Fix return addr; ip is correct.
810                          * But this is not boostable
811                          */
812                         *tos = orig_ip + (*tos - copy_ip);
813                         goto no_change;
814                 } else if (((insn[1] & 0x31) == 0x20) ||
815                            ((insn[1] & 0x31) == 0x21)) {
816                         /*
817                          * jmp near and far, absolute indirect
818                          * ip is correct. And this is boostable
819                          */
820                         p->ainsn.boostable = 1;
821                         goto no_change;
822                 }
823         default:
824                 break;
825         }
826
827         if (p->ainsn.boostable == 0) {
828                 if ((regs->ip > copy_ip) &&
829                     (regs->ip - copy_ip) + 5 < MAX_INSN_SIZE) {
830                         /*
831                          * These instructions can be executed directly if it
832                          * jumps back to correct address.
833                          */
834                         set_jmp_op((void *)regs->ip,
835                                    (void *)orig_ip + (regs->ip - copy_ip));
836                         p->ainsn.boostable = 1;
837                 } else {
838                         p->ainsn.boostable = -1;
839                 }
840         }
841
842         regs->ip += orig_ip - copy_ip;
843
844 no_change:
845         restore_btf();
846 }
847
848 /*
849  * Interrupts are disabled on entry as trap1 is an interrupt gate and they
850  * remain disabled thoroughout this function.
851  */
852 static int __kprobes post_kprobe_handler(struct pt_regs *regs)
853 {
854         struct kprobe *cur = kprobe_running();
855         struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
856
857         if (!cur)
858                 return 0;
859
860         resume_execution(cur, regs, kcb);
861         regs->flags |= kcb->kprobe_saved_flags;
862
863         if ((kcb->kprobe_status != KPROBE_REENTER) && cur->post_handler) {
864                 kcb->kprobe_status = KPROBE_HIT_SSDONE;
865                 cur->post_handler(cur, regs, 0);
866         }
867
868         /* Restore back the original saved kprobes variables and continue. */
869         if (kcb->kprobe_status == KPROBE_REENTER) {
870                 restore_previous_kprobe(kcb);
871                 goto out;
872         }
873         reset_current_kprobe();
874 out:
875         preempt_enable_no_resched();
876
877         /*
878          * if somebody else is singlestepping across a probe point, flags
879          * will have TF set, in which case, continue the remaining processing
880          * of do_debug, as if this is not a probe hit.
881          */
882         if (regs->flags & X86_EFLAGS_TF)
883                 return 0;
884
885         return 1;
886 }
887
888 int __kprobes kprobe_fault_handler(struct pt_regs *regs, int trapnr)
889 {
890         struct kprobe *cur = kprobe_running();
891         struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
892
893         switch (kcb->kprobe_status) {
894         case KPROBE_HIT_SS:
895         case KPROBE_REENTER:
896                 /*
897                  * We are here because the instruction being single
898                  * stepped caused a page fault. We reset the current
899                  * kprobe and the ip points back to the probe address
900                  * and allow the page fault handler to continue as a
901                  * normal page fault.
902                  */
903                 regs->ip = (unsigned long)cur->addr;
904                 regs->flags |= kcb->kprobe_old_flags;
905                 if (kcb->kprobe_status == KPROBE_REENTER)
906                         restore_previous_kprobe(kcb);
907                 else
908                         reset_current_kprobe();
909                 preempt_enable_no_resched();
910                 break;
911         case KPROBE_HIT_ACTIVE:
912         case KPROBE_HIT_SSDONE:
913                 /*
914                  * We increment the nmissed count for accounting,
915                  * we can also use npre/npostfault count for accounting
916                  * these specific fault cases.
917                  */
918                 kprobes_inc_nmissed_count(cur);
919
920                 /*
921                  * We come here because instructions in the pre/post
922                  * handler caused the page_fault, this could happen
923                  * if handler tries to access user space by
924                  * copy_from_user(), get_user() etc. Let the
925                  * user-specified handler try to fix it first.
926                  */
927                 if (cur->fault_handler && cur->fault_handler(cur, regs, trapnr))
928                         return 1;
929
930                 /*
931                  * In case the user-specified fault handler returned
932                  * zero, try to fix up.
933                  */
934                 if (fixup_exception(regs))
935                         return 1;
936
937                 /*
938                  * fixup routine could not handle it,
939                  * Let do_page_fault() fix it.
940                  */
941                 break;
942         default:
943                 break;
944         }
945         return 0;
946 }
947
948 /*
949  * Wrapper routine for handling exceptions.
950  */
951 int __kprobes kprobe_exceptions_notify(struct notifier_block *self,
952                                        unsigned long val, void *data)
953 {
954         struct die_args *args = data;
955         int ret = NOTIFY_DONE;
956
957         if (args->regs && user_mode_vm(args->regs))
958                 return ret;
959
960         switch (val) {
961         case DIE_INT3:
962                 if (kprobe_handler(args->regs))
963                         ret = NOTIFY_STOP;
964                 break;
965         case DIE_DEBUG:
966                 if (post_kprobe_handler(args->regs))
967                         ret = NOTIFY_STOP;
968                 break;
969         case DIE_GPF:
970                 /*
971                  * To be potentially processing a kprobe fault and to
972                  * trust the result from kprobe_running(), we have
973                  * be non-preemptible.
974                  */
975                 if (!preemptible() && kprobe_running() &&
976                     kprobe_fault_handler(args->regs, args->trapnr))
977                         ret = NOTIFY_STOP;
978                 break;
979         default:
980                 break;
981         }
982         return ret;
983 }
984
985 int __kprobes setjmp_pre_handler(struct kprobe *p, struct pt_regs *regs)
986 {
987         struct jprobe *jp = container_of(p, struct jprobe, kp);
988         unsigned long addr;
989         struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
990
991         kcb->jprobe_saved_regs = *regs;
992         kcb->jprobe_saved_sp = stack_addr(regs);
993         addr = (unsigned long)(kcb->jprobe_saved_sp);
994
995         /*
996          * As Linus pointed out, gcc assumes that the callee
997          * owns the argument space and could overwrite it, e.g.
998          * tailcall optimization. So, to be absolutely safe
999          * we also save and restore enough stack bytes to cover
1000          * the argument area.
1001          */
1002         memcpy(kcb->jprobes_stack, (kprobe_opcode_t *)addr,
1003                MIN_STACK_SIZE(addr));
1004         regs->flags &= ~X86_EFLAGS_IF;
1005         trace_hardirqs_off();
1006         regs->ip = (unsigned long)(jp->entry);
1007         return 1;
1008 }
1009
1010 void __kprobes jprobe_return(void)
1011 {
1012         struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
1013
1014         asm volatile (
1015 #ifdef CONFIG_X86_64
1016                         "       xchg   %%rbx,%%rsp      \n"
1017 #else
1018                         "       xchgl   %%ebx,%%esp     \n"
1019 #endif
1020                         "       int3                    \n"
1021                         "       .globl jprobe_return_end\n"
1022                         "       jprobe_return_end:      \n"
1023                         "       nop                     \n"::"b"
1024                         (kcb->jprobe_saved_sp):"memory");
1025 }
1026
1027 int __kprobes longjmp_break_handler(struct kprobe *p, struct pt_regs *regs)
1028 {
1029         struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
1030         u8 *addr = (u8 *) (regs->ip - 1);
1031         struct jprobe *jp = container_of(p, struct jprobe, kp);
1032
1033         if ((addr > (u8 *) jprobe_return) &&
1034             (addr < (u8 *) jprobe_return_end)) {
1035                 if (stack_addr(regs) != kcb->jprobe_saved_sp) {
1036                         struct pt_regs *saved_regs = &kcb->jprobe_saved_regs;
1037                         printk(KERN_ERR
1038                                "current sp %p does not match saved sp %p\n",
1039                                stack_addr(regs), kcb->jprobe_saved_sp);
1040                         printk(KERN_ERR "Saved registers for jprobe %p\n", jp);
1041                         show_registers(saved_regs);
1042                         printk(KERN_ERR "Current registers\n");
1043                         show_registers(regs);
1044                         BUG();
1045                 }
1046                 *regs = kcb->jprobe_saved_regs;
1047                 memcpy((kprobe_opcode_t *)(kcb->jprobe_saved_sp),
1048                        kcb->jprobes_stack,
1049                        MIN_STACK_SIZE(kcb->jprobe_saved_sp));
1050                 preempt_enable_no_resched();
1051                 return 1;
1052         }
1053         return 0;
1054 }
1055
1056 int __init arch_init_kprobes(void)
1057 {
1058         return 0;
1059 }
1060
1061 int __kprobes arch_trampoline_kprobe(struct kprobe *p)
1062 {
1063         return 0;
1064 }