arch/s390/kernel/perf_cpum_cf.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Performance event support for s390x - CPU-measurement Counter Facility
   4  *
   5  *  Copyright IBM Corp. 2012, 2019
   6  *  Author(s): Hendrik Brueckner <brueckner@linux.ibm.com>
   7  */
   8 #define KMSG_COMPONENT  "cpum_cf"
   9 #define pr_fmt(fmt)     KMSG_COMPONENT ": " fmt
  10
  11 #include <linux/kernel.h>
  12 #include <linux/kernel_stat.h>
  13 #include <linux/percpu.h>
  14 #include <linux/notifier.h>
  15 #include <linux/init.h>
  16 #include <linux/export.h>
  17 #include <asm/cpu_mcf.h>
  18
  19 static enum cpumf_ctr_set get_counter_set(u64 event)
  20 {
  21         int set = CPUMF_CTR_SET_MAX;
  22
  23         if (event < 32)
  24                 set = CPUMF_CTR_SET_BASIC;
  25         else if (event < 64)
  26                 set = CPUMF_CTR_SET_USER;
  27         else if (event < 128)
  28                 set = CPUMF_CTR_SET_CRYPTO;
  29         else if (event < 288)
  30                 set = CPUMF_CTR_SET_EXT;
  31         else if (event >= 448 && event < 496)
  32                 set = CPUMF_CTR_SET_MT_DIAG;
  33
  34         return set;
  35 }
  36
  37 static int validate_ctr_version(const struct hw_perf_event *hwc)
  38 {
  39         struct cpu_cf_events *cpuhw;
  40         int err = 0;
  41         u16 mtdiag_ctl;
  42
  43         cpuhw = &get_cpu_var(cpu_cf_events);
  44
  45         /* check required version for counter sets */
  46         switch (hwc->config_base) {
  47         case CPUMF_CTR_SET_BASIC:
  48         case CPUMF_CTR_SET_USER:
  49                 if (cpuhw->info.cfvn < 1)
  50                         err = -EOPNOTSUPP;
  51                 break;
  52         case CPUMF_CTR_SET_CRYPTO:
  53                 if ((cpuhw->info.csvn >= 1 && cpuhw->info.csvn <= 5 &&
  54                      hwc->config > 79) ||
  55                     (cpuhw->info.csvn >= 6 && hwc->config > 83))
  56                         err = -EOPNOTSUPP;
  57                 break;
  58         case CPUMF_CTR_SET_EXT:
  59                 if (cpuhw->info.csvn < 1)
  60                         err = -EOPNOTSUPP;
  61                 if ((cpuhw->info.csvn == 1 && hwc->config > 159) ||
  62                     (cpuhw->info.csvn == 2 && hwc->config > 175) ||
  63                     (cpuhw->info.csvn >= 3 && cpuhw->info.csvn <= 5
  64                      && hwc->config > 255) ||
  65                     (cpuhw->info.csvn >= 6 && hwc->config > 287))
  66                         err = -EOPNOTSUPP;
  67                 break;
  68         case CPUMF_CTR_SET_MT_DIAG:
  69                 if (cpuhw->info.csvn <= 3)
  70                         err = -EOPNOTSUPP;
  71                 /*
  72                  * MT-diagnostic counters are read-only.  The counter set
  73                  * is automatically enabled and activated on all CPUs with
  74                  * multithreading (SMT).  Deactivation of multithreading
  75                  * also disables the counter set.  State changes are ignored
  76                  * by lcctl().  Because Linux controls SMT enablement through
  77                  * a kernel parameter only, the counter set is either disabled
  78                  * or enabled and active.
  79                  *
  80                  * Thus, the counters can only be used if SMT is on and the
  81                  * counter set is enabled and active.
  82                  */
  83                 mtdiag_ctl = cpumf_ctr_ctl[CPUMF_CTR_SET_MT_DIAG];
  84                 if (!((cpuhw->info.auth_ctl & mtdiag_ctl) &&
  85                       (cpuhw->info.enable_ctl & mtdiag_ctl) &&
  86                       (cpuhw->info.act_ctl & mtdiag_ctl)))
  87                         err = -EOPNOTSUPP;
  88                 break;
  89         }
  90
  91         put_cpu_var(cpu_cf_events);
  92         return err;
  93 }
  94
  95 static int validate_ctr_auth(const struct hw_perf_event *hwc)
  96 {
  97         struct cpu_cf_events *cpuhw;
  98         u64 ctrs_state;
  99         int err = 0;
 100
 101         cpuhw = &get_cpu_var(cpu_cf_events);
 102
 103         /* Check authorization for cpu counter sets.
 104          * If the particular CPU counter set is not authorized,
 105          * return with -ENOENT in order to fall back to other
 106          * PMUs that might suffice the event request.
 107          */
 108         ctrs_state = cpumf_ctr_ctl[hwc->config_base];
 109         if (!(ctrs_state & cpuhw->info.auth_ctl))
 110                 err = -ENOENT;
 111
 112         put_cpu_var(cpu_cf_events);
 113         return err;
 114 }
 115
 116 /*
 117  * Change the CPUMF state to active.
 118  * Enable and activate the CPU-counter sets according
 119  * to the per-cpu control state.
 120  */
 121 static void cpumf_pmu_enable(struct pmu *pmu)
 122 {
 123         struct cpu_cf_events *cpuhw = this_cpu_ptr(&cpu_cf_events);
 124         int err;
 125
 126         if (cpuhw->flags & PMU_F_ENABLED)
 127                 return;
 128
 129         err = lcctl(cpuhw->state);
 130         if (err) {
 131                 pr_err("Enabling the performance measuring unit "
 132                        "failed with rc=%x\n", err);
 133                 return;
 134         }
 135
 136         cpuhw->flags |= PMU_F_ENABLED;
 137 }
 138
 139 /*
 140  * Change the CPUMF state to inactive.
 141  * Disable and enable (inactive) the CPU-counter sets according
 142  * to the per-cpu control state.
 143  */
 144 static void cpumf_pmu_disable(struct pmu *pmu)
 145 {
 146         struct cpu_cf_events *cpuhw = this_cpu_ptr(&cpu_cf_events);
 147         int err;
 148         u64 inactive;
 149
 150         if (!(cpuhw->flags & PMU_F_ENABLED))
 151                 return;
 152
 153         inactive = cpuhw->state & ~((1 << CPUMF_LCCTL_ENABLE_SHIFT) - 1);
 154         err = lcctl(inactive);
 155         if (err) {
 156                 pr_err("Disabling the performance measuring unit "
 157                        "failed with rc=%x\n", err);
 158                 return;
 159         }
 160
 161         cpuhw->flags &= ~PMU_F_ENABLED;
 162 }
 163
 164
 165 /* Number of perf events counting hardware events */
 166 static atomic_t num_events = ATOMIC_INIT(0);
 167 /* Used to avoid races in calling reserve/release_cpumf_hardware */
 168 static DEFINE_MUTEX(pmc_reserve_mutex);
 169
 170 /* Release the PMU if event is the last perf event */
 171 static void hw_perf_event_destroy(struct perf_event *event)
 172 {
 173         if (!atomic_add_unless(&num_events, -1, 1)) {
 174                 mutex_lock(&pmc_reserve_mutex);
 175                 if (atomic_dec_return(&num_events) == 0)
 176                         __kernel_cpumcf_end();
 177                 mutex_unlock(&pmc_reserve_mutex);
 178         }
 179 }
 180
 181 /* CPUMF <-> perf event mappings for kernel+userspace (basic set) */
 182 static const int cpumf_generic_events_basic[] = {
 183         [PERF_COUNT_HW_CPU_CYCLES]          = 0,
 184         [PERF_COUNT_HW_INSTRUCTIONS]        = 1,
 185         [PERF_COUNT_HW_CACHE_REFERENCES]    = -1,
 186         [PERF_COUNT_HW_CACHE_MISSES]        = -1,
 187         [PERF_COUNT_HW_BRANCH_INSTRUCTIONS] = -1,
 188         [PERF_COUNT_HW_BRANCH_MISSES]       = -1,
 189         [PERF_COUNT_HW_BUS_CYCLES]          = -1,
 190 };
 191 /* CPUMF <-> perf event mappings for userspace (problem-state set) */
 192 static const int cpumf_generic_events_user[] = {
 193         [PERF_COUNT_HW_CPU_CYCLES]          = 32,
 194         [PERF_COUNT_HW_INSTRUCTIONS]        = 33,
 195         [PERF_COUNT_HW_CACHE_REFERENCES]    = -1,
 196         [PERF_COUNT_HW_CACHE_MISSES]        = -1,
 197         [PERF_COUNT_HW_BRANCH_INSTRUCTIONS] = -1,
 198         [PERF_COUNT_HW_BRANCH_MISSES]       = -1,
 199         [PERF_COUNT_HW_BUS_CYCLES]          = -1,
 200 };
 201
 202 static int __hw_perf_event_init(struct perf_event *event, unsigned int type)
 203 {
 204         struct perf_event_attr *attr = &event->attr;
 205         struct hw_perf_event *hwc = &event->hw;
 206         enum cpumf_ctr_set set;
 207         int err = 0;
 208         u64 ev;
 209
 210         switch (type) {
 211         case PERF_TYPE_RAW:
 212                 /* Raw events are used to access counters directly,
 213                  * hence do not permit excludes */
 214                 if (attr->exclude_kernel || attr->exclude_user ||
 215                     attr->exclude_hv)
 216                         return -EOPNOTSUPP;
 217                 ev = attr->config;
 218                 break;
 219
 220         case PERF_TYPE_HARDWARE:
 221                 if (is_sampling_event(event))   /* No sampling support */
 222                         return -ENOENT;
 223                 ev = attr->config;
 224                 /* Count user space (problem-state) only */
 225                 if (!attr->exclude_user && attr->exclude_kernel) {
 226                         if (ev >= ARRAY_SIZE(cpumf_generic_events_user))
 227                                 return -EOPNOTSUPP;
 228                         ev = cpumf_generic_events_user[ev];
 229
 230                 /* No support for kernel space counters only */
 231                 } else if (!attr->exclude_kernel && attr->exclude_user) {
 232                         return -EOPNOTSUPP;
 233                 } else {        /* Count user and kernel space */
 234                         if (ev >= ARRAY_SIZE(cpumf_generic_events_basic))
 235                                 return -EOPNOTSUPP;
 236                         ev = cpumf_generic_events_basic[ev];
 237                 }
 238                 break;
 239
 240         default:
 241                 return -ENOENT;
 242         }
 243
 244         if (ev == -1)
 245                 return -ENOENT;
 246
 247         if (ev > PERF_CPUM_CF_MAX_CTR)
 248                 return -ENOENT;
 249
 250         /* Obtain the counter set to which the specified counter belongs */
 251         set = get_counter_set(ev);
 252         switch (set) {
 253         case CPUMF_CTR_SET_BASIC:
 254         case CPUMF_CTR_SET_USER:
 255         case CPUMF_CTR_SET_CRYPTO:
 256         case CPUMF_CTR_SET_EXT:
 257         case CPUMF_CTR_SET_MT_DIAG:
 258                 /*
 259                  * Use the hardware perf event structure to store the
 260                  * counter number in the 'config' member and the counter
 261                  * set number in the 'config_base'.  The counter set number
 262                  * is then later used to enable/disable the counter(s).
 263                  */
 264                 hwc->config = ev;
 265                 hwc->config_base = set;
 266                 break;
 267         case CPUMF_CTR_SET_MAX:
 268                 /* The counter could not be associated to a counter set */
 269                 return -EINVAL;
 270         }
 271
 272         /* Initialize for using the CPU-measurement counter facility */
 273         if (!atomic_inc_not_zero(&num_events)) {
 274                 mutex_lock(&pmc_reserve_mutex);
 275                 if (atomic_read(&num_events) == 0 && __kernel_cpumcf_begin())
 276                         err = -EBUSY;
 277                 else
 278                         atomic_inc(&num_events);
 279                 mutex_unlock(&pmc_reserve_mutex);
 280         }
 281         if (err)
 282                 return err;
 283         event->destroy = hw_perf_event_destroy;
 284
 285         /* Finally, validate version and authorization of the counter set */
 286         err = validate_ctr_auth(hwc);
 287         if (!err)
 288                 err = validate_ctr_version(hwc);
 289
 290         return err;
 291 }
 292
 293 static int cpumf_pmu_event_init(struct perf_event *event)
 294 {
 295         unsigned int type = event->attr.type;
 296         int err;
 297
 298         if (type == PERF_TYPE_HARDWARE || type == PERF_TYPE_RAW)
 299                 err = __hw_perf_event_init(event, type);
 300         else if (event->pmu->type == type)
 301                 /* Registered as unknown PMU */
 302                 err = __hw_perf_event_init(event, PERF_TYPE_RAW);
 303         else
 304                 return -ENOENT;
 305
 306         if (unlikely(err) && event->destroy)
 307                 event->destroy(event);
 308
 309         return err;
 310 }
 311
 312 static int hw_perf_event_reset(struct perf_event *event)
 313 {
 314         u64 prev, new;
 315         int err;
 316
 317         do {
 318                 prev = local64_read(&event->hw.prev_count);
 319                 err = ecctr(event->hw.config, &new);
 320                 if (err) {
 321                         if (err != 3)
 322                                 break;
 323                         /* The counter is not (yet) available. This
 324                          * might happen if the counter set to which
 325                          * this counter belongs is in the disabled
 326                          * state.
 327                          */
 328                         new = 0;
 329                 }
 330         } while (local64_cmpxchg(&event->hw.prev_count, prev, new) != prev);
 331
 332         return err;
 333 }
 334
 335 static void hw_perf_event_update(struct perf_event *event)
 336 {
 337         u64 prev, new, delta;
 338         int err;
 339
 340         do {
 341                 prev = local64_read(&event->hw.prev_count);
 342                 err = ecctr(event->hw.config, &new);
 343                 if (err)
 344                         return;
 345         } while (local64_cmpxchg(&event->hw.prev_count, prev, new) != prev);
 346
 347         delta = (prev <= new) ? new - prev
 348                               : (-1ULL - prev) + new + 1;        /* overflow */
 349         local64_add(delta, &event->count);
 350 }
 351
 352 static void cpumf_pmu_read(struct perf_event *event)
 353 {
 354         if (event->hw.state & PERF_HES_STOPPED)
 355                 return;
 356
 357         hw_perf_event_update(event);
 358 }
 359
 360 static void cpumf_pmu_start(struct perf_event *event, int flags)
 361 {
 362         struct cpu_cf_events *cpuhw = this_cpu_ptr(&cpu_cf_events);
 363         struct hw_perf_event *hwc = &event->hw;
 364
 365         if (WARN_ON_ONCE(!(hwc->state & PERF_HES_STOPPED)))
 366                 return;
 367
 368         if (WARN_ON_ONCE(hwc->config == -1))
 369                 return;
 370
 371         if (flags & PERF_EF_RELOAD)
 372                 WARN_ON_ONCE(!(hwc->state & PERF_HES_UPTODATE));
 373
 374         hwc->state = 0;
 375
 376         /* (Re-)enable and activate the counter set */
 377         ctr_set_enable(&cpuhw->state, hwc->config_base);
 378         ctr_set_start(&cpuhw->state, hwc->config_base);
 379
 380         /* The counter set to which this counter belongs can be already active.
 381          * Because all counters in a set are active, the event->hw.prev_count
 382          * needs to be synchronized.  At this point, the counter set can be in
 383          * the inactive or disabled state.
 384          */
 385         hw_perf_event_reset(event);
 386
 387         /* increment refcount for this counter set */
 388         atomic_inc(&cpuhw->ctr_set[hwc->config_base]);
 389 }
 390
 391 static void cpumf_pmu_stop(struct perf_event *event, int flags)
 392 {
 393         struct cpu_cf_events *cpuhw = this_cpu_ptr(&cpu_cf_events);
 394         struct hw_perf_event *hwc = &event->hw;
 395
 396         if (!(hwc->state & PERF_HES_STOPPED)) {
 397                 /* Decrement reference count for this counter set and if this
 398                  * is the last used counter in the set, clear activation
 399                  * control and set the counter set state to inactive.
 400                  */
 401                 if (!atomic_dec_return(&cpuhw->ctr_set[hwc->config_base]))
 402                         ctr_set_stop(&cpuhw->state, hwc->config_base);
 403                 hwc->state |= PERF_HES_STOPPED;
 404         }
 405
 406         if ((flags & PERF_EF_UPDATE) && !(hwc->state & PERF_HES_UPTODATE)) {
 407                 hw_perf_event_update(event);
 408                 hwc->state |= PERF_HES_UPTODATE;
 409         }
 410 }
 411
 412 static int cpumf_pmu_add(struct perf_event *event, int flags)
 413 {
 414         struct cpu_cf_events *cpuhw = this_cpu_ptr(&cpu_cf_events);
 415
 416         /* Check authorization for the counter set to which this
 417          * counter belongs.
 418          * For group events transaction, the authorization check is
 419          * done in cpumf_pmu_commit_txn().
 420          */
 421         if (!(cpuhw->txn_flags & PERF_PMU_TXN_ADD))
 422                 if (validate_ctr_auth(&event->hw))
 423                         return -ENOENT;
 424
 425         ctr_set_enable(&cpuhw->state, event->hw.config_base);
 426         event->hw.state = PERF_HES_UPTODATE | PERF_HES_STOPPED;
 427
 428         if (flags & PERF_EF_START)
 429                 cpumf_pmu_start(event, PERF_EF_RELOAD);
 430
 431         return 0;
 432 }
 433
 434 static void cpumf_pmu_del(struct perf_event *event, int flags)
 435 {
 436         struct cpu_cf_events *cpuhw = this_cpu_ptr(&cpu_cf_events);
 437
 438         cpumf_pmu_stop(event, PERF_EF_UPDATE);
 439
 440         /* Check if any counter in the counter set is still used.  If not used,
 441          * change the counter set to the disabled state.  This also clears the
 442          * content of all counters in the set.
 443          *
 444          * When a new perf event has been added but not yet started, this can
 445          * clear enable control and resets all counters in a set.  Therefore,
 446          * cpumf_pmu_start() always has to reenable a counter set.
 447          */
 448         if (!atomic_read(&cpuhw->ctr_set[event->hw.config_base]))
 449                 ctr_set_disable(&cpuhw->state, event->hw.config_base);
 450 }
 451
 452 /*
 453  * Start group events scheduling transaction.
 454  * Set flags to perform a single test at commit time.
 455  *
 456  * We only support PERF_PMU_TXN_ADD transactions. Save the
 457  * transaction flags but otherwise ignore non-PERF_PMU_TXN_ADD
 458  * transactions.
 459  */
 460 static void cpumf_pmu_start_txn(struct pmu *pmu, unsigned int txn_flags)
 461 {
 462         struct cpu_cf_events *cpuhw = this_cpu_ptr(&cpu_cf_events);
 463
 464         WARN_ON_ONCE(cpuhw->txn_flags);         /* txn already in flight */
 465
 466         cpuhw->txn_flags = txn_flags;
 467         if (txn_flags & ~PERF_PMU_TXN_ADD)
 468                 return;
 469
 470         perf_pmu_disable(pmu);
 471         cpuhw->tx_state = cpuhw->state;
 472 }
 473
 474 /*
 475  * Stop and cancel a group events scheduling tranctions.
 476  * Assumes cpumf_pmu_del() is called for each successful added
 477  * cpumf_pmu_add() during the transaction.
 478  */
 479 static void cpumf_pmu_cancel_txn(struct pmu *pmu)
 480 {
 481         unsigned int txn_flags;
 482         struct cpu_cf_events *cpuhw = this_cpu_ptr(&cpu_cf_events);
 483
 484         WARN_ON_ONCE(!cpuhw->txn_flags);        /* no txn in flight */
 485
 486         txn_flags = cpuhw->txn_flags;
 487         cpuhw->txn_flags = 0;
 488         if (txn_flags & ~PERF_PMU_TXN_ADD)
 489                 return;
 490
 491         WARN_ON(cpuhw->tx_state != cpuhw->state);
 492
 493         perf_pmu_enable(pmu);
 494 }
 495
 496 /*
 497  * Commit the group events scheduling transaction.  On success, the
 498  * transaction is closed.   On error, the transaction is kept open
 499  * until cpumf_pmu_cancel_txn() is called.
 500  */
 501 static int cpumf_pmu_commit_txn(struct pmu *pmu)
 502 {
 503         struct cpu_cf_events *cpuhw = this_cpu_ptr(&cpu_cf_events);
 504         u64 state;
 505
 506         WARN_ON_ONCE(!cpuhw->txn_flags);        /* no txn in flight */
 507
 508         if (cpuhw->txn_flags & ~PERF_PMU_TXN_ADD) {
 509                 cpuhw->txn_flags = 0;
 510                 return 0;
 511         }
 512
 513         /* check if the updated state can be scheduled */
 514         state = cpuhw->state & ~((1 << CPUMF_LCCTL_ENABLE_SHIFT) - 1);
 515         state >>= CPUMF_LCCTL_ENABLE_SHIFT;
 516         if ((state & cpuhw->info.auth_ctl) != state)
 517                 return -ENOENT;
 518
 519         cpuhw->txn_flags = 0;
 520         perf_pmu_enable(pmu);
 521         return 0;
 522 }
 523
 524 /* Performance monitoring unit for s390x */
 525 static struct pmu cpumf_pmu = {
 526         .task_ctx_nr  = perf_sw_context,
 527         .capabilities = PERF_PMU_CAP_NO_INTERRUPT,
 528         .pmu_enable   = cpumf_pmu_enable,
 529         .pmu_disable  = cpumf_pmu_disable,
 530         .event_init   = cpumf_pmu_event_init,
 531         .add          = cpumf_pmu_add,
 532         .del          = cpumf_pmu_del,
 533         .start        = cpumf_pmu_start,
 534         .stop         = cpumf_pmu_stop,
 535         .read         = cpumf_pmu_read,
 536         .start_txn    = cpumf_pmu_start_txn,
 537         .commit_txn   = cpumf_pmu_commit_txn,
 538         .cancel_txn   = cpumf_pmu_cancel_txn,
 539 };
 540
 541 static int __init cpumf_pmu_init(void)
 542 {
 543         int rc;
 544
 545         if (!kernel_cpumcf_avail())
 546                 return -ENODEV;
 547
 548         cpumf_pmu.attr_groups = cpumf_cf_event_group();
 549         rc = perf_pmu_register(&cpumf_pmu, "cpum_cf", -1);
 550         if (rc)
 551                 pr_err("Registering the cpum_cf PMU failed with rc=%i\n", rc);
 552         return rc;
 553 }
 554 subsys_initcall(cpumf_pmu_init);