Prefer sysfs/JSON events also when no PMU is provided
Subsystems (2)
Ian Rogers
reviewerv4 cover Prefer sysfs/JSON events also when no PMU is provided
At the RISC-V summit the topic of avoiding event data being in the RISC-V PMU kernel driver came up. There is a preference for sysfs/JSON events being the priority when no PMU is provided so that legacy events maybe supported via json. Originally Mark Rutland also expressed at LPC 2023 that doing this would resolve bugs on ARM Apple M? processors, but James Clark more recently tested this and believes the driver issues there may not have existed or have been resolved. In any case, it is inconsistent that with a PMU event names avoid legacy encodings, but when wildcarding PMUs (ie without a PMU with the event name) the legacy encodings have priority.
The patch doing this work was reverted in a v6.10 release candidate as, even though the patch was posted for weeks and had been on linux-next for weeks without issue, Linus was in the habit of using explicit legacy events with unsupported precision options on his Neoverse-N1. This machine has SLC PMU events for bus and CPU cycles where ARM decided to call the events bus_cycles and cycles, the latter being also a legacy event name. ARM haven't renamed the cycles event to a more consistent cpu_cycles and avoided the problem. With these changes the problematic event will now be skipped, a large warning produced, and perf record will continue for the other PMU events. This solution was proposed by Arnaldo.
Two minor changes have been added to help with the error message and to work around issues occurring with "perf stat metrics (shadow stat) test".
The patches have only been tested on my x86 non-hybrid laptop.
v4: Rework the no events opening change from v3 to make it handle
multiple dummy events. Sadly an evlist isn't empty if it just contains dummy events as the dummy event may be used with "perf record -e dummy .." as a way to determine whether permission issues exist. Other software events like cpu-clock would suffice for this, but the using dummy genie has left the bottle.
Another problem is that we appear to have an excessive number of dummy events added, for example, we can likely avoid a dummy event and add sideband data to the original event. For auxtrace more dummy events may be opened too. Anyway, this has led to the approach taken in patch 3 where the number of dummy parsed events is computed. If the number of removed/failing-to-open non-dummy events matches the number of non-dummy events then we want to fail, but only if there are no parsed dummy events or if there was one then it must have opened. The math here is hard to read, but passes my manual testing.
v3: Make no events opening for perf record a failure as suggested by
James Clark and Aditya Bodkhe <[email protected]>. Also, rebase.
v2: Rebase and add tested-by tags from James Clark, Leo Yan and Atish
Patra who have tested on RISC-V and ARM CPUs, including the problem case from before.
Ian Rogers (4):
perf evsel: Add pmu_name helper
perf stat: Fix find_stat for mixed legacy/non-legacy events perf record: Skip don't fail for events that don't open perf parse-events: Reapply "Prefer sysfs/JSON hardware events over
legacy"
tools/perf/builtin-record.c | 54 +++++++++++++++++++++--- tools/perf/util/evsel.c | 10 +++++ tools/perf/util/evsel.h | 1 + tools/perf/util/parse-events.c | 26 +++++++++--- tools/perf/util/parse-events.l | 76 +++++++++++++++++----------------- tools/perf/util/parse-events.y | 60 ++++++++++++++++++--------- tools/perf/util/pmus.c | 20 +++++++-- tools/perf/util/stat-shadow.c | 3 +- 8 files changed, 176 insertions(+), 74 deletions(-)
Signature · 1 line
2.47.1.613.gc27f4b7a9f-goog
Ian Rogers
reviewerPATCH v4 1/4 perf evsel: Add pmu_name helper
Add helper to get the name of the evsel's PMU. This handles the case where there's no sysfs PMU via parse_events event_type helper.
--- tools/perf/util/evsel.c | 10 ++++++++++ tools/perf/util/evsel.h | 1 + 2 files changed, 11 insertions(+)
tools/perf/util/evsel.c +10 -0
@@ -237,6 +237,16 @@ int evsel__object_config(size_t object_size, int (*init)(struct evsel *evsel),return 0 ; } +const char *evsel__pmu_name (const struct evsel *evsel) +{ +struct perf_pmu *pmu =evsel__find_pmu (evsel); + +if (pmu) +return pmu->name; + +return event_type (evsel->core.attr.type); +} +#define FD (e, x, y) (*(int *)xyarray__entry(e->core.fd, x, y))int __evsel__sample_size (u64 sample_type)
tools/perf/util/evsel.h +1 -0
@@ -236,6 +236,7 @@ int evsel__object_config(size_t object_size, void (*fini)(struct evsel *evsel));struct perf_pmu *evsel__find_pmu (const struct evsel *evsel); +const char *evsel__pmu_name (const struct evsel *evsel);bool evsel__is_aux_event (const struct evsel *evsel);struct evsel *evsel__new_idx (struct perf_event_attr *attr,int idx);
Signature · 1 line
2.47.1.613.gc27f4b7a9f-goog
Ian Rogers
reviewerPATCH v4 2/4 perf stat: Fix find_stat for mixed legacy/non-legacy events
In reply to Ian RogersLegacy events typically don't have a PMU when added leading to mismatched legacy/non-legacy cases in find_stat. Use evsel__find_pmu to make sure the evsel PMU is looked up. Update the evsel__find_pmu code to look for the PMU using the extended config type or, for legacy hardware/hw_cache events on non-hybrid systems, just use the core PMU.
Before:
```
$ perf stat -e cycles,cpu/instructions/ -a sleep 1
Performance counter stats for 'system wide':
215,309,764 cycles
44,326,491 cpu/instructions/
1.002555314 seconds time elapsed
```
After:
```
$ perf stat -e cycles,cpu/instructions/ -a sleep 1
Performance counter stats for 'system wide':
990,676,332 cycles
1,235,762,487 cpu/instructions/ # 1.25 insn per cycle
1.002667198 seconds time elapsed
```calculation on the hybrid")
--- tools/perf/util/pmus.c | 20 +++++++++++++++++--- tools/perf/util/stat-shadow.c | 3 ++- 2 files changed, 19 insertions(+), 4 deletions(-)
tools/perf/util/pmus.c +17 -3
@@ -710,11 +710,25 @@ char *perf_pmus__default_pmu_name(void)struct perf_pmu *evsel__find_pmu (const struct evsel *evsel) {struct perf_pmu *pmu = evsel->pmu; +bool legacy_core_type; -if (!pmu) { - pmu =perf_pmus__find_by_type (evsel->core.attr.type); - ((struct evsel *)evsel)->pmu = pmu; +if (pmu) +return pmu; + + pmu =perf_pmus__find_by_type (evsel->core.attr.type); + legacy_core_type = + evsel->core.attr.type ==PERF_TYPE_HARDWARE || + evsel->core.attr.type ==PERF_TYPE_HW_CACHE ; +if (!pmu && legacy_core_type) { +if (perf_pmus__supports_extended_type ()) { +u32 type = evsel->core.attr.config >>PERF_PMU_TYPE_SHIFT ; + + pmu =perf_pmus__find_by_type (type); + }else { + pmu =perf_pmus__find_core_pmu (); + } } + ((struct evsel *)evsel)->pmu = pmu;return pmu; }
tools/perf/util/stat-shadow.c +2 -1
@@ -151,6 +151,7 @@ static double find_stat(const struct evsel *evsel, int aggr_idx, enum stat_type {struct evsel *cur;int evsel_ctx =evsel_context (evsel); +struct perf_pmu *evsel_pmu =evsel__find_pmu (evsel);evlist__for_each_entry (evsel->evlist, cur) {struct perf_stat_aggr *aggr;
@@ -177,7 +178,7 @@ static double find_stat(const struct evsel *evsel, int aggr_idx, enum stat_type* Except the SW CLOCK events, * ignore if not the PMU we're looking for. */ -if ((type !=STAT_NSECS ) && (evsel->pmu != cur->pmu)) +if ((type !=STAT_NSECS ) && (evsel_pmu !=evsel__find_pmu (cur)))continue ; aggr = &cur->stats->aggr[aggr_idx];
Signature · 1 line
2.47.1.613.gc27f4b7a9f-goog
Ian Rogers
reviewerPATCH v4 3/4 perf record: Skip don't fail for events that don't open
In reply to Ian RogersWhilst for many tools it is an expected behavior that failure to open a perf event is a failure, ARM decided to name PMU events the same as legacy events and then failed to rename such events on a server uncore SLC PMU. As perf's default behavior when no PMU is specified is to open the event on all PMUs that advertise/"have" the event, this yielded failures when trying to make the priority of legacy and sysfs/json events uniform - something requested by RISC-V and ARM. A legacy event user on ARM hardware may find their event opened on an uncore PMU which for perf record will fail. Arnaldo suggested skipping such events which this patch implements. Rather than have the skipping conditional on running on ARM, the skipping is done on all architectures as such a fundamental behavioral difference could lead to problems with tools built/depending on perf.
An example of perf record failing to open events on x86 is:
```
$ perf record -e data_read,cycles,LLC-prefetch-read -a sleep 0.1
Error:
Failure to open event 'data_read' on PMU 'uncore_imc_free_running_0' which will be removed.
The sys_perf_event_open() syscall returned with 22 (Invalid argument) for event (data_read).
"dmesg | grep -i perf" may provide additional information.
Error:
Failure to open event 'data_read' on PMU 'uncore_imc_free_running_1' which will be removed.
The sys_perf_event_open() syscall returned with 22 (Invalid argument) for event (data_read).
"dmesg | grep -i perf" may provide additional information.
Error:
Failure to open event 'LLC-prefetch-read' on PMU 'cpu' which will be removed.
The LLC-prefetch-read event is not supported.
[ perf record: Woken up 1 times to write data ]
[ perf record: Captured and wrote 2.188 MB perf.data (87 samples) ]
$ perf report --stats
Aggregated stats:
TOTAL events: 17255
MMAP events: 284 ( 1.6%)
COMM events: 1961 (11.4%)
EXIT events: 1 ( 0.0%)
FORK events: 1960 (11.4%)
SAMPLE events: 87 ( 0.5%)
MMAP2 events: 12836 (74.4%)
KSYMBOL events: 83 ( 0.5%)
BPF_EVENT events: 36 ( 0.2%)
FINISHED_ROUND events: 2 ( 0.0%)
ID_INDEX events: 1 ( 0.0%)
THREAD_MAP events: 1 ( 0.0%)
CPU_MAP events: 1 ( 0.0%)
TIME_CONV events: 1 ( 0.0%)
FINISHED_INIT events: 1 ( 0.0%)
cycles stats:
SAMPLE events: 87
```If all events fail to open then the perf record will fail:
``` $ perf record -e LLC-prefetch-read true Error: Failure to open event 'LLC-prefetch-read' on PMU 'cpu' which will be removed. The LLC-prefetch-read event is not supported. Error: Failure to open any events for recording ```
This is done by detecting if dummy events were implicitly added by perf and seeing if the evlist is empty without them. This allows the dummy event still to be recorded:
``` $ perf record -e dummy true [ perf record: Woken up 1 times to write data ] [ perf record: Captured and wrote 0.046 MB perf.data ] ``` but fail when inserted: ``` $ perf record -e LLC-prefetch-read -a true Error: Failure to open event 'LLC-prefetch-read' on PMU 'cpu' which will be removed. The LLC-prefetch-read event is not supported. Error: Failure to open any events for recording ```
The issue with legacy events is that on RISC-V they want the driver to not have mappings from legacy to non-legacy config encodings for each vendor/model due to size, complexity and difficulty to update. It was reported that on ARM Apple-M? CPUs the legacy mapping in the driver was broken and the sysfs/json events should always take precedent, however, it isn't clear this is still the case. It is the case that without working around this issue a legacy event like cycles without a PMU can encode differently than when specified with a PMU - the non-PMU version favoring legacy encodings, the PMU one avoiding legacy encodings.
The patch removes events and then adjusts the idx value for each evsel. This is done so that the dense xyarrays used for file descriptors, etc. don't contain broken entries. As event opening happens relatively late in the record process, use of the idx value before the open will have become corrupted, so it is expected there are latent bugs hidden behind this change - the change is best effort. As the only vendor that has broken event names is ARM, this will principally effect ARM users. They will also experience warning messages like those above because of the uncore PMU advertising legacy event names.
--- tools/perf/builtin-record.c | 54 ++++++++++++++++++++++++++++++++----- 1 file changed, 48 insertions(+), 6 deletions(-)
tools/perf/builtin-record.c +48 -6
@@ -161,6 +161,7 @@ struct record {struct evlist *sb_evlist;pthread_t thread_id;int realtime_prio; +int num_parsed_dummy_events;bool switch_output_event_set;bool no_buildid;bool no_buildid_set;
@@ -961,7 +962,6 @@ static int record__config_tracking_events(struct record *rec)*/ if (opts->target.initial_delay ||target__has_cpu (&opts->target) ||perf_pmus__num_core_pmus () >1 ) { -/* * User space tasks can migrate between CPUs, so when tracing * selected CPUs, sideband for all CPUs is still needed.
@@ -1366,6 +1366,7 @@ static int record__open(struct record *rec)struct perf_session *session = rec->session;struct record_opts *opts = &rec->opts;int rc =0 ; +bool skipped = false;evlist__for_each_entry (evlist, pos) { try_again:
@@ -1381,15 +1382,50 @@ static int record__open(struct record *rec) pos =evlist__reset_weak_group (evlist, pos, true); goto try_again; } - rc = -errno;evsel__open_strerror (pos, &opts->target, errno, msg,sizeof (msg)); -ui__error ("%s\n" , msg); - goto out; +ui__error ("Failure to open event '%s' on PMU '%s' which will be removed.\n%s\n" , +evsel__name (pos),evsel__pmu_name (pos), msg); + pos->skippable = true; + skipped = true; + }else { + pos->supported = true; } - - pos->supported = true; } +if (skipped) { +struct evsel *tmp; +int idx =0 , num_dummy =0 , num_non_dummy =0 , + removed_dummy =0 , removed_non_dummy =0 ; + +/* Remove evsels that failed to open and update indices. */ +evlist__for_each_entry_safe (evlist, tmp, pos) { +if (evsel__is_dummy_event (pos)) + num_dummy++; +else + num_non_dummy++; + +if (!pos->skippable) +continue ; + +if (evsel__is_dummy_event (pos)) + removed_dummy++; +else + removed_non_dummy++; + +evlist__remove (evlist, pos); + } +evlist__for_each_entry (evlist, pos) { + pos->core.idx = idx++; + } +/* If list is empty except implicitly added dummy events then fail. */ +if ((num_non_dummy == removed_non_dummy) && + ((rec->num_parsed_dummy_events ==0 ) || + (removed_dummy >= (num_dummy - rec->num_parsed_dummy_events)))) { +ui__error ("Failure to open any events for recording.\n" ); + rc =-1 ; + goto out; + } + }if (symbol_conf.kptr_restrict && !evlist__exclude_kernel (evlist)) {pr_warning ( "WARNING: Kernel address maps (/proc/{kallsyms,modules}) are restricted,\n"
@@ -3975,6 +4011,7 @@ int cmd_record(int argc, const char **argv)int err;struct record *rec = &record;char errbuf[BUFSIZ ]; +struct evsel *evsel;setlocale (LC_ALL ,"" );
@@ -4001,6 +4038,11 @@ int cmd_record(int argc, const char **argv)if (quiet)perf_quiet_option (); +evlist__for_each_entry (rec->evlist, evsel) { +if (evsel__is_dummy_event (evsel)) + rec->num_parsed_dummy_events++; + } + err =symbol__validate_sym_arguments ();if (err)return err;
Signature · 1 line
2.47.1.613.gc27f4b7a9f-goog
Namhyung Kim
maintainerRe: [PATCH v4 3/4] perf record: Skip don't fail for events that don't open
Hi Ian,
Quoted 184 lines · Ian Rogers
Whilst for many tools it is an expected behavior that failure to open a perf event is a failure, ARM decided to name PMU events the same as legacy events and then failed to rename such events on a server uncore SLC PMU. As perf's default behavior when no PMU is specified is to open the event on all PMUs that advertise/"have" the event, this yielded failures when trying to make the priority of legacy and sysfs/json events uniform - something requested by RISC-V and ARM. A legacy event user on ARM hardware may find their event opened on an uncore PMU which for perf record will fail. Arnaldo suggested skipping such events which this patch implements. Rather than have the skipping conditional on running on ARM, the skipping is done on all architectures as such a fundamental behavioral difference could lead to problems with tools built/depending on perf.
An example of perf record failing to open events on x86 is:
``` $ perf record -e data_read,cycles,LLC-prefetch-read -a sleep 0.1 Error: Failure to open event 'data_read' on PMU 'uncore_imc_free_running_0' which will be removed. The sys_perf_event_open() syscall returned with 22 (Invalid argument) for event (data_read). "dmesg | grep -i perf" may provide additional information. Error: Failure to open event 'data_read' on PMU 'uncore_imc_free_running_1' which will be removed. The sys_perf_event_open() syscall returned with 22 (Invalid argument) for event (data_read). "dmesg | grep -i perf" may provide additional information. Error: Failure to open event 'LLC-prefetch-read' on PMU 'cpu' which will be removed. The LLC-prefetch-read event is not supported. [ perf record: Woken up 1 times to write data ] [ perf record: Captured and wrote 2.188 MB perf.data (87 samples) ] $ perf report --stats Aggregated stats: TOTAL events: 17255 MMAP events: 284 ( 1.6%) COMM events: 1961 (11.4%) EXIT events: 1 ( 0.0%) FORK events: 1960 (11.4%) SAMPLE events: 87 ( 0.5%) MMAP2 events: 12836 (74.4%) KSYMBOL events: 83 ( 0.5%) BPF_EVENT events: 36 ( 0.2%) FINISHED_ROUND events: 2 ( 0.0%) ID_INDEX events: 1 ( 0.0%) THREAD_MAP events: 1 ( 0.0%) CPU_MAP events: 1 ( 0.0%) TIME_CONV events: 1 ( 0.0%) FINISHED_INIT events: 1 ( 0.0%) cycles stats: SAMPLE events: 87 ```If all events fail to open then the perf record will fail:
``` $ perf record -e LLC-prefetch-read true Error: Failure to open event 'LLC-prefetch-read' on PMU 'cpu' which will be removed. The LLC-prefetch-read event is not supported. Error: Failure to open any events for recording ```This is done by detecting if dummy events were implicitly added by perf and seeing if the evlist is empty without them. This allows the dummy event still to be recorded:
``` $ perf record -e dummy true [ perf record: Woken up 1 times to write data ] [ perf record: Captured and wrote 0.046 MB perf.data ] ``` but fail when inserted: ``` $ perf record -e LLC-prefetch-read -a true Error: Failure to open event 'LLC-prefetch-read' on PMU 'cpu' which will be removed. The LLC-prefetch-read event is not supported. Error: Failure to open any events for recording ```The issue with legacy events is that on RISC-V they want the driver to not have mappings from legacy to non-legacy config encodings for each vendor/model due to size, complexity and difficulty to update. It was reported that on ARM Apple-M? CPUs the legacy mapping in the driver was broken and the sysfs/json events should always take precedent, however, it isn't clear this is still the case. It is the case that without working around this issue a legacy event like cycles without a PMU can encode differently than when specified with a PMU - the non-PMU version favoring legacy encodings, the PMU one avoiding legacy encodings.
The patch removes events and then adjusts the idx value for each evsel. This is done so that the dense xyarrays used for file descriptors, etc. don't contain broken entries. As event opening happens relatively late in the record process, use of the idx value before the open will have become corrupted, so it is expected there are latent bugs hidden behind this change - the change is best effort. As the only vendor that has broken event names is ARM, this will principally effect ARM users. They will also experience warning messages like those above because of the uncore PMU advertising legacy event names.
Suggested-by Arnaldo Carvalho de Melo <[email protected]>Signed-off-by Ian Rogers <[email protected]>Tested-by James Clark <[email protected]>Tested-by Leo Yan <[email protected]>Tested-by Atish Patra <[email protected]>--- tools/perf/builtin-record.c | 54 ++++++++++++++++++++++++++++++++----- 1 file changed, 48 insertions(+), 6 deletions(-)tools/perf/builtin-record.c +32
-6@@ -161,6 +161,7 @@ struct record {struct evlist *sb_evlist;pthread_t thread_id;int realtime_prio; +int num_parsed_dummy_events;bool switch_output_event_set;bool no_buildid;bool no_buildid_set;@@ -961,7 +962,6 @@ static int record__config_tracking_events(struct record *rec)*/ if (opts->target.initial_delay ||target__has_cpu (&opts->target) ||perf_pmus__num_core_pmus () >1 ) { -/* * User space tasks can migrate between CPUs, so when tracing * selected CPUs, sideband for all CPUs is still needed. @@ -1366,6 +1366,7 @@ static int record__open(struct record *rec)struct perf_session *session = rec->session;struct record_opts *opts = &rec->opts;int rc =0 ; +bool skipped = false;evlist__for_each_entry (evlist, pos) { try_again:@@ -1381,15 +1382,50 @@ static int record__open(struct record *rec) pos =evlist__reset_weak_group (evlist, pos, true); goto try_again; } - rc = -errno;evsel__open_strerror (pos, &opts->target, errno, msg,sizeof (msg)); -ui__error ("%s\n" , msg); - goto out; +ui__error ("Failure to open event '%s' on PMU '%s' which will be removed.\n%s\n" , +evsel__name (pos),evsel__pmu_name (pos), msg); + pos->skippable = true; + skipped = true; + }else { + pos->supported = true; } - - pos->supported = true; } +if (skipped) { +struct evsel *tmp; +int idx =0 , num_dummy =0 , num_non_dummy =0 , + removed_dummy =0 , removed_non_dummy =0 ; + +/* Remove evsels that failed to open and update indices. */ +evlist__for_each_entry_safe (evlist, tmp, pos) { +if (evsel__is_dummy_event (pos)) + num_dummy++; +else + num_non_dummy++; + +if (!pos->skippable) +continue ; + +if (evsel__is_dummy_event (pos)) + removed_dummy++; +else + removed_non_dummy++; + +evlist__remove (evlist, pos); + } +evlist__for_each_entry (evlist, pos) { + pos->core.idx = idx++;
tools/perf/builtin-record.c static int record__open(struct record *rec) · line 1428
Quoted 10 lines
tools/perf/builtin-record.c +10
-0+ } +/* If list is empty except implicitly added dummy events then fail. */ +if ((num_non_dummy == removed_non_dummy) && + ((rec->num_parsed_dummy_events ==0 ) || + (removed_dummy >= (num_dummy - rec->num_parsed_dummy_events)))) { +ui__error ("Failure to open any events for recording.\n" ); + rc =-1 ; + goto out; + } + }
Instead of couting dummy events, I wonder if it could check any supported non-dummy events in the evlist.
if (skipped) {
bool found = false;
evlist__for_each_entry_safe(evlist, tmp, pos) {
if (pos->skippable) {
evlist__remove(evlist, pos);
continue;
}
if (evsel__is_dummy_event(pos))
continue;
found = true;
}
if (!found) {
ui__error("...");
rc = -1;
goto out;
}
/* recalculate the index */
}Then it should do the same, no? The corner case would be when users specify dummy events in the command line (maybe to check permissions by the exit code).
$ perf record -a -e dummy true
If it fails to open, then 'skipped' set and 'found' not set so the command will fail. It it succeeds, then it doesn't set 'skipped' and the command will exit with 0.
Do I miss something?
Thanks,
Namhyung
Quoted 26 lines
tools/perf/builtin-record.c +6
-0if (symbol_conf.kptr_restrict && !evlist__exclude_kernel (evlist)) {pr_warning ( "WARNING: Kernel address maps (/proc/{kallsyms,modules}) are restricted,\n"@@ -3975,6 +4011,7 @@ int cmd_record(int argc, const char **argv)int err;struct record *rec = &record;char errbuf[BUFSIZ ]; +struct evsel *evsel;setlocale (LC_ALL ,"" );@@ -4001,6 +4038,11 @@ int cmd_record(int argc, const char **argv)if (quiet)perf_quiet_option (); +evlist__for_each_entry (rec->evlist, evsel) { +if (evsel__is_dummy_event (evsel)) + rec->num_parsed_dummy_events++; + } + err =symbol__validate_sym_arguments ();if (err)return err;Signature · 1 line
2.47.1.613.gc27f4b7a9f-goog
Ian Rogers
reviewerRe: [PATCH v4 3/4] perf record: Skip don't fail for events that don't open
Quoted 226 lines · Namhyung Kim
Hi Ian,
Quoted 184 lines · Ian Rogers
Whilst for many tools it is an expected behavior that failure to open a perf event is a failure, ARM decided to name PMU events the same as legacy events and then failed to rename such events on a server uncore SLC PMU. As perf's default behavior when no PMU is specified is to open the event on all PMUs that advertise/"have" the event, this yielded failures when trying to make the priority of legacy and sysfs/json events uniform - something requested by RISC-V and ARM. A legacy event user on ARM hardware may find their event opened on an uncore PMU which for perf record will fail. Arnaldo suggested skipping such events which this patch implements. Rather than have the skipping conditional on running on ARM, the skipping is done on all architectures as such a fundamental behavioral difference could lead to problems with tools built/depending on perf.
An example of perf record failing to open events on x86 is:
``` $ perf record -e data_read,cycles,LLC-prefetch-read -a sleep 0.1 Error: Failure to open event 'data_read' on PMU 'uncore_imc_free_running_0' which will be removed. The sys_perf_event_open() syscall returned with 22 (Invalid argument) for event (data_read). "dmesg | grep -i perf" may provide additional information. Error: Failure to open event 'data_read' on PMU 'uncore_imc_free_running_1' which will be removed. The sys_perf_event_open() syscall returned with 22 (Invalid argument) for event (data_read). "dmesg | grep -i perf" may provide additional information. Error: Failure to open event 'LLC-prefetch-read' on PMU 'cpu' which will be removed. The LLC-prefetch-read event is not supported. [ perf record: Woken up 1 times to write data ] [ perf record: Captured and wrote 2.188 MB perf.data (87 samples) ] $ perf report --stats Aggregated stats: TOTAL events: 17255 MMAP events: 284 ( 1.6%) COMM events: 1961 (11.4%) EXIT events: 1 ( 0.0%) FORK events: 1960 (11.4%) SAMPLE events: 87 ( 0.5%) MMAP2 events: 12836 (74.4%) KSYMBOL events: 83 ( 0.5%) BPF_EVENT events: 36 ( 0.2%) FINISHED_ROUND events: 2 ( 0.0%) ID_INDEX events: 1 ( 0.0%) THREAD_MAP events: 1 ( 0.0%) CPU_MAP events: 1 ( 0.0%) TIME_CONV events: 1 ( 0.0%) FINISHED_INIT events: 1 ( 0.0%) cycles stats: SAMPLE events: 87 ```If all events fail to open then the perf record will fail:
``` $ perf record -e LLC-prefetch-read true Error: Failure to open event 'LLC-prefetch-read' on PMU 'cpu' which will be removed. The LLC-prefetch-read event is not supported. Error: Failure to open any events for recording ```This is done by detecting if dummy events were implicitly added by perf and seeing if the evlist is empty without them. This allows the dummy event still to be recorded:
``` $ perf record -e dummy true [ perf record: Woken up 1 times to write data ] [ perf record: Captured and wrote 0.046 MB perf.data ] ``` but fail when inserted: ``` $ perf record -e LLC-prefetch-read -a true Error: Failure to open event 'LLC-prefetch-read' on PMU 'cpu' which will be removed. The LLC-prefetch-read event is not supported. Error: Failure to open any events for recording ```The issue with legacy events is that on RISC-V they want the driver to not have mappings from legacy to non-legacy config encodings for each vendor/model due to size, complexity and difficulty to update. It was reported that on ARM Apple-M? CPUs the legacy mapping in the driver was broken and the sysfs/json events should always take precedent, however, it isn't clear this is still the case. It is the case that without working around this issue a legacy event like cycles without a PMU can encode differently than when specified with a PMU - the non-PMU version favoring legacy encodings, the PMU one avoiding legacy encodings.
The patch removes events and then adjusts the idx value for each evsel. This is done so that the dense xyarrays used for file descriptors, etc. don't contain broken entries. As event opening happens relatively late in the record process, use of the idx value before the open will have become corrupted, so it is expected there are latent bugs hidden behind this change - the change is best effort. As the only vendor that has broken event names is ARM, this will principally effect ARM users. They will also experience warning messages like those above because of the uncore PMU advertising legacy event names.
Suggested-by Arnaldo Carvalho de Melo <[email protected]>Signed-off-by Ian Rogers <[email protected]>Tested-by James Clark <[email protected]>Tested-by Leo Yan <[email protected]>Tested-by Atish Patra <[email protected]>--- tools/perf/builtin-record.c | 54 ++++++++++++++++++++++++++++++++----- 1 file changed, 48 insertions(+), 6 deletions(-)tools/perf/builtin-record.c +32
-6@@ -161,6 +161,7 @@ struct record {struct evlist *sb_evlist;pthread_t thread_id;int realtime_prio; +int num_parsed_dummy_events;bool switch_output_event_set;bool no_buildid;bool no_buildid_set;@@ -961,7 +962,6 @@ static int record__config_tracking_events(struct record *rec)*/ if (opts->target.initial_delay ||target__has_cpu (&opts->target) ||perf_pmus__num_core_pmus () >1 ) { -/* * User space tasks can migrate between CPUs, so when tracing * selected CPUs, sideband for all CPUs is still needed. @@ -1366,6 +1366,7 @@ static int record__open(struct record *rec)struct perf_session *session = rec->session;struct record_opts *opts = &rec->opts;int rc =0 ; +bool skipped = false;evlist__for_each_entry (evlist, pos) { try_again:@@ -1381,15 +1382,50 @@ static int record__open(struct record *rec) pos =evlist__reset_weak_group (evlist, pos, true); goto try_again; } - rc = -errno;evsel__open_strerror (pos, &opts->target, errno, msg,sizeof (msg)); -ui__error ("%s\n" , msg); - goto out; +ui__error ("Failure to open event '%s' on PMU '%s' which will be removed.\n%s\n" , +evsel__name (pos),evsel__pmu_name (pos), msg); + pos->skippable = true; + skipped = true; + }else { + pos->supported = true; } - - pos->supported = true; } +if (skipped) { +struct evsel *tmp; +int idx =0 , num_dummy =0 , num_non_dummy =0 , + removed_dummy =0 , removed_non_dummy =0 ; + +/* Remove evsels that failed to open and update indices. */ +evlist__for_each_entry_safe (evlist, tmp, pos) { +if (evsel__is_dummy_event (pos)) + num_dummy++; +else + num_non_dummy++; + +if (!pos->skippable) +continue ; + +if (evsel__is_dummy_event (pos)) + removed_dummy++; +else + removed_non_dummy++; + +evlist__remove (evlist, pos); + } +evlist__for_each_entry (evlist, pos) { + pos->core.idx = idx++;tools/perf/builtin-record.c static int record__open(struct record *rec) · line 1428
Quoted 10 lines
tools/perf/builtin-record.c +10
-0+ } +/* If list is empty except implicitly added dummy events then fail. */ +if ((num_non_dummy == removed_non_dummy) && + ((rec->num_parsed_dummy_events ==0 ) || + (removed_dummy >= (num_dummy - rec->num_parsed_dummy_events)))) { +ui__error ("Failure to open any events for recording.\n" ); + rc =-1 ; + goto out; + } + }Instead of couting dummy events, I wonder if it could check any supported non-dummy events in the evlist.
if (skipped) { bool found = false; evlist__for_each_entry_safe(evlist, tmp, pos) { if (pos->skippable) { evlist__remove(evlist, pos); continue; } if (evsel__is_dummy_event(pos)) continue; found = true; } if (!found) { ui__error("..."); rc = -1; goto out; } /* recalculate the index */ }Then it should do the same, no? The corner case would be when users specify dummy events in the command line (maybe to check permissions by the exit code).
Quoted 7 lines
$ perf record -a -e dummy trueIf it fails to open, then 'skipped' set and 'found' not set so the command will fail. It it succeeds, then it doesn't set 'skipped' and the command will exit with 0.
Do I miss something?
Yep, but it depends on what we want the behavior to be. Consider an event that doesn't support record and the dummy event which for the sake of argument will open here:
$ perf record -a -e LLC-prefetch-read,dummy true
In this case initially found is false, we then process LLC-prefetch-read which didn't open and remove it from the evlist. Next we process the dummy event that did open but because it was a dummy event found won't be set to true. The code will then proceed to fail (found == false) even though the dummy event did open. Were this cycles and not dummy:
$ perf record -a -e LLC-prefetch-read,cycles true
Then the expectation would be for this to proceed with a warning on LLC-prefetch-read and to record cycles. With your code dummy will behave differently to cycles as it will terminate perf record early. Does this matter? I'm not sure, but I was trying to make the events (dummy vs non-dummy) consistent.
Thanks,
Ian
Namhyung Kim
maintainerRe: [PATCH v4 3/4] perf record: Skip don't fail for events that don't open
Quoted 248 lines · Ian Rogers
Quoted 226 lines · Namhyung Kim
Hi Ian,
Quoted 184 lines · Ian Rogers
Whilst for many tools it is an expected behavior that failure to open a perf event is a failure, ARM decided to name PMU events the same as legacy events and then failed to rename such events on a server uncore SLC PMU. As perf's default behavior when no PMU is specified is to open the event on all PMUs that advertise/"have" the event, this yielded failures when trying to make the priority of legacy and sysfs/json events uniform - something requested by RISC-V and ARM. A legacy event user on ARM hardware may find their event opened on an uncore PMU which for perf record will fail. Arnaldo suggested skipping such events which this patch implements. Rather than have the skipping conditional on running on ARM, the skipping is done on all architectures as such a fundamental behavioral difference could lead to problems with tools built/depending on perf.
An example of perf record failing to open events on x86 is:
``` $ perf record -e data_read,cycles,LLC-prefetch-read -a sleep 0.1 Error: Failure to open event 'data_read' on PMU 'uncore_imc_free_running_0' which will be removed. The sys_perf_event_open() syscall returned with 22 (Invalid argument) for event (data_read). "dmesg | grep -i perf" may provide additional information. Error: Failure to open event 'data_read' on PMU 'uncore_imc_free_running_1' which will be removed. The sys_perf_event_open() syscall returned with 22 (Invalid argument) for event (data_read). "dmesg | grep -i perf" may provide additional information. Error: Failure to open event 'LLC-prefetch-read' on PMU 'cpu' which will be removed. The LLC-prefetch-read event is not supported. [ perf record: Woken up 1 times to write data ] [ perf record: Captured and wrote 2.188 MB perf.data (87 samples) ] $ perf report --stats Aggregated stats: TOTAL events: 17255 MMAP events: 284 ( 1.6%) COMM events: 1961 (11.4%) EXIT events: 1 ( 0.0%) FORK events: 1960 (11.4%) SAMPLE events: 87 ( 0.5%) MMAP2 events: 12836 (74.4%) KSYMBOL events: 83 ( 0.5%) BPF_EVENT events: 36 ( 0.2%) FINISHED_ROUND events: 2 ( 0.0%) ID_INDEX events: 1 ( 0.0%) THREAD_MAP events: 1 ( 0.0%) CPU_MAP events: 1 ( 0.0%) TIME_CONV events: 1 ( 0.0%) FINISHED_INIT events: 1 ( 0.0%) cycles stats: SAMPLE events: 87 ```If all events fail to open then the perf record will fail:
``` $ perf record -e LLC-prefetch-read true Error: Failure to open event 'LLC-prefetch-read' on PMU 'cpu' which will be removed. The LLC-prefetch-read event is not supported. Error: Failure to open any events for recording ```This is done by detecting if dummy events were implicitly added by perf and seeing if the evlist is empty without them. This allows the dummy event still to be recorded:
``` $ perf record -e dummy true [ perf record: Woken up 1 times to write data ] [ perf record: Captured and wrote 0.046 MB perf.data ] ``` but fail when inserted: ``` $ perf record -e LLC-prefetch-read -a true Error: Failure to open event 'LLC-prefetch-read' on PMU 'cpu' which will be removed. The LLC-prefetch-read event is not supported. Error: Failure to open any events for recording ```The issue with legacy events is that on RISC-V they want the driver to not have mappings from legacy to non-legacy config encodings for each vendor/model due to size, complexity and difficulty to update. It was reported that on ARM Apple-M? CPUs the legacy mapping in the driver was broken and the sysfs/json events should always take precedent, however, it isn't clear this is still the case. It is the case that without working around this issue a legacy event like cycles without a PMU can encode differently than when specified with a PMU - the non-PMU version favoring legacy encodings, the PMU one avoiding legacy encodings.
The patch removes events and then adjusts the idx value for each evsel. This is done so that the dense xyarrays used for file descriptors, etc. don't contain broken entries. As event opening happens relatively late in the record process, use of the idx value before the open will have become corrupted, so it is expected there are latent bugs hidden behind this change - the change is best effort. As the only vendor that has broken event names is ARM, this will principally effect ARM users. They will also experience warning messages like those above because of the uncore PMU advertising legacy event names.
Suggested-by Arnaldo Carvalho de Melo <[email protected]>Signed-off-by Ian Rogers <[email protected]>Tested-by James Clark <[email protected]>Tested-by Leo Yan <[email protected]>Tested-by Atish Patra <[email protected]>--- tools/perf/builtin-record.c | 54 ++++++++++++++++++++++++++++++++----- 1 file changed, 48 insertions(+), 6 deletions(-)tools/perf/builtin-record.c +32
-6@@ -161,6 +161,7 @@ struct record {struct evlist *sb_evlist;pthread_t thread_id;int realtime_prio; +int num_parsed_dummy_events;bool switch_output_event_set;bool no_buildid;bool no_buildid_set;@@ -961,7 +962,6 @@ static int record__config_tracking_events(struct record *rec)*/ if (opts->target.initial_delay ||target__has_cpu (&opts->target) ||perf_pmus__num_core_pmus () >1 ) { -/* * User space tasks can migrate between CPUs, so when tracing * selected CPUs, sideband for all CPUs is still needed. @@ -1366,6 +1366,7 @@ static int record__open(struct record *rec)struct perf_session *session = rec->session;struct record_opts *opts = &rec->opts;int rc =0 ; +bool skipped = false;evlist__for_each_entry (evlist, pos) { try_again:@@ -1381,15 +1382,50 @@ static int record__open(struct record *rec) pos =evlist__reset_weak_group (evlist, pos, true); goto try_again; } - rc = -errno;evsel__open_strerror (pos, &opts->target, errno, msg,sizeof (msg)); -ui__error ("%s\n" , msg); - goto out; +ui__error ("Failure to open event '%s' on PMU '%s' which will be removed.\n%s\n" , +evsel__name (pos),evsel__pmu_name (pos), msg); + pos->skippable = true; + skipped = true; + }else { + pos->supported = true; } - - pos->supported = true; } +if (skipped) { +struct evsel *tmp; +int idx =0 , num_dummy =0 , num_non_dummy =0 , + removed_dummy =0 , removed_non_dummy =0 ; + +/* Remove evsels that failed to open and update indices. */ +evlist__for_each_entry_safe (evlist, tmp, pos) { +if (evsel__is_dummy_event (pos)) + num_dummy++; +else + num_non_dummy++; + +if (!pos->skippable) +continue ; + +if (evsel__is_dummy_event (pos)) + removed_dummy++; +else + removed_non_dummy++; + +evlist__remove (evlist, pos); + } +evlist__for_each_entry (evlist, pos) { + pos->core.idx = idx++;tools/perf/builtin-record.c static int record__open(struct record *rec) · line 1428
Quoted 10 lines
tools/perf/builtin-record.c +10
-0+ } +/* If list is empty except implicitly added dummy events then fail. */ +if ((num_non_dummy == removed_non_dummy) && + ((rec->num_parsed_dummy_events ==0 ) || + (removed_dummy >= (num_dummy - rec->num_parsed_dummy_events)))) { +ui__error ("Failure to open any events for recording.\n" ); + rc =-1 ; + goto out; + } + }Instead of couting dummy events, I wonder if it could check any supported non-dummy events in the evlist.
if (skipped) { bool found = false; evlist__for_each_entry_safe(evlist, tmp, pos) { if (pos->skippable) { evlist__remove(evlist, pos); continue; } if (evsel__is_dummy_event(pos)) continue; found = true; } if (!found) { ui__error("..."); rc = -1; goto out; } /* recalculate the index */ }Then it should do the same, no? The corner case would be when users specify dummy events in the command line (maybe to check permissions by the exit code).
Quoted 7 lines
$ perf record -a -e dummy trueIf it fails to open, then 'skipped' set and 'found' not set so the command will fail. It it succeeds, then it doesn't set 'skipped' and the command will exit with 0.
Do I miss something?
Yep, but it depends on what we want the behavior to be. Consider an event that doesn't support record and the dummy event which for the sake of argument will open here:
$ perf record -a -e LLC-prefetch-read,dummy trueIn this case initially found is false, we then process LLC-prefetch-read which didn't open and remove it from the evlist. Next we process the dummy event that did open but because it was a dummy event found won't be set to true. The code will then proceed to fail (found == false) even though the dummy event did open. Were this cycles and not dummy:
Quoted 7 lines
$ perf record -a -e LLC-prefetch-read,cycles trueThen the expectation would be for this to proceed with a warning on LLC-prefetch-read and to record cycles. With your code dummy will behave differently to cycles as it will terminate perf record early. Does this matter? I'm not sure, but I was trying to make the events (dummy vs non-dummy) consistent.
I'm not sure too. Anyway it won't get any samples if all other non-dummy events failed. Then there are not much points to run the perf record IMHO. I think dummy event is special as you counted it specifically so we don't need to worry about the special case too much.
Thanks,
Namhyung
Ian Rogers
reviewerRe: [PATCH v4 3/4] perf record: Skip don't fail for events that don't open
Quoted 258 lines · Namhyung Kim
Quoted 248 lines · Ian Rogers
Quoted 226 lines · Namhyung Kim
Hi Ian,
Quoted 184 lines · Ian Rogers
Whilst for many tools it is an expected behavior that failure to open a perf event is a failure, ARM decided to name PMU events the same as legacy events and then failed to rename such events on a server uncore SLC PMU. As perf's default behavior when no PMU is specified is to open the event on all PMUs that advertise/"have" the event, this yielded failures when trying to make the priority of legacy and sysfs/json events uniform - something requested by RISC-V and ARM. A legacy event user on ARM hardware may find their event opened on an uncore PMU which for perf record will fail. Arnaldo suggested skipping such events which this patch implements. Rather than have the skipping conditional on running on ARM, the skipping is done on all architectures as such a fundamental behavioral difference could lead to problems with tools built/depending on perf.
An example of perf record failing to open events on x86 is:
``` $ perf record -e data_read,cycles,LLC-prefetch-read -a sleep 0.1 Error: Failure to open event 'data_read' on PMU 'uncore_imc_free_running_0' which will be removed. The sys_perf_event_open() syscall returned with 22 (Invalid argument) for event (data_read). "dmesg | grep -i perf" may provide additional information. Error: Failure to open event 'data_read' on PMU 'uncore_imc_free_running_1' which will be removed. The sys_perf_event_open() syscall returned with 22 (Invalid argument) for event (data_read). "dmesg | grep -i perf" may provide additional information. Error: Failure to open event 'LLC-prefetch-read' on PMU 'cpu' which will be removed. The LLC-prefetch-read event is not supported. [ perf record: Woken up 1 times to write data ] [ perf record: Captured and wrote 2.188 MB perf.data (87 samples) ] $ perf report --stats Aggregated stats: TOTAL events: 17255 MMAP events: 284 ( 1.6%) COMM events: 1961 (11.4%) EXIT events: 1 ( 0.0%) FORK events: 1960 (11.4%) SAMPLE events: 87 ( 0.5%) MMAP2 events: 12836 (74.4%) KSYMBOL events: 83 ( 0.5%) BPF_EVENT events: 36 ( 0.2%) FINISHED_ROUND events: 2 ( 0.0%) ID_INDEX events: 1 ( 0.0%) THREAD_MAP events: 1 ( 0.0%) CPU_MAP events: 1 ( 0.0%) TIME_CONV events: 1 ( 0.0%) FINISHED_INIT events: 1 ( 0.0%) cycles stats: SAMPLE events: 87 ```If all events fail to open then the perf record will fail:
``` $ perf record -e LLC-prefetch-read true Error: Failure to open event 'LLC-prefetch-read' on PMU 'cpu' which will be removed. The LLC-prefetch-read event is not supported. Error: Failure to open any events for recording ```This is done by detecting if dummy events were implicitly added by perf and seeing if the evlist is empty without them. This allows the dummy event still to be recorded:
``` $ perf record -e dummy true [ perf record: Woken up 1 times to write data ] [ perf record: Captured and wrote 0.046 MB perf.data ] ``` but fail when inserted: ``` $ perf record -e LLC-prefetch-read -a true Error: Failure to open event 'LLC-prefetch-read' on PMU 'cpu' which will be removed. The LLC-prefetch-read event is not supported. Error: Failure to open any events for recording ```The issue with legacy events is that on RISC-V they want the driver to not have mappings from legacy to non-legacy config encodings for each vendor/model due to size, complexity and difficulty to update. It was reported that on ARM Apple-M? CPUs the legacy mapping in the driver was broken and the sysfs/json events should always take precedent, however, it isn't clear this is still the case. It is the case that without working around this issue a legacy event like cycles without a PMU can encode differently than when specified with a PMU - the non-PMU version favoring legacy encodings, the PMU one avoiding legacy encodings.
The patch removes events and then adjusts the idx value for each evsel. This is done so that the dense xyarrays used for file descriptors, etc. don't contain broken entries. As event opening happens relatively late in the record process, use of the idx value before the open will have become corrupted, so it is expected there are latent bugs hidden behind this change - the change is best effort. As the only vendor that has broken event names is ARM, this will principally effect ARM users. They will also experience warning messages like those above because of the uncore PMU advertising legacy event names.
Suggested-by Arnaldo Carvalho de Melo <[email protected]>Signed-off-by Ian Rogers <[email protected]>Tested-by James Clark <[email protected]>Tested-by Leo Yan <[email protected]>Tested-by Atish Patra <[email protected]>--- tools/perf/builtin-record.c | 54 ++++++++++++++++++++++++++++++++----- 1 file changed, 48 insertions(+), 6 deletions(-)tools/perf/builtin-record.c +32
-6@@ -161,6 +161,7 @@ struct record {struct evlist *sb_evlist;pthread_t thread_id;int realtime_prio; +int num_parsed_dummy_events;bool switch_output_event_set;bool no_buildid;bool no_buildid_set;@@ -961,7 +962,6 @@ static int record__config_tracking_events(struct record *rec)*/ if (opts->target.initial_delay ||target__has_cpu (&opts->target) ||perf_pmus__num_core_pmus () >1 ) { -/* * User space tasks can migrate between CPUs, so when tracing * selected CPUs, sideband for all CPUs is still needed. @@ -1366,6 +1366,7 @@ static int record__open(struct record *rec)struct perf_session *session = rec->session;struct record_opts *opts = &rec->opts;int rc =0 ; +bool skipped = false;evlist__for_each_entry (evlist, pos) { try_again:@@ -1381,15 +1382,50 @@ static int record__open(struct record *rec) pos =evlist__reset_weak_group (evlist, pos, true); goto try_again; } - rc = -errno;evsel__open_strerror (pos, &opts->target, errno, msg,sizeof (msg)); -ui__error ("%s\n" , msg); - goto out; +ui__error ("Failure to open event '%s' on PMU '%s' which will be removed.\n%s\n" , +evsel__name (pos),evsel__pmu_name (pos), msg); + pos->skippable = true; + skipped = true; + }else { + pos->supported = true; } - - pos->supported = true; } +if (skipped) { +struct evsel *tmp; +int idx =0 , num_dummy =0 , num_non_dummy =0 , + removed_dummy =0 , removed_non_dummy =0 ; + +/* Remove evsels that failed to open and update indices. */ +evlist__for_each_entry_safe (evlist, tmp, pos) { +if (evsel__is_dummy_event (pos)) + num_dummy++; +else + num_non_dummy++; + +if (!pos->skippable) +continue ; + +if (evsel__is_dummy_event (pos)) + removed_dummy++; +else + removed_non_dummy++; + +evlist__remove (evlist, pos); + } +evlist__for_each_entry (evlist, pos) { + pos->core.idx = idx++;tools/perf/builtin-record.c static int record__open(struct record *rec) · line 1428
Quoted 10 lines
tools/perf/builtin-record.c +10
-0+ } +/* If list is empty except implicitly added dummy events then fail. */ +if ((num_non_dummy == removed_non_dummy) && + ((rec->num_parsed_dummy_events ==0 ) || + (removed_dummy >= (num_dummy - rec->num_parsed_dummy_events)))) { +ui__error ("Failure to open any events for recording.\n" ); + rc =-1 ; + goto out; + } + }Instead of couting dummy events, I wonder if it could check any supported non-dummy events in the evlist.
if (skipped) { bool found = false; evlist__for_each_entry_safe(evlist, tmp, pos) { if (pos->skippable) { evlist__remove(evlist, pos); continue; } if (evsel__is_dummy_event(pos)) continue; found = true; } if (!found) { ui__error("..."); rc = -1; goto out; } /* recalculate the index */ }Then it should do the same, no? The corner case would be when users specify dummy events in the command line (maybe to check permissions by the exit code).
Quoted 7 lines
$ perf record -a -e dummy trueIf it fails to open, then 'skipped' set and 'found' not set so the command will fail. It it succeeds, then it doesn't set 'skipped' and the command will exit with 0.
Do I miss something?
Yep, but it depends on what we want the behavior to be. Consider an event that doesn't support record and the dummy event which for the sake of argument will open here:
$ perf record -a -e LLC-prefetch-read,dummy trueIn this case initially found is false, we then process LLC-prefetch-read which didn't open and remove it from the evlist. Next we process the dummy event that did open but because it was a dummy event found won't be set to true. The code will then proceed to fail (found == false) even though the dummy event did open. Were this cycles and not dummy:
Quoted 7 lines
$ perf record -a -e LLC-prefetch-read,cycles trueThen the expectation would be for this to proceed with a warning on LLC-prefetch-read and to record cycles. With your code dummy will behave differently to cycles as it will terminate perf record early. Does this matter? I'm not sure, but I was trying to make the events (dummy vs non-dummy) consistent.
Quoted 4 lines
I'm not sure too. Anyway it won't get any samples if all other non-dummy events failed. Then there are not much points to run the perf record IMHO. I think dummy event is special as you counted it specifically so we don't need to worry about the special case too much.
So the two use-cases for dummy I can think of are:
1) deliberately recording/sampling sideband data as you don't care about any real samples,
2) a permission check.
My preference was for dummy to behave as close as possible to other "regular" events like cycles. This could matter when we script and test all events like with "perf all PMU test":
https://git.kernel.org/pub/scm/linux/kernel/git/perf/perf-tools-next.git/tree/tools/perf/tests/shell/stat_all_pmu.sh?h=perf-tools-next
If my preference isn't wanted in favor of the simpler code I can make the change. The part of the series I want to land is making wildcarded and non-wildcarded event configurations consistent.
Thanks,
Ian
Namhyung Kim
maintainerRe: [PATCH v4 3/4] perf record: Skip don't fail for events that don't open
Quoted 259 lines · Ian Rogers
Quoted 258 lines · Namhyung Kim
Quoted 255 lines · Ian Rogers
Quoted 226 lines · Namhyung Kim
Hi Ian,
Quoted 184 lines · Ian Rogers
Whilst for many tools it is an expected behavior that failure to open a perf event is a failure, ARM decided to name PMU events the same as legacy events and then failed to rename such events on a server uncore SLC PMU. As perf's default behavior when no PMU is specified is to open the event on all PMUs that advertise/"have" the event, this yielded failures when trying to make the priority of legacy and sysfs/json events uniform - something requested by RISC-V and ARM. A legacy event user on ARM hardware may find their event opened on an uncore PMU which for perf record will fail. Arnaldo suggested skipping such events which this patch implements. Rather than have the skipping conditional on running on ARM, the skipping is done on all architectures as such a fundamental behavioral difference could lead to problems with tools built/depending on perf.
An example of perf record failing to open events on x86 is:
``` $ perf record -e data_read,cycles,LLC-prefetch-read -a sleep 0.1 Error: Failure to open event 'data_read' on PMU 'uncore_imc_free_running_0' which will be removed. The sys_perf_event_open() syscall returned with 22 (Invalid argument) for event (data_read). "dmesg | grep -i perf" may provide additional information. Error: Failure to open event 'data_read' on PMU 'uncore_imc_free_running_1' which will be removed. The sys_perf_event_open() syscall returned with 22 (Invalid argument) for event (data_read). "dmesg | grep -i perf" may provide additional information. Error: Failure to open event 'LLC-prefetch-read' on PMU 'cpu' which will be removed. The LLC-prefetch-read event is not supported. [ perf record: Woken up 1 times to write data ] [ perf record: Captured and wrote 2.188 MB perf.data (87 samples) ] $ perf report --stats Aggregated stats: TOTAL events: 17255 MMAP events: 284 ( 1.6%) COMM events: 1961 (11.4%) EXIT events: 1 ( 0.0%) FORK events: 1960 (11.4%) SAMPLE events: 87 ( 0.5%) MMAP2 events: 12836 (74.4%) KSYMBOL events: 83 ( 0.5%) BPF_EVENT events: 36 ( 0.2%) FINISHED_ROUND events: 2 ( 0.0%) ID_INDEX events: 1 ( 0.0%) THREAD_MAP events: 1 ( 0.0%) CPU_MAP events: 1 ( 0.0%) TIME_CONV events: 1 ( 0.0%) FINISHED_INIT events: 1 ( 0.0%) cycles stats: SAMPLE events: 87 ```If all events fail to open then the perf record will fail:
``` $ perf record -e LLC-prefetch-read true Error: Failure to open event 'LLC-prefetch-read' on PMU 'cpu' which will be removed. The LLC-prefetch-read event is not supported. Error: Failure to open any events for recording ```This is done by detecting if dummy events were implicitly added by perf and seeing if the evlist is empty without them. This allows the dummy event still to be recorded:
``` $ perf record -e dummy true [ perf record: Woken up 1 times to write data ] [ perf record: Captured and wrote 0.046 MB perf.data ] ``` but fail when inserted: ``` $ perf record -e LLC-prefetch-read -a true Error: Failure to open event 'LLC-prefetch-read' on PMU 'cpu' which will be removed. The LLC-prefetch-read event is not supported. Error: Failure to open any events for recording ```The issue with legacy events is that on RISC-V they want the driver to not have mappings from legacy to non-legacy config encodings for each vendor/model due to size, complexity and difficulty to update. It was reported that on ARM Apple-M? CPUs the legacy mapping in the driver was broken and the sysfs/json events should always take precedent, however, it isn't clear this is still the case. It is the case that without working around this issue a legacy event like cycles without a PMU can encode differently than when specified with a PMU - the non-PMU version favoring legacy encodings, the PMU one avoiding legacy encodings.
The patch removes events and then adjusts the idx value for each evsel. This is done so that the dense xyarrays used for file descriptors, etc. don't contain broken entries. As event opening happens relatively late in the record process, use of the idx value before the open will have become corrupted, so it is expected there are latent bugs hidden behind this change - the change is best effort. As the only vendor that has broken event names is ARM, this will principally effect ARM users. They will also experience warning messages like those above because of the uncore PMU advertising legacy event names.
Suggested-by Arnaldo Carvalho de Melo <[email protected]>Signed-off-by Ian Rogers <[email protected]>Tested-by James Clark <[email protected]>Tested-by Leo Yan <[email protected]>Tested-by Atish Patra <[email protected]>--- tools/perf/builtin-record.c | 54 ++++++++++++++++++++++++++++++++----- 1 file changed, 48 insertions(+), 6 deletions(-)tools/perf/builtin-record.c +32
-6@@ -161,6 +161,7 @@ struct record {struct evlist *sb_evlist;pthread_t thread_id;int realtime_prio; +int num_parsed_dummy_events;bool switch_output_event_set;bool no_buildid;bool no_buildid_set;@@ -961,7 +962,6 @@ static int record__config_tracking_events(struct record *rec)*/ if (opts->target.initial_delay ||target__has_cpu (&opts->target) ||perf_pmus__num_core_pmus () >1 ) { -/* * User space tasks can migrate between CPUs, so when tracing * selected CPUs, sideband for all CPUs is still needed. @@ -1366,6 +1366,7 @@ static int record__open(struct record *rec)struct perf_session *session = rec->session;struct record_opts *opts = &rec->opts;int rc =0 ; +bool skipped = false;evlist__for_each_entry (evlist, pos) { try_again:@@ -1381,15 +1382,50 @@ static int record__open(struct record *rec) pos =evlist__reset_weak_group (evlist, pos, true); goto try_again; } - rc = -errno;evsel__open_strerror (pos, &opts->target, errno, msg,sizeof (msg)); -ui__error ("%s\n" , msg); - goto out; +ui__error ("Failure to open event '%s' on PMU '%s' which will be removed.\n%s\n" , +evsel__name (pos),evsel__pmu_name (pos), msg); + pos->skippable = true; + skipped = true; + }else { + pos->supported = true; } - - pos->supported = true; } +if (skipped) { +struct evsel *tmp; +int idx =0 , num_dummy =0 , num_non_dummy =0 , + removed_dummy =0 , removed_non_dummy =0 ; + +/* Remove evsels that failed to open and update indices. */ +evlist__for_each_entry_safe (evlist, tmp, pos) { +if (evsel__is_dummy_event (pos)) + num_dummy++; +else + num_non_dummy++; + +if (!pos->skippable) +continue ; + +if (evsel__is_dummy_event (pos)) + removed_dummy++; +else + removed_non_dummy++; + +evlist__remove (evlist, pos); + } +evlist__for_each_entry (evlist, pos) { + pos->core.idx = idx++;tools/perf/builtin-record.c static int record__open(struct record *rec) · line 1428
Quoted 10 lines
tools/perf/builtin-record.c +10
-0+ } +/* If list is empty except implicitly added dummy events then fail. */ +if ((num_non_dummy == removed_non_dummy) && + ((rec->num_parsed_dummy_events ==0 ) || + (removed_dummy >= (num_dummy - rec->num_parsed_dummy_events)))) { +ui__error ("Failure to open any events for recording.\n" ); + rc =-1 ; + goto out; + } + }Instead of couting dummy events, I wonder if it could check any supported non-dummy events in the evlist.
if (skipped) { bool found = false; evlist__for_each_entry_safe(evlist, tmp, pos) { if (pos->skippable) { evlist__remove(evlist, pos); continue; } if (evsel__is_dummy_event(pos)) continue; found = true; } if (!found) { ui__error("..."); rc = -1; goto out; } /* recalculate the index */ }Then it should do the same, no? The corner case would be when users specify dummy events in the command line (maybe to check permissions by the exit code).
Quoted 7 lines
$ perf record -a -e dummy trueIf it fails to open, then 'skipped' set and 'found' not set so the command will fail. It it succeeds, then it doesn't set 'skipped' and the command will exit with 0.
Do I miss something?
Yep, but it depends on what we want the behavior to be. Consider an event that doesn't support record and the dummy event which for the sake of argument will open here:
$ perf record -a -e LLC-prefetch-read,dummy trueIn this case initially found is false, we then process LLC-prefetch-read which didn't open and remove it from the evlist. Next we process the dummy event that did open but because it was a dummy event found won't be set to true. The code will then proceed to fail (found == false) even though the dummy event did open. Were this cycles and not dummy:
$ perf record -a -e LLC-prefetch-read,cycles trueThen the expectation would be for this to proceed with a warning on LLC-prefetch-read and to record cycles. With your code dummy will behave differently to cycles as it will terminate perf record early. Does this matter? I'm not sure, but I was trying to make the events (dummy vs non-dummy) consistent.
Quoted 8 lines
Quoted 4 lines
I'm not sure too. Anyway it won't get any samples if all other non-dummy events failed. Then there are not much points to run the perf record IMHO. I think dummy event is special as you counted it specifically so we don't need to worry about the special case too much.
So the two use-cases for dummy I can think of are:
1) deliberately recording/sampling sideband data as you don't care about any real samples,
Then it doesn't have other events and should not fail (or you don't have the permission anyway).
Quoted 1 line
2) a permission check.
Also it can be only with a dummy event and the check would work, right?
Quoted 4 lines
My preference was for dummy to behave as close as possible to other "regular" events like cycles. This could matter when we script and test all events like with "perf all PMU test":
https://git.kernel.org/pub/scm/linux/kernel/git/perf/perf-tools-next.git/tree/tools/perf/tests/shell/stat_all_pmu.sh?h=perf-tools-next
Do you think it'd fail with the above change?
Quoted 3 lines
If my preference isn't wanted in favor of the simpler code I can make the change. The part of the series I want to land is making wildcarded and non-wildcarded event configurations consistent.
I prefer simpler code and we can fix it later if it ends up having any failing real use cases.
Thanks,
Namhyung
Ian Rogers
reviewerPATCH v4 4/4 perf parse-events: Reapply "Prefer sysfs/JSON hardware events over legacy"
In reply to Ian RogersOriginally posted and merged from:
https://lore.kernel.org/r/[email protected]
This reverts commit 4f1b067359ac8364cdb7f9fda41085fa85789d0f although the patch is now smaller due to related fixes being applied in commit 22a4db3c3603 ("perf evsel: Add alternate_hw_config and use in evsel__match").
The original commit message was:
It was requested that RISC-V be able to add events to the perf tool so the PMU driver didn't need to map legacy events to config encodings:
https://lore.kernel.org/lkml/[email protected]/
This change makes the priority of events specified without a PMU the same as those specified with a PMU, namely sysfs and JSON events are checked first before using the legacy encoding.
The hw_term is made more generic as a hardware_event that encodes a pair of string and int value, allowing parse_events_multi_pmu_add to fall back on a known encoding when the sysfs/JSON adding fails for core events. As this covers PE_VALUE_SYM_HW, that token is removed and related code simplified.
--- tools/perf/util/parse-events.c | 26 +++++++++--- tools/perf/util/parse-events.l | 76 +++++++++++++++++----------------- tools/perf/util/parse-events.y | 60 ++++++++++++++++++--------- 3 files changed, 98 insertions(+), 64 deletions(-)
tools/perf/util/parse-events.c +20 -6
@@ -1545,8 +1545,8 @@ int parse_events_multi_pmu_add(struct parse_events_state *parse_state,struct list_head *list =NULL ;struct perf_pmu *pmu =NULL ;YYLTYPE *loc = loc_; -int ok =0 ; -const char *config; +int ok =0 , core_ok =0 ; +const char *tmp;struct parse_events_terms parsed_terms; *listp =NULL ;
@@ -1559,15 +1559,15 @@ int parse_events_multi_pmu_add(struct parse_events_state *parse_state,return ret; } - config =strdup (event_name); -if (!config) + tmp =strdup (event_name); +if (!tmp) goto out_err;if (parse_events_term__num (&term,PARSE_EVENTS__TERM_TYPE_USER , - config,/*num=*/ 1 ,/*novalue=*/ true, + tmp,/*num=*/ 1 ,/*novalue=*/ true, loc,/*loc_val=*/ NULL ) <0 ) { -zfree (&config); +zfree (&tmp); goto out_err; }list_add_tail (&term->list, &parsed_terms.terms);
@@ -1598,6 +1598,8 @@ int parse_events_multi_pmu_add(struct parse_events_state *parse_state,pr_debug ("%s -> %s/%s/\n" , event_name, pmu->name, sb.buf);strbuf_release (&sb); ok++; +if (pmu->is_core) + core_ok++; } }
@@ -1614,6 +1616,18 @@ int parse_events_multi_pmu_add(struct parse_events_state *parse_state, } } +if (hw_config !=PERF_COUNT_HW_MAX && !core_ok) { +/* +* The event wasn't found on core PMUs but it has a hardware +* config version to try. +*/ +if (!parse_events_add_numeric (parse_state, list, +PERF_TYPE_HARDWARE , hw_config, + const_parsed_terms, +/*wildcard=*/ true)) + ok++; + } + out_err:parse_events_terms__exit (&parsed_terms);if (ok)
tools/perf/util/parse-events.l +38 -38
107 lines not on this page · raw message
tools/perf/util/parse-events.y +40 -20
130 lines not on this page · raw message
Signature · 1 line
2.47.1.613.gc27f4b7a9f-goog