arch/x86/kernel/kprobes/core.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2 /*
   3  *  Kernel Probes (KProbes)
   4  *
   5  * Copyright (C) IBM Corporation, 2002, 2004
   6  *
   7  * 2002-Oct     Created by Vamsi Krishna S <vamsi_krishna@in.ibm.com> Kernel
   8  *              Probes initial implementation ( includes contributions from
   9  *              Rusty Russell).
  10  * 2004-July    Suparna Bhattacharya <suparna@in.ibm.com> added jumper probes
  11  *              interface to access function arguments.
  12  * 2004-Oct     Jim Keniston <jkenisto@us.ibm.com> and Prasanna S Panchamukhi
  13  *              <prasanna@in.ibm.com> adapted for x86_64 from i386.
  14  * 2005-Mar     Roland McGrath <roland@redhat.com>
  15  *              Fixed to handle %rip-relative addressing mode correctly.
  16  * 2005-May     Hien Nguyen <hien@us.ibm.com>, Jim Keniston
  17  *              <jkenisto@us.ibm.com> and Prasanna S Panchamukhi
  18  *              <prasanna@in.ibm.com> added function-return probes.
  19  * 2005-May     Rusty Lynch <rusty.lynch@intel.com>
  20  *              Added function return probes functionality
  21  * 2006-Feb     Masami Hiramatsu <hiramatu@sdl.hitachi.co.jp> added
  22  *              kprobe-booster and kretprobe-booster for i386.
  23  * 2007-Dec     Masami Hiramatsu <mhiramat@redhat.com> added kprobe-booster
  24  *              and kretprobe-booster for x86-64
  25  * 2007-Dec     Masami Hiramatsu <mhiramat@redhat.com>, Arjan van de Ven
  26  *              <arjan@infradead.org> and Jim Keniston <jkenisto@us.ibm.com>
  27  *              unified x86 kprobes code.
  28  */
  29 #include <linux/kprobes.h>
  30 #include <linux/ptrace.h>
  31 #include <linux/string.h>
  32 #include <linux/slab.h>
  33 #include <linux/hardirq.h>
  34 #include <linux/preempt.h>
  35 #include <linux/sched/debug.h>
  36 #include <linux/perf_event.h>
  37 #include <linux/extable.h>
  38 #include <linux/kdebug.h>
  39 #include <linux/kallsyms.h>
  40 #include <linux/kgdb.h>
  41 #include <linux/ftrace.h>
  42 #include <linux/kasan.h>
  43 #include <linux/moduleloader.h>
  44 #include <linux/objtool.h>
  45 #include <linux/vmalloc.h>
  46 #include <linux/pgtable.h>
  47
  48 #include <asm/text-patching.h>
  49 #include <asm/cacheflush.h>
  50 #include <asm/desc.h>
  51 #include <linux/uaccess.h>
  52 #include <asm/alternative.h>
  53 #include <asm/insn.h>
  54 #include <asm/debugreg.h>
  55 #include <asm/set_memory.h>
  56
  57 #include "common.h"
  58
  59 DEFINE_PER_CPU(struct kprobe *, current_kprobe) = NULL;
  60 DEFINE_PER_CPU(struct kprobe_ctlblk, kprobe_ctlblk);
  61
  62 #define stack_addr(regs) ((unsigned long *)regs->sp)
  63
  64 #define W(row, b0, b1, b2, b3, b4, b5, b6, b7, b8, b9, ba, bb, bc, bd, be, bf)\
  65         (((b0##UL << 0x0)|(b1##UL << 0x1)|(b2##UL << 0x2)|(b3##UL << 0x3) |   \
  66           (b4##UL << 0x4)|(b5##UL << 0x5)|(b6##UL << 0x6)|(b7##UL << 0x7) |   \
  67           (b8##UL << 0x8)|(b9##UL << 0x9)|(ba##UL << 0xa)|(bb##UL << 0xb) |   \
  68           (bc##UL << 0xc)|(bd##UL << 0xd)|(be##UL << 0xe)|(bf##UL << 0xf))    \
  69          << (row % 32))
  70         /*
  71          * Undefined/reserved opcodes, conditional jump, Opcode Extension
  72          * Groups, and some special opcodes can not boost.
  73          * This is non-const and volatile to keep gcc from statically
  74          * optimizing it out, as variable_test_bit makes gcc think only
  75          * *(unsigned long*) is used.
  76          */
  77 static volatile u32 twobyte_is_boostable[256 / 32] = {
  78         /*      0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f          */
  79         /*      ----------------------------------------------          */
  80         W(0x00, 0, 0, 1, 1, 0, 0, 1, 0, 1, 1, 0, 0, 0, 0, 0, 0) | /* 00 */
  81         W(0x10, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1) , /* 10 */
  82         W(0x20, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) | /* 20 */
  83         W(0x30, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) , /* 30 */
  84         W(0x40, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) | /* 40 */
  85         W(0x50, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) , /* 50 */
  86         W(0x60, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 1, 1) | /* 60 */
  87         W(0x70, 0, 0, 0, 0, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 1, 1) , /* 70 */
  88         W(0x80, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) | /* 80 */
  89         W(0x90, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) , /* 90 */
  90         W(0xa0, 1, 1, 0, 1, 1, 1, 0, 0, 1, 1, 0, 1, 1, 1, 0, 1) | /* a0 */
  91         W(0xb0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 1, 1, 1, 1, 1) , /* b0 */
  92         W(0xc0, 1, 1, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1) | /* c0 */
  93         W(0xd0, 0, 1, 1, 1, 0, 1, 0, 0, 1, 1, 0, 1, 1, 1, 0, 1) , /* d0 */
  94         W(0xe0, 0, 1, 1, 0, 0, 1, 0, 0, 1, 1, 0, 1, 1, 1, 0, 1) | /* e0 */
  95         W(0xf0, 0, 1, 1, 1, 0, 1, 0, 0, 1, 1, 1, 0, 1, 1, 1, 0)   /* f0 */
  96         /*      -----------------------------------------------         */
  97         /*      0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f          */
  98 };
  99 #undef W
 100
 101 struct kretprobe_blackpoint kretprobe_blacklist[] = {
 102         {"__switch_to", }, /* This function switches only current task, but
 103                               doesn't switch kernel stack.*/
 104         {NULL, NULL}    /* Terminator */
 105 };
 106
 107 const int kretprobe_blacklist_size = ARRAY_SIZE(kretprobe_blacklist);
 108
 109 static nokprobe_inline void
 110 __synthesize_relative_insn(void *dest, void *from, void *to, u8 op)
 111 {
 112         struct __arch_relative_insn {
 113                 u8 op;
 114                 s32 raddr;
 115         } __packed *insn;
 116
 117         insn = (struct __arch_relative_insn *)dest;
 118         insn->raddr = (s32)((long)(to) - ((long)(from) + 5));
 119         insn->op = op;
 120 }
 121
 122 /* Insert a jump instruction at address 'from', which jumps to address 'to'.*/
 123 void synthesize_reljump(void *dest, void *from, void *to)
 124 {
 125         __synthesize_relative_insn(dest, from, to, JMP32_INSN_OPCODE);
 126 }
 127 NOKPROBE_SYMBOL(synthesize_reljump);
 128
 129 /* Insert a call instruction at address 'from', which calls address 'to'.*/
 130 void synthesize_relcall(void *dest, void *from, void *to)
 131 {
 132         __synthesize_relative_insn(dest, from, to, CALL_INSN_OPCODE);
 133 }
 134 NOKPROBE_SYMBOL(synthesize_relcall);
 135
 136 /*
 137  * Returns non-zero if INSN is boostable.
 138  * RIP relative instructions are adjusted at copying time in 64 bits mode
 139  */
 140 int can_boost(struct insn *insn, void *addr)
 141 {
 142         kprobe_opcode_t opcode;
 143         insn_byte_t prefix;
 144         int i;
 145
 146         if (search_exception_tables((unsigned long)addr))
 147                 return 0;       /* Page fault may occur on this address. */
 148
 149         /* 2nd-byte opcode */
 150         if (insn->opcode.nbytes == 2)
 151                 return test_bit(insn->opcode.bytes[1],
 152                                 (unsigned long *)twobyte_is_boostable);
 153
 154         if (insn->opcode.nbytes != 1)
 155                 return 0;
 156
 157         for_each_insn_prefix(insn, i, prefix) {
 158                 insn_attr_t attr;
 159
 160                 attr = inat_get_opcode_attribute(prefix);
 161                 /* Can't boost Address-size override prefix and CS override prefix */
 162                 if (prefix == 0x2e || inat_is_address_size_prefix(attr))
 163                         return 0;
 164         }
 165
 166         opcode = insn->opcode.bytes[0];
 167
 168         switch (opcode) {
 169         case 0x62:              /* bound */
 170         case 0x70 ... 0x7f:     /* Conditional jumps */
 171         case 0x9a:              /* Call far */
 172         case 0xc0 ... 0xc1:     /* Grp2 */
 173         case 0xcc ... 0xce:     /* software exceptions */
 174         case 0xd0 ... 0xd3:     /* Grp2 */
 175         case 0xd6:              /* (UD) */
 176         case 0xd8 ... 0xdf:     /* ESC */
 177         case 0xe0 ... 0xe3:     /* LOOP*, JCXZ */
 178         case 0xe8 ... 0xe9:     /* near Call, JMP */
 179         case 0xeb:              /* Short JMP */
 180         case 0xf0 ... 0xf4:     /* LOCK/REP, HLT */
 181         case 0xf6 ... 0xf7:     /* Grp3 */
 182         case 0xfe:              /* Grp4 */
 183                 /* ... are not boostable */
 184                 return 0;
 185         case 0xff:              /* Grp5 */
 186                 /* Only indirect jmp is boostable */
 187                 return X86_MODRM_REG(insn->modrm.bytes[0]) == 4;
 188         default:
 189                 return 1;
 190         }
 191 }
 192
 193 static unsigned long
 194 __recover_probed_insn(kprobe_opcode_t *buf, unsigned long addr)
 195 {
 196         struct kprobe *kp;
 197         unsigned long faddr;
 198
 199         kp = get_kprobe((void *)addr);
 200         faddr = ftrace_location(addr);
 201         /*
 202          * Addresses inside the ftrace location are refused by
 203          * arch_check_ftrace_location(). Something went terribly wrong
 204          * if such an address is checked here.
 205          */
 206         if (WARN_ON(faddr && faddr != addr))
 207                 return 0UL;
 208         /*
 209          * Use the current code if it is not modified by Kprobe
 210          * and it cannot be modified by ftrace.
 211          */
 212         if (!kp && !faddr)
 213                 return addr;
 214
 215         /*
 216          * Basically, kp->ainsn.insn has an original instruction.
 217          * However, RIP-relative instruction can not do single-stepping
 218          * at different place, __copy_instruction() tweaks the displacement of
 219          * that instruction. In that case, we can't recover the instruction
 220          * from the kp->ainsn.insn.
 221          *
 222          * On the other hand, in case on normal Kprobe, kp->opcode has a copy
 223          * of the first byte of the probed instruction, which is overwritten
 224          * by int3. And the instruction at kp->addr is not modified by kprobes
 225          * except for the first byte, we can recover the original instruction
 226          * from it and kp->opcode.
 227          *
 228          * In case of Kprobes using ftrace, we do not have a copy of
 229          * the original instruction. In fact, the ftrace location might
 230          * be modified at anytime and even could be in an inconsistent state.
 231          * Fortunately, we know that the original code is the ideal 5-byte
 232          * long NOP.
 233          */
 234         if (copy_from_kernel_nofault(buf, (void *)addr,
 235                 MAX_INSN_SIZE * sizeof(kprobe_opcode_t)))
 236                 return 0UL;
 237
 238         if (faddr)
 239                 memcpy(buf, x86_nops[5], 5);
 240         else
 241                 buf[0] = kp->opcode;
 242         return (unsigned long)buf;
 243 }
 244
 245 /*
 246  * Recover the probed instruction at addr for further analysis.
 247  * Caller must lock kprobes by kprobe_mutex, or disable preemption
 248  * for preventing to release referencing kprobes.
 249  * Returns zero if the instruction can not get recovered (or access failed).
 250  */
 251 unsigned long recover_probed_instruction(kprobe_opcode_t *buf, unsigned long addr)
 252 {
 253         unsigned long __addr;
 254
 255         __addr = __recover_optprobed_insn(buf, addr);
 256         if (__addr != addr)
 257                 return __addr;
 258
 259         return __recover_probed_insn(buf, addr);
 260 }
 261
 262 /* Check if paddr is at an instruction boundary */
 263 static int can_probe(unsigned long paddr)
 264 {
 265         unsigned long addr, __addr, offset = 0;
 266         struct insn insn;
 267         kprobe_opcode_t buf[MAX_INSN_SIZE];
 268
 269         if (!kallsyms_lookup_size_offset(paddr, NULL, &offset))
 270                 return 0;
 271
 272         /* Decode instructions */
 273         addr = paddr - offset;
 274         while (addr < paddr) {
 275                 int ret;
 276
 277                 /*
 278                  * Check if the instruction has been modified by another
 279                  * kprobe, in which case we replace the breakpoint by the
 280                  * original instruction in our buffer.
 281                  * Also, jump optimization will change the breakpoint to
 282                  * relative-jump. Since the relative-jump itself is
 283                  * normally used, we just go through if there is no kprobe.
 284                  */
 285                 __addr = recover_probed_instruction(buf, addr);
 286                 if (!__addr)
 287                         return 0;
 288
 289                 ret = insn_decode_kernel(&insn, (void *)__addr);
 290                 if (ret < 0)
 291                         return 0;
 292
 293 #ifdef CONFIG_KGDB
 294                 /*
 295                  * If there is a dynamically installed kgdb sw breakpoint,
 296                  * this function should not be probed.
 297                  */
 298                 if (insn.opcode.bytes[0] == INT3_INSN_OPCODE &&
 299                     kgdb_has_hit_break(addr))
 300                         return 0;
 301 #endif
 302                 addr += insn.length;
 303         }
 304
 305         return (addr == paddr);
 306 }
 307
 308 /*
 309  * Copy an instruction with recovering modified instruction by kprobes
 310  * and adjust the displacement if the instruction uses the %rip-relative
 311  * addressing mode. Note that since @real will be the final place of copied
 312  * instruction, displacement must be adjust by @real, not @dest.
 313  * This returns the length of copied instruction, or 0 if it has an error.
 314  */
 315 int __copy_instruction(u8 *dest, u8 *src, u8 *real, struct insn *insn)
 316 {
 317         kprobe_opcode_t buf[MAX_INSN_SIZE];
 318         unsigned long recovered_insn = recover_probed_instruction(buf, (unsigned long)src);
 319         int ret;
 320
 321         if (!recovered_insn || !insn)
 322                 return 0;
 323
 324         /* This can access kernel text if given address is not recovered */
 325         if (copy_from_kernel_nofault(dest, (void *)recovered_insn,
 326                         MAX_INSN_SIZE))
 327                 return 0;
 328
 329         ret = insn_decode_kernel(insn, dest);
 330         if (ret < 0)
 331                 return 0;
 332
 333         /* We can not probe force emulate prefixed instruction */
 334         if (insn_has_emulate_prefix(insn))
 335                 return 0;
 336
 337         /* Another subsystem puts a breakpoint, failed to recover */
 338         if (insn->opcode.bytes[0] == INT3_INSN_OPCODE)
 339                 return 0;
 340
 341         /* We should not singlestep on the exception masking instructions */
 342         if (insn_masking_exception(insn))
 343                 return 0;
 344
 345 #ifdef CONFIG_X86_64
 346         /* Only x86_64 has RIP relative instructions */
 347         if (insn_rip_relative(insn)) {
 348                 s64 newdisp;
 349                 u8 *disp;
 350                 /*
 351                  * The copied instruction uses the %rip-relative addressing
 352                  * mode.  Adjust the displacement for the difference between
 353                  * the original location of this instruction and the location
 354                  * of the copy that will actually be run.  The tricky bit here
 355                  * is making sure that the sign extension happens correctly in
 356                  * this calculation, since we need a signed 32-bit result to
 357                  * be sign-extended to 64 bits when it's added to the %rip
 358                  * value and yield the same 64-bit result that the sign-
 359                  * extension of the original signed 32-bit displacement would
 360                  * have given.
 361                  */
 362                 newdisp = (u8 *) src + (s64) insn->displacement.value
 363                           - (u8 *) real;
 364                 if ((s64) (s32) newdisp != newdisp) {
 365                         pr_err("Kprobes error: new displacement does not fit into s32 (%llx)\n", newdisp);
 366                         return 0;
 367                 }
 368                 disp = (u8 *) dest + insn_offset_displacement(insn);
 369                 *(s32 *) disp = (s32) newdisp;
 370         }
 371 #endif
 372         return insn->length;
 373 }
 374
 375 /* Prepare reljump or int3 right after instruction */
 376 static int prepare_singlestep(kprobe_opcode_t *buf, struct kprobe *p,
 377                               struct insn *insn)
 378 {
 379         int len = insn->length;
 380
 381         if (!IS_ENABLED(CONFIG_PREEMPTION) &&
 382             !p->post_handler && can_boost(insn, p->addr) &&
 383             MAX_INSN_SIZE - len >= JMP32_INSN_SIZE) {
 384                 /*
 385                  * These instructions can be executed directly if it
 386                  * jumps back to correct address.
 387                  */
 388                 synthesize_reljump(buf + len, p->ainsn.insn + len,
 389                                    p->addr + insn->length);
 390                 len += JMP32_INSN_SIZE;
 391                 p->ainsn.boostable = 1;
 392         } else {
 393                 /* Otherwise, put an int3 for trapping singlestep */
 394                 if (MAX_INSN_SIZE - len < INT3_INSN_SIZE)
 395                         return -ENOSPC;
 396
 397                 buf[len] = INT3_INSN_OPCODE;
 398                 len += INT3_INSN_SIZE;
 399         }
 400
 401         return len;
 402 }
 403
 404 /* Make page to RO mode when allocate it */
 405 void *alloc_insn_page(void)
 406 {
 407         void *page;
 408
 409         page = module_alloc(PAGE_SIZE);
 410         if (!page)
 411                 return NULL;
 412
 413         set_vm_flush_reset_perms(page);
 414         /*
 415          * First make the page read-only, and only then make it executable to
 416          * prevent it from being W+X in between.
 417          */
 418         set_memory_ro((unsigned long)page, 1);
 419
 420         /*
 421          * TODO: Once additional kernel code protection mechanisms are set, ensure
 422          * that the page was not maliciously altered and it is still zeroed.
 423          */
 424         set_memory_x((unsigned long)page, 1);
 425
 426         return page;
 427 }
 428
 429 /* Kprobe x86 instruction emulation - only regs->ip or IF flag modifiers */
 430
 431 static void kprobe_emulate_ifmodifiers(struct kprobe *p, struct pt_regs *regs)
 432 {
 433         switch (p->ainsn.opcode) {
 434         case 0xfa:      /* cli */
 435                 regs->flags &= ~(X86_EFLAGS_IF);
 436                 break;
 437         case 0xfb:      /* sti */
 438                 regs->flags |= X86_EFLAGS_IF;
 439                 break;
 440         case 0x9c:      /* pushf */
 441                 int3_emulate_push(regs, regs->flags);
 442                 break;
 443         case 0x9d:      /* popf */
 444                 regs->flags = int3_emulate_pop(regs);
 445                 break;
 446         }
 447         regs->ip = regs->ip - INT3_INSN_SIZE + p->ainsn.size;
 448 }
 449 NOKPROBE_SYMBOL(kprobe_emulate_ifmodifiers);
 450
 451 static void kprobe_emulate_ret(struct kprobe *p, struct pt_regs *regs)
 452 {
 453         int3_emulate_ret(regs);
 454 }
 455 NOKPROBE_SYMBOL(kprobe_emulate_ret);
 456
 457 static void kprobe_emulate_call(struct kprobe *p, struct pt_regs *regs)
 458 {
 459         unsigned long func = regs->ip - INT3_INSN_SIZE + p->ainsn.size;
 460
 461         func += p->ainsn.rel32;
 462         int3_emulate_call(regs, func);
 463 }
 464 NOKPROBE_SYMBOL(kprobe_emulate_call);
 465
 466 static nokprobe_inline
 467 void __kprobe_emulate_jmp(struct kprobe *p, struct pt_regs *regs, bool cond)
 468 {
 469         unsigned long ip = regs->ip - INT3_INSN_SIZE + p->ainsn.size;
 470
 471         if (cond)
 472                 ip += p->ainsn.rel32;
 473         int3_emulate_jmp(regs, ip);
 474 }
 475
 476 static void kprobe_emulate_jmp(struct kprobe *p, struct pt_regs *regs)
 477 {
 478         __kprobe_emulate_jmp(p, regs, true);
 479 }
 480 NOKPROBE_SYMBOL(kprobe_emulate_jmp);
 481
 482 static const unsigned long jcc_mask[6] = {
 483         [0] = X86_EFLAGS_OF,
 484         [1] = X86_EFLAGS_CF,
 485         [2] = X86_EFLAGS_ZF,
 486         [3] = X86_EFLAGS_CF | X86_EFLAGS_ZF,
 487         [4] = X86_EFLAGS_SF,
 488         [5] = X86_EFLAGS_PF,
 489 };
 490
 491 static void kprobe_emulate_jcc(struct kprobe *p, struct pt_regs *regs)
 492 {
 493         bool invert = p->ainsn.jcc.type & 1;
 494         bool match;
 495
 496         if (p->ainsn.jcc.type < 0xc) {
 497                 match = regs->flags & jcc_mask[p->ainsn.jcc.type >> 1];
 498         } else {
 499                 match = ((regs->flags & X86_EFLAGS_SF) >> X86_EFLAGS_SF_BIT) ^
 500                         ((regs->flags & X86_EFLAGS_OF) >> X86_EFLAGS_OF_BIT);
 501                 if (p->ainsn.jcc.type >= 0xe)
 502                         match = match || (regs->flags & X86_EFLAGS_ZF);
 503         }
 504         __kprobe_emulate_jmp(p, regs, (match && !invert) || (!match && invert));
 505 }
 506 NOKPROBE_SYMBOL(kprobe_emulate_jcc);
 507
 508 static void kprobe_emulate_loop(struct kprobe *p, struct pt_regs *regs)
 509 {
 510         bool match;
 511
 512         if (p->ainsn.loop.type != 3) {  /* LOOP* */
 513                 if (p->ainsn.loop.asize == 32)
 514                         match = ((*(u32 *)&regs->cx)--) != 0;
 515 #ifdef CONFIG_X86_64
 516                 else if (p->ainsn.loop.asize == 64)
 517                         match = ((*(u64 *)&regs->cx)--) != 0;
 518 #endif
 519                 else
 520                         match = ((*(u16 *)&regs->cx)--) != 0;
 521         } else {                        /* JCXZ */
 522                 if (p->ainsn.loop.asize == 32)
 523                         match = *(u32 *)(&regs->cx) == 0;
 524 #ifdef CONFIG_X86_64
 525                 else if (p->ainsn.loop.asize == 64)
 526                         match = *(u64 *)(&regs->cx) == 0;
 527 #endif
 528                 else
 529                         match = *(u16 *)(&regs->cx) == 0;
 530         }
 531
 532         if (p->ainsn.loop.type == 0)    /* LOOPNE */
 533                 match = match && !(regs->flags & X86_EFLAGS_ZF);
 534         else if (p->ainsn.loop.type == 1)       /* LOOPE */
 535                 match = match && (regs->flags & X86_EFLAGS_ZF);
 536
 537         __kprobe_emulate_jmp(p, regs, match);
 538 }
 539 NOKPROBE_SYMBOL(kprobe_emulate_loop);
 540
 541 static const int addrmode_regoffs[] = {
 542         offsetof(struct pt_regs, ax),
 543         offsetof(struct pt_regs, cx),
 544         offsetof(struct pt_regs, dx),
 545         offsetof(struct pt_regs, bx),
 546         offsetof(struct pt_regs, sp),
 547         offsetof(struct pt_regs, bp),
 548         offsetof(struct pt_regs, si),
 549         offsetof(struct pt_regs, di),
 550 #ifdef CONFIG_X86_64
 551         offsetof(struct pt_regs, r8),
 552         offsetof(struct pt_regs, r9),
 553         offsetof(struct pt_regs, r10),
 554         offsetof(struct pt_regs, r11),
 555         offsetof(struct pt_regs, r12),
 556         offsetof(struct pt_regs, r13),
 557         offsetof(struct pt_regs, r14),
 558         offsetof(struct pt_regs, r15),
 559 #endif
 560 };
 561
 562 static void kprobe_emulate_call_indirect(struct kprobe *p, struct pt_regs *regs)
 563 {
 564         unsigned long offs = addrmode_regoffs[p->ainsn.indirect.reg];
 565
 566         int3_emulate_call(regs, regs_get_register(regs, offs));
 567 }
 568 NOKPROBE_SYMBOL(kprobe_emulate_call_indirect);
 569
 570 static void kprobe_emulate_jmp_indirect(struct kprobe *p, struct pt_regs *regs)
 571 {
 572         unsigned long offs = addrmode_regoffs[p->ainsn.indirect.reg];
 573
 574         int3_emulate_jmp(regs, regs_get_register(regs, offs));
 575 }
 576 NOKPROBE_SYMBOL(kprobe_emulate_jmp_indirect);
 577
 578 static int prepare_emulation(struct kprobe *p, struct insn *insn)
 579 {
 580         insn_byte_t opcode = insn->opcode.bytes[0];
 581
 582         switch (opcode) {
 583         case 0xfa:              /* cli */
 584         case 0xfb:              /* sti */
 585         case 0x9c:              /* pushfl */
 586         case 0x9d:              /* popf/popfd */
 587                 /*
 588                  * IF modifiers must be emulated since it will enable interrupt while
 589                  * int3 single stepping.
 590                  */
 591                 p->ainsn.emulate_op = kprobe_emulate_ifmodifiers;
 592                 p->ainsn.opcode = opcode;
 593                 break;
 594         case 0xc2:      /* ret/lret */
 595         case 0xc3:
 596         case 0xca:
 597         case 0xcb:
 598                 p->ainsn.emulate_op = kprobe_emulate_ret;
 599                 break;
 600         case 0x9a:      /* far call absolute -- segment is not supported */
 601         case 0xea:      /* far jmp absolute -- segment is not supported */
 602         case 0xcc:      /* int3 */
 603         case 0xcf:      /* iret -- in-kernel IRET is not supported */
 604                 return -EOPNOTSUPP;
 605                 break;
 606         case 0xe8:      /* near call relative */
 607                 p->ainsn.emulate_op = kprobe_emulate_call;
 608                 if (insn->immediate.nbytes == 2)
 609                         p->ainsn.rel32 = *(s16 *)&insn->immediate.value;
 610                 else
 611                         p->ainsn.rel32 = *(s32 *)&insn->immediate.value;
 612                 break;
 613         case 0xeb:      /* short jump relative */
 614         case 0xe9:      /* near jump relative */
 615                 p->ainsn.emulate_op = kprobe_emulate_jmp;
 616                 if (insn->immediate.nbytes == 1)
 617                         p->ainsn.rel32 = *(s8 *)&insn->immediate.value;
 618                 else if (insn->immediate.nbytes == 2)
 619                         p->ainsn.rel32 = *(s16 *)&insn->immediate.value;
 620                 else
 621                         p->ainsn.rel32 = *(s32 *)&insn->immediate.value;
 622                 break;
 623         case 0x70 ... 0x7f:
 624                 /* 1 byte conditional jump */
 625                 p->ainsn.emulate_op = kprobe_emulate_jcc;
 626                 p->ainsn.jcc.type = opcode & 0xf;
 627                 p->ainsn.rel32 = *(char *)insn->immediate.bytes;
 628                 break;
 629         case 0x0f:
 630                 opcode = insn->opcode.bytes[1];
 631                 if ((opcode & 0xf0) == 0x80) {
 632                         /* 2 bytes Conditional Jump */
 633                         p->ainsn.emulate_op = kprobe_emulate_jcc;
 634                         p->ainsn.jcc.type = opcode & 0xf;
 635                         if (insn->immediate.nbytes == 2)
 636                                 p->ainsn.rel32 = *(s16 *)&insn->immediate.value;
 637                         else
 638                                 p->ainsn.rel32 = *(s32 *)&insn->immediate.value;
 639                 } else if (opcode == 0x01 &&
 640                            X86_MODRM_REG(insn->modrm.bytes[0]) == 0 &&
 641                            X86_MODRM_MOD(insn->modrm.bytes[0]) == 3) {
 642                         /* VM extensions - not supported */
 643                         return -EOPNOTSUPP;
 644                 }
 645                 break;
 646         case 0xe0:      /* Loop NZ */
 647         case 0xe1:      /* Loop */
 648         case 0xe2:      /* Loop */
 649         case 0xe3:      /* J*CXZ */
 650                 p->ainsn.emulate_op = kprobe_emulate_loop;
 651                 p->ainsn.loop.type = opcode & 0x3;
 652                 p->ainsn.loop.asize = insn->addr_bytes * 8;
 653                 p->ainsn.rel32 = *(s8 *)&insn->immediate.value;
 654                 break;
 655         case 0xff:
 656                 /*
 657                  * Since the 0xff is an extended group opcode, the instruction
 658                  * is determined by the MOD/RM byte.
 659                  */
 660                 opcode = insn->modrm.bytes[0];
 661                 if ((opcode & 0x30) == 0x10) {
 662                         if ((opcode & 0x8) == 0x8)
 663                                 return -EOPNOTSUPP;     /* far call */
 664                         /* call absolute, indirect */
 665                         p->ainsn.emulate_op = kprobe_emulate_call_indirect;
 666                 } else if ((opcode & 0x30) == 0x20) {
 667                         if ((opcode & 0x8) == 0x8)
 668                                 return -EOPNOTSUPP;     /* far jmp */
 669                         /* jmp near absolute indirect */
 670                         p->ainsn.emulate_op = kprobe_emulate_jmp_indirect;
 671                 } else
 672                         break;
 673
 674                 if (insn->addr_bytes != sizeof(unsigned long))
 675                         return -EOPNOTSUPP;     /* Don't support different size */
 676                 if (X86_MODRM_MOD(opcode) != 3)
 677                         return -EOPNOTSUPP;     /* TODO: support memory addressing */
 678
 679                 p->ainsn.indirect.reg = X86_MODRM_RM(opcode);
 680 #ifdef CONFIG_X86_64
 681                 if (X86_REX_B(insn->rex_prefix.value))
 682                         p->ainsn.indirect.reg += 8;
 683 #endif
 684                 break;
 685         default:
 686                 break;
 687         }
 688         p->ainsn.size = insn->length;
 689
 690         return 0;
 691 }
 692
 693 static int arch_copy_kprobe(struct kprobe *p)
 694 {
 695         struct insn insn;
 696         kprobe_opcode_t buf[MAX_INSN_SIZE];
 697         int ret, len;
 698
 699         /* Copy an instruction with recovering if other optprobe modifies it.*/
 700         len = __copy_instruction(buf, p->addr, p->ainsn.insn, &insn);
 701         if (!len)
 702                 return -EINVAL;
 703
 704         /* Analyze the opcode and setup emulate functions */
 705         ret = prepare_emulation(p, &insn);
 706         if (ret < 0)
 707                 return ret;
 708
 709         /* Add int3 for single-step or booster jmp */
 710         len = prepare_singlestep(buf, p, &insn);
 711         if (len < 0)
 712                 return len;
 713
 714         /* Also, displacement change doesn't affect the first byte */
 715         p->opcode = buf[0];
 716
 717         p->ainsn.tp_len = len;
 718         perf_event_text_poke(p->ainsn.insn, NULL, 0, buf, len);
 719
 720         /* OK, write back the instruction(s) into ROX insn buffer */
 721         text_poke(p->ainsn.insn, buf, len);
 722
 723         return 0;
 724 }
 725
 726 int arch_prepare_kprobe(struct kprobe *p)
 727 {
 728         int ret;
 729
 730         if (alternatives_text_reserved(p->addr, p->addr))
 731                 return -EINVAL;
 732
 733         if (!can_probe((unsigned long)p->addr))
 734                 return -EILSEQ;
 735
 736         memset(&p->ainsn, 0, sizeof(p->ainsn));
 737
 738         /* insn: must be on special executable page on x86. */
 739         p->ainsn.insn = get_insn_slot();
 740         if (!p->ainsn.insn)
 741                 return -ENOMEM;
 742
 743         ret = arch_copy_kprobe(p);
 744         if (ret) {
 745                 free_insn_slot(p->ainsn.insn, 0);
 746                 p->ainsn.insn = NULL;
 747         }
 748
 749         return ret;
 750 }
 751
 752 void arch_arm_kprobe(struct kprobe *p)
 753 {
 754         u8 int3 = INT3_INSN_OPCODE;
 755
 756         text_poke(p->addr, &int3, 1);
 757         text_poke_sync();
 758         perf_event_text_poke(p->addr, &p->opcode, 1, &int3, 1);
 759 }
 760
 761 void arch_disarm_kprobe(struct kprobe *p)
 762 {
 763         u8 int3 = INT3_INSN_OPCODE;
 764
 765         perf_event_text_poke(p->addr, &int3, 1, &p->opcode, 1);
 766         text_poke(p->addr, &p->opcode, 1);
 767         text_poke_sync();
 768 }
 769
 770 void arch_remove_kprobe(struct kprobe *p)
 771 {
 772         if (p->ainsn.insn) {
 773                 /* Record the perf event before freeing the slot */
 774                 perf_event_text_poke(p->ainsn.insn, p->ainsn.insn,
 775                                      p->ainsn.tp_len, NULL, 0);
 776                 free_insn_slot(p->ainsn.insn, p->ainsn.boostable);
 777                 p->ainsn.insn = NULL;
 778         }
 779 }
 780
 781 static nokprobe_inline void
 782 save_previous_kprobe(struct kprobe_ctlblk *kcb)
 783 {
 784         kcb->prev_kprobe.kp = kprobe_running();
 785         kcb->prev_kprobe.status = kcb->kprobe_status;
 786         kcb->prev_kprobe.old_flags = kcb->kprobe_old_flags;
 787         kcb->prev_kprobe.saved_flags = kcb->kprobe_saved_flags;
 788 }
 789
 790 static nokprobe_inline void
 791 restore_previous_kprobe(struct kprobe_ctlblk *kcb)
 792 {
 793         __this_cpu_write(current_kprobe, kcb->prev_kprobe.kp);
 794         kcb->kprobe_status = kcb->prev_kprobe.status;
 795         kcb->kprobe_old_flags = kcb->prev_kprobe.old_flags;
 796         kcb->kprobe_saved_flags = kcb->prev_kprobe.saved_flags;
 797 }
 798
 799 static nokprobe_inline void
 800 set_current_kprobe(struct kprobe *p, struct pt_regs *regs,
 801                    struct kprobe_ctlblk *kcb)
 802 {
 803         __this_cpu_write(current_kprobe, p);
 804         kcb->kprobe_saved_flags = kcb->kprobe_old_flags
 805                 = (regs->flags & X86_EFLAGS_IF);
 806 }
 807
 808 void arch_prepare_kretprobe(struct kretprobe_instance *ri, struct pt_regs *regs)
 809 {
 810         unsigned long *sara = stack_addr(regs);
 811
 812         ri->ret_addr = (kprobe_opcode_t *) *sara;
 813         ri->fp = sara;
 814
 815         /* Replace the return addr with trampoline addr */
 816         *sara = (unsigned long) &kretprobe_trampoline;
 817 }
 818 NOKPROBE_SYMBOL(arch_prepare_kretprobe);
 819
 820 static void kprobe_post_process(struct kprobe *cur, struct pt_regs *regs,
 821                                struct kprobe_ctlblk *kcb)
 822 {
 823         /* Restore back the original saved kprobes variables and continue. */
 824         if (kcb->kprobe_status == KPROBE_REENTER) {
 825                 /* This will restore both kcb and current_kprobe */
 826                 restore_previous_kprobe(kcb);
 827         } else {
 828                 /*
 829                  * Always update the kcb status because
 830                  * reset_curent_kprobe() doesn't update kcb.
 831                  */
 832                 kcb->kprobe_status = KPROBE_HIT_SSDONE;
 833                 if (cur->post_handler)
 834                         cur->post_handler(cur, regs, 0);
 835                 reset_current_kprobe();
 836         }
 837 }
 838 NOKPROBE_SYMBOL(kprobe_post_process);
 839
 840 static void setup_singlestep(struct kprobe *p, struct pt_regs *regs,
 841                              struct kprobe_ctlblk *kcb, int reenter)
 842 {
 843         if (setup_detour_execution(p, regs, reenter))
 844                 return;
 845
 846 #if !defined(CONFIG_PREEMPTION)
 847         if (p->ainsn.boostable) {
 848                 /* Boost up -- we can execute copied instructions directly */
 849                 if (!reenter)
 850                         reset_current_kprobe();
 851                 /*
 852                  * Reentering boosted probe doesn't reset current_kprobe,
 853                  * nor set current_kprobe, because it doesn't use single
 854                  * stepping.
 855                  */
 856                 regs->ip = (unsigned long)p->ainsn.insn;
 857                 return;
 858         }
 859 #endif
 860         if (reenter) {
 861                 save_previous_kprobe(kcb);
 862                 set_current_kprobe(p, regs, kcb);
 863                 kcb->kprobe_status = KPROBE_REENTER;
 864         } else
 865                 kcb->kprobe_status = KPROBE_HIT_SS;
 866
 867         if (p->ainsn.emulate_op) {
 868                 p->ainsn.emulate_op(p, regs);
 869                 kprobe_post_process(p, regs, kcb);
 870                 return;
 871         }
 872
 873         /* Disable interrupt, and set ip register on trampoline */
 874         regs->flags &= ~X86_EFLAGS_IF;
 875         regs->ip = (unsigned long)p->ainsn.insn;
 876 }
 877 NOKPROBE_SYMBOL(setup_singlestep);
 878
 879 /*
 880  * Called after single-stepping.  p->addr is the address of the
 881  * instruction whose first byte has been replaced by the "int3"
 882  * instruction.  To avoid the SMP problems that can occur when we
 883  * temporarily put back the original opcode to single-step, we
 884  * single-stepped a copy of the instruction.  The address of this
 885  * copy is p->ainsn.insn. We also doesn't use trap, but "int3" again
 886  * right after the copied instruction.
 887  * Different from the trap single-step, "int3" single-step can not
 888  * handle the instruction which changes the ip register, e.g. jmp,
 889  * call, conditional jmp, and the instructions which changes the IF
 890  * flags because interrupt must be disabled around the single-stepping.
 891  * Such instructions are software emulated, but others are single-stepped
 892  * using "int3".
 893  *
 894  * When the 2nd "int3" handled, the regs->ip and regs->flags needs to
 895  * be adjusted, so that we can resume execution on correct code.
 896  */
 897 static void resume_singlestep(struct kprobe *p, struct pt_regs *regs,
 898                               struct kprobe_ctlblk *kcb)
 899 {
 900         unsigned long copy_ip = (unsigned long)p->ainsn.insn;
 901         unsigned long orig_ip = (unsigned long)p->addr;
 902
 903         /* Restore saved interrupt flag and ip register */
 904         regs->flags |= kcb->kprobe_saved_flags;
 905         /* Note that regs->ip is executed int3 so must be a step back */
 906         regs->ip += (orig_ip - copy_ip) - INT3_INSN_SIZE;
 907 }
 908 NOKPROBE_SYMBOL(resume_singlestep);
 909
 910 /*
 911  * We have reentered the kprobe_handler(), since another probe was hit while
 912  * within the handler. We save the original kprobes variables and just single
 913  * step on the instruction of the new probe without calling any user handlers.
 914  */
 915 static int reenter_kprobe(struct kprobe *p, struct pt_regs *regs,
 916                           struct kprobe_ctlblk *kcb)
 917 {
 918         switch (kcb->kprobe_status) {
 919         case KPROBE_HIT_SSDONE:
 920         case KPROBE_HIT_ACTIVE:
 921         case KPROBE_HIT_SS:
 922                 kprobes_inc_nmissed_count(p);
 923                 setup_singlestep(p, regs, kcb, 1);
 924                 break;
 925         case KPROBE_REENTER:
 926                 /* A probe has been hit in the codepath leading up to, or just
 927                  * after, single-stepping of a probed instruction. This entire
 928                  * codepath should strictly reside in .kprobes.text section.
 929                  * Raise a BUG or we'll continue in an endless reentering loop
 930                  * and eventually a stack overflow.
 931                  */
 932                 pr_err("Unrecoverable kprobe detected.\n");
 933                 dump_kprobe(p);
 934                 BUG();
 935         default:
 936                 /* impossible cases */
 937                 WARN_ON(1);
 938                 return 0;
 939         }
 940
 941         return 1;
 942 }
 943 NOKPROBE_SYMBOL(reenter_kprobe);
 944
 945 static nokprobe_inline int kprobe_is_ss(struct kprobe_ctlblk *kcb)
 946 {
 947         return (kcb->kprobe_status == KPROBE_HIT_SS ||
 948                 kcb->kprobe_status == KPROBE_REENTER);
 949 }
 950
 951 /*
 952  * Interrupts are disabled on entry as trap3 is an interrupt gate and they
 953  * remain disabled throughout this function.
 954  */
 955 int kprobe_int3_handler(struct pt_regs *regs)
 956 {
 957         kprobe_opcode_t *addr;
 958         struct kprobe *p;
 959         struct kprobe_ctlblk *kcb;
 960
 961         if (user_mode(regs))
 962                 return 0;
 963
 964         addr = (kprobe_opcode_t *)(regs->ip - sizeof(kprobe_opcode_t));
 965         /*
 966          * We don't want to be preempted for the entire duration of kprobe
 967          * processing. Since int3 and debug trap disables irqs and we clear
 968          * IF while singlestepping, it must be no preemptible.
 969          */
 970
 971         kcb = get_kprobe_ctlblk();
 972         p = get_kprobe(addr);
 973
 974         if (p) {
 975                 if (kprobe_running()) {
 976                         if (reenter_kprobe(p, regs, kcb))
 977                                 return 1;
 978                 } else {
 979                         set_current_kprobe(p, regs, kcb);
 980                         kcb->kprobe_status = KPROBE_HIT_ACTIVE;
 981
 982                         /*
 983                          * If we have no pre-handler or it returned 0, we
 984                          * continue with normal processing.  If we have a
 985                          * pre-handler and it returned non-zero, that means
 986                          * user handler setup registers to exit to another
 987                          * instruction, we must skip the single stepping.
 988                          */
 989                         if (!p->pre_handler || !p->pre_handler(p, regs))
 990                                 setup_singlestep(p, regs, kcb, 0);
 991                         else
 992                                 reset_current_kprobe();
 993                         return 1;
 994                 }
 995         } else if (kprobe_is_ss(kcb)) {
 996                 p = kprobe_running();
 997                 if ((unsigned long)p->ainsn.insn < regs->ip &&
 998                     (unsigned long)p->ainsn.insn + MAX_INSN_SIZE > regs->ip) {
 999                         /* Most provably this is the second int3 for singlestep */
1000                         resume_singlestep(p, regs, kcb);
1001                         kprobe_post_process(p, regs, kcb);
1002                         return 1;
1003                 }
1004         }
1005
1006         if (*addr != INT3_INSN_OPCODE) {
1007                 /*
1008                  * The breakpoint instruction was removed right
1009                  * after we hit it.  Another cpu has removed
1010                  * either a probepoint or a debugger breakpoint
1011                  * at this address.  In either case, no further
1012                  * handling of this interrupt is appropriate.
1013                  * Back up over the (now missing) int3 and run
1014                  * the original instruction.
1015                  */
1016                 regs->ip = (unsigned long)addr;
1017                 return 1;
1018         } /* else: not a kprobe fault; let the kernel handle it */
1019
1020         return 0;
1021 }
1022 NOKPROBE_SYMBOL(kprobe_int3_handler);
1023
1024 /*
1025  * When a retprobed function returns, this code saves registers and
1026  * calls trampoline_handler() runs, which calls the kretprobe's handler.
1027  */
1028 asm(
1029         ".text\n"
1030         ".global kretprobe_trampoline\n"
1031         ".type kretprobe_trampoline, @function\n"
1032         "kretprobe_trampoline:\n"
1033         /* We don't bother saving the ss register */
1034 #ifdef CONFIG_X86_64
1035         "       pushq %rsp\n"
1036         "       pushfq\n"
1037         SAVE_REGS_STRING
1038         "       movq %rsp, %rdi\n"
1039         "       call trampoline_handler\n"
1040         /* Replace saved sp with true return address. */
1041         "       movq %rax, 19*8(%rsp)\n"
1042         RESTORE_REGS_STRING
1043         "       popfq\n"
1044 #else
1045         "       pushl %esp\n"
1046         "       pushfl\n"
1047         SAVE_REGS_STRING
1048         "       movl %esp, %eax\n"
1049         "       call trampoline_handler\n"
1050         /* Replace saved sp with true return address. */
1051         "       movl %eax, 15*4(%esp)\n"
1052         RESTORE_REGS_STRING
1053         "       popfl\n"
1054 #endif
1055         ASM_RET
1056         ".size kretprobe_trampoline, .-kretprobe_trampoline\n"
1057 );
1058 NOKPROBE_SYMBOL(kretprobe_trampoline);
1059 STACK_FRAME_NON_STANDARD(kretprobe_trampoline);
1060
1061
1062 /*
1063  * Called from kretprobe_trampoline
1064  */
1065 __used __visible void *trampoline_handler(struct pt_regs *regs)
1066 {
1067         /* fixup registers */
1068         regs->cs = __KERNEL_CS;
1069 #ifdef CONFIG_X86_32
1070         regs->gs = 0;
1071 #endif
1072         regs->ip = (unsigned long)&kretprobe_trampoline;
1073         regs->orig_ax = ~0UL;
1074
1075         return (void *)kretprobe_trampoline_handler(regs, &kretprobe_trampoline, &regs->sp);
1076 }
1077 NOKPROBE_SYMBOL(trampoline_handler);
1078
1079 int kprobe_fault_handler(struct pt_regs *regs, int trapnr)
1080 {
1081         struct kprobe *cur = kprobe_running();
1082         struct kprobe_ctlblk *kcb = get_kprobe_ctlblk();
1083
1084         if (unlikely(regs->ip == (unsigned long)cur->ainsn.insn)) {
1085                 /* This must happen on single-stepping */
1086                 WARN_ON(kcb->kprobe_status != KPROBE_HIT_SS &&
1087                         kcb->kprobe_status != KPROBE_REENTER);
1088                 /*
1089                  * We are here because the instruction being single
1090                  * stepped caused a page fault. We reset the current
1091                  * kprobe and the ip points back to the probe address
1092                  * and allow the page fault handler to continue as a
1093                  * normal page fault.
1094                  */
1095                 regs->ip = (unsigned long)cur->addr;
1096
1097                 /*
1098                  * If the IF flag was set before the kprobe hit,
1099                  * don't touch it:
1100                  */
1101                 regs->flags |= kcb->kprobe_old_flags;
1102
1103                 if (kcb->kprobe_status == KPROBE_REENTER)
1104                         restore_previous_kprobe(kcb);
1105                 else
1106                         reset_current_kprobe();
1107         }
1108
1109         return 0;
1110 }
1111 NOKPROBE_SYMBOL(kprobe_fault_handler);
1112
1113 int __init arch_populate_kprobe_blacklist(void)
1114 {
1115         return kprobe_add_area_blacklist((unsigned long)__entry_text_start,
1116                                          (unsigned long)__entry_text_end);
1117 }
1118
1119 int __init arch_init_kprobes(void)
1120 {
1121         return 0;
1122 }
1123
1124 int arch_trampoline_kprobe(struct kprobe *p)
1125 {
1126         return 0;
1127 }