perf test: Fix perf test 11 hwmon endianess issue
Subsystems (2)
PATCH 1/1 perf test: Fix perf test 11 hwmon endianess issue
perf test 11 hwmon fails on s390 with this error
# ./perf test -Fv 11
--- start ---
---- end ----
11.1: Basic parsing test : Ok
--- start ---
Testing 'temp_test_hwmon_event1'
Using CPUID IBM,3931,704,A01,3.7,002f
temp_test_hwmon_event1 -> hwmon_a_test_hwmon_pmu/temp_test_hwmon_event1/
FAILED tests/hwmon_pmu.c:189 Unexpected config for
'temp_test_hwmon_event1', 292470092988416 != 655361
---- end ----
11.2: Parsing without PMU name : FAILED!
--- start ---
Testing 'hwmon_a_test_hwmon_pmu/temp_test_hwmon_event1/'
FAILED tests/hwmon_pmu.c:189 Unexpected config for
'hwmon_a_test_hwmon_pmu/temp_test_hwmon_event1/',
292470092988416 != 655361
---- end ----
11.3: Parsing with PMU name : FAILED!
#The root cause is in member test_event::config which is initialized to 0xA0001 or 655361. During event parsing a long list event parsing functions are called and end up with this gdb call stack:
#0 hwmon_pmu__config_term (hwm=0x168dfd0, attr=0x3ffffff5ee8,
term=0x168db60, err=0x3ffffff81c8) at util/hwmon_pmu.c:623 #1 hwmon_pmu__config_terms (pmu=0x168dfd0, attr=0x3ffffff5ee8, terms=0x3ffffff5ea8, err=0x3ffffff81c8) at util/hwmon_pmu.c:662 #2 0x00000000012f870c in perf_pmu__config_terms (pmu=0x168dfd0, attr=0x3ffffff5ee8, terms=0x3ffffff5ea8, zero=false, apply_hardcoded=false, err=0x3ffffff81c8) at util/pmu.c:1519 #3 0x00000000012f88a4 in perf_pmu__config (pmu=0x168dfd0, attr=0x3ffffff5ee8, head_terms=0x3ffffff5ea8, apply_hardcoded=false, err=0x3ffffff81c8) at util/pmu.c:1545 #4 0x00000000012680c4 in parse_events_add_pmu (parse_state=0x3ffffff7fb8, list=0x168dc00, pmu=0x168dfd0, const_parsed_terms=0x3ffffff6090, auto_merge_stats=true, alternate_hw_config=10) at util/parse-events.c:1508 #5 0x00000000012684c6 in parse_events_multi_pmu_add (parse_state=0x3ffffff7fb8, event_name=0x168ec10 "temp_test_hwmon_event1", hw_config=10, const_parsed_terms=0x0, listp=0x3ffffff6230, loc_=0x3ffffff70e0) at util/parse-events.c:1592 #6 0x00000000012f0e4e in parse_events_parse (_parse_state=0x3ffffff7fb8, scanner=0x16878c0) at util/parse-events.y:293 #7 0x00000000012695a0 in parse_events__scanner (str=0x3ffffff81d8 "temp_test_hwmon_event1", input=0x0, parse_state=0x3ffffff7fb8) at util/parse-events.c:1867 #8 0x000000000126a1e8 in __parse_events (evlist=0x168b580, str=0x3ffffff81d8 "temp_test_hwmon_event1", pmu_filter=0x0, err=0x3ffffff81c8, fake_pmu=false, warn_if_reordered=true, fake_tp=false) at util/parse-events.c:2136 #9 0x00000000011e36aa in parse_events (evlist=0x168b580, str=0x3ffffff81d8 "temp_test_hwmon_event1", err=0x3ffffff81c8) at /root/linux/tools/perf/util/parse-events.h:41 #10 0x00000000011e3e64 in do_test (i=0, with_pmu=false, with_alias=false) at tests/hwmon_pmu.c:164 #11 0x00000000011e422c in test__hwmon_pmu (with_pmu=false) at tests/hwmon_pmu.c:219 #12 0x00000000011e431c in test__hwmon_pmu_without_pmu (test=0x1610368 <suite.hwmon_pmu>, subtest=1) at tests/hwmon_pmu.c:23
where the attr::config is set to value 292470092988416 or 0x10a0000000000 in line 625 of file ./util/hwmon_pmu.c:
attr->config = key.type_and_num;
However member key::type_and_num is defined as union and bit field:
union hwmon_pmu_event_key {
long type_and_num;
struct {
int num :16;
enum hwmon_type type :8;
};
};s390 is big endian and Intel is little endian architecture. The events for the hwmon dummy pmu have num = 1 or num = 2 and type is set to HWMON_TYPE_TEMP (which is 10).
On s390 this assignes member key::type_and_num the value of 0x10a0000000000 (which is 292470092988416) as shown in above trace output.
Fix this and export the structure/union hwmon_pmu_event_key so the test shares the same implementation as the event parsing functions for union and bit fields. This should avoid endianess issues on all platforms.
Output after:
# ./perf test -F 11 11.1: Basic parsing test : Ok 11.2: Parsing without PMU name : Ok 11.3: Parsing with PMU name : Ok #
--- tools/perf/tests/hwmon_pmu.c | 16 +++++++++++----- tools/perf/util/hwmon_pmu.c | 14 -------------- tools/perf/util/hwmon_pmu.h | 16 ++++++++++++++++ 3 files changed, 27 insertions(+), 19 deletions(-)
tools/perf/tests/hwmon_pmu.c +11 -5
@@ -13,17 +13,23 @@static const struct test_event {const char *name;const char *alias; -long config; +union hwmon_pmu_event_key key; } test_events[] = { {"temp_test_hwmon_event1" ,"temp1" , -0xA0001 , + .key = { + .num =1 , + .type =10 + }, }, {"temp_test_hwmon_event2" ,"temp2" , -0xA0002 , + .key = { + .num =2 , + .type =10 + }, }, };
@@ -183,11 +189,11 @@ static int do_test(size_t i, bool with_pmu, bool with_alias) strcmp(evsel->pmu->name, "hwmon_a_test_hwmon_pmu")) continue; -if (evsel->core.attr.config != (u64 )test_events[i].config) { +if (evsel->core.attr.config != (u64 )test_events[i].key.type_and_num) {pr_debug ("FAILED %s:%d Unexpected config for '%s', %lld != %ld\n" , __FILE__, __LINE__, str, evsel->core.attr.config, - test_events[i].config); + test_events[i].key.type_and_num); ret =TEST_FAIL ; goto out; }
tools/perf/util/hwmon_pmu.c +0 -14
@@ -107,20 +107,6 @@ struct hwmon_pmu {int hwmon_dir_fd; }; -/** -* union hwmon_pmu_event_key: Key for hwmon_pmu->events as such each key -* represents an event. -* -* Related hwmon files start <type><number> that this key represents. -*/ -union hwmon_pmu_event_key { -long type_and_num; -struct { -int num :16 ; -enum hwmon_type type :8 ; - }; -}; -/** * struct hwmon_pmu_event_value: Value in hwmon_pmu->events. *
tools/perf/util/hwmon_pmu.h +16 -0
@@ -91,6 +91,22 @@ enum hwmon_item { HWMON_ITEM__MAX, }; +/** +* union hwmon_pmu_event_key: Key for hwmon_pmu->events as such each key +* represents an event. +* union is exposed for testing to ensure problems are avoided on big +* endian machines. +* +* Related hwmon files start <type><number> that this key represents. +*/ +union hwmon_pmu_event_key { +long type_and_num; +struct { +int num :16 ; +enum hwmon_type type :8 ; + }; +}; +bool perf_pmu__is_hwmon (const struct perf_pmu *pmu);bool evsel__is_hwmon (const struct evsel *evsel);
Signature · 1 line
2.48.1
Quoted 99 lines · Thomas Richter
perf test 11 hwmon fails on s390 with this error
# ./perf test -Fv 11 --- start --- ---- end ---- 11.1: Basic parsing test : Ok --- start --- Testing 'temp_test_hwmon_event1' Using CPUID IBM,3931,704,A01,3.7,002f temp_test_hwmon_event1 -> hwmon_a_test_hwmon_pmu/temp_test_hwmon_event1/ FAILED tests/hwmon_pmu.c:189 Unexpected config for 'temp_test_hwmon_event1', 292470092988416 != 655361 ---- end ---- 11.2: Parsing without PMU name : FAILED! --- start --- Testing 'hwmon_a_test_hwmon_pmu/temp_test_hwmon_event1/' FAILED tests/hwmon_pmu.c:189 Unexpected config for 'hwmon_a_test_hwmon_pmu/temp_test_hwmon_event1/', 292470092988416 != 655361 ---- end ---- 11.3: Parsing with PMU name : FAILED! #The root cause is in member
test_event::configwhich is initialized to0xA0001or 655361. During event parsing a long list event parsing functions are called and end up with this gdb call stack:#0
hwmon_pmu__config_term(hwm=0x168dfd0, attr=0x3ffffff5ee8,term=0x168db60, err=0x3ffffff81c8) at util/hwmon_pmu.c:623 #1 hwmon_pmu__config_terms (pmu=0x168dfd0, attr=0x3ffffff5ee8, terms=0x3ffffff5ea8, err=0x3ffffff81c8) at util/hwmon_pmu.c:662 #2 0x00000000012f870c in perf_pmu__config_terms (pmu=0x168dfd0, attr=0x3ffffff5ee8, terms=0x3ffffff5ea8, zero=false, apply_hardcoded=false, err=0x3ffffff81c8) at util/pmu.c:1519 #3 0x00000000012f88a4 in perf_pmu__config (pmu=0x168dfd0, attr=0x3ffffff5ee8, head_terms=0x3ffffff5ea8, apply_hardcoded=false, err=0x3ffffff81c8) at util/pmu.c:1545 #4 0x00000000012680c4 in parse_events_add_pmu (parse_state=0x3ffffff7fb8, list=0x168dc00, pmu=0x168dfd0, const_parsed_terms=0x3ffffff6090, auto_merge_stats=true, alternate_hw_config=10) at util/parse-events.c:1508 #5 0x00000000012684c6 in parse_events_multi_pmu_add (parse_state=0x3ffffff7fb8, event_name=0x168ec10 "temp_test_hwmon_event1", hw_config=10, const_parsed_terms=0x0, listp=0x3ffffff6230, loc_=0x3ffffff70e0) at util/parse-events.c:1592 #6 0x00000000012f0e4e in parse_events_parse (_parse_state=0x3ffffff7fb8, scanner=0x16878c0) at util/parse-events.y:293 #7 0x00000000012695a0 in parse_events__scanner (str=0x3ffffff81d8 "temp_test_hwmon_event1", input=0x0, parse_state=0x3ffffff7fb8) at util/parse-events.c:1867 #8 0x000000000126a1e8 in __parse_events (evlist=0x168b580, str=0x3ffffff81d8 "temp_test_hwmon_event1", pmu_filter=0x0, err=0x3ffffff81c8, fake_pmu=false, warn_if_reordered=true, fake_tp=false) at util/parse-events.c:2136 #9 0x00000000011e36aa in parse_events (evlist=0x168b580, str=0x3ffffff81d8 "temp_test_hwmon_event1", err=0x3ffffff81c8) at /root/linux/tools/perf/util/parse-events.h:41 #10 0x00000000011e3e64 in do_test (i=0, with_pmu=false, with_alias=false) at tests/hwmon_pmu.c:164 #11 0x00000000011e422c in test__hwmon_pmu (with_pmu=false) at tests/hwmon_pmu.c:219 #12 0x00000000011e431c in test__hwmon_pmu_without_pmu (test=0x1610368 <suite.hwmon_pmu>, subtest=1) at tests/hwmon_pmu.c:23where the
attr::configis set to value 292470092988416 or0x10a0000000000in line 625 of file./util/hwmon_pmu.c:attr->config = key.type_and_num;However member
key::type_and_numis defined as union and bit field:union hwmon_pmu_event_key { long type_and_num; struct { int num :16; enum hwmon_type type :8; }; };s390 is big endian and Intel is little endian architecture. The events for the hwmon dummy pmu have num = 1 or num = 2 and type is set to
HWMON_TYPE_TEMP(which is 10).
On s390 this assignes memberkey::type_and_numthe value of0x10a0000000000(which is 292470092988416) as shown in above trace output.Fix this and export the structure/union
hwmon_pmu_event_keyso the test shares the same implementation as the event parsing functions for union and bit fields. This should avoid endianess issues on all platforms.Output after:
# ./perf test -F 11 11.1: Basic parsing test : Ok 11.2: Parsing without PMU name : Ok 11.3: Parsing with PMU name : Ok #
Quoted 3 lines
Fixes 531ee0fd4836 ("perf test: Add hwmon "PMU" test")Cc Ian Rogers <[email protected]>Signed-off-by Thomas Richter <[email protected]>
Thanks!
Ian
Quoted 106 lines
--- tools/perf/tests/hwmon_pmu.c | 16 +++++++++++----- tools/perf/util/hwmon_pmu.c | 14 -------------- tools/perf/util/hwmon_pmu.h | 16 ++++++++++++++++ 3 files changed, 27 insertions(+), 19 deletions(-)tools/perf/tests/hwmon_pmu.c +11
-5@@ -13,17 +13,23 @@static const struct test_event {const char *name;const char *alias; -long config; +union hwmon_pmu_event_key key; } test_events[] = { {"temp_test_hwmon_event1" ,"temp1" , -0xA0001 , + .key = { + .num =1 , + .type =10 + }, }, {"temp_test_hwmon_event2" ,"temp2" , -0xA0002 , + .key = { + .num =2 , + .type =10 + }, }, };@@ -183,11 +189,11 @@ static int do_test(size_t i, bool with_pmu, bool with_alias) strcmp(evsel->pmu->name, "hwmon_a_test_hwmon_pmu"))continue ; -if (evsel->core.attr.config != (u64 )test_events[i].config) { +if (evsel->core.attr.config != (u64 )test_events[i].key.type_and_num) {pr_debug ("FAILED %s:%d Unexpected config for '%s', %lld != %ld\n" , __FILE__, __LINE__, str, evsel->core.attr.config, - test_events[i].config); + test_events[i].key.type_and_num); ret =TEST_FAIL ; goto out; }tools/perf/util/hwmon_pmu.c +0
-14@@ -107,20 +107,6 @@ struct hwmon_pmu {int hwmon_dir_fd; }; -/** -* union hwmon_pmu_event_key: Key for hwmon_pmu->events as such each key -* represents an event. -* -* Related hwmon files start <type><number> that this key represents. -*/ -union hwmon_pmu_event_key { -long type_and_num; -struct { -int num :16 ; -enum hwmon_type type :8 ; - }; -}; -/** * struct hwmon_pmu_event_value: Value in hwmon_pmu->events. * tools/perf/util/hwmon_pmu.h +16
-1@@ -91,6 +91,22 @@ enum hwmon_item { HWMON_ITEM__MAX, }; +/** +* union hwmon_pmu_event_key: Key for hwmon_pmu->events as such each key +* represents an event. +* union is exposed for testing to ensure problems are avoided on big +* endian machines. +* +* Related hwmon files start <type><number> that this key represents. +*/ +union hwmon_pmu_event_key { +long type_and_num; +struct { +int num :16 ; +enum hwmon_type type :8 ; + }; +}; +bool perf_pmu__is_hwmon (const struct perf_pmu *pmu);bool evsel__is_hwmon (const struct evsel *evsel); --2.48.1
Quoted 26 lines · On Fri, 31 Jan 2025 12:24:00 +0100 Thomas Richter <[email protected]> wrote:
perf test 11 hwmon fails on s390 with this error
# ./perf test -Fv 11 --- start --- ---- end ---- 11.1: Basic parsing test : Ok --- start --- Testing 'temp_test_hwmon_event1' Using CPUID IBM,3931,704,A01,3.7,002f temp_test_hwmon_event1 -> hwmon_a_test_hwmon_pmu/temp_test_hwmon_event1/ FAILED tests/hwmon_pmu.c:189 Unexpected config for 'temp_test_hwmon_event1', 292470092988416 != 655361 ---- end ---- 11.2: Parsing without PMU name : FAILED! --- start --- Testing 'hwmon_a_test_hwmon_pmu/temp_test_hwmon_event1/' FAILED tests/hwmon_pmu.c:189 Unexpected config for 'hwmon_a_test_hwmon_pmu/temp_test_hwmon_event1/', 292470092988416 != 655361 ---- end ---- 11.3: Parsing with PMU name : FAILED! #The root cause is in member
test_event::configwhich is initialized to0xA0001or 655361. During event parsing a long list event parsing functions are called and end up with this gdb call stack:
...
Quoted 9 lines
However member
key::type_and_numis defined as union and bit field:union hwmon_pmu_event_key { long type_and_num; struct { int num :16; enum hwmon_type type :8; }; };
That is entirely horrid.
I'm surprised this even compiles:
static size_t hwmon_pmu__event_hashmap_hash(long key, void *ctx __maybe_unused)
{
return ((union hwmon_pmu_event_key)key).type_and_num;
}It has to be just 'return key', but I'm not sure what the hashmap code is doing.
AFAICT the code is just trying to generate a value for the hashmap to hash on? Why not just use (type << 16 | num) instead of 'trying to be clever' with a union?
David
Ian Rogers
reviewerQuoted 41 lines · David Laight
Quoted 26 lines · On Fri, 31 Jan 2025 12:24:00 +0100 Thomas Richter <[email protected]> wrote:
perf test 11 hwmon fails on s390 with this error
# ./perf test -Fv 11 --- start --- ---- end ---- 11.1: Basic parsing test : Ok --- start --- Testing 'temp_test_hwmon_event1' Using CPUID IBM,3931,704,A01,3.7,002f temp_test_hwmon_event1 -> hwmon_a_test_hwmon_pmu/temp_test_hwmon_event1/ FAILED tests/hwmon_pmu.c:189 Unexpected config for 'temp_test_hwmon_event1', 292470092988416 != 655361 ---- end ---- 11.2: Parsing without PMU name : FAILED! --- start --- Testing 'hwmon_a_test_hwmon_pmu/temp_test_hwmon_event1/' FAILED tests/hwmon_pmu.c:189 Unexpected config for 'hwmon_a_test_hwmon_pmu/temp_test_hwmon_event1/', 292470092988416 != 655361 ---- end ---- 11.3: Parsing with PMU name : FAILED! #The root cause is in member
test_event::configwhich is initialized to0xA0001or 655361. During event parsing a long list event parsing functions are called and end up with this gdb call stack:...
Quoted 9 lines
However member
key::type_and_numis defined as union and bit field:union hwmon_pmu_event_key { long type_and_num; struct { int num :16; enum hwmon_type type :8; }; };
Quoted 1 line
That is entirely horrid.
It also has the side-effect that if you initialize the struct bits in the type_and_num will be undefined and sanitizers will try to trip you up.
Quoted 9 lines
I'm surprised this even compiles:
staticsize_thwmon_pmu__event_hashmap_hash(long key, void *ctx __maybe_unused){ return ((union hwmon_pmu_event_key)key).type_and_num; }It has to be just 'return key', but I'm not sure what the hashmap code is doing.
AFAICT the code is just trying to generate a value for the hashmap to hash on? Why not just use (type << 16 | num) instead of 'trying to be clever' with a union?
The purpose wasn't so much to be 'clever' as you say. Perf event configs, which is where type_and_num lives in the events, have their bitfields described either by convention or by files in /sys/devices/<pmu>/format. On an Intel laptop:
```
$ cat /sys/devices/cpu/format/inv
config:23
```
So I can go:
```
$ perf stat -e 'inst_retired.any/inv=1/' true
Performance counter stats for 'true':
1,069,756 inst_retired.any/inv=1/
0.001539265 seconds time elapsed
0.001719000 seconds user
0.000000000 seconds sys
```and the configuration of my inst_retired.any event now has bit 23 in the config set. Just as the format files try to break down what the bitfields within a config u64 are doing, the union was trying to do similar. Making an attempt to have the value be intention revealing which the shift and masking may lose, for example, by making it look like bits in the num could overlap with and modify the type.
Thanks,
Ian
Quoted 80 lines · On Sat, 1 Feb 2025 08:12:38 -0800 Ian Rogers <[email protected]> wrote:
Quoted 41 lines · David Laight
Quoted 26 lines · On Fri, 31 Jan 2025 12:24:00 +0100 Thomas Richter <[email protected]> wrote:
perf test 11 hwmon fails on s390 with this error
# ./perf test -Fv 11 --- start --- ---- end ---- 11.1: Basic parsing test : Ok --- start --- Testing 'temp_test_hwmon_event1' Using CPUID IBM,3931,704,A01,3.7,002f temp_test_hwmon_event1 -> hwmon_a_test_hwmon_pmu/temp_test_hwmon_event1/ FAILED tests/hwmon_pmu.c:189 Unexpected config for 'temp_test_hwmon_event1', 292470092988416 != 655361 ---- end ---- 11.2: Parsing without PMU name : FAILED! --- start --- Testing 'hwmon_a_test_hwmon_pmu/temp_test_hwmon_event1/' FAILED tests/hwmon_pmu.c:189 Unexpected config for 'hwmon_a_test_hwmon_pmu/temp_test_hwmon_event1/', 292470092988416 != 655361 ---- end ---- 11.3: Parsing with PMU name : FAILED! #The root cause is in member
test_event::configwhich is initialized to0xA0001or 655361. During event parsing a long list event parsing functions are called and end up with this gdb call stack:...
Quoted 9 lines
However member
key::type_and_numis defined as union and bit field:union hwmon_pmu_event_key { long type_and_num; struct { int num :16; enum hwmon_type type :8; }; };Quoted 1 line
That is entirely horrid.
It also has the side-effect that if you initialize the struct bits in the
type_and_numwill be undefined and sanitizers will try to trip you up.Quoted 9 lines
I'm surprised this even compiles:
staticsize_thwmon_pmu__event_hashmap_hash(long key, void *ctx __maybe_unused){ return ((union hwmon_pmu_event_key)key).type_and_num; }It has to be just 'return key', but I'm not sure what the hashmap code is doing.
AFAICT the code is just trying to generate a value for the hashmap to hash on? Why not just use (type << 16 | num) instead of 'trying to be clever' with a union?
The purpose wasn't so much to be 'clever' as you say. Perf event configs, which is where
type_and_numlives in the events, have their bitfields described either by convention or by files in /sys/devices/<pmu>/format. On an Intel laptop:``` $ cat /sys/devices/cpu/format/inv config:23 ``` So I can go: ``` $ perf stat -e 'inst_retired.any/inv=1/' true Performance counter stats for 'true': 1,069,756 inst_retired.any/inv=1/ 0.001539265 seconds time elapsed 0.001719000 seconds user 0.000000000 seconds sys ```
Quoted 6 lines
and the configuration of my inst_retired.any event now has bit 23 in the config set. Just as the format files try to break down what the bitfields within a config u64 are doing, the union was trying to do similar. Making an attempt to have the value be intention revealing which the shift and masking may lose, for example, by making it look like bits in the num could overlap with and modify the type.
Except that is really doesn't work for big-endian at all. The 'fix' doesn't even really paper over the cracks properly.
I'm not even sure the hashing works on 64bit BE.
(assuming the int:n are also BE - but that is a different ABI option.) The 'num' and 'type' will be in the high 24 bits of the 64bit 'long'. If we assume the rest of the union is actually initialised the other bits are all zero.
And I guess that the hash function is masking with 2^n-1 - so always gets zero.
David
Quoted 3 lines
Thanks,
Ian
Ian Rogers
reviewerQuoted 94 lines · David Laight
Quoted 80 lines · On Sat, 1 Feb 2025 08:12:38 -0800 Ian Rogers <[email protected]> wrote:
Quoted 41 lines · David Laight
Quoted 26 lines · On Fri, 31 Jan 2025 12:24:00 +0100 Thomas Richter <[email protected]> wrote:
perf test 11 hwmon fails on s390 with this error
# ./perf test -Fv 11 --- start --- ---- end ---- 11.1: Basic parsing test : Ok --- start --- Testing 'temp_test_hwmon_event1' Using CPUID IBM,3931,704,A01,3.7,002f temp_test_hwmon_event1 -> hwmon_a_test_hwmon_pmu/temp_test_hwmon_event1/ FAILED tests/hwmon_pmu.c:189 Unexpected config for 'temp_test_hwmon_event1', 292470092988416 != 655361 ---- end ---- 11.2: Parsing without PMU name : FAILED! --- start --- Testing 'hwmon_a_test_hwmon_pmu/temp_test_hwmon_event1/' FAILED tests/hwmon_pmu.c:189 Unexpected config for 'hwmon_a_test_hwmon_pmu/temp_test_hwmon_event1/', 292470092988416 != 655361 ---- end ---- 11.3: Parsing with PMU name : FAILED! #The root cause is in member
test_event::configwhich is initialized to0xA0001or 655361. During event parsing a long list event parsing functions are called and end up with this gdb call stack:...
Quoted 9 lines
However member
key::type_and_numis defined as union and bit field:union hwmon_pmu_event_key { long type_and_num; struct { int num :16; enum hwmon_type type :8; }; };Quoted 1 line
That is entirely horrid.
It also has the side-effect that if you initialize the struct bits in the
type_and_numwill be undefined and sanitizers will try to trip you up.Quoted 9 lines
I'm surprised this even compiles:
staticsize_thwmon_pmu__event_hashmap_hash(long key, void *ctx __maybe_unused){ return ((union hwmon_pmu_event_key)key).type_and_num; }It has to be just 'return key', but I'm not sure what the hashmap code is doing.
AFAICT the code is just trying to generate a value for the hashmap to hash on? Why not just use (type << 16 | num) instead of 'trying to be clever' with a union?
The purpose wasn't so much to be 'clever' as you say. Perf event configs, which is where
type_and_numlives in the events, have their bitfields described either by convention or by files in /sys/devices/<pmu>/format. On an Intel laptop:``` $ cat /sys/devices/cpu/format/inv config:23 ``` So I can go: ``` $ perf stat -e 'inst_retired.any/inv=1/' true Performance counter stats for 'true': 1,069,756 inst_retired.any/inv=1/ 0.001539265 seconds time elapsed 0.001719000 seconds user 0.000000000 seconds sys ```Quoted 6 lines
and the configuration of my inst_retired.any event now has bit 23 in the config set. Just as the format files try to break down what the bitfields within a config u64 are doing, the union was trying to do similar. Making an attempt to have the value be intention revealing which the shift and masking may lose, for example, by making it look like bits in the num could overlap with and modify the type.
Except that is really doesn't work for big-endian at all. The 'fix' doesn't even really paper over the cracks properly.
Quoted 6 lines
I'm not even sure the hashing works on 64bit BE.
(assuming the int:n are also BE - but that is a different ABI option.) The 'num' and 'type' will be in the high 24 bits of the 64bit 'long'. If we assume the rest of the union is actually initialised the other bits are all zero.
And I guess that the hash function is masking with 2^n-1 - so always gets zero.
No, as is typical in any hash table you always do a secondary hash:
https://git.kernel.org/pub/scm/linux/kernel/git/perf/perf-tools-next.git/tree/tools/perf/util/hashmap.h#n15
Thanks,
Ian
Quoted 6 lines
David
Quoted 3 lines
Thanks,
Ian
Namhyung Kim
maintainerQuoted 188 lines · Thomas Richter
perf test 11 hwmon fails on s390 with this error
# ./perf test -Fv 11 --- start --- ---- end ---- 11.1: Basic parsing test : Ok --- start --- Testing 'temp_test_hwmon_event1' Using CPUID IBM,3931,704,A01,3.7,002f temp_test_hwmon_event1 -> hwmon_a_test_hwmon_pmu/temp_test_hwmon_event1/ FAILED tests/hwmon_pmu.c:189 Unexpected config for 'temp_test_hwmon_event1', 292470092988416 != 655361 ---- end ---- 11.2: Parsing without PMU name : FAILED! --- start --- Testing 'hwmon_a_test_hwmon_pmu/temp_test_hwmon_event1/' FAILED tests/hwmon_pmu.c:189 Unexpected config for 'hwmon_a_test_hwmon_pmu/temp_test_hwmon_event1/', 292470092988416 != 655361 ---- end ---- 11.3: Parsing with PMU name : FAILED! #The root cause is in member
test_event::configwhich is initialized to0xA0001or 655361. During event parsing a long list event parsing functions are called and end up with this gdb call stack:#0
hwmon_pmu__config_term(hwm=0x168dfd0, attr=0x3ffffff5ee8,term=0x168db60, err=0x3ffffff81c8) at util/hwmon_pmu.c:623 #1 hwmon_pmu__config_terms (pmu=0x168dfd0, attr=0x3ffffff5ee8, terms=0x3ffffff5ea8, err=0x3ffffff81c8) at util/hwmon_pmu.c:662 #2 0x00000000012f870c in perf_pmu__config_terms (pmu=0x168dfd0, attr=0x3ffffff5ee8, terms=0x3ffffff5ea8, zero=false, apply_hardcoded=false, err=0x3ffffff81c8) at util/pmu.c:1519 #3 0x00000000012f88a4 in perf_pmu__config (pmu=0x168dfd0, attr=0x3ffffff5ee8, head_terms=0x3ffffff5ea8, apply_hardcoded=false, err=0x3ffffff81c8) at util/pmu.c:1545 #4 0x00000000012680c4 in parse_events_add_pmu (parse_state=0x3ffffff7fb8, list=0x168dc00, pmu=0x168dfd0, const_parsed_terms=0x3ffffff6090, auto_merge_stats=true, alternate_hw_config=10) at util/parse-events.c:1508 #5 0x00000000012684c6 in parse_events_multi_pmu_add (parse_state=0x3ffffff7fb8, event_name=0x168ec10 "temp_test_hwmon_event1", hw_config=10, const_parsed_terms=0x0, listp=0x3ffffff6230, loc_=0x3ffffff70e0) at util/parse-events.c:1592 #6 0x00000000012f0e4e in parse_events_parse (_parse_state=0x3ffffff7fb8, scanner=0x16878c0) at util/parse-events.y:293 #7 0x00000000012695a0 in parse_events__scanner (str=0x3ffffff81d8 "temp_test_hwmon_event1", input=0x0, parse_state=0x3ffffff7fb8) at util/parse-events.c:1867 #8 0x000000000126a1e8 in __parse_events (evlist=0x168b580, str=0x3ffffff81d8 "temp_test_hwmon_event1", pmu_filter=0x0, err=0x3ffffff81c8, fake_pmu=false, warn_if_reordered=true, fake_tp=false) at util/parse-events.c:2136 #9 0x00000000011e36aa in parse_events (evlist=0x168b580, str=0x3ffffff81d8 "temp_test_hwmon_event1", err=0x3ffffff81c8) at /root/linux/tools/perf/util/parse-events.h:41 #10 0x00000000011e3e64 in do_test (i=0, with_pmu=false, with_alias=false) at tests/hwmon_pmu.c:164 #11 0x00000000011e422c in test__hwmon_pmu (with_pmu=false) at tests/hwmon_pmu.c:219 #12 0x00000000011e431c in test__hwmon_pmu_without_pmu (test=0x1610368 <suite.hwmon_pmu>, subtest=1) at tests/hwmon_pmu.c:23where the
attr::configis set to value 292470092988416 or0x10a0000000000in line 625 of file./util/hwmon_pmu.c:attr->config = key.type_and_num;However member
key::type_and_numis defined as union and bit field:union hwmon_pmu_event_key { long type_and_num; struct { int num :16; enum hwmon_type type :8; }; };s390 is big endian and Intel is little endian architecture. The events for the hwmon dummy pmu have num = 1 or num = 2 and type is set to
HWMON_TYPE_TEMP(which is 10).
On s390 this assignes memberkey::type_and_numthe value of0x10a0000000000(which is 292470092988416) as shown in above trace output.Fix this and export the structure/union
hwmon_pmu_event_keyso the test shares the same implementation as the event parsing functions for union and bit fields. This should avoid endianess issues on all platforms.Output after:
# ./perf test -F 11 11.1: Basic parsing test : Ok 11.2: Parsing without PMU name : Ok 11.3: Parsing with PMU name : Ok #Fixes 531ee0fd4836 ("perf test: Add hwmon "PMU" test")Cc Ian Rogers <[email protected]>Signed-off-by Thomas Richter <[email protected]>--- tools/perf/tests/hwmon_pmu.c | 16 +++++++++++----- tools/perf/util/hwmon_pmu.c | 14 -------------- tools/perf/util/hwmon_pmu.h | 16 ++++++++++++++++ 3 files changed, 27 insertions(+), 19 deletions(-)tools/perf/tests/hwmon_pmu.c +11
-5@@ -13,17 +13,23 @@static const struct test_event {const char *name;const char *alias; -long config; +union hwmon_pmu_event_key key; } test_events[] = { {"temp_test_hwmon_event1" ,"temp1" , -0xA0001 , + .key = { + .num =1 , + .type =10 + }, }, {"temp_test_hwmon_event2" ,"temp2" , -0xA0002 , + .key = { + .num =2 , + .type =10 + }, }, };@@ -183,11 +189,11 @@ static int do_test(size_t i, bool with_pmu, bool with_alias) strcmp(evsel->pmu->name, "hwmon_a_test_hwmon_pmu")) continue; -if (evsel->core.attr.config != (u64 )test_events[i].config) { +if (evsel->core.attr.config != (u64 )test_events[i].key.type_and_num) {pr_debug ("FAILED %s:%d Unexpected config for '%s', %lld != %ld\n" , __FILE__, __LINE__, str, evsel->core.attr.config, - test_events[i].config); + test_events[i].key.type_and_num); ret =TEST_FAIL ; goto out; }tools/perf/util/hwmon_pmu.c +0
-14@@ -107,20 +107,6 @@ struct hwmon_pmu {int hwmon_dir_fd; }; -/** -* union hwmon_pmu_event_key: Key for hwmon_pmu->events as such each key -* represents an event. -* -* Related hwmon files start <type><number> that this key represents. -*/ -union hwmon_pmu_event_key { -long type_and_num; -struct { -int num :16 ; -enum hwmon_type type :8 ; - }; -}; -/** * struct hwmon_pmu_event_value: Value in hwmon_pmu->events. * tools/perf/util/hwmon_pmu.h +3
-0@@ -91,6 +91,22 @@ enum hwmon_item { HWMON_ITEM__MAX, }; +/** +* union hwmon_pmu_event_key: Key for hwmon_pmu->events as such each key +* represents an event.
tools/perf/util/hwmon_pmu.h enum hwmon_item { · line 106
Quoted 10 lines
tools/perf/util/hwmon_pmu.h +10
-0+* union is exposed for testing to ensure problems are avoided on big +* endian machines. +* +* Related hwmon files start <type><number> that this key represents. +*/ +union hwmon_pmu_event_key { + long type_and_num; + struct { + int num :16; + enum hwmon_type type :8;
I'm curious if we could add this maybe as a follow-up.
int unused: 8; #if __SIZEOF_LONG__ == 8 int unused2;
#endif
Thanks,
Namhyung
Quoted 9 lines
tools/perf/util/hwmon_pmu.h +3
-0+ }; +}; +bool perf_pmu__is_hwmon (const struct perf_pmu *pmu);bool evsel__is_hwmon (const struct evsel *evsel);Signature · 1 line
2.48.1
Quoted 23 lines · Thomas Richter
perf test 11 hwmon fails on s390 with this error
# ./perf test -Fv 11 --- start --- ---- end ---- 11.1: Basic parsing test : Ok --- start --- Testing 'temp_test_hwmon_event1' Using CPUID IBM,3931,704,A01,3.7,002f temp_test_hwmon_event1 -> hwmon_a_test_hwmon_pmu/temp_test_hwmon_event1/ FAILED tests/hwmon_pmu.c:189 Unexpected config for 'temp_test_hwmon_event1', 292470092988416 != 655361 ---- end ---- 11.2: Parsing without PMU name : FAILED! --- start --- Testing 'hwmon_a_test_hwmon_pmu/temp_test_hwmon_event1/' FAILED tests/hwmon_pmu.c:189 Unexpected config for 'hwmon_a_test_hwmon_pmu/temp_test_hwmon_event1/', 292470092988416 != 655361 ---- end ---- 11.3: Parsing with PMU name : FAILED! #
Quoted 1 line
[...]
Applied to perf-tools-next, thanks!
Best regards,
Namhyung