Skip to contentSkip to conversation

perf pmus: Fix duplicate events caused segfault

PATCH In review Eric Lin 4 participants 12 messages Jul 19, 2024 – Aug 7, 2024 2 messages not in the archive perf events

lore
Share & tools
lore

Eric Lin

author
#0 lore raw

PATCH 1/1 perf pmus: Fix duplicate events caused segfault

Currently, if vendor JSON files have two duplicate event names, the "perf list" command will trigger a segfault.

In commit e6ff1eed3584 ("perf pmu: Lazily add JSON events"), pmu_events_table__num_events() gets the number of JSON events from table_pmu->num_entries, which includes duplicate events if there are duplicate event names in the JSON files.

perf_pmu__for_each_event() adds JSON events to the pmu->alias list and copies sevent data to the aliases array. However, the pmu->alias list does not contain duplicate events, as perf_pmu__new_alias() checks if the name was already created.

When sorting the alias data, if there are two duplicate events, it causes a segfault in cmp_sevent() due to invalid aliases in the aliases array.

To avoid such segfault caused by duplicate event names in the JSON files, the len should be updated before sorting the aliases.

Fixes e6ff1eed3584 ("perf pmu: Lazily add JSON events")
---
 tools/perf/util/pmus.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
tools/perf/util/pmus.c +3 -2
index b9b4c5eb5002..e38c3fd4d1ff 100644
@@ -443,7 +443,7 @@ void perf_pmus__print_pmu_events(const struct print_callbacks *print_cb, void *p
 {
 	struct perf_pmu *pmu;
 	int printed = 0;
-	int len;
+	size_t len, j;
 	struct sevent *aliases;
 	struct events_callback_state state;
 	bool skip_duplicate_pmus = print_cb->skip_duplicate_pmus(print_state);
@@ -474,8 +474,9 @@ void perf_pmus__print_pmu_events(const struct print_callbacks *print_cb, void *p
 		perf_pmu__for_each_event(pmu, skip_duplicate_pmus, &state,
 					 perf_pmus__print_pmu_events__callback);
 	}
+	len = state.index;
 	qsort(aliases, len, sizeof(struct sevent), cmp_sevent);
-	for (int j = 0; j < len; j++) {
+	for (j = 0; j < len; j++) {
 		/* Skip duplicates */
 		if (j > 0 && pmu_alias_is_duplicate(&aliases[j], &aliases[j - 1]))
 			continue;
Signature · 1 line
2.43.2
#1 lore raw
Quoted 11 lines · Eric Lin

Currently, if vendor JSON files have two duplicate event names, the "perf list" command will trigger a segfault.

In commit e6ff1eed3584 ("perf pmu: Lazily add JSON events"), pmu_events_table__num_events() gets the number of JSON events from table_pmu->num_entries, which includes duplicate events if there are duplicate event names in the JSON files.

Hi Eric,

Let us consider there are duplicate event names in the JSON files, say :

metric.json with: EventName as pmu_cache_miss, EventCode as 0x1
cache.json with:  EventName as pmu_cache_miss, EventCode as 0x2

If we fix the segfault and proceed, still “perf list” will list only one entry for pmu_cache_miss with may be 0x1/0x2 as event code ?
Can you check the result to confirm what “perf list” will list in this case ? If it’s going to have only one entry in perf list, does it mean there are two event codes for pmu_cache_miss and it can work with either of the event code ?

If it happens to be a mistake in json file to have duplicate entry with different event code (ex: with some broken commit), I am thinking if the better fix is to keep only the valid entry in json file ?

Thanks
Athira

Quoted 47 lines

perf_pmu__for_each_event() adds JSON events to the pmu->alias list and copies sevent data to the aliases array. However, the pmu->alias list does not contain duplicate events, as perf_pmu__new_alias() checks if the name was already created.

When sorting the alias data, if there are two duplicate events, it causes a segfault in cmp_sevent() due to invalid aliases in the aliases array.

To avoid such segfault caused by duplicate event names in the JSON files, the len should be updated before sorting the aliases.

Fixes e6ff1eed3584 ("perf pmu: Lazily add JSON events")

---
tools/perf/util/pmus.c | 5 +++--

1 file changed, 3 insertions(+), 2 deletions(-)
tools/perf/util/pmus.c +3 -2
index b9b4c5eb5002..e38c3fd4d1ff 100644
@@ -443,7 +443,7 @@ void perf_pmus__print_pmu_events(const struct print_callbacks *print_cb, void *p
 {
 struct perf_pmu *pmu;
 int printed = 0;
- int len;
+ size_t len, j;
 struct sevent *aliases;
 struct events_callback_state state;
 bool skip_duplicate_pmus = print_cb->skip_duplicate_pmus(print_state);
@@ -474,8 +474,9 @@ void perf_pmus__print_pmu_events(const struct print_callbacks *print_cb, void *p
 perf_pmu__for_each_event(pmu, skip_duplicate_pmus, &state,
 perf_pmus__print_pmu_events__callback);
 }
+ len = state.index;
 qsort(aliases, len, sizeof(struct sevent), cmp_sevent);
- for (int j = 0; j < len; j++) {
+ for (j = 0; j < len; j++) {
 /* Skip duplicates */
 if (j > 0 && pmu_alias_is_duplicate(&aliases[j], &aliases[j - 1]))
 continue;
Signature · 1 line
2.43.2
author
#2 lore raw

Hi Athira,

Quoted 15 lines · Athira Rajeev
Quoted 12 lines · Eric Lin

Currently, if vendor JSON files have two duplicate event names, the "perf list" command will trigger a segfault.

In commit e6ff1eed3584 ("perf pmu: Lazily add JSON events"), pmu_events_table__num_events() gets the number of JSON events from table_pmu->num_entries, which includes duplicate events if there are duplicate event names in the JSON files.

Hi Eric,

Quoted 8 lines

Let us consider there are duplicate event names in the JSON files, say :

metric.json with: EventName as pmu_cache_miss, EventCode as 0x1
cache.json with:  EventName as pmu_cache_miss, EventCode as 0x2

If we fix the segfault and proceed, still “perf list” will list only one entry for pmu_cache_miss with may be 0x1/0x2 as event code ?
Can you check the result to confirm what “perf list” will list in this case ? If it’s going to have only one entry in perf list, does it mean there are two event codes for pmu_cache_miss and it can work with either of the event code ?

Sorry for the late reply.
Yes, I've checked if there are duplicate pmu_cache_miss events in the JSON files, the perf list will have only one entry in perf list.

Quoted 2 lines

If it happens to be a mistake in json file to have duplicate entry with different event code (ex: with some broken commit), I am thinking if the better fix is to keep only the valid entry in json file ?

Yes, I agree we should fix the duplicate events in vendor JSON files.

According to this code snippet [1], it seems the perf tool originally allowed duplicate events to exist and it will skip the duplicate events not shown on the perf list.
However, after this commit e6ff1eed3584 ("perf pmu: Lazily add JSON events"), if there are two duplicate events, it causes a segfault.

Can I ask, do you have any suggestions? Thanks.

[1] https://github.com/torvalds/linux/blob/master/tools/perf/util/pmus.c#L491

Regards,
Eric Lin

Quoted 51 lines

Thanks
Athira

Quoted 47 lines

perf_pmu__for_each_event() adds JSON events to the pmu->alias list and copies sevent data to the aliases array. However, the pmu->alias list does not contain duplicate events, as perf_pmu__new_alias() checks if the name was already created.

When sorting the alias data, if there are two duplicate events, it causes a segfault in cmp_sevent() due to invalid aliases in the aliases array.

To avoid such segfault caused by duplicate event names in the JSON files, the len should be updated before sorting the aliases.

Fixes e6ff1eed3584 ("perf pmu: Lazily add JSON events")

---
tools/perf/util/pmus.c | 5 +++--

1 file changed, 3 insertions(+), 2 deletions(-)
tools/perf/util/pmus.c +3 -3
index b9b4c5eb5002..e38c3fd4d1ff 100644
@@ -443,7 +443,7 @@ void perf_pmus__print_pmu_events(const struct print_callbacks *print_cb, void *p
 {
 struct perf_pmu *pmu;
 int printed = 0;
- int len;
+ size_t len, j;
 struct sevent *aliases;
 struct events_callback_state state;
 bool skip_duplicate_pmus = print_cb->skip_duplicate_pmus(print_state);
@@ -474,8 +474,9 @@ void perf_pmus__print_pmu_events(const struct print_callbacks *print_cb, void *p
 perf_pmu__for_each_event(pmu, skip_duplicate_pmus, &state,
 perf_pmus__print_pmu_events__callback);
 }
+ len = state.index;
 qsort(aliases, len, sizeof(struct sevent), cmp_sevent);
- for (int j = 0; j < len; j++) {
+ for (j = 0; j < len; j++) {
 /* Skip duplicates */
 if (j > 0 && pmu_alias_is_duplicate(&aliases[j], &aliases[j - 1]))
 continue;
--

2.43.2

author
#3 lore raw

Hi,

Quoted 44 lines · Eric Lin

Hi Athira,

Quoted 15 lines · Athira Rajeev
Quoted 12 lines · Eric Lin

Currently, if vendor JSON files have two duplicate event names, the "perf list" command will trigger a segfault.

In commit e6ff1eed3584 ("perf pmu: Lazily add JSON events"), pmu_events_table__num_events() gets the number of JSON events from table_pmu->num_entries, which includes duplicate events if there are duplicate event names in the JSON files.

Hi Eric,

Quoted 8 lines

Let us consider there are duplicate event names in the JSON files, say :

metric.json with: EventName as pmu_cache_miss, EventCode as 0x1
cache.json with:  EventName as pmu_cache_miss, EventCode as 0x2

If we fix the segfault and proceed, still “perf list” will list only one entry for pmu_cache_miss with may be 0x1/0x2 as event code ?
Can you check the result to confirm what “perf list” will list in this case ? If it’s going to have only one entry in perf list, does it mean there are two event codes for pmu_cache_miss and it can work with either of the event code ?

Sorry for the late reply.
Yes, I've checked if there are duplicate pmu_cache_miss events in the JSON files, the perf list will have only one entry in perf list.

Quoted 2 lines

If it happens to be a mistake in json file to have duplicate entry with different event code (ex: with some broken commit), I am thinking if the better fix is to keep only the valid entry in json file ?

Yes, I agree we should fix the duplicate events in vendor JSON files.

According to this code snippet [1], it seems the perf tool originally allowed duplicate events to exist and it will skip the duplicate events not shown on the perf list.
However, after this commit e6ff1eed3584 ("perf pmu: Lazily add JSON events"), if there are two duplicate events, it causes a segfault.

Quoted 4 lines

Can I ask, do you have any suggestions? Thanks.

[1] https://github.com/torvalds/linux/blob/master/tools/perf/util/pmus.c#L491

Kindly ping.

Can I ask, are there any more comments about this patch? Thanks.

Regards,
Eric Lin

Quoted 54 lines

Regards,
Eric Lin

Quoted 51 lines

Thanks
Athira

Quoted 47 lines

perf_pmu__for_each_event() adds JSON events to the pmu->alias list and copies sevent data to the aliases array. However, the pmu->alias list does not contain duplicate events, as perf_pmu__new_alias() checks if the name was already created.

When sorting the alias data, if there are two duplicate events, it causes a segfault in cmp_sevent() due to invalid aliases in the aliases array.

To avoid such segfault caused by duplicate event names in the JSON files, the len should be updated before sorting the aliases.

Fixes e6ff1eed3584 ("perf pmu: Lazily add JSON events")

---
tools/perf/util/pmus.c | 5 +++--

1 file changed, 3 insertions(+), 2 deletions(-)
tools/perf/util/pmus.c +3 -3
index b9b4c5eb5002..e38c3fd4d1ff 100644
@@ -443,7 +443,7 @@ void perf_pmus__print_pmu_events(const struct print_callbacks *print_cb, void *p
 {
 struct perf_pmu *pmu;
 int printed = 0;
- int len;
+ size_t len, j;
 struct sevent *aliases;
 struct events_callback_state state;
 bool skip_duplicate_pmus = print_cb->skip_duplicate_pmus(print_state);
@@ -474,8 +474,9 @@ void perf_pmus__print_pmu_events(const struct print_callbacks *print_cb, void *p
 perf_pmu__for_each_event(pmu, skip_duplicate_pmus, &state,
 perf_pmus__print_pmu_events__callback);
 }
+ len = state.index;
 qsort(aliases, len, sizeof(struct sevent), cmp_sevent);
- for (int j = 0; j < len; j++) {
+ for (j = 0; j < len; j++) {
 /* Skip duplicates */
 if (j > 0 && pmu_alias_is_duplicate(&aliases[j], &aliases[j - 1]))
 continue;
--

2.43.2

#4 lore raw
Quoted 51 lines · Eric Lin

Hi,

Quoted 44 lines · Eric Lin

Hi Athira,

Quoted 15 lines · Athira Rajeev
Quoted 12 lines · Eric Lin

Currently, if vendor JSON files have two duplicate event names, the "perf list" command will trigger a segfault.

In commit e6ff1eed3584 ("perf pmu: Lazily add JSON events"), pmu_events_table__num_events() gets the number of JSON events from table_pmu->num_entries, which includes duplicate events if there are duplicate event names in the JSON files.

Hi Eric,

Quoted 8 lines

Let us consider there are duplicate event names in the JSON files, say :

metric.json with: EventName as pmu_cache_miss, EventCode as 0x1
cache.json with:  EventName as pmu_cache_miss, EventCode as 0x2

If we fix the segfault and proceed, still “perf list” will list only one entry for pmu_cache_miss with may be 0x1/0x2 as event code ?
Can you check the result to confirm what “perf list” will list in this case ? If it’s going to have only one entry in perf list, does it mean there are two event codes for pmu_cache_miss and it can work with either of the event code ?

Sorry for the late reply.
Yes, I've checked if there are duplicate pmu_cache_miss events in the JSON files, the perf list will have only one entry in perf list.

Quoted 2 lines

If it happens to be a mistake in json file to have duplicate entry with different event code (ex: with some broken commit), I am thinking if the better fix is to keep only the valid entry in json file ?

Yes, I agree we should fix the duplicate events in vendor JSON files.

According to this code snippet [1], it seems the perf tool originally allowed duplicate events to exist and it will skip the duplicate events not shown on the perf list.
However, after this commit e6ff1eed3584 ("perf pmu: Lazily add JSON events"), if there are two duplicate events, it causes a segfault.

Quoted 9 lines
Quoted 4 lines

Can I ask, do you have any suggestions? Thanks.

[1] https://github.com/torvalds/linux/blob/master/tools/perf/util/pmus.c#L491

Kindly ping.

Can I ask, are there any more comments about this patch? Thanks.

Hi Eric,

The functions there says alias and to skip duplicate alias. I am not sure if that is for events

Namhyung, Ian, Arnaldo
Any comments here ?

Thank
Athira

Quoted 55 lines

Regards,
Eric Lin

Quoted 51 lines

Regards,
Eric Lin

Quoted 48 lines

Thanks
Athira

Quoted 45 lines

perf_pmu__for_each_event() adds JSON events to the pmu->alias list and copies sevent data to the aliases array. However, the pmu->alias list does not contain duplicate events, as perf_pmu__new_alias() checks if the name was already created.

When sorting the alias data, if there are two duplicate events, it causes a segfault in cmp_sevent() due to invalid aliases in the aliases array.

To avoid such segfault caused by duplicate event names in the JSON files, the len should be updated before sorting the aliases.

Fixes e6ff1eed3584 ("perf pmu: Lazily add JSON events")

---
tools/perf/util/pmus.c | 5 +++--

1 file changed, 3 insertions(+), 2 deletions(-)
tools/perf/util/pmus.c +3 -3
index b9b4c5eb5002..e38c3fd4d1ff 100644
@@ -443,7 +443,7 @@ void perf_pmus__print_pmu_events(const struct print_callbacks *print_cb, void *p
 {
 struct perf_pmu *pmu;
 int printed = 0;
- int len;
+ size_t len, j;
 struct sevent *aliases;
 struct events_callback_state state;
 bool skip_duplicate_pmus = print_cb->skip_duplicate_pmus(print_state);
@@ -474,8 +474,9 @@ void perf_pmus__print_pmu_events(const struct print_callbacks *print_cb, void *p
 perf_pmu__for_each_event(pmu, skip_duplicate_pmus, &state,
 perf_pmus__print_pmu_events__callback);
 }
+ len = state.index;
 qsort(aliases, len, sizeof(struct sevent), cmp_sevent);
- for (int j = 0; j < len; j++) {
+ for (j = 0; j < len; j++) {
 /* Skip duplicates */
 if (j > 0 && pmu_alias_is_duplicate(&aliases[j], &aliases[j - 1]))
 continue;
--

2.43.2

#5 lore raw
Quoted 58 lines · Athira Rajeev
Quoted 58 lines · Eric Lin

Hi,

Quoted 44 lines · Eric Lin

Hi Athira,

Quoted 15 lines · Athira Rajeev
Quoted 12 lines · Eric Lin

Currently, if vendor JSON files have two duplicate event names, the "perf list" command will trigger a segfault.

In commit e6ff1eed3584 ("perf pmu: Lazily add JSON events"), pmu_events_table__num_events() gets the number of JSON events from table_pmu->num_entries, which includes duplicate events if there are duplicate event names in the JSON files.

Hi Eric,

Quoted 8 lines

Let us consider there are duplicate event names in the JSON files, say :

metric.json with: EventName as pmu_cache_miss, EventCode as 0x1
cache.json with:  EventName as pmu_cache_miss, EventCode as 0x2

If we fix the segfault and proceed, still “perf list” will list only one entry for pmu_cache_miss with may be 0x1/0x2 as event code ?
Can you check the result to confirm what “perf list” will list in this case ? If it’s going to have only one entry in perf list, does it mean there are two event codes for pmu_cache_miss and it can work with either of the event code ?

Sorry for the late reply.
Yes, I've checked if there are duplicate pmu_cache_miss events in the JSON files, the perf list will have only one entry in perf list.

Quoted 2 lines

If it happens to be a mistake in json file to have duplicate entry with different event code (ex: with some broken commit), I am thinking if the better fix is to keep only the valid entry in json file ?

Yes, I agree we should fix the duplicate events in vendor JSON files.

According to this code snippet [1], it seems the perf tool originally allowed duplicate events to exist and it will skip the duplicate events not shown on the perf list.
However, after this commit e6ff1eed3584 ("perf pmu: Lazily add JSON events"), if there are two duplicate events, it causes a segfault.

Quoted 4 lines

Can I ask, do you have any suggestions? Thanks.

[1] https://github.com/torvalds/linux/blob/master/tools/perf/util/pmus.c#L491

Kindly ping.

Quoted 8 lines
Quoted 2 lines

Can I ask, are there any more comments about this patch? Thanks.

Hi Eric,

The functions there says alias and to skip duplicate alias. I am not sure if that is for events

Namhyung, Ian, Arnaldo
Any comments here ?

So I was trying to reproduce the problem here before looking at the patch, tried a simple:

⬢[acme@toolbox perf-tools-next]$ git diff

tools/perf/pmu-events/arch/x86/rocketlake/cache.json +9 -0
index 2e93b7835b41442b..167a41b0309b7cfc 100644
@@ -1,4 +1,13 @@
 [
+    {
+        "BriefDescription": "Counts the number of cache lines replaced in L1 data cache.",
+        "Counter": "0,1,2,3",
+        "EventCode": "0x51",
+        "EventName": "L1D.REPLACEMENT",
+        "PublicDescription": "Counts L1D data line replacements including opportunistic replacements, and replacements that require stall-for-replace or block-for-replace.",
+        "SampleAfterValue": "100003",
+        "UMask": "0x1"
+    },
     {
         "BriefDescription": "Counts the number of cache lines replaced in L1 data cache.",
         "Counter": "0,1,2,3",

⬢[acme@toolbox perf-tools-next]$ grep L1D.REPLACEMENT tools/perf/pmu-events/arch/x86/rocketlake/cache.json

        "EventName": "L1D.REPLACEMENT",
        "EventName": "L1D.REPLACEMENT",

⬢[acme@toolbox perf-tools-next]$

I.e. duplicated that whole event definition:

Did a make clean and a rebuild and:

root@x1:/home/acme/git/pahole# perf list l1d.replacement

List of pre-defined events (to be used in -e or -M):

cache:
l1d.replacement
[Counts the number of cache lines replaced in L1 data cache. Unit: cpu_core]

root@x1:/home/acme/git/pahole# perf list > /dev/null
root@x1:/home/acme/git/pahole#

No crash, can you provide instructions on how to reproduce the problem?

I would like to use the experience to add a 'perf test' to show this failing and then after the patch it passing that new test.

- Arnaldo

A message that is not in the archive (sent off-list or not yet received): CAPqJEFraOmS72dQQK2ou9EoxbCKZ8m_+DhQQfPmCy6wfxfQWzQ@mail.gmail.com

reviewer
#7 lore raw
Quoted 158 lines · Eric Lin

Hi Arnaldo,

Quoted 108 lines · Arnaldo Carvalho de Melo
Quoted 58 lines · Athira Rajeev
Quoted 58 lines · Eric Lin

Hi,

Quoted 44 lines · Eric Lin

Hi Athira,

Quoted 15 lines · Athira Rajeev
Quoted 12 lines · Eric Lin

Currently, if vendor JSON files have two duplicate event names, the "perf list" command will trigger a segfault.

In commit e6ff1eed3584 ("perf pmu: Lazily add JSON events"), pmu_events_table__num_events() gets the number of JSON events from table_pmu->num_entries, which includes duplicate events if there are duplicate event names in the JSON files.

Hi Eric,

Quoted 8 lines

Let us consider there are duplicate event names in the JSON files, say :

metric.json with: EventName as pmu_cache_miss, EventCode as 0x1
cache.json with:  EventName as pmu_cache_miss, EventCode as 0x2

If we fix the segfault and proceed, still “perf list” will list only one entry for pmu_cache_miss with may be 0x1/0x2 as event code ?
Can you check the result to confirm what “perf list” will list in this case ? If it’s going to have only one entry in perf list, does it mean there are two event codes for pmu_cache_miss and it can work with either of the event code ?

Sorry for the late reply.
Yes, I've checked if there are duplicate pmu_cache_miss events in the JSON files, the perf list will have only one entry in perf list.

Quoted 2 lines

If it happens to be a mistake in json file to have duplicate entry with different event code (ex: with some broken commit), I am thinking if the better fix is to keep only the valid entry in json file ?

Yes, I agree we should fix the duplicate events in vendor JSON files.

According to this code snippet [1], it seems the perf tool originally allowed duplicate events to exist and it will skip the duplicate events not shown on the perf list.
However, after this commit e6ff1eed3584 ("perf pmu: Lazily add JSON events"), if there are two duplicate events, it causes a segfault.

Quoted 4 lines

Can I ask, do you have any suggestions? Thanks.

[1] https://github.com/torvalds/linux/blob/master/tools/perf/util/pmus.c#L491

Kindly ping.

Quoted 8 lines
Quoted 2 lines

Can I ask, are there any more comments about this patch? Thanks.

Hi Eric,

The functions there says alias and to skip duplicate alias. I am not sure if that is for events

Namhyung, Ian, Arnaldo
Any comments here ?

So I was trying to reproduce the problem here before looking at the patch, tried a simple:

⬢[acme@toolbox perf-tools-next]$ git diff

tools/perf/pmu-events/arch/x86/rocketlake/cache.json +9 -0
index 2e93b7835b41442b..167a41b0309b7cfc 100644
@@ -1,4 +1,13 @@
 [
+    {
+        "BriefDescription": "Counts the number of cache lines replaced in L1 data cache.",
+        "Counter": "0,1,2,3",
+        "EventCode": "0x51",
+        "EventName": "L1D.REPLACEMENT",
+        "PublicDescription": "Counts L1D data line replacements including opportunistic replacements, and replacements that require stall-for-replace or block-for-replace.",
+        "SampleAfterValue": "100003",
+        "UMask": "0x1"
+    },
     {
         "BriefDescription": "Counts the number of cache lines replaced in L1 data cache.",
         "Counter": "0,1,2,3",

⬢[acme@toolbox perf-tools-next]$ grep L1D.REPLACEMENT tools/perf/pmu-events/arch/x86/rocketlake/cache.json

        "EventName": "L1D.REPLACEMENT",
        "EventName": "L1D.REPLACEMENT",

⬢[acme@toolbox perf-tools-next]$

I.e. duplicated that whole event definition:

Did a make clean and a rebuild and:

root@x1:/home/acme/git/pahole# perf list l1d.replacement

List of pre-defined events (to be used in -e or -M):

cache:
l1d.replacement
[Counts the number of cache lines replaced in L1 data cache. Unit: cpu_core]

Quoted 8 lines
root@x1:/home/acme/git/pahole# perf list > /dev/null
root@x1:/home/acme/git/pahole#

No crash, can you provide instructions on how to reproduce the problem?

I would like to use the experience to add a 'perf test' to show this failing and then after the patch it passing that new test.

The segfault occurs when the vendor JSON files contain two events with duplicate names.

I tried adding two duplicate events "L1D.REPLACEMENT" and "L1D_PEND_MISS.FB_FULL" and the issue can be reproduced on my laptop on the x86 platform.

ericl@EricL-ThinkPadX1-TW 11:11 ~/linux_src/linux/tools/perf (master) git diff

tools/perf/pmu-events/arch/x86/tigerlake/cache.json +18 -0
index f4144a1110be..71062a82699d 100644
@@ -8,6 +8,24 @@
         "SampleAfterValue": "100003",
         "UMask": "0x1"
     },
+    {
+        "BriefDescription": "Counts the number of cache lines replaced in L1 data cache.",
+        "Counter": "0,1,2,3",
+        "EventCode": "0x51",
+        "EventName": "L1D.REPLACEMENT",
+        "PublicDescription": "Counts L1D data line replacements including opportunistic replacements, and replacements that require stall-for-replace or block-for-replace.",
+        "SampleAfterValue": "100003",
+        "UMask": "0x1"
+    },
+    {
+        "BriefDescription": "Number of cycles a demand request has waited due to L1D Fill Buffer (FB) unavailability.",
+        "Counter": "0,1,2,3",
+        "EventCode": "0x48",
+        "EventName": "L1D_PEND_MISS.FB_FULL",
+        "PublicDescription": "Counts number of cycles a demand request has waited due to L1D Fill Buffer (FB) unavailability. Demand requests include cacheable/uncacheable demand load, store, lock or SW prefetch accesses.",
+        "SampleAfterValue": "1000003",
+        "UMask": "0x2"
+    },
     {
         "BriefDescription": "Number of cycles a demand request has waited due to L1D Fill Buffer (FB) unavailability.",
         "Counter": "0,1,2,3",
Quoted 3 lines

ericl@EricL-ThinkPadX1-TW 11:11 ~/linux_src/linux/tools/perf (master)

$ ./perf list
Segmentation fault (core dumped)

Hi Eric,

the series we were asking you to test was:
https://lore.kernel.org/linux-perf-users/[email protected]/
It can be convenient to use the b4 tool to grab a set of patches. It is also in the perf-tools-next tree:
https://git.kernel.org/pub/scm/linux/kernel/git/perf/perf-tools-next.git/
in the tmp.perf-tools-next branch, so you could clone that.

Having duplicate events doesn't make sense. When a sysfs event and json event exist with the same name, the json events values override those of the sysfs event:
https://git.kernel.org/pub/scm/linux/kernel/git/perf/perf-tools-next.git/tree/tools/perf/util/pmu.c?h=tmp.perf-tools-next#n599
Two json events doesn't have a clear meaning and which would be found would be dependent on a binary search. To avoid the problem the linked to series forbids duplicate events in the json and adds a build test building all architectures json. As this would break due to duplicate events, as your patch shows, there are json fixes for RISC-V and ARM.

Thanks,
Ian

A message that is not in the archive (sent off-list or not yet received): CAPqJEFr78B_74PCsxxHdDZtdrJVUL6j6u4vauCaoTaR7Rr=Rrw@mail.gmail.com

Tested-by
#9 lore raw
Quoted 194 lines · Eric Lin

This Message Is From an External Sender
This message came from outside your organization.
Report Suspicious

Hi Ian,

Quoted 183 lines · Ian Rogers
Quoted 158 lines · Eric Lin

Hi Arnaldo,

Quoted 108 lines · Arnaldo Carvalho de Melo
Quoted 58 lines · Athira Rajeev
Quoted 58 lines · Eric Lin

Hi,

Quoted 44 lines · Eric Lin

Hi Athira,

Quoted 15 lines · Athira Rajeev
Quoted 12 lines · Eric Lin

Currently, if vendor JSON files have two duplicate event names, the "perf list" command will trigger a segfault.

In commit e6ff1eed3584 ("perf pmu: Lazily add JSON events"), pmu_events_table__num_events() gets the number of JSON events from table_pmu->num_entries, which includes duplicate events if there are duplicate event names in the JSON files.

Hi Eric,

Quoted 8 lines

Let us consider there are duplicate event names in the JSON files, say :

metric.json with: EventName as pmu_cache_miss, EventCode as 0x1
cache.json with:  EventName as pmu_cache_miss, EventCode as 0x2

If we fix the segfault and proceed, still “perf list” will list only one entry for pmu_cache_miss with may be 0x1/0x2 as event code ?
Can you check the result to confirm what “perf list” will list in this case ? If it’s going to have only one entry in perf list, does it mean there are two event codes for pmu_cache_miss and it can work with either of the event code ?

Sorry for the late reply.
Yes, I've checked if there are duplicate pmu_cache_miss events in the JSON files, the perf list will have only one entry in perf list.

Quoted 2 lines

If it happens to be a mistake in json file to have duplicate entry with different event code (ex: with some broken commit), I am thinking if the better fix is to keep only the valid entry in json file ?

Yes, I agree we should fix the duplicate events in vendor JSON files.

According to this code snippet [1], it seems the perf tool originally allowed duplicate events to exist and it will skip the duplicate events not shown on the perf list.
However, after this commit e6ff1eed3584 ("perf pmu: Lazily add JSON events"), if there are two duplicate events, it causes a segfault.

Quoted 4 lines

Can I ask, do you have any suggestions? Thanks.

[1] https://github.com/torvalds/linux/blob/master/tools/perf/util/pmus.c#L491

Kindly ping.

Quoted 8 lines
Quoted 2 lines

Can I ask, are there any more comments about this patch? Thanks.

Hi Eric,

The functions there says alias and to skip duplicate alias. I am not sure if that is for events

Namhyung, Ian, Arnaldo
Any comments here ?

So I was trying to reproduce the problem here before looking at the patch, tried a simple:

⬢[acme@toolbox perf-tools-next]$ git diff

tools/perf/pmu-events/arch/x86/rocketlake/cache.json +9 -0
index 2e93b7835b41442b..167a41b0309b7cfc 100644
@@ -1,4 +1,13 @@
 [
+    {
+        "BriefDescription": "Counts the number of cache lines replaced in L1 data cache.",
+        "Counter": "0,1,2,3",
+        "EventCode": "0x51",
+        "EventName": "L1D.REPLACEMENT",
+        "PublicDescription": "Counts L1D data line replacements including opportunistic replacements, and replacements that require stall-for-replace or block-for-replace.",
+        "SampleAfterValue": "100003",
+        "UMask": "0x1"
+    },
     {
         "BriefDescription": "Counts the number of cache lines replaced in L1 data cache.",
         "Counter": "0,1,2,3",

⬢[acme@toolbox perf-tools-next]$ grep L1D.REPLACEMENT tools/perf/pmu-events/arch/x86/rocketlake/cache.json

        "EventName": "L1D.REPLACEMENT",
        "EventName": "L1D.REPLACEMENT",

⬢[acme@toolbox perf-tools-next]$

I.e. duplicated that whole event definition:

Did a make clean and a rebuild and:

root@x1:/home/acme/git/pahole# perf list l1d.replacement

List of pre-defined events (to be used in -e or -M):

cache:
l1d.replacement
[Counts the number of cache lines replaced in L1 data cache. Unit: cpu_core]

Quoted 8 lines
root@x1:/home/acme/git/pahole# perf list > /dev/null
root@x1:/home/acme/git/pahole#

No crash, can you provide instructions on how to reproduce the problem?

I would like to use the experience to add a 'perf test' to show this failing and then after the patch it passing that new test.

The segfault occurs when the vendor JSON files contain two events with duplicate names.

I tried adding two duplicate events "L1D.REPLACEMENT" and "L1D_PEND_MISS.FB_FULL" and the issue can be reproduced on my laptop on the x86 platform.

ericl@EricL-ThinkPadX1-TW 11:11 ~/linux_src/linux/tools/perf (master) git diff

tools/perf/pmu-events/arch/x86/tigerlake/cache.json +18 -0
index f4144a1110be..71062a82699d 100644
@@ -8,6 +8,24 @@
         "SampleAfterValue": "100003",
         "UMask": "0x1"
     },
+    {
+        "BriefDescription": "Counts the number of cache lines replaced in L1 data cache.",
+        "Counter": "0,1,2,3",
+        "EventCode": "0x51",
+        "EventName": "L1D.REPLACEMENT",
+        "PublicDescription": "Counts L1D data line replacements including opportunistic replacements, and replacements that require stall-for-replace or block-for-replace.",
+        "SampleAfterValue": "100003",
+        "UMask": "0x1"
+    },
+    {
+        "BriefDescription": "Number of cycles a demand request has waited due to L1D Fill Buffer (FB) unavailability.",
+        "Counter": "0,1,2,3",
+        "EventCode": "0x48",
+        "EventName": "L1D_PEND_MISS.FB_FULL",
+        "PublicDescription": "Counts number of cycles a demand request has waited due to L1D Fill Buffer (FB) unavailability. Demand requests include cacheable/uncacheable demand load, store, lock or SW prefetch accesses.",
+        "SampleAfterValue": "1000003",
+        "UMask": "0x2"
+    },
     {
         "BriefDescription": "Number of cycles a demand request has waited due to L1D Fill Buffer (FB) unavailability.",
         "Counter": "0,1,2,3",
Quoted 3 lines

ericl@EricL-ThinkPadX1-TW 11:11 ~/linux_src/linux/tools/perf (master)

$ ./perf list
Segmentation fault (core dumped)

Hi Eric,

the series we were asking you to test was:
https://lore.kernel.org/linux-perf-users/[email protected]/
It can be convenient to use the b4 tool to grab a set of patches. It is also in the perf-tools-next tree:
https://git.kernel.org/pub/scm/linux/kernel/git/perf/perf-tools-next.git/
in the tmp.perf-tools-next branch, so you could clone that.

Having duplicate events doesn't make sense. When a sysfs event and json event exist with the same name, the json events values override those of the sysfs event:
https://git.kernel.org/pub/scm/linux/kernel/git/perf/perf-tools-next.git/tree/tools/perf/util/pmu.c?h=tmp.perf-tools-next#n599
Two json events doesn't have a clear meaning and which would be found would be dependent on a binary search. To avoid the problem the linked to series forbids duplicate events in the json and adds a build test building all architectures json. As this would break due to duplicate events, as your patch shows, there are json fixes for RISC-V and ARM.

Hi Arnaldo, Ian

Thanks for quick response and providing the fix.
I tested with tmp.perf-tools-next branch from git://git.kernel.org/pub/scm/linux/kernel/git/perf/perf-tools-next.git

The build reports "Duplicate event” error when having duplicate events in the JSON files

Thanks
Athira

Quoted 58 lines

I tested the series and added duplicate events on the JSON files

tools/perf/pmu-events/arch/riscv/sifive/u74/memory.json +5 -0
index be1a46312ac3..48f5aec4875a 100644
@@ -1,4 +1,9 @@
 [
+  {
+    "EventName": "ICACHE_RETIRED",
+    "EventCode": "0x0000102",
+    "BriefDescription": "Instruction cache miss"
+  },
   {
     "EventName": "ICACHE_RETIRED",
     "EventCode": "0x0000102",
@@ -29,4 +34,4 @@
     "EventCode": "0x0002002",
     "BriefDescription": "UTLB miss"
   }
 

When building the perf tool, it will show the build error as follows:

CC tests/pmu-events.o
CC util/cacheline.o
Traceback (most recent call last):
File "pmu-events/jevents.py", line 1313, in <module>

    main()                                    
  File "pmu-events/jevents.py", line 1304, in main
    ftw(arch_path, [], process_one_file)
  File "pmu-events/jevents.py", line 1245, in ftw
    ftw(item.path, parents + [item.name], action)
  File "pmu-events/jevents.py", line 1243, in ftw
    action(parents, item)
  File "pmu-events/jevents.py", line 646, in process_one_file
    print_pending_events()
  File "pmu-events/jevents.py", line 510, in print_pending_events
    assert event.name != last_name, f"Duplicate event: {last_pmu}/{last_name}/ in {_pending_events_tblname}"

AssertionError: Duplicate event: default_core/icache_retired/ in pmu_events__sifive_u74
LD arch/riscv/util/perf-util-in.o
pmu-events/Build:35: recipe for target 'pmu-events/pmu-events.c' failed make[3]: *** [pmu-events/pmu-events.c] Error 1
make[3]: *** Deleting file 'pmu-events/pmu-events.c'
Makefile.perf:763: recipe for target 'pmu-events/pmu-events-in.o' failed make[2]: *** [pmu-events/pmu-events-in.o] Error 2
make[2]: *** Waiting for unfinished jobs....
CC bench/futex-lock-pi.o

I think the patch series can detect if the vendor JSON file has duplicate events when building the perf tool. Thanks.

Best regards,
Eric Lin

Quoted 2 lines

Thanks,
Ian

author Tested-by
#10 lore raw
In reply to a message not in the archive
Quoted 238 lines · Eric Lin

Hi Ian,

Quoted 173 lines · Ian Rogers
Quoted 158 lines · Eric Lin

Hi Arnaldo,

Quoted 108 lines · Arnaldo Carvalho de Melo
Quoted 58 lines · Athira Rajeev
Quoted 58 lines · Eric Lin

Hi,

Quoted 44 lines · Eric Lin

Hi Athira,

Quoted 15 lines · Athira Rajeev
Quoted 12 lines · Eric Lin

Currently, if vendor JSON files have two duplicate event names, the "perf list" command will trigger a segfault.

In commit e6ff1eed3584 ("perf pmu: Lazily add JSON events"), pmu_events_table__num_events() gets the number of JSON events from table_pmu->num_entries, which includes duplicate events if there are duplicate event names in the JSON files.

Hi Eric,

Quoted 8 lines

Let us consider there are duplicate event names in the JSON files, say :

metric.json with: EventName as pmu_cache_miss, EventCode as 0x1
cache.json with:  EventName as pmu_cache_miss, EventCode as 0x2

If we fix the segfault and proceed, still “perf list” will list only one entry for pmu_cache_miss with may be 0x1/0x2 as event code ?
Can you check the result to confirm what “perf list” will list in this case ? If it’s going to have only one entry in perf list, does it mean there are two event codes for pmu_cache_miss and it can work with either of the event code ?

Sorry for the late reply.
Yes, I've checked if there are duplicate pmu_cache_miss events in the JSON files, the perf list will have only one entry in perf list.

Quoted 2 lines

If it happens to be a mistake in json file to have duplicate entry with different event code (ex: with some broken commit), I am thinking if the better fix is to keep only the valid entry in json file ?

Yes, I agree we should fix the duplicate events in vendor JSON files.

According to this code snippet [1], it seems the perf tool originally allowed duplicate events to exist and it will skip the duplicate events not shown on the perf list.
However, after this commit e6ff1eed3584 ("perf pmu: Lazily add JSON events"), if there are two duplicate events, it causes a segfault.

Quoted 4 lines

Can I ask, do you have any suggestions? Thanks.

[1] https://github.com/torvalds/linux/blob/master/tools/perf/util/pmus.c#L491

Kindly ping.

Quoted 8 lines
Quoted 2 lines

Can I ask, are there any more comments about this patch? Thanks.

Hi Eric,

The functions there says alias and to skip duplicate alias. I am not sure if that is for events

Namhyung, Ian, Arnaldo
Any comments here ?

So I was trying to reproduce the problem here before looking at the patch, tried a simple:

⬢[acme@toolbox perf-tools-next]$ git diff

tools/perf/pmu-events/arch/x86/rocketlake/cache.json +9 -0
index 2e93b7835b41442b..167a41b0309b7cfc 100644
@@ -1,4 +1,13 @@
 [
+    {
+        "BriefDescription": "Counts the number of cache lines replaced in L1 data cache.",
+        "Counter": "0,1,2,3",
+        "EventCode": "0x51",
+        "EventName": "L1D.REPLACEMENT",
+        "PublicDescription": "Counts L1D data line replacements including opportunistic replacements, and replacements that require stall-for-replace or block-for-replace.",
+        "SampleAfterValue": "100003",
+        "UMask": "0x1"
+    },
     {
         "BriefDescription": "Counts the number of cache lines replaced in L1 data cache.",
         "Counter": "0,1,2,3",

⬢[acme@toolbox perf-tools-next]$ grep L1D.REPLACEMENT tools/perf/pmu-events/arch/x86/rocketlake/cache.json

        "EventName": "L1D.REPLACEMENT",
        "EventName": "L1D.REPLACEMENT",

⬢[acme@toolbox perf-tools-next]$

I.e. duplicated that whole event definition:

Did a make clean and a rebuild and:

root@x1:/home/acme/git/pahole# perf list l1d.replacement

List of pre-defined events (to be used in -e or -M):

cache:
l1d.replacement
[Counts the number of cache lines replaced in L1 data cache. Unit: cpu_core]

Quoted 8 lines
root@x1:/home/acme/git/pahole# perf list > /dev/null
root@x1:/home/acme/git/pahole#

No crash, can you provide instructions on how to reproduce the problem?

I would like to use the experience to add a 'perf test' to show this failing and then after the patch it passing that new test.

The segfault occurs when the vendor JSON files contain two events with duplicate names.

I tried adding two duplicate events "L1D.REPLACEMENT" and "L1D_PEND_MISS.FB_FULL" and the issue can be reproduced on my laptop on the x86 platform.

ericl@EricL-ThinkPadX1-TW 11:11 ~/linux_src/linux/tools/perf (master) git diff

tools/perf/pmu-events/arch/x86/tigerlake/cache.json +18 -0
index f4144a1110be..71062a82699d 100644
@@ -8,6 +8,24 @@
         "SampleAfterValue": "100003",
         "UMask": "0x1"
     },
+    {
+        "BriefDescription": "Counts the number of cache lines replaced in L1 data cache.",
+        "Counter": "0,1,2,3",
+        "EventCode": "0x51",
+        "EventName": "L1D.REPLACEMENT",
+        "PublicDescription": "Counts L1D data line replacements including opportunistic replacements, and replacements that require stall-for-replace or block-for-replace.",
+        "SampleAfterValue": "100003",
+        "UMask": "0x1"
+    },
+    {
+        "BriefDescription": "Number of cycles a demand request has waited due to L1D Fill Buffer (FB) unavailability.",
+        "Counter": "0,1,2,3",
+        "EventCode": "0x48",
+        "EventName": "L1D_PEND_MISS.FB_FULL",
+        "PublicDescription": "Counts number of cycles a demand request has waited due to L1D Fill Buffer (FB) unavailability. Demand requests include cacheable/uncacheable demand load, store, lock or SW prefetch accesses.",
+        "SampleAfterValue": "1000003",
+        "UMask": "0x2"
+    },
     {
         "BriefDescription": "Number of cycles a demand request has waited due to L1D Fill Buffer (FB) unavailability.",
         "Counter": "0,1,2,3",
Quoted 3 lines

ericl@EricL-ThinkPadX1-TW 11:11 ~/linux_src/linux/tools/perf (master)

$ ./perf list
Segmentation fault (core dumped)

Hi Eric,

the series we were asking you to test was:
https://lore.kernel.org/linux-perf-users/[email protected]/
It can be convenient to use the b4 tool to grab a set of patches. It is also in the perf-tools-next tree:
https://git.kernel.org/pub/scm/linux/kernel/git/perf/perf-tools-next.git/
in the tmp.perf-tools-next branch, so you could clone that.

Quoted 10 lines

Having duplicate events doesn't make sense. When a sysfs event and json event exist with the same name, the json events values override those of the sysfs event:
https://git.kernel.org/pub/scm/linux/kernel/git/perf/perf-tools-next.git/tree/tools/perf/util/pmu.c?h=tmp.perf-tools-next#n599
Two json events doesn't have a clear meaning and which would be found would be dependent on a binary search. To avoid the problem the linked to series forbids duplicate events in the json and adds a build test building all architectures json. As this would break due to duplicate events, as your patch shows, there are json fixes for RISC-V and ARM.

I tested the series and added duplicate events on the JSON files

tools/perf/pmu-events/arch/riscv/sifive/u74/memory.json +5 -0
index be1a46312ac3..48f5aec4875a 100644
@@ -1,4 +1,9 @@
 [
+  {
+    "EventName": "ICACHE_RETIRED",
+    "EventCode": "0x0000102",
+    "BriefDescription": "Instruction cache miss"
+  },
   {
     "EventName": "ICACHE_RETIRED",
     "EventCode": "0x0000102",
@@ -29,4 +34,4 @@
     "EventCode": "0x0002002",
     "BriefDescription": "UTLB miss"
   }
 

When building the perf tool, it will show the build error as follows:

CC tests/pmu-events.o
CC util/cacheline.o
Traceback (most recent call last):
File "pmu-events/jevents.py", line 1313, in <module>

    main()
  File "pmu-events/jevents.py", line 1304, in main
    ftw(arch_path, [], process_one_file)
  File "pmu-events/jevents.py", line 1245, in ftw
    ftw(item.path, parents + [item.name], action)
  File "pmu-events/jevents.py", line 1243, in ftw
    action(parents, item)
  File "pmu-events/jevents.py", line 646, in process_one_file
    print_pending_events()
  File "pmu-events/jevents.py", line 510, in print_pending_events
    assert event.name != last_name, f"Duplicate event: {last_pmu}/{last_name}/ in {_pending_events_tblname}"

AssertionError: Duplicate event: default_core/icache_retired/ in pmu_events__sifive_u74
LD arch/riscv/util/perf-util-in.o
pmu-events/Build:35: recipe for target 'pmu-events/pmu-events.c' failed make[3]: *** [pmu-events/pmu-events.c] Error 1
make[3]: *** Deleting file 'pmu-events/pmu-events.c'
Makefile.perf:763: recipe for target 'pmu-events/pmu-events-in.o' failed make[2]: *** [pmu-events/pmu-events-in.o] Error 2
make[2]: *** Waiting for unfinished jobs....
CC bench/futex-lock-pi.o

Quoted 2 lines

I think the patch series can detect if the vendor JSON file has duplicate events when building the perf tool. Thanks.

Hi Ian, Arnaldo

I tested the duplicate event with tmp.perf-tools-next branch from
https://git.kernel.org/pub/scm/linux/kernel/git/perf/perf-tools-next.git/

Thanks.

Best regards,
Eric Lin

Quoted 6 lines

Best regards,
Eric Lin

Quoted 2 lines

Thanks,
Ian

reviewer
#11 lore raw
In reply to Athira Rajeev
Quoted 57 lines · Athira Rajeev
Quoted 57 lines · Eric Lin

Hi,

Quoted 48 lines · Eric Lin

Hi Athira,

Quoted 15 lines · Athira Rajeev
Quoted 12 lines · Eric Lin

Currently, if vendor JSON files have two duplicate event names, the "perf list" command will trigger a segfault.

In commit e6ff1eed3584 ("perf pmu: Lazily add JSON events"), pmu_events_table__num_events() gets the number of JSON events from table_pmu->num_entries, which includes duplicate events if there are duplicate event names in the JSON files.

Hi Eric,

Quoted 8 lines

Let us consider there are duplicate event names in the JSON files, say :

metric.json with: EventName as pmu_cache_miss, EventCode as 0x1
cache.json with:  EventName as pmu_cache_miss, EventCode as 0x2

If we fix the segfault and proceed, still “perf list” will list only one entry for pmu_cache_miss with may be 0x1/0x2 as event code ?
Can you check the result to confirm what “perf list” will list in this case ? If it’s going to have only one entry in perf list, does it mean there are two event codes for pmu_cache_miss and it can work with either of the event code ?

Sorry for the late reply.
Yes, I've checked if there are duplicate pmu_cache_miss events in the JSON files, the perf list will have only one entry in perf list.

Quoted 2 lines

If it happens to be a mistake in json file to have duplicate entry with different event code (ex: with some broken commit), I am thinking if the better fix is to keep only the valid entry in json file ?

Yes, I agree we should fix the duplicate events in vendor JSON files.

According to this code snippet [1], it seems the perf tool originally allowed duplicate events to exist and it will skip the duplicate events not shown on the perf list.
However, after this commit e6ff1eed3584 ("perf pmu: Lazily add JSON events"), if there are two duplicate events, it causes a segfault.

Can I ask, do you have any suggestions? Thanks.

[1] https://github.com/torvalds/linux/blob/master/tools/perf/util/pmus.c#L491

Quoted 7 lines
Quoted 4 lines

Kindly ping.

Can I ask, are there any more comments about this patch? Thanks.

Hi Eric,

The functions there says alias and to skip duplicate alias. I am not sure if that is for events

Fwiw, I'm trying to get rid of the term alias it should mean event. For some reason the code always referred to events as aliases as exemplified by:
https://git.kernel.org/pub/scm/linux/kernel/git/perf/perf-tools-next.git/tree/tools/perf/util/pmu.c?h=tmp.perf-tools-next#n55
But it is possible to have an "alias" (different) name for a PMU and I'm sure for other things too. So the term alias is ambiguous and these things are events, so let's just call them events to be most intention revealing.

Quoted 2 lines

Namhyung, Ian, Arnaldo
Any comments here ?

I'll take a look.

Thanks,
Ian

Quoted 60 lines

Thank
Athira

Quoted 55 lines

Regards,
Eric Lin

Quoted 51 lines

Regards,
Eric Lin

Quoted 48 lines

Thanks
Athira

Quoted 45 lines

perf_pmu__for_each_event() adds JSON events to the pmu->alias list and copies sevent data to the aliases array. However, the pmu->alias list does not contain duplicate events, as perf_pmu__new_alias() checks if the name was already created.

When sorting the alias data, if there are two duplicate events, it causes a segfault in cmp_sevent() due to invalid aliases in the aliases array.

To avoid such segfault caused by duplicate event names in the JSON files, the len should be updated before sorting the aliases.

Fixes e6ff1eed3584 ("perf pmu: Lazily add JSON events")

---
tools/perf/util/pmus.c | 5 +++--

1 file changed, 3 insertions(+), 2 deletions(-)
tools/perf/util/pmus.c +3 -3
index b9b4c5eb5002..e38c3fd4d1ff 100644
@@ -443,7 +443,7 @@ void perf_pmus__print_pmu_events(const struct print_callbacks *print_cb, void *p
 {
 struct perf_pmu *pmu;
 int printed = 0;
- int len;
+ size_t len, j;
 struct sevent *aliases;
 struct events_callback_state state;
 bool skip_duplicate_pmus = print_cb->skip_duplicate_pmus(print_state);
@@ -474,8 +474,9 @@ void perf_pmus__print_pmu_events(const struct print_callbacks *print_cb, void *p
 perf_pmu__for_each_event(pmu, skip_duplicate_pmus, &state,
 perf_pmus__print_pmu_events__callback);
 }
+ len = state.index;
 qsort(aliases, len, sizeof(struct sevent), cmp_sevent);
- for (int j = 0; j < len; j++) {
+ for (j = 0; j < len; j++) {
 /* Skip duplicates */
 if (j > 0 && pmu_alias_is_duplicate(&aliases[j], &aliases[j - 1]))
 continue;
--

2.43.2

reviewer
#12 lore raw
Quoted 77 lines · Ian Rogers
Quoted 57 lines · Athira Rajeev
Quoted 57 lines · Eric Lin

Hi,

Quoted 48 lines · Eric Lin

Hi Athira,

Quoted 15 lines · Athira Rajeev
Quoted 12 lines · Eric Lin

Currently, if vendor JSON files have two duplicate event names, the "perf list" command will trigger a segfault.

In commit e6ff1eed3584 ("perf pmu: Lazily add JSON events"), pmu_events_table__num_events() gets the number of JSON events from table_pmu->num_entries, which includes duplicate events if there are duplicate event names in the JSON files.

Hi Eric,

Quoted 8 lines

Let us consider there are duplicate event names in the JSON files, say :

metric.json with: EventName as pmu_cache_miss, EventCode as 0x1
cache.json with:  EventName as pmu_cache_miss, EventCode as 0x2

If we fix the segfault and proceed, still “perf list” will list only one entry for pmu_cache_miss with may be 0x1/0x2 as event code ?
Can you check the result to confirm what “perf list” will list in this case ? If it’s going to have only one entry in perf list, does it mean there are two event codes for pmu_cache_miss and it can work with either of the event code ?

Sorry for the late reply.
Yes, I've checked if there are duplicate pmu_cache_miss events in the JSON files, the perf list will have only one entry in perf list.

Quoted 2 lines

If it happens to be a mistake in json file to have duplicate entry with different event code (ex: with some broken commit), I am thinking if the better fix is to keep only the valid entry in json file ?

Yes, I agree we should fix the duplicate events in vendor JSON files.

According to this code snippet [1], it seems the perf tool originally allowed duplicate events to exist and it will skip the duplicate events not shown on the perf list.
However, after this commit e6ff1eed3584 ("perf pmu: Lazily add JSON events"), if there are two duplicate events, it causes a segfault.

Can I ask, do you have any suggestions? Thanks.

[1] https://github.com/torvalds/linux/blob/master/tools/perf/util/pmus.c#L491

Quoted 7 lines
Quoted 4 lines

Kindly ping.

Can I ask, are there any more comments about this patch? Thanks.

Hi Eric,

The functions there says alias and to skip duplicate alias. I am not sure if that is for events

Fwiw, I'm trying to get rid of the term alias it should mean event. For some reason the code always referred to events as aliases as exemplified by:
https://git.kernel.org/pub/scm/linux/kernel/git/perf/perf-tools-next.git/tree/tools/perf/util/pmu.c?h=tmp.perf-tools-next#n55
But it is possible to have an "alias" (different) name for a PMU and I'm sure for other things too. So the term alias is ambiguous and these things are events, so let's just call them events to be most intention revealing.

Quoted 4 lines
Quoted 2 lines

Namhyung, Ian, Arnaldo
Any comments here ?

I'll take a look.

The problematic events all come from copy pasting ArchStdEvent. It feels better to have an invariant that events appear once so I sent out a series to clean this up:
https://lore.kernel.org/linux-perf-users/[email protected]/
If you could test and add a tested-by tag that'd be great!

Thanks,
Ian

#13 lore raw
Quoted 22 lines · Ian Rogers
Quoted 20 lines · Ian Rogers
Quoted 7 lines · Athira Rajeev
Quoted 5 lines · Eric Lin

On Sun, Jul 21, 2024 at 11:44 PM Eric Lin <[email protected]> wrote:
Kindly ping.

Can I ask, are there any more comments about this patch? Thanks.

The functions there says alias and to skip duplicate alias. I am not sure if that is for events

Fwiw, I'm trying to get rid of the term alias it should mean event. For some reason the code always referred to events as aliases as exemplified by:
https://git.kernel.org/pub/scm/linux/kernel/git/perf/perf-tools-next.git/tree/tools/perf/util/pmu.c?h=tmp.perf-tools-next#n55
But it is possible to have an "alias" (different) name for a PMU and I'm sure for other things too. So the term alias is ambiguous and these things are events, so let's just call them events to be most intention revealing.

Quoted 2 lines

Namhyung, Ian, Arnaldo
Any comments here ?

Quoted 7 lines
Quoted 1 line

I'll take a look.

The problematic events all come from copy pasting ArchStdEvent. It feels better to have an invariant that events appear once so I sent out a series to clean this up:
https://lore.kernel.org/linux-perf-users/[email protected]/
If you could test and add a tested-by tag that'd be great!

I have the series in tmp.perf-tools-next, will collect Tested-by/Reviewed-by if they are provided, before moving it to perf-tools-next.

- Arnaldo