GNU Linux-libre 4.9.297-gnu1
[releases.git] / arch / x86 / kernel / kprobes / core.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 #include <linux/kprobes.h>
43 #include <linux/ptrace.h>
44 #include <linux/string.h>
45 #include <linux/slab.h>
46 #include <linux/hardirq.h>
47 #include <linux/preempt.h>
48 #include <linux/extable.h>
49 #include <linux/kdebug.h>
50 #include <linux/kallsyms.h>
51 #include <linux/ftrace.h>
52 #include <linux/frame.h>
53 #include <linux/kasan.h>
54 #include <linux/moduleloader.h>
55
56 #include <asm/text-patching.h>
57 #include <asm/cacheflush.h>
58 #include <asm/desc.h>
59 #include <asm/pgtable.h>
60 #include <asm/uaccess.h>
61 #include <asm/alternative.h>
62 #include <asm/insn.h>
63 #include <asm/debugreg.h>
64 #include <asm/sections.h>
65
66 #include "common.h"
67
68 void jprobe_return_end(void);
69
70 DEFINE_PER_CPU(struct kprobe *, current_kprobe) = NULL;
71 DEFINE_PER_CPU(struct kprobe_ctlblk, kprobe_ctlblk);
72
73 #define stack_addr(regs) ((unsigned long *)kernel_stack_pointer(regs))
74
75 #define W(row, b0, b1, b2, b3, b4, b5, b6, b7, b8, b9, ba, bb, bc, bd, be, bf)\
76         (((b0##UL << 0x0)|(b1##UL << 0x1)|(b2##UL << 0x2)|(b3##UL << 0x3) |   \
77           (b4##UL << 0x4)|(b5##UL << 0x5)|(b6##UL << 0x6)|(b7##UL << 0x7) |   \
78           (b8##UL << 0x8)|(b9##UL << 0x9)|(ba##UL << 0xa)|(bb##UL << 0xb) |   \
79           (bc##UL << 0xc)|(bd##UL << 0xd)|(be##UL << 0xe)|(bf##UL << 0xf))    \
80          << (row % 32))
81         /*
82          * Undefined/reserved opcodes, conditional jump, Opcode Extension
83          * Groups, and some special opcodes can not boost.
84          * This is non-const and volatile to keep gcc from statically
85          * optimizing it out, as variable_test_bit makes gcc think only
86          * *(unsigned long*) is used.
87          */
88 static volatile u32 twobyte_is_boostable[256 / 32] = {
89         /*      0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f          */
90         /*      ----------------------------------------------          */
91         W(0x00, 0, 0, 1, 1, 0, 0, 1, 0, 1, 1, 0, 0, 0, 0, 0, 0) | /* 00 */
92         W(0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1) , /* 10 */
93         W(0x20, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) | /* 20 */
94         W(0x30, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) , /* 30 */
95         W(0x40, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) | /* 40 */
96         W(0x50, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) , /* 50 */
97         W(0x60, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 1, 1) | /* 60 */
98         W(0x70, 0, 0, 0, 0, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 1, 1) , /* 70 */
99         W(0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) | /* 80 */
100         W(0x90, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) , /* 90 */
101         W(0xa0, 1, 1, 0, 1, 1, 1, 0, 0, 1, 1, 0, 1, 1, 1, 0, 1) | /* a0 */
102         W(0xb0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 1, 1, 1, 1, 1) , /* b0 */
103         W(0xc0, 1, 1, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1) | /* c0 */
104         W(0xd0, 0, 1, 1, 1, 0, 1, 0, 0, 1, 1, 0, 1, 1, 1, 0, 1) , /* d0 */
105         W(0xe0, 0, 1, 1, 0, 0, 1, 0, 0, 1, 1, 0, 1, 1, 1, 0, 1) | /* e0 */
106         W(0xf0, 0, 1, 1, 1, 0, 1, 0, 0, 1, 1, 1, 0, 1, 1, 1, 0)   /* f0 */
107         /*      -----------------------------------------------         */
108         /*      0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f          */
109 };
110 #undef W
111
112 struct kretprobe_blackpoint kretprobe_blacklist[] = {
113         {"__switch_to", }, /* This function switches only current task, but
114                               doesn't switch kernel stack.*/
115         {NULL, NULL}    /* Terminator */
116 };
117
118 const int kretprobe_blacklist_size = ARRAY_SIZE(kretprobe_blacklist);
119
120 static nokprobe_inline void
121 __synthesize_relative_insn(void *from, void *to, u8 op)
122 {
123         struct __arch_relative_insn {
124                 u8 op;
125                 s32 raddr;
126         } __packed *insn;
127
128         insn = (struct __arch_relative_insn *)from;
129         insn->raddr = (s32)((long)(to) - ((long)(from) + 5));
130         insn->op = op;
131 }
132
133 /* Insert a jump instruction at address 'from', which jumps to address 'to'.*/
134 void synthesize_reljump(void *from, void *to)
135 {
136         __synthesize_relative_insn(from, to, RELATIVEJUMP_OPCODE);
137 }
138 NOKPROBE_SYMBOL(synthesize_reljump);
139
140 /* Insert a call instruction at address 'from', which calls address 'to'.*/
141 void synthesize_relcall(void *from, void *to)
142 {
143         __synthesize_relative_insn(from, to, RELATIVECALL_OPCODE);
144 }
145 NOKPROBE_SYMBOL(synthesize_relcall);
146
147 /*
148  * Skip the prefixes of the instruction.
149  */
150 static kprobe_opcode_t *skip_prefixes(kprobe_opcode_t *insn)
151 {
152         insn_attr_t attr;
153
154         attr = inat_get_opcode_attribute((insn_byte_t)*insn);
155         while (inat_is_legacy_prefix(attr)) {
156                 insn++;
157                 attr = inat_get_opcode_attribute((insn_byte_t)*insn);
158         }
159 #ifdef CONFIG_X86_64
160         if (inat_is_rex_prefix(attr))
161                 insn++;
162 #endif
163         return insn;
164 }
165 NOKPROBE_SYMBOL(skip_prefixes);
166
167 /*
168  * Returns non-zero if opcode is boostable.
169  * RIP relative instructions are adjusted at copying time in 64 bits mode
170  */
171 int can_boost(kprobe_opcode_t *opcodes, void *addr)
172 {
173         kprobe_opcode_t opcode;
174         kprobe_opcode_t *orig_opcodes = opcodes;
175
176         if (search_exception_tables((unsigned long)addr))
177                 return 0;       /* Page fault may occur on this address. */
178
179 retry:
180         if (opcodes - orig_opcodes > MAX_INSN_SIZE - 1)
181                 return 0;
182         opcode = *(opcodes++);
183
184         /* 2nd-byte opcode */
185         if (opcode == 0x0f) {
186                 if (opcodes - orig_opcodes > MAX_INSN_SIZE - 1)
187                         return 0;
188                 return test_bit(*opcodes,
189                                 (unsigned long *)twobyte_is_boostable);
190         }
191
192         switch (opcode & 0xf0) {
193 #ifdef CONFIG_X86_64
194         case 0x40:
195                 goto retry; /* REX prefix is boostable */
196 #endif
197         case 0x60:
198                 if (0x63 < opcode && opcode < 0x67)
199                         goto retry; /* prefixes */
200                 /* can't boost Address-size override and bound */
201                 return (opcode != 0x62 && opcode != 0x67);
202         case 0x70:
203                 return 0; /* can't boost conditional jump */
204         case 0x90:
205                 return opcode != 0x9a;  /* can't boost call far */
206         case 0xc0:
207                 /* can't boost software-interruptions */
208                 return (0xc1 < opcode && opcode < 0xcc) || opcode == 0xcf;
209         case 0xd0:
210                 /* can boost AA* and XLAT */
211                 return (opcode == 0xd4 || opcode == 0xd5 || opcode == 0xd7);
212         case 0xe0:
213                 /* can boost in/out and absolute jmps */
214                 return ((opcode & 0x04) || opcode == 0xea);
215         case 0xf0:
216                 if ((opcode & 0x0c) == 0 && opcode != 0xf1)
217                         goto retry; /* lock/rep(ne) prefix */
218                 /* clear and set flags are boostable */
219                 return (opcode == 0xf5 || (0xf7 < opcode && opcode < 0xfe));
220         default:
221                 /* segment override prefixes are boostable */
222                 if (opcode == 0x26 || opcode == 0x36 || opcode == 0x3e)
223                         goto retry; /* prefixes */
224                 /* CS override prefix and call are not boostable */
225                 return (opcode != 0x2e && opcode != 0x9a);
226         }
227 }
228
229 static unsigned long
230 __recover_probed_insn(kprobe_opcode_t *buf, unsigned long addr)
231 {
232         struct kprobe *kp;
233         unsigned long faddr;
234
235         kp = get_kprobe((void *)addr);
236         faddr = ftrace_location(addr);
237         /*
238          * Addresses inside the ftrace location are refused by
239          * arch_check_ftrace_location(). Something went terribly wrong
240          * if such an address is checked here.
241          */
242         if (WARN_ON(faddr && faddr != addr))
243                 return 0UL;
244         /*
245          * Use the current code if it is not modified by Kprobe
246          * and it cannot be modified by ftrace.
247          */
248         if (!kp && !faddr)
249                 return addr;
250
251         /*
252          * Basically, kp->ainsn.insn has an original instruction.
253          * However, RIP-relative instruction can not do single-stepping
254          * at different place, __copy_instruction() tweaks the displacement of
255          * that instruction. In that case, we can't recover the instruction
256          * from the kp->ainsn.insn.
257          *
258          * On the other hand, in case on normal Kprobe, kp->opcode has a copy
259          * of the first byte of the probed instruction, which is overwritten
260          * by int3. And the instruction at kp->addr is not modified by kprobes
261          * except for the first byte, we can recover the original instruction
262          * from it and kp->opcode.
263          *
264          * In case of Kprobes using ftrace, we do not have a copy of
265          * the original instruction. In fact, the ftrace location might
266          * be modified at anytime and even could be in an inconsistent state.
267          * Fortunately, we know that the original code is the ideal 5-byte
268          * long NOP.
269          */
270         memcpy(buf, (void *)addr, MAX_INSN_SIZE * sizeof(kprobe_opcode_t));
271         if (faddr)
272                 memcpy(buf, ideal_nops[NOP_ATOMIC5], 5);
273         else
274                 buf[0] = kp->opcode;
275         return (unsigned long)buf;
276 }
277
278 /*
279  * Recover the probed instruction at addr for further analysis.
280  * Caller must lock kprobes by kprobe_mutex, or disable preemption
281  * for preventing to release referencing kprobes.
282  * Returns zero if the instruction can not get recovered.
283  */
284 unsigned long recover_probed_instruction(kprobe_opcode_t *buf, unsigned long addr)
285 {
286         unsigned long __addr;
287
288         __addr = __recover_optprobed_insn(buf, addr);
289         if (__addr != addr)
290                 return __addr;
291
292         return __recover_probed_insn(buf, addr);
293 }
294
295 /* Check if paddr is at an instruction boundary */
296 static int can_probe(unsigned long paddr)
297 {
298         unsigned long addr, __addr, offset = 0;
299         struct insn insn;
300         kprobe_opcode_t buf[MAX_INSN_SIZE];
301
302         if (!kallsyms_lookup_size_offset(paddr, NULL, &offset))
303                 return 0;
304
305         /* Decode instructions */
306         addr = paddr - offset;
307         while (addr < paddr) {
308                 /*
309                  * Check if the instruction has been modified by another
310                  * kprobe, in which case we replace the breakpoint by the
311                  * original instruction in our buffer.
312                  * Also, jump optimization will change the breakpoint to
313                  * relative-jump. Since the relative-jump itself is
314                  * normally used, we just go through if there is no kprobe.
315                  */
316                 __addr = recover_probed_instruction(buf, addr);
317                 if (!__addr)
318                         return 0;
319                 kernel_insn_init(&insn, (void *)__addr, MAX_INSN_SIZE);
320                 insn_get_length(&insn);
321
322                 /*
323                  * Another debugging subsystem might insert this breakpoint.
324                  * In that case, we can't recover it.
325                  */
326                 if (insn.opcode.bytes[0] == BREAKPOINT_INSTRUCTION)
327                         return 0;
328                 addr += insn.length;
329         }
330
331         return (addr == paddr);
332 }
333
334 /*
335  * Returns non-zero if opcode modifies the interrupt flag.
336  */
337 static int is_IF_modifier(kprobe_opcode_t *insn)
338 {
339         /* Skip prefixes */
340         insn = skip_prefixes(insn);
341
342         switch (*insn) {
343         case 0xfa:              /* cli */
344         case 0xfb:              /* sti */
345         case 0xcf:              /* iret/iretd */
346         case 0x9d:              /* popf/popfd */
347                 return 1;
348         }
349
350         return 0;
351 }
352
353 /*
354  * Copy an instruction and adjust the displacement if the instruction
355  * uses the %rip-relative addressing mode.
356  * If it does, Return the address of the 32-bit displacement word.
357  * If not, return null.
358  * Only applicable to 64-bit x86.
359  */
360 int __copy_instruction(u8 *dest, u8 *src)
361 {
362         struct insn insn;
363         kprobe_opcode_t buf[MAX_INSN_SIZE];
364         int length;
365         unsigned long recovered_insn =
366                 recover_probed_instruction(buf, (unsigned long)src);
367
368         if (!recovered_insn)
369                 return 0;
370         kernel_insn_init(&insn, (void *)recovered_insn, MAX_INSN_SIZE);
371         insn_get_length(&insn);
372         length = insn.length;
373
374         /* Another subsystem puts a breakpoint, failed to recover */
375         if (insn.opcode.bytes[0] == BREAKPOINT_INSTRUCTION)
376                 return 0;
377         memcpy(dest, insn.kaddr, length);
378
379         /* We should not singlestep on the exception masking instructions */
380         if (insn_masking_exception(&insn))
381                 return 0;
382
383 #ifdef CONFIG_X86_64
384         if (insn_rip_relative(&insn)) {
385                 s64 newdisp;
386                 u8 *disp;
387                 kernel_insn_init(&insn, dest, length);
388                 insn_get_displacement(&insn);
389                 /*
390                  * The copied instruction uses the %rip-relative addressing
391                  * mode.  Adjust the displacement for the difference between
392                  * the original location of this instruction and the location
393                  * of the copy that will actually be run.  The tricky bit here
394                  * is making sure that the sign extension happens correctly in
395                  * this calculation, since we need a signed 32-bit result to
396                  * be sign-extended to 64 bits when it's added to the %rip
397                  * value and yield the same 64-bit result that the sign-
398                  * extension of the original signed 32-bit displacement would
399                  * have given.
400                  */
401                 newdisp = (u8 *) src + (s64) insn.displacement.value - (u8 *) dest;
402                 if ((s64) (s32) newdisp != newdisp) {
403                         pr_err("Kprobes error: new displacement does not fit into s32 (%llx)\n", newdisp);
404                         return 0;
405                 }
406                 disp = (u8 *) dest + insn_offset_displacement(&insn);
407                 *(s32 *) disp = (s32) newdisp;
408         }
409 #endif
410         return length;
411 }
412
413 /* Recover page to RW mode before releasing it */
414 void free_insn_page(void *page)
415 {
416         set_memory_nx((unsigned long)page & PAGE_MASK, 1);
417         set_memory_rw((unsigned long)page & PAGE_MASK, 1);
418         module_memfree(page);
419 }
420
421 /* Prepare reljump right after instruction to boost */
422 static void prepare_boost(struct kprobe *p, int length)
423 {
424         if (can_boost(p->ainsn.insn, p->addr) &&
425             MAX_INSN_SIZE - length >= RELATIVEJUMP_SIZE) {
426                 /*
427                  * These instructions can be executed directly if it
428                  * jumps back to correct address.
429                  */
430                 synthesize_reljump(p->ainsn.insn + length, p->addr + length);
431                 p->ainsn.boostable = 1;
432         } else {
433                 p->ainsn.boostable = -1;
434         }
435 }
436
437 static int arch_copy_kprobe(struct kprobe *p)
438 {
439         int len;
440
441         set_memory_rw((unsigned long)p->ainsn.insn & PAGE_MASK, 1);
442
443         /* Copy an instruction with recovering if other optprobe modifies it.*/
444         len = __copy_instruction(p->ainsn.insn, p->addr);
445         if (!len)
446                 return -EINVAL;
447
448         /*
449          * __copy_instruction can modify the displacement of the instruction,
450          * but it doesn't affect boostable check.
451          */
452         prepare_boost(p, len);
453
454         set_memory_ro((unsigned long)p->ainsn.insn & PAGE_MASK, 1);
455
456         /* Check whether the instruction modifies Interrupt Flag or not */
457         p->ainsn.if_modifier = is_IF_modifier(p->ainsn.insn);
458
459         /* Also, displacement change doesn't affect the first byte */
460         p->opcode = p->ainsn.insn[0];
461
462         return 0;
463 }
464
465 int arch_prepare_kprobe(struct kprobe *p)
466 {
467         if (alternatives_text_reserved(p->addr, p->addr))
468                 return -EINVAL;
469
470         if (!can_probe((unsigned long)p->addr))
471                 return -EILSEQ;
472         /* insn: must be on special executable page on x86. */
473         p->ainsn.insn = get_insn_slot();
474         if (!p->ainsn.insn)
475                 return -ENOMEM;
476
477         return arch_copy_kprobe(p);
478 }
479
480 void arch_arm_kprobe(struct kprobe *p)
481 {
482         text_poke(p->addr, ((unsigned char []){BREAKPOINT_INSTRUCTION}), 1);
483 }
484
485 void arch_disarm_kprobe(struct kprobe *p)
486 {
487         text_poke(p->addr, &p->opcode, 1);
488 }
489
490 void arch_remove_kprobe(struct kprobe *p)
491 {
492         if (p->ainsn.insn) {
493                 free_insn_slot(p->ainsn.insn, (p->ainsn.boostable == 1));
494                 p->ainsn.insn = NULL;
495         }
496 }
497
498 static nokprobe_inline void
499 save_previous_kprobe(struct kprobe_ctlblk *kcb)
500 {
501         kcb->prev_kprobe.kp = kprobe_running();
502         kcb->prev_kprobe.status = kcb->kprobe_status;
503         kcb->prev_kprobe.old_flags = kcb->kprobe_old_flags;
504         kcb->prev_kprobe.saved_flags = kcb->kprobe_saved_flags;
505 }
506
507 static nokprobe_inline void
508 restore_previous_kprobe(struct kprobe_ctlblk *kcb)
509 {
510         __this_cpu_write(current_kprobe, kcb->prev_kprobe.kp);
511         kcb->kprobe_status = kcb->prev_kprobe.status;
512         kcb->kprobe_old_flags = kcb->prev_kprobe.old_flags;
513         kcb->kprobe_saved_flags = kcb->prev_kprobe.saved_flags;
514 }
515
516 static nokprobe_inline void
517 set_current_kprobe(struct kprobe *p, struct pt_regs *regs,
518                    struct kprobe_ctlblk *kcb)
519 {
520         __this_cpu_write(current_kprobe, p);
521         kcb->kprobe_saved_flags = kcb->kprobe_old_flags
522                 = (regs->flags & (X86_EFLAGS_TF | X86_EFLAGS_IF));
523         if (p->ainsn.if_modifier)
524                 kcb->kprobe_saved_flags &= ~X86_EFLAGS_IF;
525 }
526
527 static nokprobe_inline void clear_btf(void)
528 {
529         if (test_thread_flag(TIF_BLOCKSTEP)) {
530                 unsigned long debugctl = get_debugctlmsr();
531
532                 debugctl &= ~DEBUGCTLMSR_BTF;
533                 update_debugctlmsr(debugctl);
534         }
535 }
536
537 static nokprobe_inline void restore_btf(void)
538 {
539         if (test_thread_flag(TIF_BLOCKSTEP)) {
540                 unsigned long debugctl = get_debugctlmsr();
541
542                 debugctl |= DEBUGCTLMSR_BTF;
543                 update_debugctlmsr(debugctl);
544         }
545 }
546
547 void arch_prepare_kretprobe(struct kretprobe_instance *ri, struct pt_regs *regs)
548 {
549         unsigned long *sara = stack_addr(regs);
550
551         ri->ret_addr = (kprobe_opcode_t *) *sara;
552         ri->fp = sara;
553
554         /* Replace the return addr with trampoline addr */
555         *sara = (unsigned long) &kretprobe_trampoline;
556 }
557 NOKPROBE_SYMBOL(arch_prepare_kretprobe);
558
559 static void setup_singlestep(struct kprobe *p, struct pt_regs *regs,
560                              struct kprobe_ctlblk *kcb, int reenter)
561 {
562         if (setup_detour_execution(p, regs, reenter))
563                 return;
564
565 #if !defined(CONFIG_PREEMPT)
566         if (p->ainsn.boostable == 1 && !p->post_handler) {
567                 /* Boost up -- we can execute copied instructions directly */
568                 if (!reenter)
569                         reset_current_kprobe();
570                 /*
571                  * Reentering boosted probe doesn't reset current_kprobe,
572                  * nor set current_kprobe, because it doesn't use single
573                  * stepping.
574                  */
575                 regs->ip = (unsigned long)p->ainsn.insn;
576                 preempt_enable_no_resched();
577                 return;
578         }
579 #endif
580         if (reenter) {
581                 save_previous_kprobe(kcb);
582                 set_current_kprobe(p, regs, kcb);
583                 kcb->kprobe_status = KPROBE_REENTER;
584         } else
585                 kcb->kprobe_status = KPROBE_HIT_SS;
586         /* Prepare real single stepping */
587         clear_btf();
588         regs->flags |= X86_EFLAGS_TF;
589         regs->flags &= ~X86_EFLAGS_IF;
590         /* single step inline if the instruction is an int3 */
591         if (p->opcode == BREAKPOINT_INSTRUCTION)
592                 regs->ip = (unsigned long)p->addr;
593         else
594                 regs->ip = (unsigned long)p->ainsn.insn;
595 }
596 NOKPROBE_SYMBOL(setup_singlestep);
597
598 /*
599  * We have reentered the kprobe_handler(), since another probe was hit while
600  * within the handler. We save the original kprobes variables and just single
601  * step on the instruction of the new probe without calling any user handlers.
602  */
603 static int reenter_kprobe(struct kprobe *p, struct pt_regs *regs,
604                           struct kprobe_ctlblk *kcb)
605 {
606         switch (kcb->kprobe_status) {
607         case KPROBE_HIT_SSDONE:
608         case KPROBE_HIT_ACTIVE:
609         case KPROBE_HIT_SS:
610                 kprobes_inc_nmissed_count(p);
611                 setup_singlestep(p, regs, kcb, 1);
612                 break;
613         case KPROBE_REENTER:
614                 /* A probe has been hit in the codepath leading up to, or just
615                  * after, single-stepping of a probed instruction. This entire
616                  * codepath should strictly reside in .kprobes.text section.
617                  * Raise a BUG or we'll continue in an endless reentering loop
618                  * and eventually a stack overflow.
619                  */
620                 pr_err("Unrecoverable kprobe detected.\n");
621                 dump_kprobe(p);
622                 BUG();
623         default:
624                 /* impossible cases */
625                 WARN_ON(1);
626                 return 0;
627         }
628
629         return 1;
630 }
631 NOKPROBE_SYMBOL(reenter_kprobe);
632
633 /*
634  * Interrupts are disabled on entry as trap3 is an interrupt gate and they
635  * remain disabled throughout this function.
636  */
637 int kprobe_int3_handler(struct pt_regs *regs)
638 {
639         kprobe_opcode_t *addr;
640         struct kprobe *p;
641         struct kprobe_ctlblk *kcb;
642
643         if (user_mode(regs))
644                 return 0;
645
646         addr = (kprobe_opcode_t *)(regs->ip - sizeof(kprobe_opcode_t));
647         /*
648          * We don't want to be preempted for the entire
649          * duration of kprobe processing. We conditionally
650          * re-enable preemption at the end of this function,
651          * and also in reenter_kprobe() and setup_singlestep().
652          */
653         preempt_disable();
654
655         kcb = get_kprobe_ctlblk();
656         p = get_kprobe(addr);
657
658         if (p) {
659                 if (kprobe_running()) {
660                         if (reenter_kprobe(p, regs, kcb))
661                                 return 1;
662                 } else {
663                         set_current_kprobe(p, regs, kcb);
664                         kcb->kprobe_status = KPROBE_HIT_ACTIVE;
665
666                         /*
667                          * If we have no pre-handler or it returned 0, we
668                          * continue with normal processing.  If we have a
669                          * pre-handler and it returned non-zero, it prepped
670                          * for calling the break_handler below on re-entry
671                          * for jprobe processing, so get out doing nothing
672                          * more here.
673                          */
674                         if (!p->pre_handler || !p->pre_handler(p, regs))
675                                 setup_singlestep(p, regs, kcb, 0);
676                         return 1;
677                 }
678         } else if (*addr != BREAKPOINT_INSTRUCTION) {
679                 /*
680                  * The breakpoint instruction was removed right
681                  * after we hit it.  Another cpu has removed
682                  * either a probepoint or a debugger breakpoint
683                  * at this address.  In either case, no further
684                  * handling of this interrupt is appropriate.
685                  * Back up over the (now missing) int3 and run
686                  * the original instruction.
687                  */
688                 regs->ip = (unsigned long)addr;
689                 preempt_enable_no_resched();
690                 return 1;
691         } else if (kprobe_running()) {
692                 p = __this_cpu_read(current_kprobe);
693                 if (p->break_handler && p->break_handler(p, regs)) {
694                         if (!skip_singlestep(p, regs, kcb))
695                                 setup_singlestep(p, regs, kcb, 0);
696                         return 1;
697                 }
698         } /* else: not a kprobe fault; let the kernel handle it */
699
700         preempt_enable_no_resched();
701         return 0;
702 }
703 NOKPROBE_SYMBOL(kprobe_int3_handler);
704
705 /*
706  * When a retprobed function returns, this code saves registers and
707  * calls trampoline_handler() runs, which calls the kretprobe's handler.
708  */
709 asm(
710         ".global kretprobe_trampoline\n"
711         ".type kretprobe_trampoline, @function\n"
712         "kretprobe_trampoline:\n"
713 #ifdef CONFIG_X86_64
714         /* We don't bother saving the ss register */
715         "       pushq %rsp\n"
716         "       pushfq\n"
717         SAVE_REGS_STRING
718         "       movq %rsp, %rdi\n"
719         "       call trampoline_handler\n"
720         /* Replace saved sp with true return address. */
721         "       movq %rax, 152(%rsp)\n"
722         RESTORE_REGS_STRING
723         "       popfq\n"
724 #else
725         "       pushf\n"
726         SAVE_REGS_STRING
727         "       movl %esp, %eax\n"
728         "       call trampoline_handler\n"
729         /* Move flags to cs */
730         "       movl 56(%esp), %edx\n"
731         "       movl %edx, 52(%esp)\n"
732         /* Replace saved flags with true return address. */
733         "       movl %eax, 56(%esp)\n"
734         RESTORE_REGS_STRING
735         "       popf\n"
736 #endif
737         "       ret\n"
738         ".size kretprobe_trampoline, .-kretprobe_trampoline\n"
739 );
740 NOKPROBE_SYMBOL(kretprobe_trampoline);
741 STACK_FRAME_NON_STANDARD(kretprobe_trampoline);
742
743 /*
744  * Called from kretprobe_trampoline
745  */
746 __visible __used void *trampoline_handler(struct pt_regs *regs)
747 {
748         struct kretprobe_instance *ri = NULL;
749         struct hlist_head *head, empty_rp;
750         struct hlist_node *tmp;
751         unsigned long flags, orig_ret_address = 0;
752         unsigned long trampoline_address = (unsigned long)&kretprobe_trampoline;
753         kprobe_opcode_t *correct_ret_addr = NULL;
754         void *frame_pointer;
755         bool skipped = false;
756
757         /*
758          * Set a dummy kprobe for avoiding kretprobe recursion.
759          * Since kretprobe never run in kprobe handler, kprobe must not
760          * be running at this point.
761          */
762         kprobe_busy_begin();
763
764         INIT_HLIST_HEAD(&empty_rp);
765         kretprobe_hash_lock(current, &head, &flags);
766         /* fixup registers */
767 #ifdef CONFIG_X86_64
768         regs->cs = __KERNEL_CS;
769         /* On x86-64, we use pt_regs->sp for return address holder. */
770         frame_pointer = &regs->sp;
771 #else
772         regs->cs = __KERNEL_CS | get_kernel_rpl();
773         regs->gs = 0;
774         /* On x86-32, we use pt_regs->flags for return address holder. */
775         frame_pointer = &regs->flags;
776 #endif
777         regs->ip = trampoline_address;
778         regs->orig_ax = ~0UL;
779
780         /*
781          * It is possible to have multiple instances associated with a given
782          * task either because multiple functions in the call path have
783          * return probes installed on them, and/or more than one
784          * return probe was registered for a target function.
785          *
786          * We can handle this because:
787          *     - instances are always pushed into the head of the list
788          *     - when multiple return probes are registered for the same
789          *       function, the (chronologically) first instance's ret_addr
790          *       will be the real return address, and all the rest will
791          *       point to kretprobe_trampoline.
792          */
793         hlist_for_each_entry_safe(ri, tmp, head, hlist) {
794                 if (ri->task != current)
795                         /* another task is sharing our hash bucket */
796                         continue;
797                 /*
798                  * Return probes must be pushed on this hash list correct
799                  * order (same as return order) so that it can be poped
800                  * correctly. However, if we find it is pushed it incorrect
801                  * order, this means we find a function which should not be
802                  * probed, because the wrong order entry is pushed on the
803                  * path of processing other kretprobe itself.
804                  */
805                 if (ri->fp != frame_pointer) {
806                         if (!skipped)
807                                 pr_warn("kretprobe is stacked incorrectly. Trying to fixup.\n");
808                         skipped = true;
809                         continue;
810                 }
811
812                 orig_ret_address = (unsigned long)ri->ret_addr;
813                 if (skipped)
814                         pr_warn("%ps must be blacklisted because of incorrect kretprobe order\n",
815                                 ri->rp->kp.addr);
816
817                 if (orig_ret_address != trampoline_address)
818                         /*
819                          * This is the real return address. Any other
820                          * instances associated with this task are for
821                          * other calls deeper on the call stack
822                          */
823                         break;
824         }
825
826         kretprobe_assert(ri, orig_ret_address, trampoline_address);
827
828         correct_ret_addr = ri->ret_addr;
829         hlist_for_each_entry_safe(ri, tmp, head, hlist) {
830                 if (ri->task != current)
831                         /* another task is sharing our hash bucket */
832                         continue;
833                 if (ri->fp != frame_pointer)
834                         continue;
835
836                 orig_ret_address = (unsigned long)ri->ret_addr;
837                 if (ri->rp && ri->rp->handler) {
838                         __this_cpu_write(current_kprobe, &ri->rp->kp);
839                         ri->ret_addr = correct_ret_addr;
840                         ri->rp->handler(ri, regs);
841                         __this_cpu_write(current_kprobe, &kprobe_busy);
842                 }
843
844                 recycle_rp_inst(ri, &empty_rp);
845
846                 if (orig_ret_address != trampoline_address)
847                         /*
848                          * This is the real return address. Any other
849                          * instances associated with this task are for
850                          * other calls deeper on the call stack
851                          */
852                         break;
853         }
854
855         kretprobe_hash_unlock(current, &flags);
856
857         kprobe_busy_end();
858
859         hlist_for_each_entry_safe(ri, tmp, &empty_rp, hlist) {
860                 hlist_del(&ri->hlist);
861                 kfree(ri);
862         }
863         return (void *)orig_ret_address;
864 }
865 NOKPROBE_SYMBOL(trampoline_handler);
866
867 /*
868  * Called after single-stepping.  p->addr is the address of the
869  * instruction whose first byte has been replaced by the "int 3"
870  * instruction.  To avoid the SMP problems that can occur when we
871  * temporarily put back the original opcode to single-step, we
872  * single-stepped a copy of the instruction.  The address of this
873  * copy is p->ainsn.insn.
874  *
875  * This function prepares to return from the post-single-step
876  * interrupt.  We have to fix up the stack as follows:
877  *
878  * 0) Except in the case of absolute or indirect jump or call instructions,
879  * the new ip is relative to the copied instruction.  We need to make
880  * it relative to the original instruction.
881  *
882  * 1) If the single-stepped instruction was pushfl, then the TF and IF
883  * flags are set in the just-pushed flags, and may need to be cleared.
884  *
885  * 2) If the single-stepped instruction was a call, the return address
886  * that is atop the stack is the address following the copied instruction.
887  * We need to make it the address following the original instruction.
888  *
889  * If this is the first time we've single-stepped the instruction at
890  * this probepoint, and the instruction is boostable, boost it: add a
891  * jump instruction after the copied instruction, that jumps to the next
892  * instruction after the probepoint.
893  */
894 static void resume_execution(struct kprobe *p, struct pt_regs *regs,
895                              struct kprobe_ctlblk *kcb)
896 {
897         unsigned long *tos = stack_addr(regs);
898         unsigned long copy_ip = (unsigned long)p->ainsn.insn;
899         unsigned long orig_ip = (unsigned long)p->addr;
900         kprobe_opcode_t *insn = p->ainsn.insn;
901
902         /* Skip prefixes */
903         insn = skip_prefixes(insn);
904
905         regs->flags &= ~X86_EFLAGS_TF;
906         switch (*insn) {
907         case 0x9c:      /* pushfl */
908                 *tos &= ~(X86_EFLAGS_TF | X86_EFLAGS_IF);
909                 *tos |= kcb->kprobe_old_flags;
910                 break;
911         case 0xc2:      /* iret/ret/lret */
912         case 0xc3:
913         case 0xca:
914         case 0xcb:
915         case 0xcf:
916         case 0xea:      /* jmp absolute -- ip is correct */
917                 /* ip is already adjusted, no more changes required */
918                 p->ainsn.boostable = 1;
919                 goto no_change;
920         case 0xe8:      /* call relative - Fix return addr */
921                 *tos = orig_ip + (*tos - copy_ip);
922                 break;
923 #ifdef CONFIG_X86_32
924         case 0x9a:      /* call absolute -- same as call absolute, indirect */
925                 *tos = orig_ip + (*tos - copy_ip);
926                 goto no_change;
927 #endif
928         case 0xff:
929                 if ((insn[1] & 0x30) == 0x10) {
930                         /*
931                          * call absolute, indirect
932                          * Fix return addr; ip is correct.
933                          * But this is not boostable
934                          */
935                         *tos = orig_ip + (*tos - copy_ip);
936                         goto no_change;
937                 } else if (((insn[1] & 0x31) == 0x20) ||
938                            ((insn[1] & 0x31) == 0x21)) {
939                         /*
940                          * jmp near and far, absolute indirect
941                          * ip is correct. And this is boostable
942                          */
943                         p->ainsn.boostable = 1;
944                         goto no_change;
945                 }
946         default:
947                 break;
948         }
949
950         regs->ip += orig_ip - copy_ip;
951
952 no_change:
953         restore_btf();
954 }
955 NOKPROBE_SYMBOL(resume_execution);
956
957 /*
958  * Interrupts are disabled on entry as trap1 is an interrupt gate and they
959  * remain disabled throughout this function.
960  */
961 int kprobe_debug_handler(struct pt_regs *regs)
962 {
963         struct kprobe *cur = kprobe_running();
964         struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
965
966         if (!cur)
967                 return 0;
968
969         resume_execution(cur, regs, kcb);
970         regs->flags |= kcb->kprobe_saved_flags;
971
972         if ((kcb->kprobe_status != KPROBE_REENTER) && cur->post_handler) {
973                 kcb->kprobe_status = KPROBE_HIT_SSDONE;
974                 cur->post_handler(cur, regs, 0);
975         }
976
977         /* Restore back the original saved kprobes variables and continue. */
978         if (kcb->kprobe_status == KPROBE_REENTER) {
979                 restore_previous_kprobe(kcb);
980                 goto out;
981         }
982         reset_current_kprobe();
983 out:
984         preempt_enable_no_resched();
985
986         /*
987          * if somebody else is singlestepping across a probe point, flags
988          * will have TF set, in which case, continue the remaining processing
989          * of do_debug, as if this is not a probe hit.
990          */
991         if (regs->flags & X86_EFLAGS_TF)
992                 return 0;
993
994         return 1;
995 }
996 NOKPROBE_SYMBOL(kprobe_debug_handler);
997
998 int kprobe_fault_handler(struct pt_regs *regs, int trapnr)
999 {
1000         struct kprobe *cur = kprobe_running();
1001         struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
1002
1003         if (unlikely(regs->ip == (unsigned long)cur->ainsn.insn)) {
1004                 /* This must happen on single-stepping */
1005                 WARN_ON(kcb->kprobe_status != KPROBE_HIT_SS &&
1006                         kcb->kprobe_status != KPROBE_REENTER);
1007                 /*
1008                  * We are here because the instruction being single
1009                  * stepped caused a page fault. We reset the current
1010                  * kprobe and the ip points back to the probe address
1011                  * and allow the page fault handler to continue as a
1012                  * normal page fault.
1013                  */
1014                 regs->ip = (unsigned long)cur->addr;
1015                 /*
1016                  * Trap flag (TF) has been set here because this fault
1017                  * happened where the single stepping will be done.
1018                  * So clear it by resetting the current kprobe:
1019                  */
1020                 regs->flags &= ~X86_EFLAGS_TF;
1021                 /*
1022                  * Since the single step (trap) has been cancelled,
1023                  * we need to restore BTF here.
1024                  */
1025                 restore_btf();
1026
1027                 /*
1028                  * If the TF flag was set before the kprobe hit,
1029                  * don't touch it:
1030                  */
1031                 regs->flags |= kcb->kprobe_old_flags;
1032
1033                 if (kcb->kprobe_status == KPROBE_REENTER)
1034                         restore_previous_kprobe(kcb);
1035                 else
1036                         reset_current_kprobe();
1037                 preempt_enable_no_resched();
1038         } else if (kcb->kprobe_status == KPROBE_HIT_ACTIVE ||
1039                    kcb->kprobe_status == KPROBE_HIT_SSDONE) {
1040                 /*
1041                  * We increment the nmissed count for accounting,
1042                  * we can also use npre/npostfault count for accounting
1043                  * these specific fault cases.
1044                  */
1045                 kprobes_inc_nmissed_count(cur);
1046
1047                 /*
1048                  * We come here because instructions in the pre/post
1049                  * handler caused the page_fault, this could happen
1050                  * if handler tries to access user space by
1051                  * copy_from_user(), get_user() etc. Let the
1052                  * user-specified handler try to fix it first.
1053                  */
1054                 if (cur->fault_handler && cur->fault_handler(cur, regs, trapnr))
1055                         return 1;
1056
1057                 /*
1058                  * In case the user-specified fault handler returned
1059                  * zero, try to fix up.
1060                  */
1061                 if (fixup_exception(regs, trapnr))
1062                         return 1;
1063
1064                 /*
1065                  * fixup routine could not handle it,
1066                  * Let do_page_fault() fix it.
1067                  */
1068         }
1069
1070         return 0;
1071 }
1072 NOKPROBE_SYMBOL(kprobe_fault_handler);
1073
1074 /*
1075  * Wrapper routine for handling exceptions.
1076  */
1077 int kprobe_exceptions_notify(struct notifier_block *self, unsigned long val,
1078                              void *data)
1079 {
1080         struct die_args *args = data;
1081         int ret = NOTIFY_DONE;
1082
1083         if (args->regs && user_mode(args->regs))
1084                 return ret;
1085
1086         if (val == DIE_GPF) {
1087                 /*
1088                  * To be potentially processing a kprobe fault and to
1089                  * trust the result from kprobe_running(), we have
1090                  * be non-preemptible.
1091                  */
1092                 if (!preemptible() && kprobe_running() &&
1093                     kprobe_fault_handler(args->regs, args->trapnr))
1094                         ret = NOTIFY_STOP;
1095         }
1096         return ret;
1097 }
1098 NOKPROBE_SYMBOL(kprobe_exceptions_notify);
1099
1100 int setjmp_pre_handler(struct kprobe *p, struct pt_regs *regs)
1101 {
1102         struct jprobe *jp = container_of(p, struct jprobe, kp);
1103         unsigned long addr;
1104         struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
1105
1106         kcb->jprobe_saved_regs = *regs;
1107         kcb->jprobe_saved_sp = stack_addr(regs);
1108         addr = (unsigned long)(kcb->jprobe_saved_sp);
1109
1110         /*
1111          * As Linus pointed out, gcc assumes that the callee
1112          * owns the argument space and could overwrite it, e.g.
1113          * tailcall optimization. So, to be absolutely safe
1114          * we also save and restore enough stack bytes to cover
1115          * the argument area.
1116          * Use __memcpy() to avoid KASAN stack out-of-bounds reports as we copy
1117          * raw stack chunk with redzones:
1118          */
1119         __memcpy(kcb->jprobes_stack, (kprobe_opcode_t *)addr, MIN_STACK_SIZE(addr));
1120         regs->flags &= ~X86_EFLAGS_IF;
1121         trace_hardirqs_off();
1122         regs->ip = (unsigned long)(jp->entry);
1123
1124         /*
1125          * jprobes use jprobe_return() which skips the normal return
1126          * path of the function, and this messes up the accounting of the
1127          * function graph tracer to get messed up.
1128          *
1129          * Pause function graph tracing while performing the jprobe function.
1130          */
1131         pause_graph_tracing();
1132         return 1;
1133 }
1134 NOKPROBE_SYMBOL(setjmp_pre_handler);
1135
1136 void jprobe_return(void)
1137 {
1138         struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
1139
1140         /* Unpoison stack redzones in the frames we are going to jump over. */
1141         kasan_unpoison_stack_above_sp_to(kcb->jprobe_saved_sp);
1142
1143         asm volatile (
1144 #ifdef CONFIG_X86_64
1145                         "       xchg   %%rbx,%%rsp      \n"
1146 #else
1147                         "       xchgl   %%ebx,%%esp     \n"
1148 #endif
1149                         "       int3                    \n"
1150                         "       .globl jprobe_return_end\n"
1151                         "       jprobe_return_end:      \n"
1152                         "       nop                     \n"::"b"
1153                         (kcb->jprobe_saved_sp):"memory");
1154 }
1155 NOKPROBE_SYMBOL(jprobe_return);
1156 NOKPROBE_SYMBOL(jprobe_return_end);
1157
1158 int longjmp_break_handler(struct kprobe *p, struct pt_regs *regs)
1159 {
1160         struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
1161         u8 *addr = (u8 *) (regs->ip - 1);
1162         struct jprobe *jp = container_of(p, struct jprobe, kp);
1163         void *saved_sp = kcb->jprobe_saved_sp;
1164
1165         if ((addr > (u8 *) jprobe_return) &&
1166             (addr < (u8 *) jprobe_return_end)) {
1167                 if (stack_addr(regs) != saved_sp) {
1168                         struct pt_regs *saved_regs = &kcb->jprobe_saved_regs;
1169                         printk(KERN_ERR
1170                                "current sp %p does not match saved sp %p\n",
1171                                stack_addr(regs), saved_sp);
1172                         printk(KERN_ERR "Saved registers for jprobe %p\n", jp);
1173                         show_regs(saved_regs);
1174                         printk(KERN_ERR "Current registers\n");
1175                         show_regs(regs);
1176                         BUG();
1177                 }
1178                 /* It's OK to start function graph tracing again */
1179                 unpause_graph_tracing();
1180                 *regs = kcb->jprobe_saved_regs;
1181                 __memcpy(saved_sp, kcb->jprobes_stack, MIN_STACK_SIZE(saved_sp));
1182                 preempt_enable_no_resched();
1183                 return 1;
1184         }
1185         return 0;
1186 }
1187 NOKPROBE_SYMBOL(longjmp_break_handler);
1188
1189 bool arch_within_kprobe_blacklist(unsigned long addr)
1190 {
1191         return  (addr >= (unsigned long)__kprobes_text_start &&
1192                  addr < (unsigned long)__kprobes_text_end) ||
1193                 (addr >= (unsigned long)__entry_text_start &&
1194                  addr < (unsigned long)__entry_text_end);
1195 }
1196
1197 int __init arch_init_kprobes(void)
1198 {
1199         return 0;
1200 }
1201
1202 int arch_trampoline_kprobe(struct kprobe *p)
1203 {
1204         return 0;
1205 }