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) IBM Corporation, 2009
  18  * Copyright (C) 2009, Frederic Weisbecker <fweisbec@gmail.com>
  19  *
  20  * Thanks to Ingo Molnar for his many suggestions.
  21  *
  22  * Authors: Alan Stern <stern@rowland.harvard.edu>
  23  *          K.Prasad <prasad@linux.vnet.ibm.com>
  24  *          Frederic Weisbecker <fweisbec@gmail.com>
  25  */
  26
  27 /*
  28  * HW_breakpoint: a unified kernel/user-space hardware breakpoint facility,
  29  * using the CPU's debug registers.
  30  * This file contains the arch-independent routines.
  31  */
  32
  33 #include <linux/irqflags.h>
  34 #include <linux/kallsyms.h>
  35 #include <linux/notifier.h>
  36 #include <linux/kprobes.h>
  37 #include <linux/kdebug.h>
  38 #include <linux/kernel.h>
  39 #include <linux/module.h>
  40 #include <linux/percpu.h>
  41 #include <linux/sched.h>
  42 #include <linux/init.h>
  43 #include <linux/slab.h>
  44 #include <linux/cpu.h>
  45 #include <linux/smp.h>
  46
  47 #include <linux/hw_breakpoint.h>
  48
  49
  50 /*
  51  * Constraints data
  52  */
  53
  54 /* Number of pinned cpu breakpoints in a cpu */
  55 static DEFINE_PER_CPU(unsigned int, nr_cpu_bp_pinned[TYPE_MAX]);
  56
  57 /* Number of pinned task breakpoints in a cpu */
  58 static DEFINE_PER_CPU(unsigned int *, nr_task_bp_pinned[TYPE_MAX]);
  59
  60 /* Number of non-pinned cpu/task breakpoints in a cpu */
  61 static DEFINE_PER_CPU(unsigned int, nr_bp_flexible[TYPE_MAX]);
  62
  63 static int nr_slots[TYPE_MAX];
  64
  65 static int constraints_initialized;
  66
  67 /* Gather the number of total pinned and un-pinned bp in a cpuset */
  68 struct bp_busy_slots {
  69         unsigned int pinned;
  70         unsigned int flexible;
  71 };
  72
  73 /* Serialize accesses to the above constraints */
  74 static DEFINE_MUTEX(nr_bp_mutex);
  75
  76 __weak int hw_breakpoint_weight(struct perf_event *bp)
  77 {
  78         return 1;
  79 }
  80
  81 static inline enum bp_type_idx find_slot_idx(struct perf_event *bp)
  82 {
  83         if (bp->attr.bp_type & HW_BREAKPOINT_RW)
  84                 return TYPE_DATA;
  85
  86         return TYPE_INST;
  87 }
  88
  89 /*
  90  * Report the maximum number of pinned breakpoints a task
  91  * have in this cpu
  92  */
  93 static unsigned int max_task_bp_pinned(int cpu, enum bp_type_idx type)
  94 {
  95         int i;
  96         unsigned int *tsk_pinned = per_cpu(nr_task_bp_pinned[type], cpu);
  97
  98         for (i = nr_slots[type] - 1; i >= 0; i--) {
  99                 if (tsk_pinned[i] > 0)
 100                         return i + 1;
 101         }
 102
 103         return 0;
 104 }
 105
 106 static int task_bp_pinned(struct task_struct *tsk, enum bp_type_idx type)
 107 {
 108         struct perf_event_context *ctx = tsk->perf_event_ctxp;
 109         struct list_head *list;
 110         struct perf_event *bp;
 111         unsigned long flags;
 112         int count = 0;
 113
 114         if (WARN_ONCE(!ctx, "No perf context for this task"))
 115                 return 0;
 116
 117         list = &ctx->event_list;
 118
 119         raw_spin_lock_irqsave(&ctx->lock, flags);
 120
 121         /*
 122          * The current breakpoint counter is not included in the list
 123          * at the open() callback time
 124          */
 125         list_for_each_entry(bp, list, event_entry) {
 126                 if (bp->attr.type == PERF_TYPE_BREAKPOINT)
 127                         if (find_slot_idx(bp) == type)
 128                                 count += hw_breakpoint_weight(bp);
 129         }
 130
 131         raw_spin_unlock_irqrestore(&ctx->lock, flags);
 132
 133         return count;
 134 }
 135
 136 /*
 137  * Report the number of pinned/un-pinned breakpoints we have in
 138  * a given cpu (cpu > -1) or in all of them (cpu = -1).
 139  */
 140 static void
 141 fetch_bp_busy_slots(struct bp_busy_slots *slots, struct perf_event *bp,
 142                     enum bp_type_idx type)
 143 {
 144         int cpu = bp->cpu;
 145         struct task_struct *tsk = bp->ctx->task;
 146
 147         if (cpu >= 0) {
 148                 slots->pinned = per_cpu(nr_cpu_bp_pinned[type], cpu);
 149                 if (!tsk)
 150                         slots->pinned += max_task_bp_pinned(cpu, type);
 151                 else
 152                         slots->pinned += task_bp_pinned(tsk, type);
 153                 slots->flexible = per_cpu(nr_bp_flexible[type], cpu);
 154
 155                 return;
 156         }
 157
 158         for_each_online_cpu(cpu) {
 159                 unsigned int nr;
 160
 161                 nr = per_cpu(nr_cpu_bp_pinned[type], cpu);
 162                 if (!tsk)
 163                         nr += max_task_bp_pinned(cpu, type);
 164                 else
 165                         nr += task_bp_pinned(tsk, type);
 166
 167                 if (nr > slots->pinned)
 168                         slots->pinned = nr;
 169
 170                 nr = per_cpu(nr_bp_flexible[type], cpu);
 171
 172                 if (nr > slots->flexible)
 173                         slots->flexible = nr;
 174         }
 175 }
 176
 177 /*
 178  * For now, continue to consider flexible as pinned, until we can
 179  * ensure no flexible event can ever be scheduled before a pinned event
 180  * in a same cpu.
 181  */
 182 static void
 183 fetch_this_slot(struct bp_busy_slots *slots, int weight)
 184 {
 185         slots->pinned += weight;
 186 }
 187
 188 /*
 189  * Add a pinned breakpoint for the given task in our constraint table
 190  */
 191 static void toggle_bp_task_slot(struct task_struct *tsk, int cpu, bool enable,
 192                                 enum bp_type_idx type, int weight)
 193 {
 194         unsigned int *tsk_pinned;
 195         int old_count = 0;
 196         int old_idx = 0;
 197         int idx = 0;
 198
 199         old_count = task_bp_pinned(tsk, type);
 200         old_idx = old_count - 1;
 201         idx = old_idx + weight;
 202
 203         tsk_pinned = per_cpu(nr_task_bp_pinned[type], cpu);
 204         if (enable) {
 205                 tsk_pinned[idx]++;
 206                 if (old_count > 0)
 207                         tsk_pinned[old_idx]--;
 208         } else {
 209                 tsk_pinned[idx]--;
 210                 if (old_count > 0)
 211                         tsk_pinned[old_idx]++;
 212         }
 213 }
 214
 215 /*
 216  * Add/remove the given breakpoint in our constraint table
 217  */
 218 static void
 219 toggle_bp_slot(struct perf_event *bp, bool enable, enum bp_type_idx type,
 220                int weight)
 221 {
 222         int cpu = bp->cpu;
 223         struct task_struct *tsk = bp->ctx->task;
 224
 225         /* Pinned counter task profiling */
 226         if (tsk) {
 227                 if (cpu >= 0) {
 228                         toggle_bp_task_slot(tsk, cpu, enable, type, weight);
 229                         return;
 230                 }
 231
 232                 for_each_online_cpu(cpu)
 233                         toggle_bp_task_slot(tsk, cpu, enable, type, weight);
 234                 return;
 235         }
 236
 237         /* Pinned counter cpu profiling */
 238         if (enable)
 239                 per_cpu(nr_cpu_bp_pinned[type], bp->cpu) += weight;
 240         else
 241                 per_cpu(nr_cpu_bp_pinned[type], bp->cpu) -= weight;
 242 }
 243
 244 /*
 245  * Function to perform processor-specific cleanup during unregistration
 246  */
 247 __weak void arch_unregister_hw_breakpoint(struct perf_event *bp)
 248 {
 249         /*
 250          * A weak stub function here for those archs that don't define
 251          * it inside arch/.../kernel/hw_breakpoint.c
 252          */
 253 }
 254
 255 /*
 256  * Contraints to check before allowing this new breakpoint counter:
 257  *
 258  *  == Non-pinned counter == (Considered as pinned for now)
 259  *
 260  *   - If attached to a single cpu, check:
 261  *
 262  *       (per_cpu(nr_bp_flexible, cpu) || (per_cpu(nr_cpu_bp_pinned, cpu)
 263  *           + max(per_cpu(nr_task_bp_pinned, cpu)))) < HBP_NUM
 264  *
 265  *       -> If there are already non-pinned counters in this cpu, it means
 266  *          there is already a free slot for them.
 267  *          Otherwise, we check that the maximum number of per task
 268  *          breakpoints (for this cpu) plus the number of per cpu breakpoint
 269  *          (for this cpu) doesn't cover every registers.
 270  *
 271  *   - If attached to every cpus, check:
 272  *
 273  *       (per_cpu(nr_bp_flexible, *) || (max(per_cpu(nr_cpu_bp_pinned, *))
 274  *           + max(per_cpu(nr_task_bp_pinned, *)))) < HBP_NUM
 275  *
 276  *       -> This is roughly the same, except we check the number of per cpu
 277  *          bp for every cpu and we keep the max one. Same for the per tasks
 278  *          breakpoints.
 279  *
 280  *
 281  * == Pinned counter ==
 282  *
 283  *   - If attached to a single cpu, check:
 284  *
 285  *       ((per_cpu(nr_bp_flexible, cpu) > 1) + per_cpu(nr_cpu_bp_pinned, cpu)
 286  *            + max(per_cpu(nr_task_bp_pinned, cpu))) < HBP_NUM
 287  *
 288  *       -> Same checks as before. But now the nr_bp_flexible, if any, must keep
 289  *          one register at least (or they will never be fed).
 290  *
 291  *   - If attached to every cpus, check:
 292  *
 293  *       ((per_cpu(nr_bp_flexible, *) > 1) + max(per_cpu(nr_cpu_bp_pinned, *))
 294  *            + max(per_cpu(nr_task_bp_pinned, *))) < HBP_NUM
 295  */
 296 static int __reserve_bp_slot(struct perf_event *bp)
 297 {
 298         struct bp_busy_slots slots = {0};
 299         enum bp_type_idx type;
 300         int weight;
 301
 302         /* We couldn't initialize breakpoint constraints on boot */
 303         if (!constraints_initialized)
 304                 return -ENOMEM;
 305
 306         /* Basic checks */
 307         if (bp->attr.bp_type == HW_BREAKPOINT_EMPTY ||
 308             bp->attr.bp_type == HW_BREAKPOINT_INVALID)
 309                 return -EINVAL;
 310
 311         type = find_slot_idx(bp);
 312         weight = hw_breakpoint_weight(bp);
 313
 314         fetch_bp_busy_slots(&slots, bp, type);
 315         fetch_this_slot(&slots, weight);
 316
 317         /* Flexible counters need to keep at least one slot */
 318         if (slots.pinned + (!!slots.flexible) > nr_slots[type])
 319                 return -ENOSPC;
 320
 321         toggle_bp_slot(bp, true, type, weight);
 322
 323         return 0;
 324 }
 325
 326 int reserve_bp_slot(struct perf_event *bp)
 327 {
 328         int ret;
 329
 330         mutex_lock(&nr_bp_mutex);
 331
 332         ret = __reserve_bp_slot(bp);
 333
 334         mutex_unlock(&nr_bp_mutex);
 335
 336         return ret;
 337 }
 338
 339 static void __release_bp_slot(struct perf_event *bp)
 340 {
 341         enum bp_type_idx type;
 342         int weight;
 343
 344         type = find_slot_idx(bp);
 345         weight = hw_breakpoint_weight(bp);
 346         toggle_bp_slot(bp, false, type, weight);
 347 }
 348
 349 void release_bp_slot(struct perf_event *bp)
 350 {
 351         mutex_lock(&nr_bp_mutex);
 352
 353         arch_unregister_hw_breakpoint(bp);
 354         __release_bp_slot(bp);
 355
 356         mutex_unlock(&nr_bp_mutex);
 357 }
 358
 359 /*
 360  * Allow the kernel debugger to reserve breakpoint slots without
 361  * taking a lock using the dbg_* variant of for the reserve and
 362  * release breakpoint slots.
 363  */
 364 int dbg_reserve_bp_slot(struct perf_event *bp)
 365 {
 366         if (mutex_is_locked(&nr_bp_mutex))
 367                 return -1;
 368
 369         return __reserve_bp_slot(bp);
 370 }
 371
 372 int dbg_release_bp_slot(struct perf_event *bp)
 373 {
 374         if (mutex_is_locked(&nr_bp_mutex))
 375                 return -1;
 376
 377         __release_bp_slot(bp);
 378
 379         return 0;
 380 }
 381
 382 static int validate_hw_breakpoint(struct perf_event *bp)
 383 {
 384         int ret;
 385
 386         ret = arch_validate_hwbkpt_settings(bp);
 387         if (ret)
 388                 return ret;
 389
 390         if (arch_check_bp_in_kernelspace(bp)) {
 391                 if (bp->attr.exclude_kernel)
 392                         return -EINVAL;
 393                 /*
 394                  * Don't let unprivileged users set a breakpoint in the trap
 395                  * path to avoid trap recursion attacks.
 396                  */
 397                 if (!capable(CAP_SYS_ADMIN))
 398                         return -EPERM;
 399         }
 400
 401         return 0;
 402 }
 403
 404 int register_perf_hw_breakpoint(struct perf_event *bp)
 405 {
 406         int ret;
 407
 408         ret = reserve_bp_slot(bp);
 409         if (ret)
 410                 return ret;
 411
 412         ret = validate_hw_breakpoint(bp);
 413
 414         /* if arch_validate_hwbkpt_settings() fails then release bp slot */
 415         if (ret)
 416                 release_bp_slot(bp);
 417
 418         return ret;
 419 }
 420
 421 /**
 422  * register_user_hw_breakpoint - register a hardware breakpoint for user space
 423  * @attr: breakpoint attributes
 424  * @triggered: callback to trigger when we hit the breakpoint
 425  * @tsk: pointer to 'task_struct' of the process to which the address belongs
 426  */
 427 struct perf_event *
 428 register_user_hw_breakpoint(struct perf_event_attr *attr,
 429                             perf_overflow_handler_t triggered,
 430                             struct task_struct *tsk)
 431 {
 432         return perf_event_create_kernel_counter(attr, -1, tsk->pid, triggered);
 433 }
 434 EXPORT_SYMBOL_GPL(register_user_hw_breakpoint);
 435
 436 /**
 437  * modify_user_hw_breakpoint - modify a user-space hardware breakpoint
 438  * @bp: the breakpoint structure to modify
 439  * @attr: new breakpoint attributes
 440  * @triggered: callback to trigger when we hit the breakpoint
 441  * @tsk: pointer to 'task_struct' of the process to which the address belongs
 442  */
 443 int modify_user_hw_breakpoint(struct perf_event *bp, struct perf_event_attr *attr)
 444 {
 445         u64 old_addr = bp->attr.bp_addr;
 446         u64 old_len = bp->attr.bp_len;
 447         int old_type = bp->attr.bp_type;
 448         int err = 0;
 449
 450         perf_event_disable(bp);
 451
 452         bp->attr.bp_addr = attr->bp_addr;
 453         bp->attr.bp_type = attr->bp_type;
 454         bp->attr.bp_len = attr->bp_len;
 455
 456         if (attr->disabled)
 457                 goto end;
 458
 459         err = validate_hw_breakpoint(bp);
 460         if (!err)
 461                 perf_event_enable(bp);
 462
 463         if (err) {
 464                 bp->attr.bp_addr = old_addr;
 465                 bp->attr.bp_type = old_type;
 466                 bp->attr.bp_len = old_len;
 467                 if (!bp->attr.disabled)
 468                         perf_event_enable(bp);
 469
 470                 return err;
 471         }
 472
 473 end:
 474         bp->attr.disabled = attr->disabled;
 475
 476         return 0;
 477 }
 478 EXPORT_SYMBOL_GPL(modify_user_hw_breakpoint);
 479
 480 /**
 481  * unregister_hw_breakpoint - unregister a user-space hardware breakpoint
 482  * @bp: the breakpoint structure to unregister
 483  */
 484 void unregister_hw_breakpoint(struct perf_event *bp)
 485 {
 486         if (!bp)
 487                 return;
 488         perf_event_release_kernel(bp);
 489 }
 490 EXPORT_SYMBOL_GPL(unregister_hw_breakpoint);
 491
 492 /**
 493  * register_wide_hw_breakpoint - register a wide breakpoint in the kernel
 494  * @attr: breakpoint attributes
 495  * @triggered: callback to trigger when we hit the breakpoint
 496  *
 497  * @return a set of per_cpu pointers to perf events
 498  */
 499 struct perf_event * __percpu *
 500 register_wide_hw_breakpoint(struct perf_event_attr *attr,
 501                             perf_overflow_handler_t triggered)
 502 {
 503         struct perf_event * __percpu *cpu_events, **pevent, *bp;
 504         long err;
 505         int cpu;
 506
 507         cpu_events = alloc_percpu(typeof(*cpu_events));
 508         if (!cpu_events)
 509                 return (void __percpu __force *)ERR_PTR(-ENOMEM);
 510
 511         get_online_cpus();
 512         for_each_online_cpu(cpu) {
 513                 pevent = per_cpu_ptr(cpu_events, cpu);
 514                 bp = perf_event_create_kernel_counter(attr, cpu, -1, triggered);
 515
 516                 *pevent = bp;
 517
 518                 if (IS_ERR(bp)) {
 519                         err = PTR_ERR(bp);
 520                         goto fail;
 521                 }
 522         }
 523         put_online_cpus();
 524
 525         return cpu_events;
 526
 527 fail:
 528         for_each_online_cpu(cpu) {
 529                 pevent = per_cpu_ptr(cpu_events, cpu);
 530                 if (IS_ERR(*pevent))
 531                         break;
 532                 unregister_hw_breakpoint(*pevent);
 533         }
 534         put_online_cpus();
 535
 536         free_percpu(cpu_events);
 537         return (void __percpu __force *)ERR_PTR(err);
 538 }
 539 EXPORT_SYMBOL_GPL(register_wide_hw_breakpoint);
 540
 541 /**
 542  * unregister_wide_hw_breakpoint - unregister a wide breakpoint in the kernel
 543  * @cpu_events: the per cpu set of events to unregister
 544  */
 545 void unregister_wide_hw_breakpoint(struct perf_event * __percpu *cpu_events)
 546 {
 547         int cpu;
 548         struct perf_event **pevent;
 549
 550         for_each_possible_cpu(cpu) {
 551                 pevent = per_cpu_ptr(cpu_events, cpu);
 552                 unregister_hw_breakpoint(*pevent);
 553         }
 554         free_percpu(cpu_events);
 555 }
 556 EXPORT_SYMBOL_GPL(unregister_wide_hw_breakpoint);
 557
 558 static struct notifier_block hw_breakpoint_exceptions_nb = {
 559         .notifier_call = hw_breakpoint_exceptions_notify,
 560         /* we need to be notified first */
 561         .priority = 0x7fffffff
 562 };
 563
 564 static int __init init_hw_breakpoint(void)
 565 {
 566         unsigned int **task_bp_pinned;
 567         int cpu, err_cpu;
 568         int i;
 569
 570         for (i = 0; i < TYPE_MAX; i++)
 571                 nr_slots[i] = hw_breakpoint_slots(i);
 572
 573         for_each_possible_cpu(cpu) {
 574                 for (i = 0; i < TYPE_MAX; i++) {
 575                         task_bp_pinned = &per_cpu(nr_task_bp_pinned[i], cpu);
 576                         *task_bp_pinned = kzalloc(sizeof(int) * nr_slots[i],
 577                                                   GFP_KERNEL);
 578                         if (!*task_bp_pinned)
 579                                 goto err_alloc;
 580                 }
 581         }
 582
 583         constraints_initialized = 1;
 584
 585         return register_die_notifier(&hw_breakpoint_exceptions_nb);
 586
 587  err_alloc:
 588         for_each_possible_cpu(err_cpu) {
 589                 if (err_cpu == cpu)
 590                         break;
 591                 for (i = 0; i < TYPE_MAX; i++)
 592                         kfree(per_cpu(nr_task_bp_pinned[i], cpu));
 593         }
 594
 595         return -ENOMEM;
 596 }
 597 core_initcall(init_hw_breakpoint);
 598
 599
 600 struct pmu perf_ops_bp = {
 601         .enable         = arch_install_hw_breakpoint,
 602         .disable        = arch_uninstall_hw_breakpoint,
 603         .read           = hw_breakpoint_pmu_read,
 604 };