arch/x86/kernel/uprobes.c

   1 /*
   2  * User-space Probes (UProbes) for x86
   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, 2008-2011
  19  * Authors:
  20  *      Srikar Dronamraju
  21  *      Jim Keniston
  22  */
  23 #include <linux/kernel.h>
  24 #include <linux/sched.h>
  25 #include <linux/ptrace.h>
  26 #include <linux/uprobes.h>
  27 #include <linux/uaccess.h>
  28
  29 #include <linux/kdebug.h>
  30 #include <asm/processor.h>
  31 #include <asm/insn.h>
  32
  33 /* Post-execution fixups. */
  34
  35 /* Adjust IP back to vicinity of actual insn */
  36 #define UPROBE_FIX_IP           0x01
  37
  38 /* Adjust the return address of a call insn */
  39 #define UPROBE_FIX_CALL         0x02
  40
  41 /* Instruction will modify TF, don't change it */
  42 #define UPROBE_FIX_SETF         0x04
  43
  44 #define UPROBE_FIX_RIP_AX       0x08
  45 #define UPROBE_FIX_RIP_CX       0x10
  46
  47 #define UPROBE_TRAP_NR          UINT_MAX
  48
  49 /* Adaptations for mhiramat x86 decoder v14. */
  50 #define OPCODE1(insn)           ((insn)->opcode.bytes[0])
  51 #define OPCODE2(insn)           ((insn)->opcode.bytes[1])
  52 #define OPCODE3(insn)           ((insn)->opcode.bytes[2])
  53 #define MODRM_REG(insn)         X86_MODRM_REG((insn)->modrm.value)
  54
  55 #define W(row, b0, b1, b2, b3, b4, b5, b6, b7, b8, b9, ba, bb, bc, bd, be, bf)\
  56         (((b0##UL << 0x0)|(b1##UL << 0x1)|(b2##UL << 0x2)|(b3##UL << 0x3) |   \
  57           (b4##UL << 0x4)|(b5##UL << 0x5)|(b6##UL << 0x6)|(b7##UL << 0x7) |   \
  58           (b8##UL << 0x8)|(b9##UL << 0x9)|(ba##UL << 0xa)|(bb##UL << 0xb) |   \
  59           (bc##UL << 0xc)|(bd##UL << 0xd)|(be##UL << 0xe)|(bf##UL << 0xf))    \
  60          << (row % 32))
  61
  62 /*
  63  * Good-instruction tables for 32-bit apps.  This is non-const and volatile
  64  * to keep gcc from statically optimizing it out, as variable_test_bit makes
  65  * some versions of gcc to think only *(unsigned long*) is used.
  66  */
  67 #if defined(CONFIG_X86_32) || defined(CONFIG_IA32_EMULATION)
  68 static volatile u32 good_insns_32[256 / 32] = {
  69         /*      0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f         */
  70         /*      ----------------------------------------------         */
  71         W(0x00, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 1, 1, 1, 0) | /* 00 */
  72         W(0x10, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 1, 1, 1, 0) , /* 10 */
  73         W(0x20, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 1, 1, 1, 0, 1) | /* 20 */
  74         W(0x30, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 1, 1, 1, 0, 1) , /* 30 */
  75         W(0x40, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) | /* 40 */
  76         W(0x50, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) , /* 50 */
  77         W(0x60, 1, 1, 1, 0, 1, 1, 0, 0, 1, 1, 1, 1, 0, 0, 0, 0) | /* 60 */
  78         W(0x70, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) , /* 70 */
  79         W(0x80, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) | /* 80 */
  80         W(0x90, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) , /* 90 */
  81         W(0xa0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) | /* a0 */
  82         W(0xb0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) , /* b0 */
  83         W(0xc0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0) | /* c0 */
  84         W(0xd0, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1) , /* d0 */
  85         W(0xe0, 1, 1, 1, 1, 0, 0, 0, 0, 1, 1, 1, 1, 0, 0, 0, 0) | /* e0 */
  86         W(0xf0, 0, 0, 1, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1, 1, 1, 1)   /* f0 */
  87         /*      ----------------------------------------------         */
  88         /*      0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f         */
  89 };
  90 #else
  91 #define good_insns_32   NULL
  92 #endif
  93
  94 /* Good-instruction tables for 64-bit apps */
  95 #if defined(CONFIG_X86_64)
  96 static volatile u32 good_insns_64[256 / 32] = {
  97         /*      0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f         */
  98         /*      ----------------------------------------------         */
  99         W(0x00, 1, 1, 1, 1, 1, 1, 0, 0, 1, 1, 1, 1, 1, 1, 0, 0) | /* 00 */
 100         W(0x10, 1, 1, 1, 1, 1, 1, 0, 0, 1, 1, 1, 1, 1, 1, 0, 0) , /* 10 */
 101         W(0x20, 1, 1, 1, 1, 1, 1, 0, 0, 1, 1, 1, 1, 1, 1, 0, 0) | /* 20 */
 102         W(0x30, 1, 1, 1, 1, 1, 1, 0, 0, 1, 1, 1, 1, 1, 1, 0, 0) , /* 30 */
 103         W(0x40, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) | /* 40 */
 104         W(0x50, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) , /* 50 */
 105         W(0x60, 0, 0, 0, 1, 1, 1, 0, 0, 1, 1, 1, 1, 0, 0, 0, 0) | /* 60 */
 106         W(0x70, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) , /* 70 */
 107         W(0x80, 1, 1, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) | /* 80 */
 108         W(0x90, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) , /* 90 */
 109         W(0xa0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) | /* a0 */
 110         W(0xb0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) , /* b0 */
 111         W(0xc0, 1, 1, 1, 1, 0, 0, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0) | /* c0 */
 112         W(0xd0, 1, 1, 1, 1, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1) , /* d0 */
 113         W(0xe0, 1, 1, 1, 1, 0, 0, 0, 0, 1, 1, 1, 1, 0, 0, 0, 0) | /* e0 */
 114         W(0xf0, 0, 0, 1, 1, 0, 1, 1, 1, 1, 1, 0, 0, 1, 1, 1, 1)   /* f0 */
 115         /*      ----------------------------------------------         */
 116         /*      0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f         */
 117 };
 118 #else
 119 #define good_insns_64   NULL
 120 #endif
 121
 122 /* Using this for both 64-bit and 32-bit apps */
 123 static volatile u32 good_2byte_insns[256 / 32] = {
 124         /*      0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f         */
 125         /*      ----------------------------------------------         */
 126         W(0x00, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1) | /* 00 */
 127         W(0x10, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 1, 1, 1) , /* 10 */
 128         W(0x20, 1, 1, 1, 1, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1) | /* 20 */
 129         W(0x30, 0, 1, 1, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0) , /* 30 */
 130         W(0x40, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) | /* 40 */
 131         W(0x50, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) , /* 50 */
 132         W(0x60, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) | /* 60 */
 133         W(0x70, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, 1, 1) , /* 70 */
 134         W(0x80, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) | /* 80 */
 135         W(0x90, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) , /* 90 */
 136         W(0xa0, 1, 1, 1, 1, 1, 1, 0, 0, 1, 1, 1, 1, 1, 1, 0, 1) | /* a0 */
 137         W(0xb0, 1, 1, 1, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 1, 1, 1) , /* b0 */
 138         W(0xc0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) | /* c0 */
 139         W(0xd0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) , /* d0 */
 140         W(0xe0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1) | /* e0 */
 141         W(0xf0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0)   /* f0 */
 142         /*      ----------------------------------------------         */
 143         /*      0  1  2  3  4  5  6  7  8  9  a  b  c  d  e  f         */
 144 };
 145 #undef W
 146
 147 /*
 148  * opcodes we'll probably never support:
 149  *
 150  *  6c-6d, e4-e5, ec-ed - in
 151  *  6e-6f, e6-e7, ee-ef - out
 152  *  cc, cd - int3, int
 153  *  cf - iret
 154  *  d6 - illegal instruction
 155  *  f1 - int1/icebp
 156  *  f4 - hlt
 157  *  fa, fb - cli, sti
 158  *  0f - lar, lsl, syscall, clts, sysret, sysenter, sysexit, invd, wbinvd, ud2
 159  *
 160  * invalid opcodes in 64-bit mode:
 161  *
 162  *  06, 0e, 16, 1e, 27, 2f, 37, 3f, 60-62, 82, c4-c5, d4-d5
 163  *  63 - we support this opcode in x86_64 but not in i386.
 164  *
 165  * opcodes we may need to refine support for:
 166  *
 167  *  0f - 2-byte instructions: For many of these instructions, the validity
 168  *  depends on the prefix and/or the reg field.  On such instructions, we
 169  *  just consider the opcode combination valid if it corresponds to any
 170  *  valid instruction.
 171  *
 172  *  8f - Group 1 - only reg = 0 is OK
 173  *  c6-c7 - Group 11 - only reg = 0 is OK
 174  *  d9-df - fpu insns with some illegal encodings
 175  *  f2, f3 - repnz, repz prefixes.  These are also the first byte for
 176  *  certain floating-point instructions, such as addsd.
 177  *
 178  *  fe - Group 4 - only reg = 0 or 1 is OK
 179  *  ff - Group 5 - only reg = 0-6 is OK
 180  *
 181  * others -- Do we need to support these?
 182  *
 183  *  0f - (floating-point?) prefetch instructions
 184  *  07, 17, 1f - pop es, pop ss, pop ds
 185  *  26, 2e, 36, 3e - es:, cs:, ss:, ds: segment prefixes --
 186  *      but 64 and 65 (fs: and gs:) seem to be used, so we support them
 187  *  67 - addr16 prefix
 188  *  ce - into
 189  *  f0 - lock prefix
 190  */
 191
 192 /*
 193  * TODO:
 194  * - Where necessary, examine the modrm byte and allow only valid instructions
 195  * in the different Groups and fpu instructions.
 196  */
 197
 198 static bool is_prefix_bad(struct insn *insn)
 199 {
 200         int i;
 201
 202         for (i = 0; i < insn->prefixes.nbytes; i++) {
 203                 switch (insn->prefixes.bytes[i]) {
 204                 case 0x26:      /* INAT_PFX_ES   */
 205                 case 0x2E:      /* INAT_PFX_CS   */
 206                 case 0x36:      /* INAT_PFX_DS   */
 207                 case 0x3E:      /* INAT_PFX_SS   */
 208                 case 0xF0:      /* INAT_PFX_LOCK */
 209                         return true;
 210                 }
 211         }
 212         return false;
 213 }
 214
 215 static int uprobe_init_insn(struct arch_uprobe *auprobe, struct insn *insn, bool x86_64)
 216 {
 217         u32 volatile *good_insns;
 218
 219         insn_init(insn, auprobe->insn, x86_64);
 220         /* has the side-effect of processing the entire instruction */
 221         insn_get_length(insn);
 222         if (WARN_ON_ONCE(!insn_complete(insn)))
 223                 return -ENOEXEC;
 224
 225         if (is_prefix_bad(insn))
 226                 return -ENOTSUPP;
 227
 228         if (x86_64)
 229                 good_insns = good_insns_64;
 230         else
 231                 good_insns = good_insns_32;
 232
 233         if (test_bit(OPCODE1(insn), (unsigned long *)good_insns))
 234                 return 0;
 235
 236         if (insn->opcode.nbytes == 2) {
 237                 if (test_bit(OPCODE2(insn), (unsigned long *)good_2byte_insns))
 238                         return 0;
 239         }
 240
 241         return -ENOTSUPP;
 242 }
 243
 244 #ifdef CONFIG_X86_64
 245 static inline bool is_64bit_mm(struct mm_struct *mm)
 246 {
 247         return  !config_enabled(CONFIG_IA32_EMULATION) ||
 248                 !(mm->context.ia32_compat == TIF_IA32);
 249 }
 250 /*
 251  * If arch_uprobe->insn doesn't use rip-relative addressing, return
 252  * immediately.  Otherwise, rewrite the instruction so that it accesses
 253  * its memory operand indirectly through a scratch register.  Set
 254  * def->fixups and def->riprel_target accordingly. (The contents of the
 255  * scratch register will be saved before we single-step the modified
 256  * instruction, and restored afterward).
 257  *
 258  * We do this because a rip-relative instruction can access only a
 259  * relatively small area (+/- 2 GB from the instruction), and the XOL
 260  * area typically lies beyond that area.  At least for instructions
 261  * that store to memory, we can't execute the original instruction
 262  * and "fix things up" later, because the misdirected store could be
 263  * disastrous.
 264  *
 265  * Some useful facts about rip-relative instructions:
 266  *
 267  *  - There's always a modrm byte.
 268  *  - There's never a SIB byte.
 269  *  - The displacement is always 4 bytes.
 270  */
 271 static void
 272 handle_riprel_insn(struct arch_uprobe *auprobe, struct insn *insn)
 273 {
 274         u8 *cursor;
 275         u8 reg;
 276
 277         if (!insn_rip_relative(insn))
 278                 return;
 279
 280         /*
 281          * insn_rip_relative() would have decoded rex_prefix, modrm.
 282          * Clear REX.b bit (extension of MODRM.rm field):
 283          * we want to encode rax/rcx, not r8/r9.
 284          */
 285         if (insn->rex_prefix.nbytes) {
 286                 cursor = auprobe->insn + insn_offset_rex_prefix(insn);
 287                 *cursor &= 0xfe;        /* Clearing REX.B bit */
 288         }
 289
 290         /*
 291          * Point cursor at the modrm byte.  The next 4 bytes are the
 292          * displacement.  Beyond the displacement, for some instructions,
 293          * is the immediate operand.
 294          */
 295         cursor = auprobe->insn + insn_offset_modrm(insn);
 296         /*
 297          * Convert from rip-relative addressing to indirect addressing
 298          * via a scratch register.  Change the r/m field from 0x5 (%rip)
 299          * to 0x0 (%rax) or 0x1 (%rcx), and squeeze out the offset field.
 300          */
 301         reg = MODRM_REG(insn);
 302         if (reg == 0) {
 303                 /*
 304                  * The register operand (if any) is either the A register
 305                  * (%rax, %eax, etc.) or (if the 0x4 bit is set in the
 306                  * REX prefix) %r8.  In any case, we know the C register
 307                  * is NOT the register operand, so we use %rcx (register
 308                  * #1) for the scratch register.
 309                  */
 310                 auprobe->def.fixups |= UPROBE_FIX_RIP_CX;
 311                 /* Change modrm from 00 000 101 to 00 000 001. */
 312                 *cursor = 0x1;
 313         } else {
 314                 /* Use %rax (register #0) for the scratch register. */
 315                 auprobe->def.fixups |= UPROBE_FIX_RIP_AX;
 316                 /* Change modrm from 00 xxx 101 to 00 xxx 000 */
 317                 *cursor = (reg << 3);
 318         }
 319
 320         /* Target address = address of next instruction + (signed) offset */
 321         auprobe->def.riprel_target = (long)insn->length + insn->displacement.value;
 322
 323         /* Displacement field is gone; slide immediate field (if any) over. */
 324         if (insn->immediate.nbytes) {
 325                 cursor++;
 326                 memmove(cursor, cursor + insn->displacement.nbytes, insn->immediate.nbytes);
 327         }
 328 }
 329
 330 /*
 331  * If we're emulating a rip-relative instruction, save the contents
 332  * of the scratch register and store the target address in that register.
 333  */
 334 static void
 335 pre_xol_rip_insn(struct arch_uprobe *auprobe, struct pt_regs *regs,
 336                                 struct arch_uprobe_task *autask)
 337 {
 338         if (auprobe->def.fixups & UPROBE_FIX_RIP_AX) {
 339                 autask->saved_scratch_register = regs->ax;
 340                 regs->ax = current->utask->vaddr;
 341                 regs->ax += auprobe->def.riprel_target;
 342         } else if (auprobe->def.fixups & UPROBE_FIX_RIP_CX) {
 343                 autask->saved_scratch_register = regs->cx;
 344                 regs->cx = current->utask->vaddr;
 345                 regs->cx += auprobe->def.riprel_target;
 346         }
 347 }
 348
 349 static void
 350 handle_riprel_post_xol(struct arch_uprobe *auprobe, struct pt_regs *regs, long *correction)
 351 {
 352         if (auprobe->def.fixups & (UPROBE_FIX_RIP_AX | UPROBE_FIX_RIP_CX)) {
 353                 struct arch_uprobe_task *autask;
 354
 355                 autask = &current->utask->autask;
 356                 if (auprobe->def.fixups & UPROBE_FIX_RIP_AX)
 357                         regs->ax = autask->saved_scratch_register;
 358                 else
 359                         regs->cx = autask->saved_scratch_register;
 360
 361                 /*
 362                  * The original instruction includes a displacement, and so
 363                  * is 4 bytes longer than what we've just single-stepped.
 364                  * Caller may need to apply other fixups to handle stuff
 365                  * like "jmpq *...(%rip)" and "callq *...(%rip)".
 366                  */
 367                 if (correction)
 368                         *correction += 4;
 369         }
 370 }
 371 #else /* 32-bit: */
 372 static inline bool is_64bit_mm(struct mm_struct *mm)
 373 {
 374         return false;
 375 }
 376 /*
 377  * No RIP-relative addressing on 32-bit
 378  */
 379 static void handle_riprel_insn(struct arch_uprobe *auprobe, struct insn *insn)
 380 {
 381 }
 382 static void pre_xol_rip_insn(struct arch_uprobe *auprobe, struct pt_regs *regs,
 383                                 struct arch_uprobe_task *autask)
 384 {
 385 }
 386 static void handle_riprel_post_xol(struct arch_uprobe *auprobe, struct pt_regs *regs,
 387                                         long *correction)
 388 {
 389 }
 390 #endif /* CONFIG_X86_64 */
 391
 392 struct uprobe_xol_ops {
 393         bool    (*emulate)(struct arch_uprobe *, struct pt_regs *);
 394         int     (*pre_xol)(struct arch_uprobe *, struct pt_regs *);
 395         int     (*post_xol)(struct arch_uprobe *, struct pt_regs *);
 396         void    (*abort)(struct arch_uprobe *, struct pt_regs *);
 397 };
 398
 399 static inline int sizeof_long(void)
 400 {
 401         return is_ia32_task() ? 4 : 8;
 402 }
 403
 404 static int default_pre_xol_op(struct arch_uprobe *auprobe, struct pt_regs *regs)
 405 {
 406         pre_xol_rip_insn(auprobe, regs, &current->utask->autask);
 407         return 0;
 408 }
 409
 410 static int push_ret_address(struct pt_regs *regs, unsigned long ip)
 411 {
 412         unsigned long new_sp = regs->sp - sizeof_long();
 413
 414         if (copy_to_user((void __user *)new_sp, &ip, sizeof_long()))
 415                 return -EFAULT;
 416
 417         regs->sp = new_sp;
 418         return 0;
 419 }
 420
 421 static int default_post_xol_op(struct arch_uprobe *auprobe, struct pt_regs *regs)
 422 {
 423         struct uprobe_task *utask = current->utask;
 424         long correction = (long)(utask->vaddr - utask->xol_vaddr);
 425
 426         handle_riprel_post_xol(auprobe, regs, &correction);
 427         if (auprobe->def.fixups & UPROBE_FIX_IP) {
 428                 regs->ip += correction;
 429         } else if (auprobe->def.fixups & UPROBE_FIX_CALL) {
 430                 regs->sp += sizeof_long();
 431                 if (push_ret_address(regs, utask->vaddr + auprobe->def.ilen))
 432                         return -ERESTART;
 433         }
 434         /* popf; tell the caller to not touch TF */
 435         if (auprobe->def.fixups & UPROBE_FIX_SETF)
 436                 utask->autask.saved_tf = true;
 437
 438         return 0;
 439 }
 440
 441 static void default_abort_op(struct arch_uprobe *auprobe, struct pt_regs *regs)
 442 {
 443         handle_riprel_post_xol(auprobe, regs, NULL);
 444 }
 445
 446 static struct uprobe_xol_ops default_xol_ops = {
 447         .pre_xol  = default_pre_xol_op,
 448         .post_xol = default_post_xol_op,
 449         .abort    = default_abort_op,
 450 };
 451
 452 static bool branch_is_call(struct arch_uprobe *auprobe)
 453 {
 454         return auprobe->branch.opc1 == 0xe8;
 455 }
 456
 457 #define CASE_COND                                       \
 458         COND(70, 71, XF(OF))                            \
 459         COND(72, 73, XF(CF))                            \
 460         COND(74, 75, XF(ZF))                            \
 461         COND(78, 79, XF(SF))                            \
 462         COND(7a, 7b, XF(PF))                            \
 463         COND(76, 77, XF(CF) || XF(ZF))                  \
 464         COND(7c, 7d, XF(SF) != XF(OF))                  \
 465         COND(7e, 7f, XF(ZF) || XF(SF) != XF(OF))
 466
 467 #define COND(op_y, op_n, expr)                          \
 468         case 0x ## op_y: DO((expr) != 0)                \
 469         case 0x ## op_n: DO((expr) == 0)
 470
 471 #define XF(xf)  (!!(flags & X86_EFLAGS_ ## xf))
 472
 473 static bool is_cond_jmp_opcode(u8 opcode)
 474 {
 475         switch (opcode) {
 476         #define DO(expr)        \
 477                 return true;
 478         CASE_COND
 479         #undef  DO
 480
 481         default:
 482                 return false;
 483         }
 484 }
 485
 486 static bool check_jmp_cond(struct arch_uprobe *auprobe, struct pt_regs *regs)
 487 {
 488         unsigned long flags = regs->flags;
 489
 490         switch (auprobe->branch.opc1) {
 491         #define DO(expr)        \
 492                 return expr;
 493         CASE_COND
 494         #undef  DO
 495
 496         default:        /* not a conditional jmp */
 497                 return true;
 498         }
 499 }
 500
 501 #undef  XF
 502 #undef  COND
 503 #undef  CASE_COND
 504
 505 static bool branch_emulate_op(struct arch_uprobe *auprobe, struct pt_regs *regs)
 506 {
 507         unsigned long new_ip = regs->ip += auprobe->branch.ilen;
 508         unsigned long offs = (long)auprobe->branch.offs;
 509
 510         if (branch_is_call(auprobe)) {
 511                 /*
 512                  * If it fails we execute this (mangled, see the comment in
 513                  * branch_clear_offset) insn out-of-line. In the likely case
 514                  * this should trigger the trap, and the probed application
 515                  * should die or restart the same insn after it handles the
 516                  * signal, arch_uprobe_post_xol() won't be even called.
 517                  *
 518                  * But there is corner case, see the comment in ->post_xol().
 519                  */
 520                 if (push_ret_address(regs, new_ip))
 521                         return false;
 522         } else if (!check_jmp_cond(auprobe, regs)) {
 523                 offs = 0;
 524         }
 525
 526         regs->ip = new_ip + offs;
 527         return true;
 528 }
 529
 530 static int branch_post_xol_op(struct arch_uprobe *auprobe, struct pt_regs *regs)
 531 {
 532         BUG_ON(!branch_is_call(auprobe));
 533         /*
 534          * We can only get here if branch_emulate_op() failed to push the ret
 535          * address _and_ another thread expanded our stack before the (mangled)
 536          * "call" insn was executed out-of-line. Just restore ->sp and restart.
 537          * We could also restore ->ip and try to call branch_emulate_op() again.
 538          */
 539         regs->sp += sizeof_long();
 540         return -ERESTART;
 541 }
 542
 543 static void branch_clear_offset(struct arch_uprobe *auprobe, struct insn *insn)
 544 {
 545         /*
 546          * Turn this insn into "call 1f; 1:", this is what we will execute
 547          * out-of-line if ->emulate() fails. We only need this to generate
 548          * a trap, so that the probed task receives the correct signal with
 549          * the properly filled siginfo.
 550          *
 551          * But see the comment in ->post_xol(), in the unlikely case it can
 552          * succeed. So we need to ensure that the new ->ip can not fall into
 553          * the non-canonical area and trigger #GP.
 554          *
 555          * We could turn it into (say) "pushf", but then we would need to
 556          * divorce ->insn[] and ->ixol[]. We need to preserve the 1st byte
 557          * of ->insn[] for set_orig_insn().
 558          */
 559         memset(auprobe->insn + insn_offset_immediate(insn),
 560                 0, insn->immediate.nbytes);
 561 }
 562
 563 static struct uprobe_xol_ops branch_xol_ops = {
 564         .emulate  = branch_emulate_op,
 565         .post_xol = branch_post_xol_op,
 566 };
 567
 568 /* Returns -ENOSYS if branch_xol_ops doesn't handle this insn */
 569 static int branch_setup_xol_ops(struct arch_uprobe *auprobe, struct insn *insn)
 570 {
 571         u8 opc1 = OPCODE1(insn);
 572         int i;
 573
 574         switch (opc1) {
 575         case 0xeb:      /* jmp 8 */
 576         case 0xe9:      /* jmp 32 */
 577         case 0x90:      /* prefix* + nop; same as jmp with .offs = 0 */
 578                 break;
 579
 580         case 0xe8:      /* call relative */
 581                 branch_clear_offset(auprobe, insn);
 582                 break;
 583
 584         case 0x0f:
 585                 if (insn->opcode.nbytes != 2)
 586                         return -ENOSYS;
 587                 /*
 588                  * If it is a "near" conditional jmp, OPCODE2() - 0x10 matches
 589                  * OPCODE1() of the "short" jmp which checks the same condition.
 590                  */
 591                 opc1 = OPCODE2(insn) - 0x10;
 592         default:
 593                 if (!is_cond_jmp_opcode(opc1))
 594                         return -ENOSYS;
 595         }
 596
 597         /*
 598          * 16-bit overrides such as CALLW (66 e8 nn nn) are not supported.
 599          * Intel and AMD behavior differ in 64-bit mode: Intel ignores 66 prefix.
 600          * No one uses these insns, reject any branch insns with such prefix.
 601          */
 602         for (i = 0; i < insn->prefixes.nbytes; i++) {
 603                 if (insn->prefixes.bytes[i] == 0x66)
 604                         return -ENOTSUPP;
 605         }
 606
 607         auprobe->branch.opc1 = opc1;
 608         auprobe->branch.ilen = insn->length;
 609         auprobe->branch.offs = insn->immediate.value;
 610
 611         auprobe->ops = &branch_xol_ops;
 612         return 0;
 613 }
 614
 615 /**
 616  * arch_uprobe_analyze_insn - instruction analysis including validity and fixups.
 617  * @mm: the probed address space.
 618  * @arch_uprobe: the probepoint information.
 619  * @addr: virtual address at which to install the probepoint
 620  * Return 0 on success or a -ve number on error.
 621  */
 622 int arch_uprobe_analyze_insn(struct arch_uprobe *auprobe, struct mm_struct *mm, unsigned long addr)
 623 {
 624         struct insn insn;
 625         u8 fix_ip_or_call = UPROBE_FIX_IP;
 626         int ret;
 627
 628         ret = uprobe_init_insn(auprobe, &insn, is_64bit_mm(mm));
 629         if (ret)
 630                 return ret;
 631
 632         ret = branch_setup_xol_ops(auprobe, &insn);
 633         if (ret != -ENOSYS)
 634                 return ret;
 635
 636         /*
 637          * Figure out which fixups default_post_xol_op() will need to perform,
 638          * and annotate def->fixups accordingly. To start with, ->fixups is
 639          * either zero or it reflects rip-related fixups.
 640          */
 641         switch (OPCODE1(&insn)) {
 642         case 0x9d:              /* popf */
 643                 auprobe->def.fixups |= UPROBE_FIX_SETF;
 644                 break;
 645         case 0xc3:              /* ret or lret -- ip is correct */
 646         case 0xcb:
 647         case 0xc2:
 648         case 0xca:
 649         case 0xea:              /* jmp absolute -- ip is correct */
 650                 fix_ip_or_call = 0;
 651                 break;
 652         case 0x9a:              /* call absolute - Fix return addr, not ip */
 653                 fix_ip_or_call = UPROBE_FIX_CALL;
 654                 break;
 655         case 0xff:
 656                 switch (MODRM_REG(&insn)) {
 657                 case 2: case 3:                 /* call or lcall, indirect */
 658                         fix_ip_or_call = UPROBE_FIX_CALL;
 659                         break;
 660                 case 4: case 5:                 /* jmp or ljmp, indirect */
 661                         fix_ip_or_call = 0;
 662                         break;
 663                 }
 664                 /* fall through */
 665         default:
 666                 handle_riprel_insn(auprobe, &insn);
 667         }
 668
 669         auprobe->def.ilen = insn.length;
 670         auprobe->def.fixups |= fix_ip_or_call;
 671
 672         auprobe->ops = &default_xol_ops;
 673         return 0;
 674 }
 675
 676 /*
 677  * arch_uprobe_pre_xol - prepare to execute out of line.
 678  * @auprobe: the probepoint information.
 679  * @regs: reflects the saved user state of current task.
 680  */
 681 int arch_uprobe_pre_xol(struct arch_uprobe *auprobe, struct pt_regs *regs)
 682 {
 683         struct uprobe_task *utask = current->utask;
 684
 685         if (auprobe->ops->pre_xol) {
 686                 int err = auprobe->ops->pre_xol(auprobe, regs);
 687                 if (err)
 688                         return err;
 689         }
 690
 691         regs->ip = utask->xol_vaddr;
 692         utask->autask.saved_trap_nr = current->thread.trap_nr;
 693         current->thread.trap_nr = UPROBE_TRAP_NR;
 694
 695         utask->autask.saved_tf = !!(regs->flags & X86_EFLAGS_TF);
 696         regs->flags |= X86_EFLAGS_TF;
 697         if (test_tsk_thread_flag(current, TIF_BLOCKSTEP))
 698                 set_task_blockstep(current, false);
 699
 700         return 0;
 701 }
 702
 703 /*
 704  * If xol insn itself traps and generates a signal(Say,
 705  * SIGILL/SIGSEGV/etc), then detect the case where a singlestepped
 706  * instruction jumps back to its own address. It is assumed that anything
 707  * like do_page_fault/do_trap/etc sets thread.trap_nr != -1.
 708  *
 709  * arch_uprobe_pre_xol/arch_uprobe_post_xol save/restore thread.trap_nr,
 710  * arch_uprobe_xol_was_trapped() simply checks that ->trap_nr is not equal to
 711  * UPROBE_TRAP_NR == -1 set by arch_uprobe_pre_xol().
 712  */
 713 bool arch_uprobe_xol_was_trapped(struct task_struct *t)
 714 {
 715         if (t->thread.trap_nr != UPROBE_TRAP_NR)
 716                 return true;
 717
 718         return false;
 719 }
 720
 721 /*
 722  * Called after single-stepping. To avoid the SMP problems that can
 723  * occur when we temporarily put back the original opcode to
 724  * single-step, we single-stepped a copy of the instruction.
 725  *
 726  * This function prepares to resume execution after the single-step.
 727  * We have to fix things up as follows:
 728  *
 729  * Typically, the new ip is relative to the copied instruction.  We need
 730  * to make it relative to the original instruction (FIX_IP).  Exceptions
 731  * are return instructions and absolute or indirect jump or call instructions.
 732  *
 733  * If the single-stepped instruction was a call, the return address that
 734  * is atop the stack is the address following the copied instruction.  We
 735  * need to make it the address following the original instruction (FIX_CALL).
 736  *
 737  * If the original instruction was a rip-relative instruction such as
 738  * "movl %edx,0xnnnn(%rip)", we have instead executed an equivalent
 739  * instruction using a scratch register -- e.g., "movl %edx,(%rax)".
 740  * We need to restore the contents of the scratch register and adjust
 741  * the ip, keeping in mind that the instruction we executed is 4 bytes
 742  * shorter than the original instruction (since we squeezed out the offset
 743  * field).  (FIX_RIP_AX or FIX_RIP_CX)
 744  */
 745 int arch_uprobe_post_xol(struct arch_uprobe *auprobe, struct pt_regs *regs)
 746 {
 747         struct uprobe_task *utask = current->utask;
 748         bool send_sigtrap = utask->autask.saved_tf;
 749         int err = 0;
 750
 751         WARN_ON_ONCE(current->thread.trap_nr != UPROBE_TRAP_NR);
 752         current->thread.trap_nr = utask->autask.saved_trap_nr;
 753
 754         if (auprobe->ops->post_xol) {
 755                 err = auprobe->ops->post_xol(auprobe, regs);
 756                 if (err) {
 757                         /*
 758                          * Restore ->ip for restart or post mortem analysis.
 759                          * ->post_xol() must not return -ERESTART unless this
 760                          * is really possible.
 761                          */
 762                         regs->ip = utask->vaddr;
 763                         if (err == -ERESTART)
 764                                 err = 0;
 765                         send_sigtrap = false;
 766                 }
 767         }
 768         /*
 769          * arch_uprobe_pre_xol() doesn't save the state of TIF_BLOCKSTEP
 770          * so we can get an extra SIGTRAP if we do not clear TF. We need
 771          * to examine the opcode to make it right.
 772          */
 773         if (send_sigtrap)
 774                 send_sig(SIGTRAP, current, 0);
 775
 776         if (!utask->autask.saved_tf)
 777                 regs->flags &= ~X86_EFLAGS_TF;
 778
 779         return err;
 780 }
 781
 782 /* callback routine for handling exceptions. */
 783 int arch_uprobe_exception_notify(struct notifier_block *self, unsigned long val, void *data)
 784 {
 785         struct die_args *args = data;
 786         struct pt_regs *regs = args->regs;
 787         int ret = NOTIFY_DONE;
 788
 789         /* We are only interested in userspace traps */
 790         if (regs && !user_mode_vm(regs))
 791                 return NOTIFY_DONE;
 792
 793         switch (val) {
 794         case DIE_INT3:
 795                 if (uprobe_pre_sstep_notifier(regs))
 796                         ret = NOTIFY_STOP;
 797
 798                 break;
 799
 800         case DIE_DEBUG:
 801                 if (uprobe_post_sstep_notifier(regs))
 802                         ret = NOTIFY_STOP;
 803
 804         default:
 805                 break;
 806         }
 807
 808         return ret;
 809 }
 810
 811 /*
 812  * This function gets called when XOL instruction either gets trapped or
 813  * the thread has a fatal signal. Reset the instruction pointer to its
 814  * probed address for the potential restart or for post mortem analysis.
 815  */
 816 void arch_uprobe_abort_xol(struct arch_uprobe *auprobe, struct pt_regs *regs)
 817 {
 818         struct uprobe_task *utask = current->utask;
 819
 820         if (auprobe->ops->abort)
 821                 auprobe->ops->abort(auprobe, regs);
 822
 823         current->thread.trap_nr = utask->autask.saved_trap_nr;
 824         regs->ip = utask->vaddr;
 825         /* clear TF if it was set by us in arch_uprobe_pre_xol() */
 826         if (!utask->autask.saved_tf)
 827                 regs->flags &= ~X86_EFLAGS_TF;
 828 }
 829
 830 static bool __skip_sstep(struct arch_uprobe *auprobe, struct pt_regs *regs)
 831 {
 832         if (auprobe->ops->emulate)
 833                 return auprobe->ops->emulate(auprobe, regs);
 834         return false;
 835 }
 836
 837 bool arch_uprobe_skip_sstep(struct arch_uprobe *auprobe, struct pt_regs *regs)
 838 {
 839         bool ret = __skip_sstep(auprobe, regs);
 840         if (ret && (regs->flags & X86_EFLAGS_TF))
 841                 send_sig(SIGTRAP, current, 0);
 842         return ret;
 843 }
 844
 845 unsigned long
 846 arch_uretprobe_hijack_return_addr(unsigned long trampoline_vaddr, struct pt_regs *regs)
 847 {
 848         int rasize = sizeof_long(), nleft;
 849         unsigned long orig_ret_vaddr = 0; /* clear high bits for 32-bit apps */
 850
 851         if (copy_from_user(&orig_ret_vaddr, (void __user *)regs->sp, rasize))
 852                 return -1;
 853
 854         /* check whether address has been already hijacked */
 855         if (orig_ret_vaddr == trampoline_vaddr)
 856                 return orig_ret_vaddr;
 857
 858         nleft = copy_to_user((void __user *)regs->sp, &trampoline_vaddr, rasize);
 859         if (likely(!nleft))
 860                 return orig_ret_vaddr;
 861
 862         if (nleft != rasize) {
 863                 pr_err("uprobe: return address clobbered: pid=%d, %%sp=%#lx, "
 864                         "%%ip=%#lx\n", current->pid, regs->sp, regs->ip);
 865
 866                 force_sig_info(SIGSEGV, SEND_SIG_FORCED, current);
 867         }
 868
 869         return -1;
 870 }