arch/x86/events/intel/cstate.c

   1 /*
   2  * Support cstate residency counters
   3  *
   4  * Copyright (C) 2015, Intel Corp.
   5  * Author: Kan Liang (kan.liang@intel.com)
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  */
  18
  19 /*
  20  * This file export cstate related free running (read-only) counters
  21  * for perf. These counters may be use simultaneously by other tools,
  22  * such as turbostat. However, it still make sense to implement them
  23  * in perf. Because we can conveniently collect them together with
  24  * other events, and allow to use them from tools without special MSR
  25  * access code.
  26  *
  27  * The events only support system-wide mode counting. There is no
  28  * sampling support because it is not supported by the hardware.
  29  *
  30  * According to counters' scope and category, two PMUs are registered
  31  * with the perf_event core subsystem.
  32  *  - 'cstate_core': The counter is available for each physical core.
  33  *    The counters include CORE_C*_RESIDENCY.
  34  *  - 'cstate_pkg': The counter is available for each physical package.
  35  *    The counters include PKG_C*_RESIDENCY.
  36  *
  37  * All of these counters are specified in the Intel® 64 and IA-32
  38  * Architectures Software Developer.s Manual Vol3b.
  39  *
  40  * Model specific counters:
  41  *      MSR_CORE_C1_RES: CORE C1 Residency Counter
  42  *                       perf code: 0x00
  43  *                       Available model: SLM,AMT,GLM,CNL
  44  *                       Scope: Core (each processor core has a MSR)
  45  *      MSR_CORE_C3_RESIDENCY: CORE C3 Residency Counter
  46  *                             perf code: 0x01
  47  *                             Available model: NHM,WSM,SNB,IVB,HSW,BDW,SKL,GLM,
  48                                                 CNL
  49  *                             Scope: Core
  50  *      MSR_CORE_C6_RESIDENCY: CORE C6 Residency Counter
  51  *                             perf code: 0x02
  52  *                             Available model: SLM,AMT,NHM,WSM,SNB,IVB,HSW,BDW,
  53  *                                              SKL,KNL,GLM,CNL
  54  *                             Scope: Core
  55  *      MSR_CORE_C7_RESIDENCY: CORE C7 Residency Counter
  56  *                             perf code: 0x03
  57  *                             Available model: SNB,IVB,HSW,BDW,SKL,CNL
  58  *                             Scope: Core
  59  *      MSR_PKG_C2_RESIDENCY:  Package C2 Residency Counter.
  60  *                             perf code: 0x00
  61  *                             Available model: SNB,IVB,HSW,BDW,SKL,KNL,GLM,CNL
  62  *                             Scope: Package (physical package)
  63  *      MSR_PKG_C3_RESIDENCY:  Package C3 Residency Counter.
  64  *                             perf code: 0x01
  65  *                             Available model: NHM,WSM,SNB,IVB,HSW,BDW,SKL,KNL,
  66  *                                              GLM,CNL
  67  *                             Scope: Package (physical package)
  68  *      MSR_PKG_C6_RESIDENCY:  Package C6 Residency Counter.
  69  *                             perf code: 0x02
  70  *                             Available model: SLM,AMT,NHM,WSM,SNB,IVB,HSW,BDW
  71  *                                              SKL,KNL,GLM,CNL
  72  *                             Scope: Package (physical package)
  73  *      MSR_PKG_C7_RESIDENCY:  Package C7 Residency Counter.
  74  *                             perf code: 0x03
  75  *                             Available model: NHM,WSM,SNB,IVB,HSW,BDW,SKL,CNL
  76  *                             Scope: Package (physical package)
  77  *      MSR_PKG_C8_RESIDENCY:  Package C8 Residency Counter.
  78  *                             perf code: 0x04
  79  *                             Available model: HSW ULT,CNL
  80  *                             Scope: Package (physical package)
  81  *      MSR_PKG_C9_RESIDENCY:  Package C9 Residency Counter.
  82  *                             perf code: 0x05
  83  *                             Available model: HSW ULT,CNL
  84  *                             Scope: Package (physical package)
  85  *      MSR_PKG_C10_RESIDENCY: Package C10 Residency Counter.
  86  *                             perf code: 0x06
  87  *                             Available model: HSW ULT,GLM,CNL
  88  *                             Scope: Package (physical package)
  89  *
  90  */
  91
  92 #include <linux/module.h>
  93 #include <linux/slab.h>
  94 #include <linux/perf_event.h>
  95 #include <linux/nospec.h>
  96 #include <asm/cpu_device_id.h>
  97 #include <asm/intel-family.h>
  98 #include "../perf_event.h"
  99
 100 MODULE_LICENSE("GPL");
 101
 102 #define DEFINE_CSTATE_FORMAT_ATTR(_var, _name, _format)         \
 103 static ssize_t __cstate_##_var##_show(struct kobject *kobj,     \
 104                                 struct kobj_attribute *attr,    \
 105                                 char *page)                     \
 106 {                                                               \
 107         BUILD_BUG_ON(sizeof(_format) >= PAGE_SIZE);             \
 108         return sprintf(page, _format "\n");                     \
 109 }                                                               \
 110 static struct kobj_attribute format_attr_##_var =               \
 111         __ATTR(_name, 0444, __cstate_##_var##_show, NULL)
 112
 113 static ssize_t cstate_get_attr_cpumask(struct device *dev,
 114                                        struct device_attribute *attr,
 115                                        char *buf);
 116
 117 /* Model -> events mapping */
 118 struct cstate_model {
 119         unsigned long           core_events;
 120         unsigned long           pkg_events;
 121         unsigned long           quirks;
 122 };
 123
 124 /* Quirk flags */
 125 #define SLM_PKG_C6_USE_C7_MSR   (1UL << 0)
 126 #define KNL_CORE_C6_MSR         (1UL << 1)
 127
 128 struct perf_cstate_msr {
 129         u64     msr;
 130         struct  perf_pmu_events_attr *attr;
 131 };
 132
 133
 134 /* cstate_core PMU */
 135 static struct pmu cstate_core_pmu;
 136 static bool has_cstate_core;
 137
 138 enum perf_cstate_core_events {
 139         PERF_CSTATE_CORE_C1_RES = 0,
 140         PERF_CSTATE_CORE_C3_RES,
 141         PERF_CSTATE_CORE_C6_RES,
 142         PERF_CSTATE_CORE_C7_RES,
 143
 144         PERF_CSTATE_CORE_EVENT_MAX,
 145 };
 146
 147 PMU_EVENT_ATTR_STRING(c1-residency, evattr_cstate_core_c1, "event=0x00");
 148 PMU_EVENT_ATTR_STRING(c3-residency, evattr_cstate_core_c3, "event=0x01");
 149 PMU_EVENT_ATTR_STRING(c6-residency, evattr_cstate_core_c6, "event=0x02");
 150 PMU_EVENT_ATTR_STRING(c7-residency, evattr_cstate_core_c7, "event=0x03");
 151
 152 static struct perf_cstate_msr core_msr[] = {
 153         [PERF_CSTATE_CORE_C1_RES] = { MSR_CORE_C1_RES,          &evattr_cstate_core_c1 },
 154         [PERF_CSTATE_CORE_C3_RES] = { MSR_CORE_C3_RESIDENCY,    &evattr_cstate_core_c3 },
 155         [PERF_CSTATE_CORE_C6_RES] = { MSR_CORE_C6_RESIDENCY,    &evattr_cstate_core_c6 },
 156         [PERF_CSTATE_CORE_C7_RES] = { MSR_CORE_C7_RESIDENCY,    &evattr_cstate_core_c7 },
 157 };
 158
 159 static struct attribute *core_events_attrs[PERF_CSTATE_CORE_EVENT_MAX + 1] = {
 160         NULL,
 161 };
 162
 163 static struct attribute_group core_events_attr_group = {
 164         .name = "events",
 165         .attrs = core_events_attrs,
 166 };
 167
 168 DEFINE_CSTATE_FORMAT_ATTR(core_event, event, "config:0-63");
 169 static struct attribute *core_format_attrs[] = {
 170         &format_attr_core_event.attr,
 171         NULL,
 172 };
 173
 174 static struct attribute_group core_format_attr_group = {
 175         .name = "format",
 176         .attrs = core_format_attrs,
 177 };
 178
 179 static cpumask_t cstate_core_cpu_mask;
 180 static DEVICE_ATTR(cpumask, S_IRUGO, cstate_get_attr_cpumask, NULL);
 181
 182 static struct attribute *cstate_cpumask_attrs[] = {
 183         &dev_attr_cpumask.attr,
 184         NULL,
 185 };
 186
 187 static struct attribute_group cpumask_attr_group = {
 188         .attrs = cstate_cpumask_attrs,
 189 };
 190
 191 static const struct attribute_group *core_attr_groups[] = {
 192         &core_events_attr_group,
 193         &core_format_attr_group,
 194         &cpumask_attr_group,
 195         NULL,
 196 };
 197
 198 /* cstate_pkg PMU */
 199 static struct pmu cstate_pkg_pmu;
 200 static bool has_cstate_pkg;
 201
 202 enum perf_cstate_pkg_events {
 203         PERF_CSTATE_PKG_C2_RES = 0,
 204         PERF_CSTATE_PKG_C3_RES,
 205         PERF_CSTATE_PKG_C6_RES,
 206         PERF_CSTATE_PKG_C7_RES,
 207         PERF_CSTATE_PKG_C8_RES,
 208         PERF_CSTATE_PKG_C9_RES,
 209         PERF_CSTATE_PKG_C10_RES,
 210
 211         PERF_CSTATE_PKG_EVENT_MAX,
 212 };
 213
 214 PMU_EVENT_ATTR_STRING(c2-residency, evattr_cstate_pkg_c2, "event=0x00");
 215 PMU_EVENT_ATTR_STRING(c3-residency, evattr_cstate_pkg_c3, "event=0x01");
 216 PMU_EVENT_ATTR_STRING(c6-residency, evattr_cstate_pkg_c6, "event=0x02");
 217 PMU_EVENT_ATTR_STRING(c7-residency, evattr_cstate_pkg_c7, "event=0x03");
 218 PMU_EVENT_ATTR_STRING(c8-residency, evattr_cstate_pkg_c8, "event=0x04");
 219 PMU_EVENT_ATTR_STRING(c9-residency, evattr_cstate_pkg_c9, "event=0x05");
 220 PMU_EVENT_ATTR_STRING(c10-residency, evattr_cstate_pkg_c10, "event=0x06");
 221
 222 static struct perf_cstate_msr pkg_msr[] = {
 223         [PERF_CSTATE_PKG_C2_RES] = { MSR_PKG_C2_RESIDENCY,      &evattr_cstate_pkg_c2 },
 224         [PERF_CSTATE_PKG_C3_RES] = { MSR_PKG_C3_RESIDENCY,      &evattr_cstate_pkg_c3 },
 225         [PERF_CSTATE_PKG_C6_RES] = { MSR_PKG_C6_RESIDENCY,      &evattr_cstate_pkg_c6 },
 226         [PERF_CSTATE_PKG_C7_RES] = { MSR_PKG_C7_RESIDENCY,      &evattr_cstate_pkg_c7 },
 227         [PERF_CSTATE_PKG_C8_RES] = { MSR_PKG_C8_RESIDENCY,      &evattr_cstate_pkg_c8 },
 228         [PERF_CSTATE_PKG_C9_RES] = { MSR_PKG_C9_RESIDENCY,      &evattr_cstate_pkg_c9 },
 229         [PERF_CSTATE_PKG_C10_RES] = { MSR_PKG_C10_RESIDENCY,    &evattr_cstate_pkg_c10 },
 230 };
 231
 232 static struct attribute *pkg_events_attrs[PERF_CSTATE_PKG_EVENT_MAX + 1] = {
 233         NULL,
 234 };
 235
 236 static struct attribute_group pkg_events_attr_group = {
 237         .name = "events",
 238         .attrs = pkg_events_attrs,
 239 };
 240
 241 DEFINE_CSTATE_FORMAT_ATTR(pkg_event, event, "config:0-63");
 242 static struct attribute *pkg_format_attrs[] = {
 243         &format_attr_pkg_event.attr,
 244         NULL,
 245 };
 246 static struct attribute_group pkg_format_attr_group = {
 247         .name = "format",
 248         .attrs = pkg_format_attrs,
 249 };
 250
 251 static cpumask_t cstate_pkg_cpu_mask;
 252
 253 static const struct attribute_group *pkg_attr_groups[] = {
 254         &pkg_events_attr_group,
 255         &pkg_format_attr_group,
 256         &cpumask_attr_group,
 257         NULL,
 258 };
 259
 260 static ssize_t cstate_get_attr_cpumask(struct device *dev,
 261                                        struct device_attribute *attr,
 262                                        char *buf)
 263 {
 264         struct pmu *pmu = dev_get_drvdata(dev);
 265
 266         if (pmu == &cstate_core_pmu)
 267                 return cpumap_print_to_pagebuf(true, buf, &cstate_core_cpu_mask);
 268         else if (pmu == &cstate_pkg_pmu)
 269                 return cpumap_print_to_pagebuf(true, buf, &cstate_pkg_cpu_mask);
 270         else
 271                 return 0;
 272 }
 273
 274 static int cstate_pmu_event_init(struct perf_event *event)
 275 {
 276         u64 cfg = event->attr.config;
 277         int cpu;
 278
 279         if (event->attr.type != event->pmu->type)
 280                 return -ENOENT;
 281
 282         /* unsupported modes and filters */
 283         if (event->attr.sample_period) /* no sampling */
 284                 return -EINVAL;
 285
 286         if (event->cpu < 0)
 287                 return -EINVAL;
 288
 289         if (event->pmu == &cstate_core_pmu) {
 290                 if (cfg >= PERF_CSTATE_CORE_EVENT_MAX)
 291                         return -EINVAL;
 292                 if (!core_msr[cfg].attr)
 293                         return -EINVAL;
 294                 event->hw.event_base = core_msr[cfg].msr;
 295                 cpu = cpumask_any_and(&cstate_core_cpu_mask,
 296                                       topology_sibling_cpumask(event->cpu));
 297         } else if (event->pmu == &cstate_pkg_pmu) {
 298                 if (cfg >= PERF_CSTATE_PKG_EVENT_MAX)
 299                         return -EINVAL;
 300                 cfg = array_index_nospec((unsigned long)cfg, PERF_CSTATE_PKG_EVENT_MAX);
 301                 if (!pkg_msr[cfg].attr)
 302                         return -EINVAL;
 303                 event->hw.event_base = pkg_msr[cfg].msr;
 304                 cpu = cpumask_any_and(&cstate_pkg_cpu_mask,
 305                                       topology_core_cpumask(event->cpu));
 306         } else {
 307                 return -ENOENT;
 308         }
 309
 310         if (cpu >= nr_cpu_ids)
 311                 return -ENODEV;
 312
 313         event->cpu = cpu;
 314         event->hw.config = cfg;
 315         event->hw.idx = -1;
 316         return 0;
 317 }
 318
 319 static inline u64 cstate_pmu_read_counter(struct perf_event *event)
 320 {
 321         u64 val;
 322
 323         rdmsrl(event->hw.event_base, val);
 324         return val;
 325 }
 326
 327 static void cstate_pmu_event_update(struct perf_event *event)
 328 {
 329         struct hw_perf_event *hwc = &event->hw;
 330         u64 prev_raw_count, new_raw_count;
 331
 332 again:
 333         prev_raw_count = local64_read(&hwc->prev_count);
 334         new_raw_count = cstate_pmu_read_counter(event);
 335
 336         if (local64_cmpxchg(&hwc->prev_count, prev_raw_count,
 337                             new_raw_count) != prev_raw_count)
 338                 goto again;
 339
 340         local64_add(new_raw_count - prev_raw_count, &event->count);
 341 }
 342
 343 static void cstate_pmu_event_start(struct perf_event *event, int mode)
 344 {
 345         local64_set(&event->hw.prev_count, cstate_pmu_read_counter(event));
 346 }
 347
 348 static void cstate_pmu_event_stop(struct perf_event *event, int mode)
 349 {
 350         cstate_pmu_event_update(event);
 351 }
 352
 353 static void cstate_pmu_event_del(struct perf_event *event, int mode)
 354 {
 355         cstate_pmu_event_stop(event, PERF_EF_UPDATE);
 356 }
 357
 358 static int cstate_pmu_event_add(struct perf_event *event, int mode)
 359 {
 360         if (mode & PERF_EF_START)
 361                 cstate_pmu_event_start(event, mode);
 362
 363         return 0;
 364 }
 365
 366 /*
 367  * Check if exiting cpu is the designated reader. If so migrate the
 368  * events when there is a valid target available
 369  */
 370 static int cstate_cpu_exit(unsigned int cpu)
 371 {
 372         unsigned int target;
 373
 374         if (has_cstate_core &&
 375             cpumask_test_and_clear_cpu(cpu, &cstate_core_cpu_mask)) {
 376
 377                 target = cpumask_any_but(topology_sibling_cpumask(cpu), cpu);
 378                 /* Migrate events if there is a valid target */
 379                 if (target < nr_cpu_ids) {
 380                         cpumask_set_cpu(target, &cstate_core_cpu_mask);
 381                         perf_pmu_migrate_context(&cstate_core_pmu, cpu, target);
 382                 }
 383         }
 384
 385         if (has_cstate_pkg &&
 386             cpumask_test_and_clear_cpu(cpu, &cstate_pkg_cpu_mask)) {
 387
 388                 target = cpumask_any_but(topology_core_cpumask(cpu), cpu);
 389                 /* Migrate events if there is a valid target */
 390                 if (target < nr_cpu_ids) {
 391                         cpumask_set_cpu(target, &cstate_pkg_cpu_mask);
 392                         perf_pmu_migrate_context(&cstate_pkg_pmu, cpu, target);
 393                 }
 394         }
 395         return 0;
 396 }
 397
 398 static int cstate_cpu_init(unsigned int cpu)
 399 {
 400         unsigned int target;
 401
 402         /*
 403          * If this is the first online thread of that core, set it in
 404          * the core cpu mask as the designated reader.
 405          */
 406         target = cpumask_any_and(&cstate_core_cpu_mask,
 407                                  topology_sibling_cpumask(cpu));
 408
 409         if (has_cstate_core && target >= nr_cpu_ids)
 410                 cpumask_set_cpu(cpu, &cstate_core_cpu_mask);
 411
 412         /*
 413          * If this is the first online thread of that package, set it
 414          * in the package cpu mask as the designated reader.
 415          */
 416         target = cpumask_any_and(&cstate_pkg_cpu_mask,
 417                                  topology_core_cpumask(cpu));
 418         if (has_cstate_pkg && target >= nr_cpu_ids)
 419                 cpumask_set_cpu(cpu, &cstate_pkg_cpu_mask);
 420
 421         return 0;
 422 }
 423
 424 static struct pmu cstate_core_pmu = {
 425         .attr_groups    = core_attr_groups,
 426         .name           = "cstate_core",
 427         .task_ctx_nr    = perf_invalid_context,
 428         .event_init     = cstate_pmu_event_init,
 429         .add            = cstate_pmu_event_add,
 430         .del            = cstate_pmu_event_del,
 431         .start          = cstate_pmu_event_start,
 432         .stop           = cstate_pmu_event_stop,
 433         .read           = cstate_pmu_event_update,
 434         .capabilities   = PERF_PMU_CAP_NO_INTERRUPT | PERF_PMU_CAP_NO_EXCLUDE,
 435         .module         = THIS_MODULE,
 436 };
 437
 438 static struct pmu cstate_pkg_pmu = {
 439         .attr_groups    = pkg_attr_groups,
 440         .name           = "cstate_pkg",
 441         .task_ctx_nr    = perf_invalid_context,
 442         .event_init     = cstate_pmu_event_init,
 443         .add            = cstate_pmu_event_add,
 444         .del            = cstate_pmu_event_del,
 445         .start          = cstate_pmu_event_start,
 446         .stop           = cstate_pmu_event_stop,
 447         .read           = cstate_pmu_event_update,
 448         .capabilities   = PERF_PMU_CAP_NO_INTERRUPT | PERF_PMU_CAP_NO_EXCLUDE,
 449         .module         = THIS_MODULE,
 450 };
 451
 452 static const struct cstate_model nhm_cstates __initconst = {
 453         .core_events            = BIT(PERF_CSTATE_CORE_C3_RES) |
 454                                   BIT(PERF_CSTATE_CORE_C6_RES),
 455
 456         .pkg_events             = BIT(PERF_CSTATE_PKG_C3_RES) |
 457                                   BIT(PERF_CSTATE_PKG_C6_RES) |
 458                                   BIT(PERF_CSTATE_PKG_C7_RES),
 459 };
 460
 461 static const struct cstate_model snb_cstates __initconst = {
 462         .core_events            = BIT(PERF_CSTATE_CORE_C3_RES) |
 463                                   BIT(PERF_CSTATE_CORE_C6_RES) |
 464                                   BIT(PERF_CSTATE_CORE_C7_RES),
 465
 466         .pkg_events             = BIT(PERF_CSTATE_PKG_C2_RES) |
 467                                   BIT(PERF_CSTATE_PKG_C3_RES) |
 468                                   BIT(PERF_CSTATE_PKG_C6_RES) |
 469                                   BIT(PERF_CSTATE_PKG_C7_RES),
 470 };
 471
 472 static const struct cstate_model hswult_cstates __initconst = {
 473         .core_events            = BIT(PERF_CSTATE_CORE_C3_RES) |
 474                                   BIT(PERF_CSTATE_CORE_C6_RES) |
 475                                   BIT(PERF_CSTATE_CORE_C7_RES),
 476
 477         .pkg_events             = BIT(PERF_CSTATE_PKG_C2_RES) |
 478                                   BIT(PERF_CSTATE_PKG_C3_RES) |
 479                                   BIT(PERF_CSTATE_PKG_C6_RES) |
 480                                   BIT(PERF_CSTATE_PKG_C7_RES) |
 481                                   BIT(PERF_CSTATE_PKG_C8_RES) |
 482                                   BIT(PERF_CSTATE_PKG_C9_RES) |
 483                                   BIT(PERF_CSTATE_PKG_C10_RES),
 484 };
 485
 486 static const struct cstate_model cnl_cstates __initconst = {
 487         .core_events            = BIT(PERF_CSTATE_CORE_C1_RES) |
 488                                   BIT(PERF_CSTATE_CORE_C3_RES) |
 489                                   BIT(PERF_CSTATE_CORE_C6_RES) |
 490                                   BIT(PERF_CSTATE_CORE_C7_RES),
 491
 492         .pkg_events             = BIT(PERF_CSTATE_PKG_C2_RES) |
 493                                   BIT(PERF_CSTATE_PKG_C3_RES) |
 494                                   BIT(PERF_CSTATE_PKG_C6_RES) |
 495                                   BIT(PERF_CSTATE_PKG_C7_RES) |
 496                                   BIT(PERF_CSTATE_PKG_C8_RES) |
 497                                   BIT(PERF_CSTATE_PKG_C9_RES) |
 498                                   BIT(PERF_CSTATE_PKG_C10_RES),
 499 };
 500
 501 static const struct cstate_model slm_cstates __initconst = {
 502         .core_events            = BIT(PERF_CSTATE_CORE_C1_RES) |
 503                                   BIT(PERF_CSTATE_CORE_C6_RES),
 504
 505         .pkg_events             = BIT(PERF_CSTATE_PKG_C6_RES),
 506         .quirks                 = SLM_PKG_C6_USE_C7_MSR,
 507 };
 508
 509
 510 static const struct cstate_model knl_cstates __initconst = {
 511         .core_events            = BIT(PERF_CSTATE_CORE_C6_RES),
 512
 513         .pkg_events             = BIT(PERF_CSTATE_PKG_C2_RES) |
 514                                   BIT(PERF_CSTATE_PKG_C3_RES) |
 515                                   BIT(PERF_CSTATE_PKG_C6_RES),
 516         .quirks                 = KNL_CORE_C6_MSR,
 517 };
 518
 519
 520 static const struct cstate_model glm_cstates __initconst = {
 521         .core_events            = BIT(PERF_CSTATE_CORE_C1_RES) |
 522                                   BIT(PERF_CSTATE_CORE_C3_RES) |
 523                                   BIT(PERF_CSTATE_CORE_C6_RES),
 524
 525         .pkg_events             = BIT(PERF_CSTATE_PKG_C2_RES) |
 526                                   BIT(PERF_CSTATE_PKG_C3_RES) |
 527                                   BIT(PERF_CSTATE_PKG_C6_RES) |
 528                                   BIT(PERF_CSTATE_PKG_C10_RES),
 529 };
 530
 531
 532 #define X86_CSTATES_MODEL(model, states)                                \
 533         { X86_VENDOR_INTEL, 6, model, X86_FEATURE_ANY, (unsigned long) &(states) }
 534
 535 static const struct x86_cpu_id intel_cstates_match[] __initconst = {
 536         X86_CSTATES_MODEL(INTEL_FAM6_NEHALEM,    nhm_cstates),
 537         X86_CSTATES_MODEL(INTEL_FAM6_NEHALEM_EP, nhm_cstates),
 538         X86_CSTATES_MODEL(INTEL_FAM6_NEHALEM_EX, nhm_cstates),
 539
 540         X86_CSTATES_MODEL(INTEL_FAM6_WESTMERE,    nhm_cstates),
 541         X86_CSTATES_MODEL(INTEL_FAM6_WESTMERE_EP, nhm_cstates),
 542         X86_CSTATES_MODEL(INTEL_FAM6_WESTMERE_EX, nhm_cstates),
 543
 544         X86_CSTATES_MODEL(INTEL_FAM6_SANDYBRIDGE,   snb_cstates),
 545         X86_CSTATES_MODEL(INTEL_FAM6_SANDYBRIDGE_X, snb_cstates),
 546
 547         X86_CSTATES_MODEL(INTEL_FAM6_IVYBRIDGE,   snb_cstates),
 548         X86_CSTATES_MODEL(INTEL_FAM6_IVYBRIDGE_X, snb_cstates),
 549
 550         X86_CSTATES_MODEL(INTEL_FAM6_HASWELL_CORE, snb_cstates),
 551         X86_CSTATES_MODEL(INTEL_FAM6_HASWELL_X,    snb_cstates),
 552         X86_CSTATES_MODEL(INTEL_FAM6_HASWELL_GT3E, snb_cstates),
 553
 554         X86_CSTATES_MODEL(INTEL_FAM6_HASWELL_ULT, hswult_cstates),
 555
 556         X86_CSTATES_MODEL(INTEL_FAM6_ATOM_SILVERMONT, slm_cstates),
 557         X86_CSTATES_MODEL(INTEL_FAM6_ATOM_SILVERMONT_X, slm_cstates),
 558         X86_CSTATES_MODEL(INTEL_FAM6_ATOM_AIRMONT,     slm_cstates),
 559
 560         X86_CSTATES_MODEL(INTEL_FAM6_BROADWELL_CORE,   snb_cstates),
 561         X86_CSTATES_MODEL(INTEL_FAM6_BROADWELL_XEON_D, snb_cstates),
 562         X86_CSTATES_MODEL(INTEL_FAM6_BROADWELL_GT3E,   snb_cstates),
 563         X86_CSTATES_MODEL(INTEL_FAM6_BROADWELL_X,      snb_cstates),
 564
 565         X86_CSTATES_MODEL(INTEL_FAM6_SKYLAKE_MOBILE,  snb_cstates),
 566         X86_CSTATES_MODEL(INTEL_FAM6_SKYLAKE_DESKTOP, snb_cstates),
 567         X86_CSTATES_MODEL(INTEL_FAM6_SKYLAKE_X, snb_cstates),
 568
 569         X86_CSTATES_MODEL(INTEL_FAM6_KABYLAKE_MOBILE,  snb_cstates),
 570         X86_CSTATES_MODEL(INTEL_FAM6_KABYLAKE_DESKTOP, snb_cstates),
 571
 572         X86_CSTATES_MODEL(INTEL_FAM6_CANNONLAKE_MOBILE, cnl_cstates),
 573
 574         X86_CSTATES_MODEL(INTEL_FAM6_XEON_PHI_KNL, knl_cstates),
 575         X86_CSTATES_MODEL(INTEL_FAM6_XEON_PHI_KNM, knl_cstates),
 576
 577         X86_CSTATES_MODEL(INTEL_FAM6_ATOM_GOLDMONT, glm_cstates),
 578         X86_CSTATES_MODEL(INTEL_FAM6_ATOM_GOLDMONT_X, glm_cstates),
 579
 580         X86_CSTATES_MODEL(INTEL_FAM6_ATOM_GOLDMONT_PLUS, glm_cstates),
 581         { },
 582 };
 583 MODULE_DEVICE_TABLE(x86cpu, intel_cstates_match);
 584
 585 /*
 586  * Probe the cstate events and insert the available one into sysfs attrs
 587  * Return false if there are no available events.
 588  */
 589 static bool __init cstate_probe_msr(const unsigned long evmsk, int max,
 590                                    struct perf_cstate_msr *msr,
 591                                    struct attribute **attrs)
 592 {
 593         bool found = false;
 594         unsigned int bit;
 595         u64 val;
 596
 597         for (bit = 0; bit < max; bit++) {
 598                 if (test_bit(bit, &evmsk) && !rdmsrl_safe(msr[bit].msr, &val)) {
 599                         *attrs++ = &msr[bit].attr->attr.attr;
 600                         found = true;
 601                 } else {
 602                         msr[bit].attr = NULL;
 603                 }
 604         }
 605         *attrs = NULL;
 606
 607         return found;
 608 }
 609
 610 static int __init cstate_probe(const struct cstate_model *cm)
 611 {
 612         /* SLM has different MSR for PKG C6 */
 613         if (cm->quirks & SLM_PKG_C6_USE_C7_MSR)
 614                 pkg_msr[PERF_CSTATE_PKG_C6_RES].msr = MSR_PKG_C7_RESIDENCY;
 615
 616         /* KNL has different MSR for CORE C6 */
 617         if (cm->quirks & KNL_CORE_C6_MSR)
 618                 pkg_msr[PERF_CSTATE_CORE_C6_RES].msr = MSR_KNL_CORE_C6_RESIDENCY;
 619
 620
 621         has_cstate_core = cstate_probe_msr(cm->core_events,
 622                                            PERF_CSTATE_CORE_EVENT_MAX,
 623                                            core_msr, core_events_attrs);
 624
 625         has_cstate_pkg = cstate_probe_msr(cm->pkg_events,
 626                                           PERF_CSTATE_PKG_EVENT_MAX,
 627                                           pkg_msr, pkg_events_attrs);
 628
 629         return (has_cstate_core || has_cstate_pkg) ? 0 : -ENODEV;
 630 }
 631
 632 static inline void cstate_cleanup(void)
 633 {
 634         cpuhp_remove_state_nocalls(CPUHP_AP_PERF_X86_CSTATE_ONLINE);
 635         cpuhp_remove_state_nocalls(CPUHP_AP_PERF_X86_CSTATE_STARTING);
 636
 637         if (has_cstate_core)
 638                 perf_pmu_unregister(&cstate_core_pmu);
 639
 640         if (has_cstate_pkg)
 641                 perf_pmu_unregister(&cstate_pkg_pmu);
 642 }
 643
 644 static int __init cstate_init(void)
 645 {
 646         int err;
 647
 648         cpuhp_setup_state(CPUHP_AP_PERF_X86_CSTATE_STARTING,
 649                           "perf/x86/cstate:starting", cstate_cpu_init, NULL);
 650         cpuhp_setup_state(CPUHP_AP_PERF_X86_CSTATE_ONLINE,
 651                           "perf/x86/cstate:online", NULL, cstate_cpu_exit);
 652
 653         if (has_cstate_core) {
 654                 err = perf_pmu_register(&cstate_core_pmu, cstate_core_pmu.name, -1);
 655                 if (err) {
 656                         has_cstate_core = false;
 657                         pr_info("Failed to register cstate core pmu\n");
 658                         cstate_cleanup();
 659                         return err;
 660                 }
 661         }
 662
 663         if (has_cstate_pkg) {
 664                 err = perf_pmu_register(&cstate_pkg_pmu, cstate_pkg_pmu.name, -1);
 665                 if (err) {
 666                         has_cstate_pkg = false;
 667                         pr_info("Failed to register cstate pkg pmu\n");
 668                         cstate_cleanup();
 669                         return err;
 670                 }
 671         }
 672         return 0;
 673 }
 674
 675 static int __init cstate_pmu_init(void)
 676 {
 677         const struct x86_cpu_id *id;
 678         int err;
 679
 680         if (boot_cpu_has(X86_FEATURE_HYPERVISOR))
 681                 return -ENODEV;
 682
 683         id = x86_match_cpu(intel_cstates_match);
 684         if (!id)
 685                 return -ENODEV;
 686
 687         err = cstate_probe((const struct cstate_model *) id->driver_data);
 688         if (err)
 689                 return err;
 690
 691         return cstate_init();
 692 }
 693 module_init(cstate_pmu_init);
 694
 695 static void __exit cstate_pmu_exit(void)
 696 {
 697         cstate_cleanup();
 698 }
 699 module_exit(cstate_pmu_exit);