xref: /linux/arch/s390/kernel/perf_cpum_cf.c (revision 38fe0e0156c037c060f81fe4e36549fae760322d)
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 (!(hwc->state & PERF_HES_STOPPED))
366 		return;
367 
368 	hwc->state = 0;
369 
370 	/* (Re-)enable and activate the counter set */
371 	ctr_set_enable(&cpuhw->state, hwc->config_base);
372 	ctr_set_start(&cpuhw->state, hwc->config_base);
373 
374 	/* The counter set to which this counter belongs can be already active.
375 	 * Because all counters in a set are active, the event->hw.prev_count
376 	 * needs to be synchronized.  At this point, the counter set can be in
377 	 * the inactive or disabled state.
378 	 */
379 	hw_perf_event_reset(event);
380 
381 	/* increment refcount for this counter set */
382 	atomic_inc(&cpuhw->ctr_set[hwc->config_base]);
383 }
384 
385 static void cpumf_pmu_stop(struct perf_event *event, int flags)
386 {
387 	struct cpu_cf_events *cpuhw = this_cpu_ptr(&cpu_cf_events);
388 	struct hw_perf_event *hwc = &event->hw;
389 
390 	if (!(hwc->state & PERF_HES_STOPPED)) {
391 		/* Decrement reference count for this counter set and if this
392 		 * is the last used counter in the set, clear activation
393 		 * control and set the counter set state to inactive.
394 		 */
395 		if (!atomic_dec_return(&cpuhw->ctr_set[hwc->config_base]))
396 			ctr_set_stop(&cpuhw->state, hwc->config_base);
397 		hwc->state |= PERF_HES_STOPPED;
398 	}
399 
400 	if ((flags & PERF_EF_UPDATE) && !(hwc->state & PERF_HES_UPTODATE)) {
401 		hw_perf_event_update(event);
402 		hwc->state |= PERF_HES_UPTODATE;
403 	}
404 }
405 
406 static int cpumf_pmu_add(struct perf_event *event, int flags)
407 {
408 	struct cpu_cf_events *cpuhw = this_cpu_ptr(&cpu_cf_events);
409 
410 	ctr_set_enable(&cpuhw->state, event->hw.config_base);
411 	event->hw.state = PERF_HES_UPTODATE | PERF_HES_STOPPED;
412 
413 	if (flags & PERF_EF_START)
414 		cpumf_pmu_start(event, PERF_EF_RELOAD);
415 
416 	return 0;
417 }
418 
419 static void cpumf_pmu_del(struct perf_event *event, int flags)
420 {
421 	struct cpu_cf_events *cpuhw = this_cpu_ptr(&cpu_cf_events);
422 
423 	cpumf_pmu_stop(event, PERF_EF_UPDATE);
424 
425 	/* Check if any counter in the counter set is still used.  If not used,
426 	 * change the counter set to the disabled state.  This also clears the
427 	 * content of all counters in the set.
428 	 *
429 	 * When a new perf event has been added but not yet started, this can
430 	 * clear enable control and resets all counters in a set.  Therefore,
431 	 * cpumf_pmu_start() always has to reenable a counter set.
432 	 */
433 	if (!atomic_read(&cpuhw->ctr_set[event->hw.config_base]))
434 		ctr_set_disable(&cpuhw->state, event->hw.config_base);
435 }
436 
437 /* Performance monitoring unit for s390x */
438 static struct pmu cpumf_pmu = {
439 	.task_ctx_nr  = perf_sw_context,
440 	.capabilities = PERF_PMU_CAP_NO_INTERRUPT,
441 	.pmu_enable   = cpumf_pmu_enable,
442 	.pmu_disable  = cpumf_pmu_disable,
443 	.event_init   = cpumf_pmu_event_init,
444 	.add	      = cpumf_pmu_add,
445 	.del	      = cpumf_pmu_del,
446 	.start	      = cpumf_pmu_start,
447 	.stop	      = cpumf_pmu_stop,
448 	.read	      = cpumf_pmu_read,
449 };
450 
451 static int __init cpumf_pmu_init(void)
452 {
453 	int rc;
454 
455 	if (!kernel_cpumcf_avail())
456 		return -ENODEV;
457 
458 	cpumf_pmu.attr_groups = cpumf_cf_event_group();
459 	rc = perf_pmu_register(&cpumf_pmu, "cpum_cf", -1);
460 	if (rc)
461 		pr_err("Registering the cpum_cf PMU failed with rc=%i\n", rc);
462 	return rc;
463 }
464 subsys_initcall(cpumf_pmu_init);
465