xref: /openbmc/linux/arch/x86/events/intel/cstate.c (revision 234489ac)
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,ICX,TNT,ADL,RPL
44  *					  MTL
45  *			 Scope: Core (each processor core has a MSR)
46  *	MSR_CORE_C3_RESIDENCY: CORE C3 Residency Counter
47  *			       perf code: 0x01
48  *			       Available model: NHM,WSM,SNB,IVB,HSW,BDW,SKL,GLM,
49  *						CNL,KBL,CML,TNT
50  *			       Scope: Core
51  *	MSR_CORE_C6_RESIDENCY: CORE C6 Residency Counter
52  *			       perf code: 0x02
53  *			       Available model: SLM,AMT,NHM,WSM,SNB,IVB,HSW,BDW,
54  *						SKL,KNL,GLM,CNL,KBL,CML,ICL,ICX,
55  *						TGL,TNT,RKL,ADL,RPL,SPR,MTL
56  *			       Scope: Core
57  *	MSR_CORE_C7_RESIDENCY: CORE C7 Residency Counter
58  *			       perf code: 0x03
59  *			       Available model: SNB,IVB,HSW,BDW,SKL,CNL,KBL,CML,
60  *						ICL,TGL,RKL,ADL,RPL,MTL
61  *			       Scope: Core
62  *	MSR_PKG_C2_RESIDENCY:  Package C2 Residency Counter.
63  *			       perf code: 0x00
64  *			       Available model: SNB,IVB,HSW,BDW,SKL,KNL,GLM,CNL,
65  *						KBL,CML,ICL,ICX,TGL,TNT,RKL,ADL,
66  *						RPL,SPR,MTL
67  *			       Scope: Package (physical package)
68  *	MSR_PKG_C3_RESIDENCY:  Package C3 Residency Counter.
69  *			       perf code: 0x01
70  *			       Available model: NHM,WSM,SNB,IVB,HSW,BDW,SKL,KNL,
71  *						GLM,CNL,KBL,CML,ICL,TGL,TNT,RKL,
72  *						ADL,RPL,MTL
73  *			       Scope: Package (physical package)
74  *	MSR_PKG_C6_RESIDENCY:  Package C6 Residency Counter.
75  *			       perf code: 0x02
76  *			       Available model: SLM,AMT,NHM,WSM,SNB,IVB,HSW,BDW,
77  *						SKL,KNL,GLM,CNL,KBL,CML,ICL,ICX,
78  *						TGL,TNT,RKL,ADL,RPL,SPR,MTL
79  *			       Scope: Package (physical package)
80  *	MSR_PKG_C7_RESIDENCY:  Package C7 Residency Counter.
81  *			       perf code: 0x03
82  *			       Available model: NHM,WSM,SNB,IVB,HSW,BDW,SKL,CNL,
83  *						KBL,CML,ICL,TGL,RKL,ADL,RPL,MTL
84  *			       Scope: Package (physical package)
85  *	MSR_PKG_C8_RESIDENCY:  Package C8 Residency Counter.
86  *			       perf code: 0x04
87  *			       Available model: HSW ULT,KBL,CNL,CML,ICL,TGL,RKL,
88  *						ADL,RPL,MTL
89  *			       Scope: Package (physical package)
90  *	MSR_PKG_C9_RESIDENCY:  Package C9 Residency Counter.
91  *			       perf code: 0x05
92  *			       Available model: HSW ULT,KBL,CNL,CML,ICL,TGL,RKL,
93  *						ADL,RPL,MTL
94  *			       Scope: Package (physical package)
95  *	MSR_PKG_C10_RESIDENCY: Package C10 Residency Counter.
96  *			       perf code: 0x06
97  *			       Available model: HSW ULT,KBL,GLM,CNL,CML,ICL,TGL,
98  *						TNT,RKL,ADL,RPL,MTL
99  *			       Scope: Package (physical package)
100  *
101  */
102 
103 #include <linux/module.h>
104 #include <linux/slab.h>
105 #include <linux/perf_event.h>
106 #include <linux/nospec.h>
107 #include <asm/cpu_device_id.h>
108 #include <asm/intel-family.h>
109 #include "../perf_event.h"
110 #include "../probe.h"
111 
112 MODULE_LICENSE("GPL");
113 
114 #define DEFINE_CSTATE_FORMAT_ATTR(_var, _name, _format)		\
115 static ssize_t __cstate_##_var##_show(struct device *dev,	\
116 				struct device_attribute *attr,	\
117 				char *page)			\
118 {								\
119 	BUILD_BUG_ON(sizeof(_format) >= PAGE_SIZE);		\
120 	return sprintf(page, _format "\n");			\
121 }								\
122 static struct device_attribute format_attr_##_var =		\
123 	__ATTR(_name, 0444, __cstate_##_var##_show, NULL)
124 
125 static ssize_t cstate_get_attr_cpumask(struct device *dev,
126 				       struct device_attribute *attr,
127 				       char *buf);
128 
129 /* Model -> events mapping */
130 struct cstate_model {
131 	unsigned long		core_events;
132 	unsigned long		pkg_events;
133 	unsigned long		quirks;
134 };
135 
136 /* Quirk flags */
137 #define SLM_PKG_C6_USE_C7_MSR	(1UL << 0)
138 #define KNL_CORE_C6_MSR		(1UL << 1)
139 
140 struct perf_cstate_msr {
141 	u64	msr;
142 	struct	perf_pmu_events_attr *attr;
143 };
144 
145 
146 /* cstate_core PMU */
147 static struct pmu cstate_core_pmu;
148 static bool has_cstate_core;
149 
150 enum perf_cstate_core_events {
151 	PERF_CSTATE_CORE_C1_RES = 0,
152 	PERF_CSTATE_CORE_C3_RES,
153 	PERF_CSTATE_CORE_C6_RES,
154 	PERF_CSTATE_CORE_C7_RES,
155 
156 	PERF_CSTATE_CORE_EVENT_MAX,
157 };
158 
159 PMU_EVENT_ATTR_STRING(c1-residency, attr_cstate_core_c1, "event=0x00");
160 PMU_EVENT_ATTR_STRING(c3-residency, attr_cstate_core_c3, "event=0x01");
161 PMU_EVENT_ATTR_STRING(c6-residency, attr_cstate_core_c6, "event=0x02");
162 PMU_EVENT_ATTR_STRING(c7-residency, attr_cstate_core_c7, "event=0x03");
163 
164 static unsigned long core_msr_mask;
165 
166 PMU_EVENT_GROUP(events, cstate_core_c1);
167 PMU_EVENT_GROUP(events, cstate_core_c3);
168 PMU_EVENT_GROUP(events, cstate_core_c6);
169 PMU_EVENT_GROUP(events, cstate_core_c7);
170 
171 static bool test_msr(int idx, void *data)
172 {
173 	return test_bit(idx, (unsigned long *) data);
174 }
175 
176 static struct perf_msr core_msr[] = {
177 	[PERF_CSTATE_CORE_C1_RES] = { MSR_CORE_C1_RES,		&group_cstate_core_c1,	test_msr },
178 	[PERF_CSTATE_CORE_C3_RES] = { MSR_CORE_C3_RESIDENCY,	&group_cstate_core_c3,	test_msr },
179 	[PERF_CSTATE_CORE_C6_RES] = { MSR_CORE_C6_RESIDENCY,	&group_cstate_core_c6,	test_msr },
180 	[PERF_CSTATE_CORE_C7_RES] = { MSR_CORE_C7_RESIDENCY,	&group_cstate_core_c7,	test_msr },
181 };
182 
183 static struct attribute *attrs_empty[] = {
184 	NULL,
185 };
186 
187 /*
188  * There are no default events, but we need to create
189  * "events" group (with empty attrs) before updating
190  * it with detected events.
191  */
192 static struct attribute_group core_events_attr_group = {
193 	.name = "events",
194 	.attrs = attrs_empty,
195 };
196 
197 DEFINE_CSTATE_FORMAT_ATTR(core_event, event, "config:0-63");
198 static struct attribute *core_format_attrs[] = {
199 	&format_attr_core_event.attr,
200 	NULL,
201 };
202 
203 static struct attribute_group core_format_attr_group = {
204 	.name = "format",
205 	.attrs = core_format_attrs,
206 };
207 
208 static cpumask_t cstate_core_cpu_mask;
209 static DEVICE_ATTR(cpumask, S_IRUGO, cstate_get_attr_cpumask, NULL);
210 
211 static struct attribute *cstate_cpumask_attrs[] = {
212 	&dev_attr_cpumask.attr,
213 	NULL,
214 };
215 
216 static struct attribute_group cpumask_attr_group = {
217 	.attrs = cstate_cpumask_attrs,
218 };
219 
220 static const struct attribute_group *core_attr_groups[] = {
221 	&core_events_attr_group,
222 	&core_format_attr_group,
223 	&cpumask_attr_group,
224 	NULL,
225 };
226 
227 /* cstate_pkg PMU */
228 static struct pmu cstate_pkg_pmu;
229 static bool has_cstate_pkg;
230 
231 enum perf_cstate_pkg_events {
232 	PERF_CSTATE_PKG_C2_RES = 0,
233 	PERF_CSTATE_PKG_C3_RES,
234 	PERF_CSTATE_PKG_C6_RES,
235 	PERF_CSTATE_PKG_C7_RES,
236 	PERF_CSTATE_PKG_C8_RES,
237 	PERF_CSTATE_PKG_C9_RES,
238 	PERF_CSTATE_PKG_C10_RES,
239 
240 	PERF_CSTATE_PKG_EVENT_MAX,
241 };
242 
243 PMU_EVENT_ATTR_STRING(c2-residency,  attr_cstate_pkg_c2,  "event=0x00");
244 PMU_EVENT_ATTR_STRING(c3-residency,  attr_cstate_pkg_c3,  "event=0x01");
245 PMU_EVENT_ATTR_STRING(c6-residency,  attr_cstate_pkg_c6,  "event=0x02");
246 PMU_EVENT_ATTR_STRING(c7-residency,  attr_cstate_pkg_c7,  "event=0x03");
247 PMU_EVENT_ATTR_STRING(c8-residency,  attr_cstate_pkg_c8,  "event=0x04");
248 PMU_EVENT_ATTR_STRING(c9-residency,  attr_cstate_pkg_c9,  "event=0x05");
249 PMU_EVENT_ATTR_STRING(c10-residency, attr_cstate_pkg_c10, "event=0x06");
250 
251 static unsigned long pkg_msr_mask;
252 
253 PMU_EVENT_GROUP(events, cstate_pkg_c2);
254 PMU_EVENT_GROUP(events, cstate_pkg_c3);
255 PMU_EVENT_GROUP(events, cstate_pkg_c6);
256 PMU_EVENT_GROUP(events, cstate_pkg_c7);
257 PMU_EVENT_GROUP(events, cstate_pkg_c8);
258 PMU_EVENT_GROUP(events, cstate_pkg_c9);
259 PMU_EVENT_GROUP(events, cstate_pkg_c10);
260 
261 static struct perf_msr pkg_msr[] = {
262 	[PERF_CSTATE_PKG_C2_RES]  = { MSR_PKG_C2_RESIDENCY,	&group_cstate_pkg_c2,	test_msr },
263 	[PERF_CSTATE_PKG_C3_RES]  = { MSR_PKG_C3_RESIDENCY,	&group_cstate_pkg_c3,	test_msr },
264 	[PERF_CSTATE_PKG_C6_RES]  = { MSR_PKG_C6_RESIDENCY,	&group_cstate_pkg_c6,	test_msr },
265 	[PERF_CSTATE_PKG_C7_RES]  = { MSR_PKG_C7_RESIDENCY,	&group_cstate_pkg_c7,	test_msr },
266 	[PERF_CSTATE_PKG_C8_RES]  = { MSR_PKG_C8_RESIDENCY,	&group_cstate_pkg_c8,	test_msr },
267 	[PERF_CSTATE_PKG_C9_RES]  = { MSR_PKG_C9_RESIDENCY,	&group_cstate_pkg_c9,	test_msr },
268 	[PERF_CSTATE_PKG_C10_RES] = { MSR_PKG_C10_RESIDENCY,	&group_cstate_pkg_c10,	test_msr },
269 };
270 
271 static struct attribute_group pkg_events_attr_group = {
272 	.name = "events",
273 	.attrs = attrs_empty,
274 };
275 
276 DEFINE_CSTATE_FORMAT_ATTR(pkg_event, event, "config:0-63");
277 static struct attribute *pkg_format_attrs[] = {
278 	&format_attr_pkg_event.attr,
279 	NULL,
280 };
281 static struct attribute_group pkg_format_attr_group = {
282 	.name = "format",
283 	.attrs = pkg_format_attrs,
284 };
285 
286 static cpumask_t cstate_pkg_cpu_mask;
287 
288 static const struct attribute_group *pkg_attr_groups[] = {
289 	&pkg_events_attr_group,
290 	&pkg_format_attr_group,
291 	&cpumask_attr_group,
292 	NULL,
293 };
294 
295 static ssize_t cstate_get_attr_cpumask(struct device *dev,
296 				       struct device_attribute *attr,
297 				       char *buf)
298 {
299 	struct pmu *pmu = dev_get_drvdata(dev);
300 
301 	if (pmu == &cstate_core_pmu)
302 		return cpumap_print_to_pagebuf(true, buf, &cstate_core_cpu_mask);
303 	else if (pmu == &cstate_pkg_pmu)
304 		return cpumap_print_to_pagebuf(true, buf, &cstate_pkg_cpu_mask);
305 	else
306 		return 0;
307 }
308 
309 static int cstate_pmu_event_init(struct perf_event *event)
310 {
311 	u64 cfg = event->attr.config;
312 	int cpu;
313 
314 	if (event->attr.type != event->pmu->type)
315 		return -ENOENT;
316 
317 	/* unsupported modes and filters */
318 	if (event->attr.sample_period) /* no sampling */
319 		return -EINVAL;
320 
321 	if (event->cpu < 0)
322 		return -EINVAL;
323 
324 	if (event->pmu == &cstate_core_pmu) {
325 		if (cfg >= PERF_CSTATE_CORE_EVENT_MAX)
326 			return -EINVAL;
327 		cfg = array_index_nospec((unsigned long)cfg, PERF_CSTATE_CORE_EVENT_MAX);
328 		if (!(core_msr_mask & (1 << cfg)))
329 			return -EINVAL;
330 		event->hw.event_base = core_msr[cfg].msr;
331 		cpu = cpumask_any_and(&cstate_core_cpu_mask,
332 				      topology_sibling_cpumask(event->cpu));
333 	} else if (event->pmu == &cstate_pkg_pmu) {
334 		if (cfg >= PERF_CSTATE_PKG_EVENT_MAX)
335 			return -EINVAL;
336 		cfg = array_index_nospec((unsigned long)cfg, PERF_CSTATE_PKG_EVENT_MAX);
337 		if (!(pkg_msr_mask & (1 << cfg)))
338 			return -EINVAL;
339 		event->hw.event_base = pkg_msr[cfg].msr;
340 		cpu = cpumask_any_and(&cstate_pkg_cpu_mask,
341 				      topology_die_cpumask(event->cpu));
342 	} else {
343 		return -ENOENT;
344 	}
345 
346 	if (cpu >= nr_cpu_ids)
347 		return -ENODEV;
348 
349 	event->cpu = cpu;
350 	event->hw.config = cfg;
351 	event->hw.idx = -1;
352 	return 0;
353 }
354 
355 static inline u64 cstate_pmu_read_counter(struct perf_event *event)
356 {
357 	u64 val;
358 
359 	rdmsrl(event->hw.event_base, val);
360 	return val;
361 }
362 
363 static void cstate_pmu_event_update(struct perf_event *event)
364 {
365 	struct hw_perf_event *hwc = &event->hw;
366 	u64 prev_raw_count, new_raw_count;
367 
368 again:
369 	prev_raw_count = local64_read(&hwc->prev_count);
370 	new_raw_count = cstate_pmu_read_counter(event);
371 
372 	if (local64_cmpxchg(&hwc->prev_count, prev_raw_count,
373 			    new_raw_count) != prev_raw_count)
374 		goto again;
375 
376 	local64_add(new_raw_count - prev_raw_count, &event->count);
377 }
378 
379 static void cstate_pmu_event_start(struct perf_event *event, int mode)
380 {
381 	local64_set(&event->hw.prev_count, cstate_pmu_read_counter(event));
382 }
383 
384 static void cstate_pmu_event_stop(struct perf_event *event, int mode)
385 {
386 	cstate_pmu_event_update(event);
387 }
388 
389 static void cstate_pmu_event_del(struct perf_event *event, int mode)
390 {
391 	cstate_pmu_event_stop(event, PERF_EF_UPDATE);
392 }
393 
394 static int cstate_pmu_event_add(struct perf_event *event, int mode)
395 {
396 	if (mode & PERF_EF_START)
397 		cstate_pmu_event_start(event, mode);
398 
399 	return 0;
400 }
401 
402 /*
403  * Check if exiting cpu is the designated reader. If so migrate the
404  * events when there is a valid target available
405  */
406 static int cstate_cpu_exit(unsigned int cpu)
407 {
408 	unsigned int target;
409 
410 	if (has_cstate_core &&
411 	    cpumask_test_and_clear_cpu(cpu, &cstate_core_cpu_mask)) {
412 
413 		target = cpumask_any_but(topology_sibling_cpumask(cpu), cpu);
414 		/* Migrate events if there is a valid target */
415 		if (target < nr_cpu_ids) {
416 			cpumask_set_cpu(target, &cstate_core_cpu_mask);
417 			perf_pmu_migrate_context(&cstate_core_pmu, cpu, target);
418 		}
419 	}
420 
421 	if (has_cstate_pkg &&
422 	    cpumask_test_and_clear_cpu(cpu, &cstate_pkg_cpu_mask)) {
423 
424 		target = cpumask_any_but(topology_die_cpumask(cpu), cpu);
425 		/* Migrate events if there is a valid target */
426 		if (target < nr_cpu_ids) {
427 			cpumask_set_cpu(target, &cstate_pkg_cpu_mask);
428 			perf_pmu_migrate_context(&cstate_pkg_pmu, cpu, target);
429 		}
430 	}
431 	return 0;
432 }
433 
434 static int cstate_cpu_init(unsigned int cpu)
435 {
436 	unsigned int target;
437 
438 	/*
439 	 * If this is the first online thread of that core, set it in
440 	 * the core cpu mask as the designated reader.
441 	 */
442 	target = cpumask_any_and(&cstate_core_cpu_mask,
443 				 topology_sibling_cpumask(cpu));
444 
445 	if (has_cstate_core && target >= nr_cpu_ids)
446 		cpumask_set_cpu(cpu, &cstate_core_cpu_mask);
447 
448 	/*
449 	 * If this is the first online thread of that package, set it
450 	 * in the package cpu mask as the designated reader.
451 	 */
452 	target = cpumask_any_and(&cstate_pkg_cpu_mask,
453 				 topology_die_cpumask(cpu));
454 	if (has_cstate_pkg && target >= nr_cpu_ids)
455 		cpumask_set_cpu(cpu, &cstate_pkg_cpu_mask);
456 
457 	return 0;
458 }
459 
460 static const struct attribute_group *core_attr_update[] = {
461 	&group_cstate_core_c1,
462 	&group_cstate_core_c3,
463 	&group_cstate_core_c6,
464 	&group_cstate_core_c7,
465 	NULL,
466 };
467 
468 static const struct attribute_group *pkg_attr_update[] = {
469 	&group_cstate_pkg_c2,
470 	&group_cstate_pkg_c3,
471 	&group_cstate_pkg_c6,
472 	&group_cstate_pkg_c7,
473 	&group_cstate_pkg_c8,
474 	&group_cstate_pkg_c9,
475 	&group_cstate_pkg_c10,
476 	NULL,
477 };
478 
479 static struct pmu cstate_core_pmu = {
480 	.attr_groups	= core_attr_groups,
481 	.attr_update	= core_attr_update,
482 	.name		= "cstate_core",
483 	.task_ctx_nr	= perf_invalid_context,
484 	.event_init	= cstate_pmu_event_init,
485 	.add		= cstate_pmu_event_add,
486 	.del		= cstate_pmu_event_del,
487 	.start		= cstate_pmu_event_start,
488 	.stop		= cstate_pmu_event_stop,
489 	.read		= cstate_pmu_event_update,
490 	.capabilities	= PERF_PMU_CAP_NO_INTERRUPT | PERF_PMU_CAP_NO_EXCLUDE,
491 	.module		= THIS_MODULE,
492 };
493 
494 static struct pmu cstate_pkg_pmu = {
495 	.attr_groups	= pkg_attr_groups,
496 	.attr_update	= pkg_attr_update,
497 	.name		= "cstate_pkg",
498 	.task_ctx_nr	= perf_invalid_context,
499 	.event_init	= cstate_pmu_event_init,
500 	.add		= cstate_pmu_event_add,
501 	.del		= cstate_pmu_event_del,
502 	.start		= cstate_pmu_event_start,
503 	.stop		= cstate_pmu_event_stop,
504 	.read		= cstate_pmu_event_update,
505 	.capabilities	= PERF_PMU_CAP_NO_INTERRUPT | PERF_PMU_CAP_NO_EXCLUDE,
506 	.module		= THIS_MODULE,
507 };
508 
509 static const struct cstate_model nhm_cstates __initconst = {
510 	.core_events		= BIT(PERF_CSTATE_CORE_C3_RES) |
511 				  BIT(PERF_CSTATE_CORE_C6_RES),
512 
513 	.pkg_events		= BIT(PERF_CSTATE_PKG_C3_RES) |
514 				  BIT(PERF_CSTATE_PKG_C6_RES) |
515 				  BIT(PERF_CSTATE_PKG_C7_RES),
516 };
517 
518 static const struct cstate_model snb_cstates __initconst = {
519 	.core_events		= BIT(PERF_CSTATE_CORE_C3_RES) |
520 				  BIT(PERF_CSTATE_CORE_C6_RES) |
521 				  BIT(PERF_CSTATE_CORE_C7_RES),
522 
523 	.pkg_events		= BIT(PERF_CSTATE_PKG_C2_RES) |
524 				  BIT(PERF_CSTATE_PKG_C3_RES) |
525 				  BIT(PERF_CSTATE_PKG_C6_RES) |
526 				  BIT(PERF_CSTATE_PKG_C7_RES),
527 };
528 
529 static const struct cstate_model hswult_cstates __initconst = {
530 	.core_events		= BIT(PERF_CSTATE_CORE_C3_RES) |
531 				  BIT(PERF_CSTATE_CORE_C6_RES) |
532 				  BIT(PERF_CSTATE_CORE_C7_RES),
533 
534 	.pkg_events		= BIT(PERF_CSTATE_PKG_C2_RES) |
535 				  BIT(PERF_CSTATE_PKG_C3_RES) |
536 				  BIT(PERF_CSTATE_PKG_C6_RES) |
537 				  BIT(PERF_CSTATE_PKG_C7_RES) |
538 				  BIT(PERF_CSTATE_PKG_C8_RES) |
539 				  BIT(PERF_CSTATE_PKG_C9_RES) |
540 				  BIT(PERF_CSTATE_PKG_C10_RES),
541 };
542 
543 static const struct cstate_model cnl_cstates __initconst = {
544 	.core_events		= BIT(PERF_CSTATE_CORE_C1_RES) |
545 				  BIT(PERF_CSTATE_CORE_C3_RES) |
546 				  BIT(PERF_CSTATE_CORE_C6_RES) |
547 				  BIT(PERF_CSTATE_CORE_C7_RES),
548 
549 	.pkg_events		= BIT(PERF_CSTATE_PKG_C2_RES) |
550 				  BIT(PERF_CSTATE_PKG_C3_RES) |
551 				  BIT(PERF_CSTATE_PKG_C6_RES) |
552 				  BIT(PERF_CSTATE_PKG_C7_RES) |
553 				  BIT(PERF_CSTATE_PKG_C8_RES) |
554 				  BIT(PERF_CSTATE_PKG_C9_RES) |
555 				  BIT(PERF_CSTATE_PKG_C10_RES),
556 };
557 
558 static const struct cstate_model icl_cstates __initconst = {
559 	.core_events		= BIT(PERF_CSTATE_CORE_C6_RES) |
560 				  BIT(PERF_CSTATE_CORE_C7_RES),
561 
562 	.pkg_events		= BIT(PERF_CSTATE_PKG_C2_RES) |
563 				  BIT(PERF_CSTATE_PKG_C3_RES) |
564 				  BIT(PERF_CSTATE_PKG_C6_RES) |
565 				  BIT(PERF_CSTATE_PKG_C7_RES) |
566 				  BIT(PERF_CSTATE_PKG_C8_RES) |
567 				  BIT(PERF_CSTATE_PKG_C9_RES) |
568 				  BIT(PERF_CSTATE_PKG_C10_RES),
569 };
570 
571 static const struct cstate_model icx_cstates __initconst = {
572 	.core_events		= BIT(PERF_CSTATE_CORE_C1_RES) |
573 				  BIT(PERF_CSTATE_CORE_C6_RES),
574 
575 	.pkg_events		= BIT(PERF_CSTATE_PKG_C2_RES) |
576 				  BIT(PERF_CSTATE_PKG_C6_RES),
577 };
578 
579 static const struct cstate_model adl_cstates __initconst = {
580 	.core_events		= BIT(PERF_CSTATE_CORE_C1_RES) |
581 				  BIT(PERF_CSTATE_CORE_C6_RES) |
582 				  BIT(PERF_CSTATE_CORE_C7_RES),
583 
584 	.pkg_events		= BIT(PERF_CSTATE_PKG_C2_RES) |
585 				  BIT(PERF_CSTATE_PKG_C3_RES) |
586 				  BIT(PERF_CSTATE_PKG_C6_RES) |
587 				  BIT(PERF_CSTATE_PKG_C7_RES) |
588 				  BIT(PERF_CSTATE_PKG_C8_RES) |
589 				  BIT(PERF_CSTATE_PKG_C9_RES) |
590 				  BIT(PERF_CSTATE_PKG_C10_RES),
591 };
592 
593 static const struct cstate_model slm_cstates __initconst = {
594 	.core_events		= BIT(PERF_CSTATE_CORE_C1_RES) |
595 				  BIT(PERF_CSTATE_CORE_C6_RES),
596 
597 	.pkg_events		= BIT(PERF_CSTATE_PKG_C6_RES),
598 	.quirks			= SLM_PKG_C6_USE_C7_MSR,
599 };
600 
601 
602 static const struct cstate_model knl_cstates __initconst = {
603 	.core_events		= BIT(PERF_CSTATE_CORE_C6_RES),
604 
605 	.pkg_events		= BIT(PERF_CSTATE_PKG_C2_RES) |
606 				  BIT(PERF_CSTATE_PKG_C3_RES) |
607 				  BIT(PERF_CSTATE_PKG_C6_RES),
608 	.quirks			= KNL_CORE_C6_MSR,
609 };
610 
611 
612 static const struct cstate_model glm_cstates __initconst = {
613 	.core_events		= BIT(PERF_CSTATE_CORE_C1_RES) |
614 				  BIT(PERF_CSTATE_CORE_C3_RES) |
615 				  BIT(PERF_CSTATE_CORE_C6_RES),
616 
617 	.pkg_events		= BIT(PERF_CSTATE_PKG_C2_RES) |
618 				  BIT(PERF_CSTATE_PKG_C3_RES) |
619 				  BIT(PERF_CSTATE_PKG_C6_RES) |
620 				  BIT(PERF_CSTATE_PKG_C10_RES),
621 };
622 
623 
624 static const struct x86_cpu_id intel_cstates_match[] __initconst = {
625 	X86_MATCH_INTEL_FAM6_MODEL(NEHALEM,		&nhm_cstates),
626 	X86_MATCH_INTEL_FAM6_MODEL(NEHALEM_EP,		&nhm_cstates),
627 	X86_MATCH_INTEL_FAM6_MODEL(NEHALEM_EX,		&nhm_cstates),
628 
629 	X86_MATCH_INTEL_FAM6_MODEL(WESTMERE,		&nhm_cstates),
630 	X86_MATCH_INTEL_FAM6_MODEL(WESTMERE_EP,		&nhm_cstates),
631 	X86_MATCH_INTEL_FAM6_MODEL(WESTMERE_EX,		&nhm_cstates),
632 
633 	X86_MATCH_INTEL_FAM6_MODEL(SANDYBRIDGE,		&snb_cstates),
634 	X86_MATCH_INTEL_FAM6_MODEL(SANDYBRIDGE_X,	&snb_cstates),
635 
636 	X86_MATCH_INTEL_FAM6_MODEL(IVYBRIDGE,		&snb_cstates),
637 	X86_MATCH_INTEL_FAM6_MODEL(IVYBRIDGE_X,		&snb_cstates),
638 
639 	X86_MATCH_INTEL_FAM6_MODEL(HASWELL,		&snb_cstates),
640 	X86_MATCH_INTEL_FAM6_MODEL(HASWELL_X,		&snb_cstates),
641 	X86_MATCH_INTEL_FAM6_MODEL(HASWELL_G,		&snb_cstates),
642 
643 	X86_MATCH_INTEL_FAM6_MODEL(HASWELL_L,		&hswult_cstates),
644 
645 	X86_MATCH_INTEL_FAM6_MODEL(ATOM_SILVERMONT,	&slm_cstates),
646 	X86_MATCH_INTEL_FAM6_MODEL(ATOM_SILVERMONT_D,	&slm_cstates),
647 	X86_MATCH_INTEL_FAM6_MODEL(ATOM_AIRMONT,	&slm_cstates),
648 
649 	X86_MATCH_INTEL_FAM6_MODEL(BROADWELL,		&snb_cstates),
650 	X86_MATCH_INTEL_FAM6_MODEL(BROADWELL_D,		&snb_cstates),
651 	X86_MATCH_INTEL_FAM6_MODEL(BROADWELL_G,		&snb_cstates),
652 	X86_MATCH_INTEL_FAM6_MODEL(BROADWELL_X,		&snb_cstates),
653 
654 	X86_MATCH_INTEL_FAM6_MODEL(SKYLAKE_L,		&snb_cstates),
655 	X86_MATCH_INTEL_FAM6_MODEL(SKYLAKE,		&snb_cstates),
656 	X86_MATCH_INTEL_FAM6_MODEL(SKYLAKE_X,		&snb_cstates),
657 
658 	X86_MATCH_INTEL_FAM6_MODEL(KABYLAKE_L,		&hswult_cstates),
659 	X86_MATCH_INTEL_FAM6_MODEL(KABYLAKE,		&hswult_cstates),
660 	X86_MATCH_INTEL_FAM6_MODEL(COMETLAKE_L,		&hswult_cstates),
661 	X86_MATCH_INTEL_FAM6_MODEL(COMETLAKE,		&hswult_cstates),
662 
663 	X86_MATCH_INTEL_FAM6_MODEL(CANNONLAKE_L,	&cnl_cstates),
664 
665 	X86_MATCH_INTEL_FAM6_MODEL(XEON_PHI_KNL,	&knl_cstates),
666 	X86_MATCH_INTEL_FAM6_MODEL(XEON_PHI_KNM,	&knl_cstates),
667 
668 	X86_MATCH_INTEL_FAM6_MODEL(ATOM_GOLDMONT,	&glm_cstates),
669 	X86_MATCH_INTEL_FAM6_MODEL(ATOM_GOLDMONT_D,	&glm_cstates),
670 	X86_MATCH_INTEL_FAM6_MODEL(ATOM_GOLDMONT_PLUS,	&glm_cstates),
671 	X86_MATCH_INTEL_FAM6_MODEL(ATOM_TREMONT_D,	&glm_cstates),
672 	X86_MATCH_INTEL_FAM6_MODEL(ATOM_TREMONT,	&glm_cstates),
673 	X86_MATCH_INTEL_FAM6_MODEL(ATOM_TREMONT_L,	&glm_cstates),
674 
675 	X86_MATCH_INTEL_FAM6_MODEL(ICELAKE_L,		&icl_cstates),
676 	X86_MATCH_INTEL_FAM6_MODEL(ICELAKE,		&icl_cstates),
677 	X86_MATCH_INTEL_FAM6_MODEL(ICELAKE_X,		&icx_cstates),
678 	X86_MATCH_INTEL_FAM6_MODEL(ICELAKE_D,		&icx_cstates),
679 	X86_MATCH_INTEL_FAM6_MODEL(SAPPHIRERAPIDS_X,	&icx_cstates),
680 	X86_MATCH_INTEL_FAM6_MODEL(EMERALDRAPIDS_X,	&icx_cstates),
681 	X86_MATCH_INTEL_FAM6_MODEL(GRANITERAPIDS_X,	&icx_cstates),
682 	X86_MATCH_INTEL_FAM6_MODEL(GRANITERAPIDS_D,	&icx_cstates),
683 
684 	X86_MATCH_INTEL_FAM6_MODEL(TIGERLAKE_L,		&icl_cstates),
685 	X86_MATCH_INTEL_FAM6_MODEL(TIGERLAKE,		&icl_cstates),
686 	X86_MATCH_INTEL_FAM6_MODEL(ROCKETLAKE,		&icl_cstates),
687 	X86_MATCH_INTEL_FAM6_MODEL(ALDERLAKE,		&adl_cstates),
688 	X86_MATCH_INTEL_FAM6_MODEL(ALDERLAKE_L,		&adl_cstates),
689 	X86_MATCH_INTEL_FAM6_MODEL(ALDERLAKE_N,		&adl_cstates),
690 	X86_MATCH_INTEL_FAM6_MODEL(RAPTORLAKE,		&adl_cstates),
691 	X86_MATCH_INTEL_FAM6_MODEL(RAPTORLAKE_P,	&adl_cstates),
692 	X86_MATCH_INTEL_FAM6_MODEL(RAPTORLAKE_S,	&adl_cstates),
693 	X86_MATCH_INTEL_FAM6_MODEL(METEORLAKE,		&adl_cstates),
694 	X86_MATCH_INTEL_FAM6_MODEL(METEORLAKE_L,	&adl_cstates),
695 	{ },
696 };
697 MODULE_DEVICE_TABLE(x86cpu, intel_cstates_match);
698 
699 static int __init cstate_probe(const struct cstate_model *cm)
700 {
701 	/* SLM has different MSR for PKG C6 */
702 	if (cm->quirks & SLM_PKG_C6_USE_C7_MSR)
703 		pkg_msr[PERF_CSTATE_PKG_C6_RES].msr = MSR_PKG_C7_RESIDENCY;
704 
705 	/* KNL has different MSR for CORE C6 */
706 	if (cm->quirks & KNL_CORE_C6_MSR)
707 		pkg_msr[PERF_CSTATE_CORE_C6_RES].msr = MSR_KNL_CORE_C6_RESIDENCY;
708 
709 
710 	core_msr_mask = perf_msr_probe(core_msr, PERF_CSTATE_CORE_EVENT_MAX,
711 				       true, (void *) &cm->core_events);
712 
713 	pkg_msr_mask = perf_msr_probe(pkg_msr, PERF_CSTATE_PKG_EVENT_MAX,
714 				      true, (void *) &cm->pkg_events);
715 
716 	has_cstate_core = !!core_msr_mask;
717 	has_cstate_pkg  = !!pkg_msr_mask;
718 
719 	return (has_cstate_core || has_cstate_pkg) ? 0 : -ENODEV;
720 }
721 
722 static inline void cstate_cleanup(void)
723 {
724 	cpuhp_remove_state_nocalls(CPUHP_AP_PERF_X86_CSTATE_ONLINE);
725 	cpuhp_remove_state_nocalls(CPUHP_AP_PERF_X86_CSTATE_STARTING);
726 
727 	if (has_cstate_core)
728 		perf_pmu_unregister(&cstate_core_pmu);
729 
730 	if (has_cstate_pkg)
731 		perf_pmu_unregister(&cstate_pkg_pmu);
732 }
733 
734 static int __init cstate_init(void)
735 {
736 	int err;
737 
738 	cpuhp_setup_state(CPUHP_AP_PERF_X86_CSTATE_STARTING,
739 			  "perf/x86/cstate:starting", cstate_cpu_init, NULL);
740 	cpuhp_setup_state(CPUHP_AP_PERF_X86_CSTATE_ONLINE,
741 			  "perf/x86/cstate:online", NULL, cstate_cpu_exit);
742 
743 	if (has_cstate_core) {
744 		err = perf_pmu_register(&cstate_core_pmu, cstate_core_pmu.name, -1);
745 		if (err) {
746 			has_cstate_core = false;
747 			pr_info("Failed to register cstate core pmu\n");
748 			cstate_cleanup();
749 			return err;
750 		}
751 	}
752 
753 	if (has_cstate_pkg) {
754 		if (topology_max_die_per_package() > 1) {
755 			err = perf_pmu_register(&cstate_pkg_pmu,
756 						"cstate_die", -1);
757 		} else {
758 			err = perf_pmu_register(&cstate_pkg_pmu,
759 						cstate_pkg_pmu.name, -1);
760 		}
761 		if (err) {
762 			has_cstate_pkg = false;
763 			pr_info("Failed to register cstate pkg pmu\n");
764 			cstate_cleanup();
765 			return err;
766 		}
767 	}
768 	return 0;
769 }
770 
771 static int __init cstate_pmu_init(void)
772 {
773 	const struct x86_cpu_id *id;
774 	int err;
775 
776 	if (boot_cpu_has(X86_FEATURE_HYPERVISOR))
777 		return -ENODEV;
778 
779 	id = x86_match_cpu(intel_cstates_match);
780 	if (!id)
781 		return -ENODEV;
782 
783 	err = cstate_probe((const struct cstate_model *) id->driver_data);
784 	if (err)
785 		return err;
786 
787 	return cstate_init();
788 }
789 module_init(cstate_pmu_init);
790 
791 static void __exit cstate_pmu_exit(void)
792 {
793 	cstate_cleanup();
794 }
795 module_exit(cstate_pmu_exit);
796