1 // SPDX-License-Identifier: GPL-2.0-only
3 * Perf support for the Statistical Profiling Extension, introduced as
6 * Copyright (C) 2016 ARM Limited
11 #define PMUNAME "arm_spe"
12 #define DRVNAME PMUNAME "_pmu"
13 #define pr_fmt(fmt) DRVNAME ": " fmt
15 #include <linux/bitfield.h>
16 #include <linux/bitops.h>
17 #include <linux/bug.h>
18 #include <linux/capability.h>
19 #include <linux/cpuhotplug.h>
20 #include <linux/cpumask.h>
21 #include <linux/device.h>
22 #include <linux/errno.h>
23 #include <linux/interrupt.h>
24 #include <linux/irq.h>
25 #include <linux/kernel.h>
26 #include <linux/list.h>
27 #include <linux/module.h>
28 #include <linux/of_address.h>
29 #include <linux/of_device.h>
30 #include <linux/perf_event.h>
31 #include <linux/perf/arm_pmu.h>
32 #include <linux/platform_device.h>
33 #include <linux/printk.h>
34 #include <linux/slab.h>
35 #include <linux/smp.h>
36 #include <linux/vmalloc.h>
38 #include <asm/barrier.h>
39 #include <asm/cpufeature.h>
41 #include <asm/sysreg.h>
44 * Cache if the event is allowed to trace Context information.
45 * This allows us to perform the check, i.e, perfmon_capable(),
46 * in the context of the event owner, once, during the event_init().
48 #define SPE_PMU_HW_FLAGS_CX 0x00001
50 static_assert((PERF_EVENT_FLAG_ARCH & SPE_PMU_HW_FLAGS_CX) == SPE_PMU_HW_FLAGS_CX);
52 static void set_spe_event_has_cx(struct perf_event *event)
54 if (IS_ENABLED(CONFIG_PID_IN_CONTEXTIDR) && perfmon_capable())
55 event->hw.flags |= SPE_PMU_HW_FLAGS_CX;
58 static bool get_spe_event_has_cx(struct perf_event *event)
60 return !!(event->hw.flags & SPE_PMU_HW_FLAGS_CX);
63 #define ARM_SPE_BUF_PAD_BYTE 0
65 struct arm_spe_pmu_buf {
73 struct platform_device *pdev;
74 cpumask_t supported_cpus;
75 struct hlist_node hotplug_node;
82 #define SPE_PMU_FEAT_FILT_EVT (1UL << 0)
83 #define SPE_PMU_FEAT_FILT_TYP (1UL << 1)
84 #define SPE_PMU_FEAT_FILT_LAT (1UL << 2)
85 #define SPE_PMU_FEAT_ARCH_INST (1UL << 3)
86 #define SPE_PMU_FEAT_LDS (1UL << 4)
87 #define SPE_PMU_FEAT_ERND (1UL << 5)
88 #define SPE_PMU_FEAT_INV_FILT_EVT (1UL << 6)
89 #define SPE_PMU_FEAT_DEV_PROBED (1UL << 63)
94 struct perf_output_handle __percpu *handle;
97 #define to_spe_pmu(p) (container_of(p, struct arm_spe_pmu, pmu))
99 /* Convert a free-running index from perf into an SPE buffer offset */
100 #define PERF_IDX2OFF(idx, buf) ((idx) % ((buf)->nr_pages << PAGE_SHIFT))
102 /* Keep track of our dynamic hotplug state */
103 static enum cpuhp_state arm_spe_pmu_online;
105 enum arm_spe_pmu_buf_fault_action {
106 SPE_PMU_BUF_FAULT_ACT_SPURIOUS,
107 SPE_PMU_BUF_FAULT_ACT_FATAL,
108 SPE_PMU_BUF_FAULT_ACT_OK,
111 /* This sysfs gunk was really good fun to write. */
112 enum arm_spe_pmu_capabilities {
113 SPE_PMU_CAP_ARCH_INST = 0,
115 SPE_PMU_CAP_FEAT_MAX,
116 SPE_PMU_CAP_CNT_SZ = SPE_PMU_CAP_FEAT_MAX,
117 SPE_PMU_CAP_MIN_IVAL,
120 static int arm_spe_pmu_feat_caps[SPE_PMU_CAP_FEAT_MAX] = {
121 [SPE_PMU_CAP_ARCH_INST] = SPE_PMU_FEAT_ARCH_INST,
122 [SPE_PMU_CAP_ERND] = SPE_PMU_FEAT_ERND,
125 static u32 arm_spe_pmu_cap_get(struct arm_spe_pmu *spe_pmu, int cap)
127 if (cap < SPE_PMU_CAP_FEAT_MAX)
128 return !!(spe_pmu->features & arm_spe_pmu_feat_caps[cap]);
131 case SPE_PMU_CAP_CNT_SZ:
132 return spe_pmu->counter_sz;
133 case SPE_PMU_CAP_MIN_IVAL:
134 return spe_pmu->min_period;
136 WARN(1, "unknown cap %d\n", cap);
142 static ssize_t arm_spe_pmu_cap_show(struct device *dev,
143 struct device_attribute *attr,
146 struct arm_spe_pmu *spe_pmu = dev_get_drvdata(dev);
147 struct dev_ext_attribute *ea =
148 container_of(attr, struct dev_ext_attribute, attr);
149 int cap = (long)ea->var;
151 return sysfs_emit(buf, "%u\n", arm_spe_pmu_cap_get(spe_pmu, cap));
154 #define SPE_EXT_ATTR_ENTRY(_name, _func, _var) \
155 &((struct dev_ext_attribute[]) { \
156 { __ATTR(_name, S_IRUGO, _func, NULL), (void *)_var } \
159 #define SPE_CAP_EXT_ATTR_ENTRY(_name, _var) \
160 SPE_EXT_ATTR_ENTRY(_name, arm_spe_pmu_cap_show, _var)
162 static struct attribute *arm_spe_pmu_cap_attr[] = {
163 SPE_CAP_EXT_ATTR_ENTRY(arch_inst, SPE_PMU_CAP_ARCH_INST),
164 SPE_CAP_EXT_ATTR_ENTRY(ernd, SPE_PMU_CAP_ERND),
165 SPE_CAP_EXT_ATTR_ENTRY(count_size, SPE_PMU_CAP_CNT_SZ),
166 SPE_CAP_EXT_ATTR_ENTRY(min_interval, SPE_PMU_CAP_MIN_IVAL),
170 static const struct attribute_group arm_spe_pmu_cap_group = {
172 .attrs = arm_spe_pmu_cap_attr,
176 #define ATTR_CFG_FLD_ts_enable_CFG config /* PMSCR_EL1.TS */
177 #define ATTR_CFG_FLD_ts_enable_LO 0
178 #define ATTR_CFG_FLD_ts_enable_HI 0
179 #define ATTR_CFG_FLD_pa_enable_CFG config /* PMSCR_EL1.PA */
180 #define ATTR_CFG_FLD_pa_enable_LO 1
181 #define ATTR_CFG_FLD_pa_enable_HI 1
182 #define ATTR_CFG_FLD_pct_enable_CFG config /* PMSCR_EL1.PCT */
183 #define ATTR_CFG_FLD_pct_enable_LO 2
184 #define ATTR_CFG_FLD_pct_enable_HI 2
185 #define ATTR_CFG_FLD_jitter_CFG config /* PMSIRR_EL1.RND */
186 #define ATTR_CFG_FLD_jitter_LO 16
187 #define ATTR_CFG_FLD_jitter_HI 16
188 #define ATTR_CFG_FLD_branch_filter_CFG config /* PMSFCR_EL1.B */
189 #define ATTR_CFG_FLD_branch_filter_LO 32
190 #define ATTR_CFG_FLD_branch_filter_HI 32
191 #define ATTR_CFG_FLD_load_filter_CFG config /* PMSFCR_EL1.LD */
192 #define ATTR_CFG_FLD_load_filter_LO 33
193 #define ATTR_CFG_FLD_load_filter_HI 33
194 #define ATTR_CFG_FLD_store_filter_CFG config /* PMSFCR_EL1.ST */
195 #define ATTR_CFG_FLD_store_filter_LO 34
196 #define ATTR_CFG_FLD_store_filter_HI 34
198 #define ATTR_CFG_FLD_event_filter_CFG config1 /* PMSEVFR_EL1 */
199 #define ATTR_CFG_FLD_event_filter_LO 0
200 #define ATTR_CFG_FLD_event_filter_HI 63
202 #define ATTR_CFG_FLD_min_latency_CFG config2 /* PMSLATFR_EL1.MINLAT */
203 #define ATTR_CFG_FLD_min_latency_LO 0
204 #define ATTR_CFG_FLD_min_latency_HI 11
206 #define ATTR_CFG_FLD_inv_event_filter_CFG config3 /* PMSNEVFR_EL1 */
207 #define ATTR_CFG_FLD_inv_event_filter_LO 0
208 #define ATTR_CFG_FLD_inv_event_filter_HI 63
210 /* Why does everything I do descend into this? */
211 #define __GEN_PMU_FORMAT_ATTR(cfg, lo, hi) \
212 (lo) == (hi) ? #cfg ":" #lo "\n" : #cfg ":" #lo "-" #hi
214 #define _GEN_PMU_FORMAT_ATTR(cfg, lo, hi) \
215 __GEN_PMU_FORMAT_ATTR(cfg, lo, hi)
217 #define GEN_PMU_FORMAT_ATTR(name) \
218 PMU_FORMAT_ATTR(name, \
219 _GEN_PMU_FORMAT_ATTR(ATTR_CFG_FLD_##name##_CFG, \
220 ATTR_CFG_FLD_##name##_LO, \
221 ATTR_CFG_FLD_##name##_HI))
223 #define _ATTR_CFG_GET_FLD(attr, cfg, lo, hi) \
224 ((((attr)->cfg) >> lo) & GENMASK(hi - lo, 0))
226 #define ATTR_CFG_GET_FLD(attr, name) \
227 _ATTR_CFG_GET_FLD(attr, \
228 ATTR_CFG_FLD_##name##_CFG, \
229 ATTR_CFG_FLD_##name##_LO, \
230 ATTR_CFG_FLD_##name##_HI)
232 GEN_PMU_FORMAT_ATTR(ts_enable);
233 GEN_PMU_FORMAT_ATTR(pa_enable);
234 GEN_PMU_FORMAT_ATTR(pct_enable);
235 GEN_PMU_FORMAT_ATTR(jitter);
236 GEN_PMU_FORMAT_ATTR(branch_filter);
237 GEN_PMU_FORMAT_ATTR(load_filter);
238 GEN_PMU_FORMAT_ATTR(store_filter);
239 GEN_PMU_FORMAT_ATTR(event_filter);
240 GEN_PMU_FORMAT_ATTR(inv_event_filter);
241 GEN_PMU_FORMAT_ATTR(min_latency);
243 static struct attribute *arm_spe_pmu_formats_attr[] = {
244 &format_attr_ts_enable.attr,
245 &format_attr_pa_enable.attr,
246 &format_attr_pct_enable.attr,
247 &format_attr_jitter.attr,
248 &format_attr_branch_filter.attr,
249 &format_attr_load_filter.attr,
250 &format_attr_store_filter.attr,
251 &format_attr_event_filter.attr,
252 &format_attr_inv_event_filter.attr,
253 &format_attr_min_latency.attr,
257 static umode_t arm_spe_pmu_format_attr_is_visible(struct kobject *kobj,
258 struct attribute *attr,
261 struct device *dev = kobj_to_dev(kobj);
262 struct arm_spe_pmu *spe_pmu = dev_get_drvdata(dev);
264 if (attr == &format_attr_inv_event_filter.attr && !(spe_pmu->features & SPE_PMU_FEAT_INV_FILT_EVT))
270 static const struct attribute_group arm_spe_pmu_format_group = {
272 .is_visible = arm_spe_pmu_format_attr_is_visible,
273 .attrs = arm_spe_pmu_formats_attr,
276 static ssize_t cpumask_show(struct device *dev,
277 struct device_attribute *attr, char *buf)
279 struct arm_spe_pmu *spe_pmu = dev_get_drvdata(dev);
281 return cpumap_print_to_pagebuf(true, buf, &spe_pmu->supported_cpus);
283 static DEVICE_ATTR_RO(cpumask);
285 static struct attribute *arm_spe_pmu_attrs[] = {
286 &dev_attr_cpumask.attr,
290 static const struct attribute_group arm_spe_pmu_group = {
291 .attrs = arm_spe_pmu_attrs,
294 static const struct attribute_group *arm_spe_pmu_attr_groups[] = {
296 &arm_spe_pmu_cap_group,
297 &arm_spe_pmu_format_group,
301 /* Convert between user ABI and register values */
302 static u64 arm_spe_event_to_pmscr(struct perf_event *event)
304 struct perf_event_attr *attr = &event->attr;
307 reg |= FIELD_PREP(PMSCR_EL1_TS, ATTR_CFG_GET_FLD(attr, ts_enable));
308 reg |= FIELD_PREP(PMSCR_EL1_PA, ATTR_CFG_GET_FLD(attr, pa_enable));
309 reg |= FIELD_PREP(PMSCR_EL1_PCT, ATTR_CFG_GET_FLD(attr, pct_enable));
311 if (!attr->exclude_user)
312 reg |= PMSCR_EL1_E0SPE;
314 if (!attr->exclude_kernel)
315 reg |= PMSCR_EL1_E1SPE;
317 if (get_spe_event_has_cx(event))
323 static void arm_spe_event_sanitise_period(struct perf_event *event)
325 struct arm_spe_pmu *spe_pmu = to_spe_pmu(event->pmu);
326 u64 period = event->hw.sample_period;
327 u64 max_period = PMSIRR_EL1_INTERVAL_MASK;
329 if (period < spe_pmu->min_period)
330 period = spe_pmu->min_period;
331 else if (period > max_period)
334 period &= max_period;
336 event->hw.sample_period = period;
339 static u64 arm_spe_event_to_pmsirr(struct perf_event *event)
341 struct perf_event_attr *attr = &event->attr;
344 arm_spe_event_sanitise_period(event);
346 reg |= FIELD_PREP(PMSIRR_EL1_RND, ATTR_CFG_GET_FLD(attr, jitter));
347 reg |= event->hw.sample_period;
352 static u64 arm_spe_event_to_pmsfcr(struct perf_event *event)
354 struct perf_event_attr *attr = &event->attr;
357 reg |= FIELD_PREP(PMSFCR_EL1_LD, ATTR_CFG_GET_FLD(attr, load_filter));
358 reg |= FIELD_PREP(PMSFCR_EL1_ST, ATTR_CFG_GET_FLD(attr, store_filter));
359 reg |= FIELD_PREP(PMSFCR_EL1_B, ATTR_CFG_GET_FLD(attr, branch_filter));
362 reg |= PMSFCR_EL1_FT;
364 if (ATTR_CFG_GET_FLD(attr, event_filter))
365 reg |= PMSFCR_EL1_FE;
367 if (ATTR_CFG_GET_FLD(attr, inv_event_filter))
368 reg |= PMSFCR_EL1_FnE;
370 if (ATTR_CFG_GET_FLD(attr, min_latency))
371 reg |= PMSFCR_EL1_FL;
376 static u64 arm_spe_event_to_pmsevfr(struct perf_event *event)
378 struct perf_event_attr *attr = &event->attr;
379 return ATTR_CFG_GET_FLD(attr, event_filter);
382 static u64 arm_spe_event_to_pmsnevfr(struct perf_event *event)
384 struct perf_event_attr *attr = &event->attr;
385 return ATTR_CFG_GET_FLD(attr, inv_event_filter);
388 static u64 arm_spe_event_to_pmslatfr(struct perf_event *event)
390 struct perf_event_attr *attr = &event->attr;
391 return FIELD_PREP(PMSLATFR_EL1_MINLAT, ATTR_CFG_GET_FLD(attr, min_latency));
394 static void arm_spe_pmu_pad_buf(struct perf_output_handle *handle, int len)
396 struct arm_spe_pmu_buf *buf = perf_get_aux(handle);
397 u64 head = PERF_IDX2OFF(handle->head, buf);
399 memset(buf->base + head, ARM_SPE_BUF_PAD_BYTE, len);
401 perf_aux_output_skip(handle, len);
404 static u64 arm_spe_pmu_next_snapshot_off(struct perf_output_handle *handle)
406 struct arm_spe_pmu_buf *buf = perf_get_aux(handle);
407 struct arm_spe_pmu *spe_pmu = to_spe_pmu(handle->event->pmu);
408 u64 head = PERF_IDX2OFF(handle->head, buf);
409 u64 limit = buf->nr_pages * PAGE_SIZE;
412 * The trace format isn't parseable in reverse, so clamp
413 * the limit to half of the buffer size in snapshot mode
414 * so that the worst case is half a buffer of records, as
415 * opposed to a single record.
417 if (head < limit >> 1)
421 * If we're within max_record_sz of the limit, we must
422 * pad, move the head index and recompute the limit.
424 if (limit - head < spe_pmu->max_record_sz) {
425 arm_spe_pmu_pad_buf(handle, limit - head);
426 handle->head = PERF_IDX2OFF(limit, buf);
427 limit = ((buf->nr_pages * PAGE_SIZE) >> 1) + handle->head;
433 static u64 __arm_spe_pmu_next_off(struct perf_output_handle *handle)
435 struct arm_spe_pmu *spe_pmu = to_spe_pmu(handle->event->pmu);
436 struct arm_spe_pmu_buf *buf = perf_get_aux(handle);
437 const u64 bufsize = buf->nr_pages * PAGE_SIZE;
439 u64 head, tail, wakeup;
442 * The head can be misaligned for two reasons:
444 * 1. The hardware left PMBPTR pointing to the first byte after
445 * a record when generating a buffer management event.
447 * 2. We used perf_aux_output_skip to consume handle->size bytes
448 * and CIRC_SPACE was used to compute the size, which always
449 * leaves one entry free.
451 * Deal with this by padding to the next alignment boundary and
452 * moving the head index. If we run out of buffer space, we'll
453 * reduce handle->size to zero and end up reporting truncation.
455 head = PERF_IDX2OFF(handle->head, buf);
456 if (!IS_ALIGNED(head, spe_pmu->align)) {
457 unsigned long delta = roundup(head, spe_pmu->align) - head;
459 delta = min(delta, handle->size);
460 arm_spe_pmu_pad_buf(handle, delta);
461 head = PERF_IDX2OFF(handle->head, buf);
464 /* If we've run out of free space, then nothing more to do */
468 /* Compute the tail and wakeup indices now that we've aligned head */
469 tail = PERF_IDX2OFF(handle->head + handle->size, buf);
470 wakeup = PERF_IDX2OFF(handle->wakeup, buf);
473 * Avoid clobbering unconsumed data. We know we have space, so
474 * if we see head == tail we know that the buffer is empty. If
475 * head > tail, then there's nothing to clobber prior to
479 limit = round_down(tail, PAGE_SIZE);
482 * Wakeup may be arbitrarily far into the future. If it's not in
483 * the current generation, either we'll wrap before hitting it,
484 * or it's in the past and has been handled already.
486 * If there's a wakeup before we wrap, arrange to be woken up by
487 * the page boundary following it. Keep the tail boundary if
490 if (handle->wakeup < (handle->head + handle->size) && head <= wakeup)
491 limit = min(limit, round_up(wakeup, PAGE_SIZE));
496 arm_spe_pmu_pad_buf(handle, handle->size);
498 perf_aux_output_flag(handle, PERF_AUX_FLAG_TRUNCATED);
499 perf_aux_output_end(handle, 0);
503 static u64 arm_spe_pmu_next_off(struct perf_output_handle *handle)
505 struct arm_spe_pmu_buf *buf = perf_get_aux(handle);
506 struct arm_spe_pmu *spe_pmu = to_spe_pmu(handle->event->pmu);
507 u64 limit = __arm_spe_pmu_next_off(handle);
508 u64 head = PERF_IDX2OFF(handle->head, buf);
511 * If the head has come too close to the end of the buffer,
512 * then pad to the end and recompute the limit.
514 if (limit && (limit - head < spe_pmu->max_record_sz)) {
515 arm_spe_pmu_pad_buf(handle, limit - head);
516 limit = __arm_spe_pmu_next_off(handle);
522 static void arm_spe_perf_aux_output_begin(struct perf_output_handle *handle,
523 struct perf_event *event)
526 struct arm_spe_pmu_buf *buf;
528 /* Start a new aux session */
529 buf = perf_aux_output_begin(handle, event);
531 event->hw.state |= PERF_HES_STOPPED;
533 * We still need to clear the limit pointer, since the
534 * profiler might only be disabled by virtue of a fault.
537 goto out_write_limit;
540 limit = buf->snapshot ? arm_spe_pmu_next_snapshot_off(handle)
541 : arm_spe_pmu_next_off(handle);
543 limit |= PMBLIMITR_EL1_E;
545 limit += (u64)buf->base;
546 base = (u64)buf->base + PERF_IDX2OFF(handle->head, buf);
547 write_sysreg_s(base, SYS_PMBPTR_EL1);
550 write_sysreg_s(limit, SYS_PMBLIMITR_EL1);
553 static void arm_spe_perf_aux_output_end(struct perf_output_handle *handle)
555 struct arm_spe_pmu_buf *buf = perf_get_aux(handle);
558 offset = read_sysreg_s(SYS_PMBPTR_EL1) - (u64)buf->base;
559 size = offset - PERF_IDX2OFF(handle->head, buf);
562 handle->head = offset;
564 perf_aux_output_end(handle, size);
567 static void arm_spe_pmu_disable_and_drain_local(void)
569 /* Disable profiling at EL0 and EL1 */
570 write_sysreg_s(0, SYS_PMSCR_EL1);
573 /* Drain any buffered data */
577 /* Disable the profiling buffer */
578 write_sysreg_s(0, SYS_PMBLIMITR_EL1);
583 static enum arm_spe_pmu_buf_fault_action
584 arm_spe_pmu_buf_get_fault_act(struct perf_output_handle *handle)
588 enum arm_spe_pmu_buf_fault_action ret;
591 * Ensure new profiling data is visible to the CPU and any external
592 * aborts have been resolved.
597 /* Ensure hardware updates to PMBPTR_EL1 are visible */
600 /* Service required? */
601 pmbsr = read_sysreg_s(SYS_PMBSR_EL1);
602 if (!FIELD_GET(PMBSR_EL1_S, pmbsr))
603 return SPE_PMU_BUF_FAULT_ACT_SPURIOUS;
606 * If we've lost data, disable profiling and also set the PARTIAL
607 * flag to indicate that the last record is corrupted.
609 if (FIELD_GET(PMBSR_EL1_DL, pmbsr))
610 perf_aux_output_flag(handle, PERF_AUX_FLAG_TRUNCATED |
611 PERF_AUX_FLAG_PARTIAL);
613 /* Report collisions to userspace so that it can up the period */
614 if (FIELD_GET(PMBSR_EL1_COLL, pmbsr))
615 perf_aux_output_flag(handle, PERF_AUX_FLAG_COLLISION);
617 /* We only expect buffer management events */
618 switch (FIELD_GET(PMBSR_EL1_EC, pmbsr)) {
619 case PMBSR_EL1_EC_BUF:
622 case PMBSR_EL1_EC_FAULT_S1:
623 case PMBSR_EL1_EC_FAULT_S2:
624 err_str = "Unexpected buffer fault";
627 err_str = "Unknown error code";
631 /* Buffer management event */
632 switch (FIELD_GET(PMBSR_EL1_BUF_BSC_MASK, pmbsr)) {
633 case PMBSR_EL1_BUF_BSC_FULL:
634 ret = SPE_PMU_BUF_FAULT_ACT_OK;
637 err_str = "Unknown buffer status code";
641 pr_err_ratelimited("%s on CPU %d [PMBSR=0x%016llx, PMBPTR=0x%016llx, PMBLIMITR=0x%016llx]\n",
642 err_str, smp_processor_id(), pmbsr,
643 read_sysreg_s(SYS_PMBPTR_EL1),
644 read_sysreg_s(SYS_PMBLIMITR_EL1));
645 ret = SPE_PMU_BUF_FAULT_ACT_FATAL;
648 arm_spe_perf_aux_output_end(handle);
652 static irqreturn_t arm_spe_pmu_irq_handler(int irq, void *dev)
654 struct perf_output_handle *handle = dev;
655 struct perf_event *event = handle->event;
656 enum arm_spe_pmu_buf_fault_action act;
658 if (!perf_get_aux(handle))
661 act = arm_spe_pmu_buf_get_fault_act(handle);
662 if (act == SPE_PMU_BUF_FAULT_ACT_SPURIOUS)
666 * Ensure perf callbacks have completed, which may disable the
667 * profiling buffer in response to a TRUNCATION flag.
672 case SPE_PMU_BUF_FAULT_ACT_FATAL:
674 * If a fatal exception occurred then leaving the profiling
675 * buffer enabled is a recipe waiting to happen. Since
676 * fatal faults don't always imply truncation, make sure
677 * that the profiling buffer is disabled explicitly before
678 * clearing the syndrome register.
680 arm_spe_pmu_disable_and_drain_local();
682 case SPE_PMU_BUF_FAULT_ACT_OK:
684 * We handled the fault (the buffer was full), so resume
685 * profiling as long as we didn't detect truncation.
686 * PMBPTR might be misaligned, but we'll burn that bridge
689 if (!(handle->aux_flags & PERF_AUX_FLAG_TRUNCATED)) {
690 arm_spe_perf_aux_output_begin(handle, event);
694 case SPE_PMU_BUF_FAULT_ACT_SPURIOUS:
695 /* We've seen you before, but GCC has the memory of a sieve. */
699 /* The buffer pointers are now sane, so resume profiling. */
700 write_sysreg_s(0, SYS_PMBSR_EL1);
704 static u64 arm_spe_pmsevfr_res0(u16 pmsver)
707 case ID_AA64DFR0_EL1_PMSVer_IMP:
708 return PMSEVFR_EL1_RES0_IMP;
709 case ID_AA64DFR0_EL1_PMSVer_V1P1:
710 return PMSEVFR_EL1_RES0_V1P1;
711 case ID_AA64DFR0_EL1_PMSVer_V1P2:
712 /* Return the highest version we support in default */
714 return PMSEVFR_EL1_RES0_V1P2;
719 static int arm_spe_pmu_event_init(struct perf_event *event)
722 struct perf_event_attr *attr = &event->attr;
723 struct arm_spe_pmu *spe_pmu = to_spe_pmu(event->pmu);
725 /* This is, of course, deeply driver-specific */
726 if (attr->type != event->pmu->type)
729 if (event->cpu >= 0 &&
730 !cpumask_test_cpu(event->cpu, &spe_pmu->supported_cpus))
733 if (arm_spe_event_to_pmsevfr(event) & arm_spe_pmsevfr_res0(spe_pmu->pmsver))
736 if (arm_spe_event_to_pmsnevfr(event) & arm_spe_pmsevfr_res0(spe_pmu->pmsver))
739 if (attr->exclude_idle)
743 * Feedback-directed frequency throttling doesn't work when we
744 * have a buffer of samples. We'd need to manually count the
745 * samples in the buffer when it fills up and adjust the event
746 * count to reflect that. Instead, just force the user to specify
752 reg = arm_spe_event_to_pmsfcr(event);
753 if ((FIELD_GET(PMSFCR_EL1_FE, reg)) &&
754 !(spe_pmu->features & SPE_PMU_FEAT_FILT_EVT))
757 if ((FIELD_GET(PMSFCR_EL1_FnE, reg)) &&
758 !(spe_pmu->features & SPE_PMU_FEAT_INV_FILT_EVT))
761 if ((FIELD_GET(PMSFCR_EL1_FT, reg)) &&
762 !(spe_pmu->features & SPE_PMU_FEAT_FILT_TYP))
765 if ((FIELD_GET(PMSFCR_EL1_FL, reg)) &&
766 !(spe_pmu->features & SPE_PMU_FEAT_FILT_LAT))
769 set_spe_event_has_cx(event);
770 reg = arm_spe_event_to_pmscr(event);
771 if (!perfmon_capable() &&
772 (reg & (PMSCR_EL1_PA | PMSCR_EL1_PCT)))
778 static void arm_spe_pmu_start(struct perf_event *event, int flags)
781 struct arm_spe_pmu *spe_pmu = to_spe_pmu(event->pmu);
782 struct hw_perf_event *hwc = &event->hw;
783 struct perf_output_handle *handle = this_cpu_ptr(spe_pmu->handle);
786 arm_spe_perf_aux_output_begin(handle, event);
790 reg = arm_spe_event_to_pmsfcr(event);
791 write_sysreg_s(reg, SYS_PMSFCR_EL1);
793 reg = arm_spe_event_to_pmsevfr(event);
794 write_sysreg_s(reg, SYS_PMSEVFR_EL1);
796 if (spe_pmu->features & SPE_PMU_FEAT_INV_FILT_EVT) {
797 reg = arm_spe_event_to_pmsnevfr(event);
798 write_sysreg_s(reg, SYS_PMSNEVFR_EL1);
801 reg = arm_spe_event_to_pmslatfr(event);
802 write_sysreg_s(reg, SYS_PMSLATFR_EL1);
804 if (flags & PERF_EF_RELOAD) {
805 reg = arm_spe_event_to_pmsirr(event);
806 write_sysreg_s(reg, SYS_PMSIRR_EL1);
808 reg = local64_read(&hwc->period_left);
809 write_sysreg_s(reg, SYS_PMSICR_EL1);
812 reg = arm_spe_event_to_pmscr(event);
814 write_sysreg_s(reg, SYS_PMSCR_EL1);
817 static void arm_spe_pmu_stop(struct perf_event *event, int flags)
819 struct arm_spe_pmu *spe_pmu = to_spe_pmu(event->pmu);
820 struct hw_perf_event *hwc = &event->hw;
821 struct perf_output_handle *handle = this_cpu_ptr(spe_pmu->handle);
823 /* If we're already stopped, then nothing to do */
824 if (hwc->state & PERF_HES_STOPPED)
827 /* Stop all trace generation */
828 arm_spe_pmu_disable_and_drain_local();
830 if (flags & PERF_EF_UPDATE) {
832 * If there's a fault pending then ensure we contain it
833 * to this buffer, since we might be on the context-switch
836 if (perf_get_aux(handle)) {
837 enum arm_spe_pmu_buf_fault_action act;
839 act = arm_spe_pmu_buf_get_fault_act(handle);
840 if (act == SPE_PMU_BUF_FAULT_ACT_SPURIOUS)
841 arm_spe_perf_aux_output_end(handle);
843 write_sysreg_s(0, SYS_PMBSR_EL1);
847 * This may also contain ECOUNT, but nobody else should
848 * be looking at period_left, since we forbid frequency
851 local64_set(&hwc->period_left, read_sysreg_s(SYS_PMSICR_EL1));
852 hwc->state |= PERF_HES_UPTODATE;
855 hwc->state |= PERF_HES_STOPPED;
858 static int arm_spe_pmu_add(struct perf_event *event, int flags)
861 struct arm_spe_pmu *spe_pmu = to_spe_pmu(event->pmu);
862 struct hw_perf_event *hwc = &event->hw;
863 int cpu = event->cpu == -1 ? smp_processor_id() : event->cpu;
865 if (!cpumask_test_cpu(cpu, &spe_pmu->supported_cpus))
868 hwc->state = PERF_HES_UPTODATE | PERF_HES_STOPPED;
870 if (flags & PERF_EF_START) {
871 arm_spe_pmu_start(event, PERF_EF_RELOAD);
872 if (hwc->state & PERF_HES_STOPPED)
879 static void arm_spe_pmu_del(struct perf_event *event, int flags)
881 arm_spe_pmu_stop(event, PERF_EF_UPDATE);
884 static void arm_spe_pmu_read(struct perf_event *event)
888 static void *arm_spe_pmu_setup_aux(struct perf_event *event, void **pages,
889 int nr_pages, bool snapshot)
891 int i, cpu = event->cpu;
892 struct page **pglist;
893 struct arm_spe_pmu_buf *buf;
895 /* We need at least two pages for this to work. */
900 * We require an even number of pages for snapshot mode, so that
901 * we can effectively treat the buffer as consisting of two equal
902 * parts and give userspace a fighting chance of getting some
903 * useful data out of it.
905 if (snapshot && (nr_pages & 1))
909 cpu = raw_smp_processor_id();
911 buf = kzalloc_node(sizeof(*buf), GFP_KERNEL, cpu_to_node(cpu));
915 pglist = kcalloc(nr_pages, sizeof(*pglist), GFP_KERNEL);
919 for (i = 0; i < nr_pages; ++i)
920 pglist[i] = virt_to_page(pages[i]);
922 buf->base = vmap(pglist, nr_pages, VM_MAP, PAGE_KERNEL);
924 goto out_free_pglist;
926 buf->nr_pages = nr_pages;
927 buf->snapshot = snapshot;
939 static void arm_spe_pmu_free_aux(void *aux)
941 struct arm_spe_pmu_buf *buf = aux;
947 /* Initialisation and teardown functions */
948 static int arm_spe_pmu_perf_init(struct arm_spe_pmu *spe_pmu)
950 static atomic_t pmu_idx = ATOMIC_INIT(-1);
954 struct device *dev = &spe_pmu->pdev->dev;
956 spe_pmu->pmu = (struct pmu) {
957 .module = THIS_MODULE,
958 .capabilities = PERF_PMU_CAP_EXCLUSIVE | PERF_PMU_CAP_ITRACE,
959 .attr_groups = arm_spe_pmu_attr_groups,
961 * We hitch a ride on the software context here, so that
962 * we can support per-task profiling (which is not possible
963 * with the invalid context as it doesn't get sched callbacks).
964 * This requires that userspace either uses a dummy event for
965 * perf_event_open, since the aux buffer is not setup until
966 * a subsequent mmap, or creates the profiling event in a
967 * disabled state and explicitly PERF_EVENT_IOC_ENABLEs it
968 * once the buffer has been created.
970 .task_ctx_nr = perf_sw_context,
971 .event_init = arm_spe_pmu_event_init,
972 .add = arm_spe_pmu_add,
973 .del = arm_spe_pmu_del,
974 .start = arm_spe_pmu_start,
975 .stop = arm_spe_pmu_stop,
976 .read = arm_spe_pmu_read,
977 .setup_aux = arm_spe_pmu_setup_aux,
978 .free_aux = arm_spe_pmu_free_aux,
981 idx = atomic_inc_return(&pmu_idx);
982 name = devm_kasprintf(dev, GFP_KERNEL, "%s_%d", PMUNAME, idx);
984 dev_err(dev, "failed to allocate name for pmu %d\n", idx);
988 return perf_pmu_register(&spe_pmu->pmu, name, -1);
991 static void arm_spe_pmu_perf_destroy(struct arm_spe_pmu *spe_pmu)
993 perf_pmu_unregister(&spe_pmu->pmu);
996 static void __arm_spe_pmu_dev_probe(void *info)
1000 struct arm_spe_pmu *spe_pmu = info;
1001 struct device *dev = &spe_pmu->pdev->dev;
1003 fld = cpuid_feature_extract_unsigned_field(read_cpuid(ID_AA64DFR0_EL1),
1004 ID_AA64DFR0_EL1_PMSVer_SHIFT);
1007 "unsupported ID_AA64DFR0_EL1.PMSVer [%d] on CPU %d\n",
1008 fld, smp_processor_id());
1011 spe_pmu->pmsver = (u16)fld;
1013 /* Read PMBIDR first to determine whether or not we have access */
1014 reg = read_sysreg_s(SYS_PMBIDR_EL1);
1015 if (FIELD_GET(PMBIDR_EL1_P, reg)) {
1017 "profiling buffer owned by higher exception level\n");
1021 /* Minimum alignment. If it's out-of-range, then fail the probe */
1022 fld = FIELD_GET(PMBIDR_EL1_ALIGN, reg);
1023 spe_pmu->align = 1 << fld;
1024 if (spe_pmu->align > SZ_2K) {
1025 dev_err(dev, "unsupported PMBIDR.Align [%d] on CPU %d\n",
1026 fld, smp_processor_id());
1030 /* It's now safe to read PMSIDR and figure out what we've got */
1031 reg = read_sysreg_s(SYS_PMSIDR_EL1);
1032 if (FIELD_GET(PMSIDR_EL1_FE, reg))
1033 spe_pmu->features |= SPE_PMU_FEAT_FILT_EVT;
1035 if (FIELD_GET(PMSIDR_EL1_FnE, reg))
1036 spe_pmu->features |= SPE_PMU_FEAT_INV_FILT_EVT;
1038 if (FIELD_GET(PMSIDR_EL1_FT, reg))
1039 spe_pmu->features |= SPE_PMU_FEAT_FILT_TYP;
1041 if (FIELD_GET(PMSIDR_EL1_FL, reg))
1042 spe_pmu->features |= SPE_PMU_FEAT_FILT_LAT;
1044 if (FIELD_GET(PMSIDR_EL1_ARCHINST, reg))
1045 spe_pmu->features |= SPE_PMU_FEAT_ARCH_INST;
1047 if (FIELD_GET(PMSIDR_EL1_LDS, reg))
1048 spe_pmu->features |= SPE_PMU_FEAT_LDS;
1050 if (FIELD_GET(PMSIDR_EL1_ERND, reg))
1051 spe_pmu->features |= SPE_PMU_FEAT_ERND;
1053 /* This field has a spaced out encoding, so just use a look-up */
1054 fld = FIELD_GET(PMSIDR_EL1_INTERVAL, reg);
1056 case PMSIDR_EL1_INTERVAL_256:
1057 spe_pmu->min_period = 256;
1059 case PMSIDR_EL1_INTERVAL_512:
1060 spe_pmu->min_period = 512;
1062 case PMSIDR_EL1_INTERVAL_768:
1063 spe_pmu->min_period = 768;
1065 case PMSIDR_EL1_INTERVAL_1024:
1066 spe_pmu->min_period = 1024;
1068 case PMSIDR_EL1_INTERVAL_1536:
1069 spe_pmu->min_period = 1536;
1071 case PMSIDR_EL1_INTERVAL_2048:
1072 spe_pmu->min_period = 2048;
1074 case PMSIDR_EL1_INTERVAL_3072:
1075 spe_pmu->min_period = 3072;
1078 dev_warn(dev, "unknown PMSIDR_EL1.Interval [%d]; assuming 8\n",
1081 case PMSIDR_EL1_INTERVAL_4096:
1082 spe_pmu->min_period = 4096;
1085 /* Maximum record size. If it's out-of-range, then fail the probe */
1086 fld = FIELD_GET(PMSIDR_EL1_MAXSIZE, reg);
1087 spe_pmu->max_record_sz = 1 << fld;
1088 if (spe_pmu->max_record_sz > SZ_2K || spe_pmu->max_record_sz < 16) {
1089 dev_err(dev, "unsupported PMSIDR_EL1.MaxSize [%d] on CPU %d\n",
1090 fld, smp_processor_id());
1094 fld = FIELD_GET(PMSIDR_EL1_COUNTSIZE, reg);
1097 dev_warn(dev, "unknown PMSIDR_EL1.CountSize [%d]; assuming 2\n",
1100 case PMSIDR_EL1_COUNTSIZE_12_BIT_SAT:
1101 spe_pmu->counter_sz = 12;
1103 case PMSIDR_EL1_COUNTSIZE_16_BIT_SAT:
1104 spe_pmu->counter_sz = 16;
1108 "probed SPEv1.%d for CPUs %*pbl [max_record_sz %u, align %u, features 0x%llx]\n",
1109 spe_pmu->pmsver - 1, cpumask_pr_args(&spe_pmu->supported_cpus),
1110 spe_pmu->max_record_sz, spe_pmu->align, spe_pmu->features);
1112 spe_pmu->features |= SPE_PMU_FEAT_DEV_PROBED;
1115 static void __arm_spe_pmu_reset_local(void)
1118 * This is probably overkill, as we have no idea where we're
1119 * draining any buffered data to...
1121 arm_spe_pmu_disable_and_drain_local();
1123 /* Reset the buffer base pointer */
1124 write_sysreg_s(0, SYS_PMBPTR_EL1);
1127 /* Clear any pending management interrupts */
1128 write_sysreg_s(0, SYS_PMBSR_EL1);
1132 static void __arm_spe_pmu_setup_one(void *info)
1134 struct arm_spe_pmu *spe_pmu = info;
1136 __arm_spe_pmu_reset_local();
1137 enable_percpu_irq(spe_pmu->irq, IRQ_TYPE_NONE);
1140 static void __arm_spe_pmu_stop_one(void *info)
1142 struct arm_spe_pmu *spe_pmu = info;
1144 disable_percpu_irq(spe_pmu->irq);
1145 __arm_spe_pmu_reset_local();
1148 static int arm_spe_pmu_cpu_startup(unsigned int cpu, struct hlist_node *node)
1150 struct arm_spe_pmu *spe_pmu;
1152 spe_pmu = hlist_entry_safe(node, struct arm_spe_pmu, hotplug_node);
1153 if (!cpumask_test_cpu(cpu, &spe_pmu->supported_cpus))
1156 __arm_spe_pmu_setup_one(spe_pmu);
1160 static int arm_spe_pmu_cpu_teardown(unsigned int cpu, struct hlist_node *node)
1162 struct arm_spe_pmu *spe_pmu;
1164 spe_pmu = hlist_entry_safe(node, struct arm_spe_pmu, hotplug_node);
1165 if (!cpumask_test_cpu(cpu, &spe_pmu->supported_cpus))
1168 __arm_spe_pmu_stop_one(spe_pmu);
1172 static int arm_spe_pmu_dev_init(struct arm_spe_pmu *spe_pmu)
1175 cpumask_t *mask = &spe_pmu->supported_cpus;
1177 /* Make sure we probe the hardware on a relevant CPU */
1178 ret = smp_call_function_any(mask, __arm_spe_pmu_dev_probe, spe_pmu, 1);
1179 if (ret || !(spe_pmu->features & SPE_PMU_FEAT_DEV_PROBED))
1182 /* Request our PPIs (note that the IRQ is still disabled) */
1183 ret = request_percpu_irq(spe_pmu->irq, arm_spe_pmu_irq_handler, DRVNAME,
1189 * Register our hotplug notifier now so we don't miss any events.
1190 * This will enable the IRQ for any supported CPUs that are already
1193 ret = cpuhp_state_add_instance(arm_spe_pmu_online,
1194 &spe_pmu->hotplug_node);
1196 free_percpu_irq(spe_pmu->irq, spe_pmu->handle);
1201 static void arm_spe_pmu_dev_teardown(struct arm_spe_pmu *spe_pmu)
1203 cpuhp_state_remove_instance(arm_spe_pmu_online, &spe_pmu->hotplug_node);
1204 free_percpu_irq(spe_pmu->irq, spe_pmu->handle);
1207 /* Driver and device probing */
1208 static int arm_spe_pmu_irq_probe(struct arm_spe_pmu *spe_pmu)
1210 struct platform_device *pdev = spe_pmu->pdev;
1211 int irq = platform_get_irq(pdev, 0);
1216 if (!irq_is_percpu(irq)) {
1217 dev_err(&pdev->dev, "expected PPI but got SPI (%d)\n", irq);
1221 if (irq_get_percpu_devid_partition(irq, &spe_pmu->supported_cpus)) {
1222 dev_err(&pdev->dev, "failed to get PPI partition (%d)\n", irq);
1230 static const struct of_device_id arm_spe_pmu_of_match[] = {
1231 { .compatible = "arm,statistical-profiling-extension-v1", .data = (void *)1 },
1234 MODULE_DEVICE_TABLE(of, arm_spe_pmu_of_match);
1236 static const struct platform_device_id arm_spe_match[] = {
1237 { ARMV8_SPE_PDEV_NAME, 0},
1240 MODULE_DEVICE_TABLE(platform, arm_spe_match);
1242 static int arm_spe_pmu_device_probe(struct platform_device *pdev)
1245 struct arm_spe_pmu *spe_pmu;
1246 struct device *dev = &pdev->dev;
1249 * If kernelspace is unmapped when running at EL0, then the SPE
1250 * buffer will fault and prematurely terminate the AUX session.
1252 if (arm64_kernel_unmapped_at_el0()) {
1253 dev_warn_once(dev, "profiling buffer inaccessible. Try passing \"kpti=off\" on the kernel command line\n");
1257 spe_pmu = devm_kzalloc(dev, sizeof(*spe_pmu), GFP_KERNEL);
1261 spe_pmu->handle = alloc_percpu(typeof(*spe_pmu->handle));
1262 if (!spe_pmu->handle)
1265 spe_pmu->pdev = pdev;
1266 platform_set_drvdata(pdev, spe_pmu);
1268 ret = arm_spe_pmu_irq_probe(spe_pmu);
1270 goto out_free_handle;
1272 ret = arm_spe_pmu_dev_init(spe_pmu);
1274 goto out_free_handle;
1276 ret = arm_spe_pmu_perf_init(spe_pmu);
1278 goto out_teardown_dev;
1283 arm_spe_pmu_dev_teardown(spe_pmu);
1285 free_percpu(spe_pmu->handle);
1289 static int arm_spe_pmu_device_remove(struct platform_device *pdev)
1291 struct arm_spe_pmu *spe_pmu = platform_get_drvdata(pdev);
1293 arm_spe_pmu_perf_destroy(spe_pmu);
1294 arm_spe_pmu_dev_teardown(spe_pmu);
1295 free_percpu(spe_pmu->handle);
1299 static struct platform_driver arm_spe_pmu_driver = {
1300 .id_table = arm_spe_match,
1303 .of_match_table = of_match_ptr(arm_spe_pmu_of_match),
1304 .suppress_bind_attrs = true,
1306 .probe = arm_spe_pmu_device_probe,
1307 .remove = arm_spe_pmu_device_remove,
1310 static int __init arm_spe_pmu_init(void)
1314 ret = cpuhp_setup_state_multi(CPUHP_AP_ONLINE_DYN, DRVNAME,
1315 arm_spe_pmu_cpu_startup,
1316 arm_spe_pmu_cpu_teardown);
1319 arm_spe_pmu_online = ret;
1321 ret = platform_driver_register(&arm_spe_pmu_driver);
1323 cpuhp_remove_multi_state(arm_spe_pmu_online);
1328 static void __exit arm_spe_pmu_exit(void)
1330 platform_driver_unregister(&arm_spe_pmu_driver);
1331 cpuhp_remove_multi_state(arm_spe_pmu_online);
1334 module_init(arm_spe_pmu_init);
1335 module_exit(arm_spe_pmu_exit);
1337 MODULE_DESCRIPTION("Perf driver for the ARMv8.2 Statistical Profiling Extension");
1339 MODULE_LICENSE("GPL v2");