arch/x86/kernel/kprobes.c

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