arch/x86/kernel/hw_breakpoint.c

   1 /*
   2  * This program is free software; you can redistribute it and/or modify
   3  * it under the terms of the GNU General Public License as published by
   4  * the Free Software Foundation; either version 2 of the License, or
   5  * (at your option) any later version.
   6  *
   7  * This program is distributed in the hope that it will be useful,
   8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
   9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  10  * GNU General Public License for more details.
  11  *
  12  * You should have received a copy of the GNU General Public License
  13  * along with this program; if not, write to the Free Software
  14  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  15  *
  16  * Copyright (C) 2007 Alan Stern
  17  * Copyright (C) 2009 IBM Corporation
  18  * Copyright (C) 2009 Frederic Weisbecker <fweisbec@gmail.com>
  19  *
  20  * Authors: Alan Stern <stern@rowland.harvard.edu>
  21  *          K.Prasad <prasad@linux.vnet.ibm.com>
  22  *          Frederic Weisbecker <fweisbec@gmail.com>
  23  */
  24
  25 /*
  26  * HW_breakpoint: a unified kernel/user-space hardware breakpoint facility,
  27  * using the CPU's debug registers.
  28  */
  29
  30 #include <linux/perf_event.h>
  31 #include <linux/hw_breakpoint.h>
  32 #include <linux/irqflags.h>
  33 #include <linux/notifier.h>
  34 #include <linux/kallsyms.h>
  35 #include <linux/kprobes.h>
  36 #include <linux/percpu.h>
  37 #include <linux/kdebug.h>
  38 #include <linux/kernel.h>
  39 #include <linux/module.h>
  40 #include <linux/sched.h>
  41 #include <linux/init.h>
  42 #include <linux/smp.h>
  43
  44 #include <asm/hw_breakpoint.h>
  45 #include <asm/processor.h>
  46 #include <asm/debugreg.h>
  47
  48 /* Per cpu debug control register value */
  49 DEFINE_PER_CPU(unsigned long, cpu_dr7);
  50 EXPORT_PER_CPU_SYMBOL(cpu_dr7);
  51
  52 /* Per cpu debug address registers values */
  53 static DEFINE_PER_CPU(unsigned long, cpu_debugreg[HBP_NUM]);
  54
  55 /*
  56  * Stores the breakpoints currently in use on each breakpoint address
  57  * register for each cpus
  58  */
  59 static DEFINE_PER_CPU(struct perf_event *, bp_per_reg[HBP_NUM]);
  60
  61
  62 static inline unsigned long
  63 __encode_dr7(int drnum, unsigned int len, unsigned int type)
  64 {
  65         unsigned long bp_info;
  66
  67         bp_info = (len | type) & 0xf;
  68         bp_info <<= (DR_CONTROL_SHIFT + drnum * DR_CONTROL_SIZE);
  69         bp_info |= (DR_GLOBAL_ENABLE << (drnum * DR_ENABLE_SIZE));
  70
  71         return bp_info;
  72 }
  73
  74 /*
  75  * Encode the length, type, Exact, and Enable bits for a particular breakpoint
  76  * as stored in debug register 7.
  77  */
  78 unsigned long encode_dr7(int drnum, unsigned int len, unsigned int type)
  79 {
  80         return __encode_dr7(drnum, len, type) | DR_GLOBAL_SLOWDOWN;
  81 }
  82
  83 /*
  84  * Decode the length and type bits for a particular breakpoint as
  85  * stored in debug register 7.  Return the "enabled" status.
  86  */
  87 int decode_dr7(unsigned long dr7, int bpnum, unsigned *len, unsigned *type)
  88 {
  89         int bp_info = dr7 >> (DR_CONTROL_SHIFT + bpnum * DR_CONTROL_SIZE);
  90
  91         *len = (bp_info & 0xc) | 0x40;
  92         *type = (bp_info & 0x3) | 0x80;
  93
  94         return (dr7 >> (bpnum * DR_ENABLE_SIZE)) & 0x3;
  95 }
  96
  97 /*
  98  * Install a perf counter breakpoint.
  99  *
 100  * We seek a free debug address register and use it for this
 101  * breakpoint. Eventually we enable it in the debug control register.
 102  *
 103  * Atomic: we hold the counter->ctx->lock and we only handle variables
 104  * and registers local to this cpu.
 105  */
 106 int arch_install_hw_breakpoint(struct perf_event *bp)
 107 {
 108         struct arch_hw_breakpoint *info = counter_arch_bp(bp);
 109         unsigned long *dr7;
 110         int i;
 111
 112         for (i = 0; i < HBP_NUM; i++) {
 113                 struct perf_event **slot = &__get_cpu_var(bp_per_reg[i]);
 114
 115                 if (!*slot) {
 116                         *slot = bp;
 117                         break;
 118                 }
 119         }
 120
 121         if (WARN_ONCE(i == HBP_NUM, "Can't find any breakpoint slot"))
 122                 return -EBUSY;
 123
 124         set_debugreg(info->address, i);
 125         __get_cpu_var(cpu_debugreg[i]) = info->address;
 126
 127         dr7 = &__get_cpu_var(cpu_dr7);
 128         *dr7 |= encode_dr7(i, info->len, info->type);
 129
 130         set_debugreg(*dr7, 7);
 131
 132         return 0;
 133 }
 134
 135 /*
 136  * Uninstall the breakpoint contained in the given counter.
 137  *
 138  * First we search the debug address register it uses and then we disable
 139  * it.
 140  *
 141  * Atomic: we hold the counter->ctx->lock and we only handle variables
 142  * and registers local to this cpu.
 143  */
 144 void arch_uninstall_hw_breakpoint(struct perf_event *bp)
 145 {
 146         struct arch_hw_breakpoint *info = counter_arch_bp(bp);
 147         unsigned long *dr7;
 148         int i;
 149
 150         for (i = 0; i < HBP_NUM; i++) {
 151                 struct perf_event **slot = &__get_cpu_var(bp_per_reg[i]);
 152
 153                 if (*slot == bp) {
 154                         *slot = NULL;
 155                         break;
 156                 }
 157         }
 158
 159         if (WARN_ONCE(i == HBP_NUM, "Can't find any breakpoint slot"))
 160                 return;
 161
 162         dr7 = &__get_cpu_var(cpu_dr7);
 163         *dr7 &= ~__encode_dr7(i, info->len, info->type);
 164
 165         set_debugreg(*dr7, 7);
 166 }
 167
 168 static int get_hbp_len(u8 hbp_len)
 169 {
 170         unsigned int len_in_bytes = 0;
 171
 172         switch (hbp_len) {
 173         case X86_BREAKPOINT_LEN_1:
 174                 len_in_bytes = 1;
 175                 break;
 176         case X86_BREAKPOINT_LEN_2:
 177                 len_in_bytes = 2;
 178                 break;
 179         case X86_BREAKPOINT_LEN_4:
 180                 len_in_bytes = 4;
 181                 break;
 182 #ifdef CONFIG_X86_64
 183         case X86_BREAKPOINT_LEN_8:
 184                 len_in_bytes = 8;
 185                 break;
 186 #endif
 187         }
 188         return len_in_bytes;
 189 }
 190
 191 /*
 192  * Check for virtual address in kernel space.
 193  */
 194 int arch_check_bp_in_kernelspace(struct perf_event *bp)
 195 {
 196         unsigned int len;
 197         unsigned long va;
 198         struct arch_hw_breakpoint *info = counter_arch_bp(bp);
 199
 200         va = info->address;
 201         len = get_hbp_len(info->len);
 202
 203         return (va >= TASK_SIZE) && ((va + len - 1) >= TASK_SIZE);
 204 }
 205
 206 int arch_bp_generic_fields(int x86_len, int x86_type,
 207                            int *gen_len, int *gen_type)
 208 {
 209         /* Len */
 210         switch (x86_len) {
 211         case X86_BREAKPOINT_LEN_1:
 212                 *gen_len = HW_BREAKPOINT_LEN_1;
 213                 break;
 214         case X86_BREAKPOINT_LEN_2:
 215                 *gen_len = HW_BREAKPOINT_LEN_2;
 216                 break;
 217         case X86_BREAKPOINT_LEN_4:
 218                 *gen_len = HW_BREAKPOINT_LEN_4;
 219                 break;
 220 #ifdef CONFIG_X86_64
 221         case X86_BREAKPOINT_LEN_8:
 222                 *gen_len = HW_BREAKPOINT_LEN_8;
 223                 break;
 224 #endif
 225         default:
 226                 return -EINVAL;
 227         }
 228
 229         /* Type */
 230         switch (x86_type) {
 231         case X86_BREAKPOINT_EXECUTE:
 232                 *gen_type = HW_BREAKPOINT_X;
 233                 break;
 234         case X86_BREAKPOINT_WRITE:
 235                 *gen_type = HW_BREAKPOINT_W;
 236                 break;
 237         case X86_BREAKPOINT_RW:
 238                 *gen_type = HW_BREAKPOINT_W | HW_BREAKPOINT_R;
 239                 break;
 240         default:
 241                 return -EINVAL;
 242         }
 243
 244         return 0;
 245 }
 246
 247
 248 static int arch_build_bp_info(struct perf_event *bp)
 249 {
 250         struct arch_hw_breakpoint *info = counter_arch_bp(bp);
 251
 252         info->address = bp->attr.bp_addr;
 253
 254         /* Len */
 255         switch (bp->attr.bp_len) {
 256         case HW_BREAKPOINT_LEN_1:
 257                 info->len = X86_BREAKPOINT_LEN_1;
 258                 break;
 259         case HW_BREAKPOINT_LEN_2:
 260                 info->len = X86_BREAKPOINT_LEN_2;
 261                 break;
 262         case HW_BREAKPOINT_LEN_4:
 263                 info->len = X86_BREAKPOINT_LEN_4;
 264                 break;
 265 #ifdef CONFIG_X86_64
 266         case HW_BREAKPOINT_LEN_8:
 267                 info->len = X86_BREAKPOINT_LEN_8;
 268                 break;
 269 #endif
 270         default:
 271                 return -EINVAL;
 272         }
 273
 274         /* Type */
 275         switch (bp->attr.bp_type) {
 276         case HW_BREAKPOINT_W:
 277                 info->type = X86_BREAKPOINT_WRITE;
 278                 break;
 279         case HW_BREAKPOINT_W | HW_BREAKPOINT_R:
 280                 info->type = X86_BREAKPOINT_RW;
 281                 break;
 282         case HW_BREAKPOINT_X:
 283                 info->type = X86_BREAKPOINT_EXECUTE;
 284                 break;
 285         default:
 286                 return -EINVAL;
 287         }
 288
 289         return 0;
 290 }
 291 /*
 292  * Validate the arch-specific HW Breakpoint register settings
 293  */
 294 int arch_validate_hwbkpt_settings(struct perf_event *bp)
 295 {
 296         struct arch_hw_breakpoint *info = counter_arch_bp(bp);
 297         unsigned int align;
 298         int ret;
 299
 300
 301         ret = arch_build_bp_info(bp);
 302         if (ret)
 303                 return ret;
 304
 305         ret = -EINVAL;
 306
 307         switch (info->len) {
 308         case X86_BREAKPOINT_LEN_1:
 309                 align = 0;
 310                 break;
 311         case X86_BREAKPOINT_LEN_2:
 312                 align = 1;
 313                 break;
 314         case X86_BREAKPOINT_LEN_4:
 315                 align = 3;
 316                 break;
 317 #ifdef CONFIG_X86_64
 318         case X86_BREAKPOINT_LEN_8:
 319                 align = 7;
 320                 break;
 321 #endif
 322         default:
 323                 return ret;
 324         }
 325
 326         /*
 327          * Check that the low-order bits of the address are appropriate
 328          * for the alignment implied by len.
 329          */
 330         if (info->address & align)
 331                 return -EINVAL;
 332
 333         return 0;
 334 }
 335
 336 /*
 337  * Dump the debug register contents to the user.
 338  * We can't dump our per cpu values because it
 339  * may contain cpu wide breakpoint, something that
 340  * doesn't belong to the current task.
 341  *
 342  * TODO: include non-ptrace user breakpoints (perf)
 343  */
 344 void aout_dump_debugregs(struct user *dump)
 345 {
 346         int i;
 347         int dr7 = 0;
 348         struct perf_event *bp;
 349         struct arch_hw_breakpoint *info;
 350         struct thread_struct *thread = &current->thread;
 351
 352         for (i = 0; i < HBP_NUM; i++) {
 353                 bp = thread->ptrace_bps[i];
 354
 355                 if (bp && !bp->attr.disabled) {
 356                         dump->u_debugreg[i] = bp->attr.bp_addr;
 357                         info = counter_arch_bp(bp);
 358                         dr7 |= encode_dr7(i, info->len, info->type);
 359                 } else {
 360                         dump->u_debugreg[i] = 0;
 361                 }
 362         }
 363
 364         dump->u_debugreg[4] = 0;
 365         dump->u_debugreg[5] = 0;
 366         dump->u_debugreg[6] = current->thread.debugreg6;
 367
 368         dump->u_debugreg[7] = dr7;
 369 }
 370 EXPORT_SYMBOL_GPL(aout_dump_debugregs);
 371
 372 /*
 373  * Release the user breakpoints used by ptrace
 374  */
 375 void flush_ptrace_hw_breakpoint(struct task_struct *tsk)
 376 {
 377         int i;
 378         struct thread_struct *t = &tsk->thread;
 379
 380         for (i = 0; i < HBP_NUM; i++) {
 381                 unregister_hw_breakpoint(t->ptrace_bps[i]);
 382                 t->ptrace_bps[i] = NULL;
 383         }
 384 }
 385
 386 void hw_breakpoint_restore(void)
 387 {
 388         set_debugreg(__get_cpu_var(cpu_debugreg[0]), 0);
 389         set_debugreg(__get_cpu_var(cpu_debugreg[1]), 1);
 390         set_debugreg(__get_cpu_var(cpu_debugreg[2]), 2);
 391         set_debugreg(__get_cpu_var(cpu_debugreg[3]), 3);
 392         set_debugreg(current->thread.debugreg6, 6);
 393         set_debugreg(__get_cpu_var(cpu_dr7), 7);
 394 }
 395 EXPORT_SYMBOL_GPL(hw_breakpoint_restore);
 396
 397 /*
 398  * Handle debug exception notifications.
 399  *
 400  * Return value is either NOTIFY_STOP or NOTIFY_DONE as explained below.
 401  *
 402  * NOTIFY_DONE returned if one of the following conditions is true.
 403  * i) When the causative address is from user-space and the exception
 404  * is a valid one, i.e. not triggered as a result of lazy debug register
 405  * switching
 406  * ii) When there are more bits than trap<n> set in DR6 register (such
 407  * as BD, BS or BT) indicating that more than one debug condition is
 408  * met and requires some more action in do_debug().
 409  *
 410  * NOTIFY_STOP returned for all other cases
 411  *
 412  */
 413 static int __kprobes hw_breakpoint_handler(struct die_args *args)
 414 {
 415         int i, cpu, rc = NOTIFY_STOP;
 416         struct perf_event *bp;
 417         unsigned long dr7, dr6;
 418         unsigned long *dr6_p;
 419
 420         /* The DR6 value is pointed by args->err */
 421         dr6_p = (unsigned long *)ERR_PTR(args->err);
 422         dr6 = *dr6_p;
 423
 424         /* Do an early return if no trap bits are set in DR6 */
 425         if ((dr6 & DR_TRAP_BITS) == 0)
 426                 return NOTIFY_DONE;
 427
 428         get_debugreg(dr7, 7);
 429         /* Disable breakpoints during exception handling */
 430         set_debugreg(0UL, 7);
 431         /*
 432          * Assert that local interrupts are disabled
 433          * Reset the DRn bits in the virtualized register value.
 434          * The ptrace trigger routine will add in whatever is needed.
 435          */
 436         current->thread.debugreg6 &= ~DR_TRAP_BITS;
 437         cpu = get_cpu();
 438
 439         /* Handle all the breakpoints that were triggered */
 440         for (i = 0; i < HBP_NUM; ++i) {
 441                 if (likely(!(dr6 & (DR_TRAP0 << i))))
 442                         continue;
 443
 444                 /*
 445                  * The counter may be concurrently released but that can only
 446                  * occur from a call_rcu() path. We can then safely fetch
 447                  * the breakpoint, use its callback, touch its counter
 448                  * while we are in an rcu_read_lock() path.
 449                  */
 450                 rcu_read_lock();
 451
 452                 bp = per_cpu(bp_per_reg[i], cpu);
 453                 /*
 454                  * Reset the 'i'th TRAP bit in dr6 to denote completion of
 455                  * exception handling
 456                  */
 457                 (*dr6_p) &= ~(DR_TRAP0 << i);
 458                 /*
 459                  * bp can be NULL due to lazy debug register switching
 460                  * or due to concurrent perf counter removing.
 461                  */
 462                 if (!bp) {
 463                         rcu_read_unlock();
 464                         break;
 465                 }
 466
 467                 perf_bp_event(bp, args->regs);
 468
 469                 rcu_read_unlock();
 470         }
 471         /*
 472          * Further processing in do_debug() is needed for a) user-space
 473          * breakpoints (to generate signals) and b) when the system has
 474          * taken exception due to multiple causes
 475          */
 476         if ((current->thread.debugreg6 & DR_TRAP_BITS) ||
 477             (dr6 & (~DR_TRAP_BITS)))
 478                 rc = NOTIFY_DONE;
 479
 480         set_debugreg(dr7, 7);
 481         put_cpu();
 482
 483         return rc;
 484 }
 485
 486 /*
 487  * Handle debug exception notifications.
 488  */
 489 int __kprobes hw_breakpoint_exceptions_notify(
 490                 struct notifier_block *unused, unsigned long val, void *data)
 491 {
 492         if (val != DIE_DEBUG)
 493                 return NOTIFY_DONE;
 494
 495         return hw_breakpoint_handler(data);
 496 }
 497
 498 void hw_breakpoint_pmu_read(struct perf_event *bp)
 499 {
 500         /* TODO */
 501 }