arch/arm/kernel/perf_event.c

   1 #undef DEBUG
   2
   3 /*
   4  * ARM performance counter support.
   5  *
   6  * Copyright (C) 2009 picoChip Designs, Ltd., Jamie Iles
   7  * Copyright (C) 2010 ARM Ltd., Will Deacon <will.deacon@arm.com>
   8  *
   9  * This code is based on the sparc64 perf event code, which is in turn based
  10  * on the x86 code. Callchain code is based on the ARM OProfile backtrace
  11  * code.
  12  */
  13 #define pr_fmt(fmt) "hw perfevents: " fmt
  14
  15 #include <linux/kernel.h>
  16 #include <linux/platform_device.h>
  17 #include <linux/pm_runtime.h>
  18 #include <linux/uaccess.h>
  19
  20 #include <asm/irq_regs.h>
  21 #include <asm/pmu.h>
  22 #include <asm/stacktrace.h>
  23
  24 static int
  25 armpmu_map_cache_event(const unsigned (*cache_map)
  26                                       [PERF_COUNT_HW_CACHE_MAX]
  27                                       [PERF_COUNT_HW_CACHE_OP_MAX]
  28                                       [PERF_COUNT_HW_CACHE_RESULT_MAX],
  29                        u64 config)
  30 {
  31         unsigned int cache_type, cache_op, cache_result, ret;
  32
  33         cache_type = (config >>  0) & 0xff;
  34         if (cache_type >= PERF_COUNT_HW_CACHE_MAX)
  35                 return -EINVAL;
  36
  37         cache_op = (config >>  8) & 0xff;
  38         if (cache_op >= PERF_COUNT_HW_CACHE_OP_MAX)
  39                 return -EINVAL;
  40
  41         cache_result = (config >> 16) & 0xff;
  42         if (cache_result >= PERF_COUNT_HW_CACHE_RESULT_MAX)
  43                 return -EINVAL;
  44
  45         ret = (int)(*cache_map)[cache_type][cache_op][cache_result];
  46
  47         if (ret == CACHE_OP_UNSUPPORTED)
  48                 return -ENOENT;
  49
  50         return ret;
  51 }
  52
  53 static int
  54 armpmu_map_hw_event(const unsigned (*event_map)[PERF_COUNT_HW_MAX], u64 config)
  55 {
  56         int mapping;
  57
  58         if (config >= PERF_COUNT_HW_MAX)
  59                 return -EINVAL;
  60
  61         mapping = (*event_map)[config];
  62         return mapping == HW_OP_UNSUPPORTED ? -ENOENT : mapping;
  63 }
  64
  65 static int
  66 armpmu_map_raw_event(u32 raw_event_mask, u64 config)
  67 {
  68         return (int)(config & raw_event_mask);
  69 }
  70
  71 int
  72 armpmu_map_event(struct perf_event *event,
  73                  const unsigned (*event_map)[PERF_COUNT_HW_MAX],
  74                  const unsigned (*cache_map)
  75                                 [PERF_COUNT_HW_CACHE_MAX]
  76                                 [PERF_COUNT_HW_CACHE_OP_MAX]
  77                                 [PERF_COUNT_HW_CACHE_RESULT_MAX],
  78                  u32 raw_event_mask)
  79 {
  80         u64 config = event->attr.config;
  81
  82         switch (event->attr.type) {
  83         case PERF_TYPE_HARDWARE:
  84                 return armpmu_map_hw_event(event_map, config);
  85         case PERF_TYPE_HW_CACHE:
  86                 return armpmu_map_cache_event(cache_map, config);
  87         case PERF_TYPE_RAW:
  88                 return armpmu_map_raw_event(raw_event_mask, config);
  89         }
  90
  91         return -ENOENT;
  92 }
  93
  94 int armpmu_event_set_period(struct perf_event *event)
  95 {
  96         struct arm_pmu *armpmu = to_arm_pmu(event->pmu);
  97         struct hw_perf_event *hwc = &event->hw;
  98         s64 left = local64_read(&hwc->period_left);
  99         s64 period = hwc->sample_period;
 100         int ret = 0;
 101
 102         /* The period may have been changed by PERF_EVENT_IOC_PERIOD */
 103         if (unlikely(period != hwc->last_period))
 104                 left = period - (hwc->last_period - left);
 105
 106         if (unlikely(left <= -period)) {
 107                 left = period;
 108                 local64_set(&hwc->period_left, left);
 109                 hwc->last_period = period;
 110                 ret = 1;
 111         }
 112
 113         if (unlikely(left <= 0)) {
 114                 left += period;
 115                 local64_set(&hwc->period_left, left);
 116                 hwc->last_period = period;
 117                 ret = 1;
 118         }
 119
 120         if (left > (s64)armpmu->max_period)
 121                 left = armpmu->max_period;
 122
 123         local64_set(&hwc->prev_count, (u64)-left);
 124
 125         armpmu->write_counter(event, (u64)(-left) & 0xffffffff);
 126
 127         perf_event_update_userpage(event);
 128
 129         return ret;
 130 }
 131
 132 u64 armpmu_event_update(struct perf_event *event)
 133 {
 134         struct arm_pmu *armpmu = to_arm_pmu(event->pmu);
 135         struct hw_perf_event *hwc = &event->hw;
 136         u64 delta, prev_raw_count, new_raw_count;
 137
 138 again:
 139         prev_raw_count = local64_read(&hwc->prev_count);
 140         new_raw_count = armpmu->read_counter(event);
 141
 142         if (local64_cmpxchg(&hwc->prev_count, prev_raw_count,
 143                              new_raw_count) != prev_raw_count)
 144                 goto again;
 145
 146         delta = (new_raw_count - prev_raw_count) & armpmu->max_period;
 147
 148         local64_add(delta, &event->count);
 149         local64_sub(delta, &hwc->period_left);
 150
 151         return new_raw_count;
 152 }
 153
 154 static void
 155 armpmu_read(struct perf_event *event)
 156 {
 157         armpmu_event_update(event);
 158 }
 159
 160 static void
 161 armpmu_stop(struct perf_event *event, int flags)
 162 {
 163         struct arm_pmu *armpmu = to_arm_pmu(event->pmu);
 164         struct hw_perf_event *hwc = &event->hw;
 165
 166         /*
 167          * ARM pmu always has to update the counter, so ignore
 168          * PERF_EF_UPDATE, see comments in armpmu_start().
 169          */
 170         if (!(hwc->state & PERF_HES_STOPPED)) {
 171                 armpmu->disable(event);
 172                 armpmu_event_update(event);
 173                 hwc->state |= PERF_HES_STOPPED | PERF_HES_UPTODATE;
 174         }
 175 }
 176
 177 static void armpmu_start(struct perf_event *event, int flags)
 178 {
 179         struct arm_pmu *armpmu = to_arm_pmu(event->pmu);
 180         struct hw_perf_event *hwc = &event->hw;
 181
 182         /*
 183          * ARM pmu always has to reprogram the period, so ignore
 184          * PERF_EF_RELOAD, see the comment below.
 185          */
 186         if (flags & PERF_EF_RELOAD)
 187                 WARN_ON_ONCE(!(hwc->state & PERF_HES_UPTODATE));
 188
 189         hwc->state = 0;
 190         /*
 191          * Set the period again. Some counters can't be stopped, so when we
 192          * were stopped we simply disabled the IRQ source and the counter
 193          * may have been left counting. If we don't do this step then we may
 194          * get an interrupt too soon or *way* too late if the overflow has
 195          * happened since disabling.
 196          */
 197         armpmu_event_set_period(event);
 198         armpmu->enable(event);
 199 }
 200
 201 static void
 202 armpmu_del(struct perf_event *event, int flags)
 203 {
 204         struct arm_pmu *armpmu = to_arm_pmu(event->pmu);
 205         struct pmu_hw_events *hw_events = armpmu->get_hw_events();
 206         struct hw_perf_event *hwc = &event->hw;
 207         int idx = hwc->idx;
 208
 209         armpmu_stop(event, PERF_EF_UPDATE);
 210         hw_events->events[idx] = NULL;
 211         clear_bit(idx, hw_events->used_mask);
 212
 213         perf_event_update_userpage(event);
 214 }
 215
 216 static int
 217 armpmu_add(struct perf_event *event, int flags)
 218 {
 219         struct arm_pmu *armpmu = to_arm_pmu(event->pmu);
 220         struct pmu_hw_events *hw_events = armpmu->get_hw_events();
 221         struct hw_perf_event *hwc = &event->hw;
 222         int idx;
 223         int err = 0;
 224
 225         perf_pmu_disable(event->pmu);
 226
 227         /* If we don't have a space for the counter then finish early. */
 228         idx = armpmu->get_event_idx(hw_events, event);
 229         if (idx < 0) {
 230                 err = idx;
 231                 goto out;
 232         }
 233
 234         /*
 235          * If there is an event in the counter we are going to use then make
 236          * sure it is disabled.
 237          */
 238         event->hw.idx = idx;
 239         armpmu->disable(event);
 240         hw_events->events[idx] = event;
 241
 242         hwc->state = PERF_HES_STOPPED | PERF_HES_UPTODATE;
 243         if (flags & PERF_EF_START)
 244                 armpmu_start(event, PERF_EF_RELOAD);
 245
 246         /* Propagate our changes to the userspace mapping. */
 247         perf_event_update_userpage(event);
 248
 249 out:
 250         perf_pmu_enable(event->pmu);
 251         return err;
 252 }
 253
 254 static int
 255 validate_event(struct pmu_hw_events *hw_events,
 256                struct perf_event *event)
 257 {
 258         struct arm_pmu *armpmu = to_arm_pmu(event->pmu);
 259         struct pmu *leader_pmu = event->group_leader->pmu;
 260
 261         if (is_software_event(event))
 262                 return 1;
 263
 264         if (event->pmu != leader_pmu || event->state < PERF_EVENT_STATE_OFF)
 265                 return 1;
 266
 267         if (event->state == PERF_EVENT_STATE_OFF && !event->attr.enable_on_exec)
 268                 return 1;
 269
 270         return armpmu->get_event_idx(hw_events, event) >= 0;
 271 }
 272
 273 static int
 274 validate_group(struct perf_event *event)
 275 {
 276         struct perf_event *sibling, *leader = event->group_leader;
 277         struct pmu_hw_events fake_pmu;
 278         DECLARE_BITMAP(fake_used_mask, ARMPMU_MAX_HWEVENTS);
 279
 280         /*
 281          * Initialise the fake PMU. We only need to populate the
 282          * used_mask for the purposes of validation.
 283          */
 284         memset(fake_used_mask, 0, sizeof(fake_used_mask));
 285         fake_pmu.used_mask = fake_used_mask;
 286
 287         if (!validate_event(&fake_pmu, leader))
 288                 return -EINVAL;
 289
 290         list_for_each_entry(sibling, &leader->sibling_list, group_entry) {
 291                 if (!validate_event(&fake_pmu, sibling))
 292                         return -EINVAL;
 293         }
 294
 295         if (!validate_event(&fake_pmu, event))
 296                 return -EINVAL;
 297
 298         return 0;
 299 }
 300
 301 static irqreturn_t armpmu_dispatch_irq(int irq, void *dev)
 302 {
 303         struct arm_pmu *armpmu = (struct arm_pmu *) dev;
 304         struct platform_device *plat_device = armpmu->plat_device;
 305         struct arm_pmu_platdata *plat = dev_get_platdata(&plat_device->dev);
 306
 307         if (plat && plat->handle_irq)
 308                 return plat->handle_irq(irq, dev, armpmu->handle_irq);
 309         else
 310                 return armpmu->handle_irq(irq, dev);
 311 }
 312
 313 static void
 314 armpmu_release_hardware(struct arm_pmu *armpmu)
 315 {
 316         armpmu->free_irq(armpmu);
 317         pm_runtime_put_sync(&armpmu->plat_device->dev);
 318 }
 319
 320 static int
 321 armpmu_reserve_hardware(struct arm_pmu *armpmu)
 322 {
 323         int err;
 324         struct platform_device *pmu_device = armpmu->plat_device;
 325
 326         if (!pmu_device)
 327                 return -ENODEV;
 328
 329         pm_runtime_get_sync(&pmu_device->dev);
 330         err = armpmu->request_irq(armpmu, armpmu_dispatch_irq);
 331         if (err) {
 332                 armpmu_release_hardware(armpmu);
 333                 return err;
 334         }
 335
 336         return 0;
 337 }
 338
 339 static void
 340 hw_perf_event_destroy(struct perf_event *event)
 341 {
 342         struct arm_pmu *armpmu = to_arm_pmu(event->pmu);
 343         atomic_t *active_events  = &armpmu->active_events;
 344         struct mutex *pmu_reserve_mutex = &armpmu->reserve_mutex;
 345
 346         if (atomic_dec_and_mutex_lock(active_events, pmu_reserve_mutex)) {
 347                 armpmu_release_hardware(armpmu);
 348                 mutex_unlock(pmu_reserve_mutex);
 349         }
 350 }
 351
 352 static int
 353 event_requires_mode_exclusion(struct perf_event_attr *attr)
 354 {
 355         return attr->exclude_idle || attr->exclude_user ||
 356                attr->exclude_kernel || attr->exclude_hv;
 357 }
 358
 359 static int
 360 __hw_perf_event_init(struct perf_event *event)
 361 {
 362         struct arm_pmu *armpmu = to_arm_pmu(event->pmu);
 363         struct hw_perf_event *hwc = &event->hw;
 364         int mapping;
 365
 366         mapping = armpmu->map_event(event);
 367
 368         if (mapping < 0) {
 369                 pr_debug("event %x:%llx not supported\n", event->attr.type,
 370                          event->attr.config);
 371                 return mapping;
 372         }
 373
 374         /*
 375          * We don't assign an index until we actually place the event onto
 376          * hardware. Use -1 to signify that we haven't decided where to put it
 377          * yet. For SMP systems, each core has it's own PMU so we can't do any
 378          * clever allocation or constraints checking at this point.
 379          */
 380         hwc->idx                = -1;
 381         hwc->config_base        = 0;
 382         hwc->config             = 0;
 383         hwc->event_base         = 0;
 384
 385         /*
 386          * Check whether we need to exclude the counter from certain modes.
 387          */
 388         if ((!armpmu->set_event_filter ||
 389              armpmu->set_event_filter(hwc, &event->attr)) &&
 390              event_requires_mode_exclusion(&event->attr)) {
 391                 pr_debug("ARM performance counters do not support "
 392                          "mode exclusion\n");
 393                 return -EOPNOTSUPP;
 394         }
 395
 396         /*
 397          * Store the event encoding into the config_base field.
 398          */
 399         hwc->config_base            |= (unsigned long)mapping;
 400
 401         if (!hwc->sample_period) {
 402                 /*
 403                  * For non-sampling runs, limit the sample_period to half
 404                  * of the counter width. That way, the new counter value
 405                  * is far less likely to overtake the previous one unless
 406                  * you have some serious IRQ latency issues.
 407                  */
 408                 hwc->sample_period  = armpmu->max_period >> 1;
 409                 hwc->last_period    = hwc->sample_period;
 410                 local64_set(&hwc->period_left, hwc->sample_period);
 411         }
 412
 413         if (event->group_leader != event) {
 414                 if (validate_group(event) != 0)
 415                         return -EINVAL;
 416         }
 417
 418         return 0;
 419 }
 420
 421 static int armpmu_event_init(struct perf_event *event)
 422 {
 423         struct arm_pmu *armpmu = to_arm_pmu(event->pmu);
 424         int err = 0;
 425         atomic_t *active_events = &armpmu->active_events;
 426
 427         /* does not support taken branch sampling */
 428         if (has_branch_stack(event))
 429                 return -EOPNOTSUPP;
 430
 431         if (armpmu->map_event(event) == -ENOENT)
 432                 return -ENOENT;
 433
 434         event->destroy = hw_perf_event_destroy;
 435
 436         if (!atomic_inc_not_zero(active_events)) {
 437                 mutex_lock(&armpmu->reserve_mutex);
 438                 if (atomic_read(active_events) == 0)
 439                         err = armpmu_reserve_hardware(armpmu);
 440
 441                 if (!err)
 442                         atomic_inc(active_events);
 443                 mutex_unlock(&armpmu->reserve_mutex);
 444         }
 445
 446         if (err)
 447                 return err;
 448
 449         err = __hw_perf_event_init(event);
 450         if (err)
 451                 hw_perf_event_destroy(event);
 452
 453         return err;
 454 }
 455
 456 static void armpmu_enable(struct pmu *pmu)
 457 {
 458         struct arm_pmu *armpmu = to_arm_pmu(pmu);
 459         struct pmu_hw_events *hw_events = armpmu->get_hw_events();
 460         int enabled = bitmap_weight(hw_events->used_mask, armpmu->num_events);
 461
 462         if (enabled)
 463                 armpmu->start(armpmu);
 464 }
 465
 466 static void armpmu_disable(struct pmu *pmu)
 467 {
 468         struct arm_pmu *armpmu = to_arm_pmu(pmu);
 469         armpmu->stop(armpmu);
 470 }
 471
 472 #ifdef CONFIG_PM_RUNTIME
 473 static int armpmu_runtime_resume(struct device *dev)
 474 {
 475         struct arm_pmu_platdata *plat = dev_get_platdata(dev);
 476
 477         if (plat && plat->runtime_resume)
 478                 return plat->runtime_resume(dev);
 479
 480         return 0;
 481 }
 482
 483 static int armpmu_runtime_suspend(struct device *dev)
 484 {
 485         struct arm_pmu_platdata *plat = dev_get_platdata(dev);
 486
 487         if (plat && plat->runtime_suspend)
 488                 return plat->runtime_suspend(dev);
 489
 490         return 0;
 491 }
 492 #endif
 493
 494 const struct dev_pm_ops armpmu_dev_pm_ops = {
 495         SET_RUNTIME_PM_OPS(armpmu_runtime_suspend, armpmu_runtime_resume, NULL)
 496 };
 497
 498 static void armpmu_init(struct arm_pmu *armpmu)
 499 {
 500         atomic_set(&armpmu->active_events, 0);
 501         mutex_init(&armpmu->reserve_mutex);
 502
 503         armpmu->pmu = (struct pmu) {
 504                 .pmu_enable     = armpmu_enable,
 505                 .pmu_disable    = armpmu_disable,
 506                 .event_init     = armpmu_event_init,
 507                 .add            = armpmu_add,
 508                 .del            = armpmu_del,
 509                 .start          = armpmu_start,
 510                 .stop           = armpmu_stop,
 511                 .read           = armpmu_read,
 512         };
 513 }
 514
 515 int armpmu_register(struct arm_pmu *armpmu, int type)
 516 {
 517         armpmu_init(armpmu);
 518         pm_runtime_enable(&armpmu->plat_device->dev);
 519         pr_info("enabled with %s PMU driver, %d counters available\n",
 520                         armpmu->name, armpmu->num_events);
 521         return perf_pmu_register(&armpmu->pmu, armpmu->name, type);
 522 }
 523
 524 /*
 525  * Callchain handling code.
 526  */
 527
 528 /*
 529  * The registers we're interested in are at the end of the variable
 530  * length saved register structure. The fp points at the end of this
 531  * structure so the address of this struct is:
 532  * (struct frame_tail *)(xxx->fp)-1
 533  *
 534  * This code has been adapted from the ARM OProfile support.
 535  */
 536 struct frame_tail {
 537         struct frame_tail __user *fp;
 538         unsigned long sp;
 539         unsigned long lr;
 540 } __attribute__((packed));
 541
 542 /*
 543  * Get the return address for a single stackframe and return a pointer to the
 544  * next frame tail.
 545  */
 546 static struct frame_tail __user *
 547 user_backtrace(struct frame_tail __user *tail,
 548                struct perf_callchain_entry *entry)
 549 {
 550         struct frame_tail buftail;
 551
 552         /* Also check accessibility of one struct frame_tail beyond */
 553         if (!access_ok(VERIFY_READ, tail, sizeof(buftail)))
 554                 return NULL;
 555         if (__copy_from_user_inatomic(&buftail, tail, sizeof(buftail)))
 556                 return NULL;
 557
 558         perf_callchain_store(entry, buftail.lr);
 559
 560         /*
 561          * Frame pointers should strictly progress back up the stack
 562          * (towards higher addresses).
 563          */
 564         if (tail + 1 >= buftail.fp)
 565                 return NULL;
 566
 567         return buftail.fp - 1;
 568 }
 569
 570 void
 571 perf_callchain_user(struct perf_callchain_entry *entry, struct pt_regs *regs)
 572 {
 573         struct frame_tail __user *tail;
 574
 575         if (perf_guest_cbs && perf_guest_cbs->is_in_guest()) {
 576                 /* We don't support guest os callchain now */
 577                 return;
 578         }
 579
 580         perf_callchain_store(entry, regs->ARM_pc);
 581         tail = (struct frame_tail __user *)regs->ARM_fp - 1;
 582
 583         while ((entry->nr < PERF_MAX_STACK_DEPTH) &&
 584                tail && !((unsigned long)tail & 0x3))
 585                 tail = user_backtrace(tail, entry);
 586 }
 587
 588 /*
 589  * Gets called by walk_stackframe() for every stackframe. This will be called
 590  * whist unwinding the stackframe and is like a subroutine return so we use
 591  * the PC.
 592  */
 593 static int
 594 callchain_trace(struct stackframe *fr,
 595                 void *data)
 596 {
 597         struct perf_callchain_entry *entry = data;
 598         perf_callchain_store(entry, fr->pc);
 599         return 0;
 600 }
 601
 602 void
 603 perf_callchain_kernel(struct perf_callchain_entry *entry, struct pt_regs *regs)
 604 {
 605         struct stackframe fr;
 606
 607         if (perf_guest_cbs && perf_guest_cbs->is_in_guest()) {
 608                 /* We don't support guest os callchain now */
 609                 return;
 610         }
 611
 612         fr.fp = regs->ARM_fp;
 613         fr.sp = regs->ARM_sp;
 614         fr.lr = regs->ARM_lr;
 615         fr.pc = regs->ARM_pc;
 616         walk_stackframe(&fr, callchain_trace, entry);
 617 }
 618
 619 unsigned long perf_instruction_pointer(struct pt_regs *regs)
 620 {
 621         if (perf_guest_cbs && perf_guest_cbs->is_in_guest())
 622                 return perf_guest_cbs->get_guest_ip();
 623
 624         return instruction_pointer(regs);
 625 }
 626
 627 unsigned long perf_misc_flags(struct pt_regs *regs)
 628 {
 629         int misc = 0;
 630
 631         if (perf_guest_cbs && perf_guest_cbs->is_in_guest()) {
 632                 if (perf_guest_cbs->is_user_mode())
 633                         misc |= PERF_RECORD_MISC_GUEST_USER;
 634                 else
 635                         misc |= PERF_RECORD_MISC_GUEST_KERNEL;
 636         } else {
 637                 if (user_mode(regs))
 638                         misc |= PERF_RECORD_MISC_USER;
 639                 else
 640                         misc |= PERF_RECORD_MISC_KERNEL;
 641         }
 642
 643         return misc;
 644 }