linux/tools/perf/tests/attr
Thomas Richter b6d8b858db perf test: test case 'Setup struct perf_event_attr' fails on s390 on z/vm
perf test 17 'Setup struct perf_event_attr' fails on s390 z/VM guest,
using linux-next kernel.

Root cause is the fall-back from hardware counter cycles

   perf_event_attr:
    type                             0 (PERF_TYPE_HARDWARE)
    size                             136
    config                           0 (PERF_COUNT_HW_CPU_CYCLES)
    { sample_period, sample_freq }   4000
    sample_type                      IP|TID|TIME|ADDR|PERIOD|DATA_SRC
    read_format                      ID|LOST

which returns -ENOENT on s390 z/VM guest. This causes the code to fall
back to software counter task-clock, as can be seen in the debug output:

  ------------------------------------------------------------
   perf_event_attr:
    type                             1 (PERF_TYPE_SOFTWARE)
    size                             136
    config                           0x1 (PERF_COUNT_SW_TASK_CLOCK) <-here
    { sample_period, sample_freq }   4000
    sample_type                      IP|TID|TIME|ADDR|PERIOD|DATA_SRC
    read_format                      ID|LOST

This succeeds on s390 z/VM guest.

This successful installation of the counter task-clock is not listed in
the expected results and the test case fails.

This is caused by commit eb2eac0c7b ("perf evsel: Fallback to
"task-clock" when not system wide") which introduced fall back from
event 'cycles' to event 'task-clock'.

To fix this on s390 allow event number 0 (cycles) and event number 1
(task-clock) as expected result.

Output before:

  # ./perf test -Fv 17
  17: Setup struct perf_event_attr                                    :
  --- start ---
  running './tests/attr/test-stat-group1'
  unsupp  './tests/attr/test-stat-group1'
  running './tests/attr/test-record-graph-default'
  test limitation '!aarch64'
  excluded architecture list ['aarch64']
  expected config=0, got 1
  FAILED './tests/attr/test-record-graph-default' - match failure
  ---- end ----
  Setup struct perf_event_attr: FAILED!
  #

Output after:

  # ./perf test -F 17
  17: Setup struct perf_event_attr               : Ok
  #

Fixes: eb2eac0c7b ("perf evsel: Fallback to "task-clock" when not system wide")
Signed-off-by: Thomas Richter <tmricht@linux.ibm.com>
Acked-by: Ian Rogers <irogers@google.com>
Cc: Alexander Gordeev <agordeev@linux.ibm.com>
Cc: Heiko Carstens <hca@linux.ibm.com>
Cc: Sumanth Korikkar <sumanthk@linux.ibm.com>
Cc: Sven Schnelle <svens@linux.ibm.com>
Cc: Vasily Gorbik <gor@linux.ibm.com>
Link: https://lore.kernel.org/r/20231219143235.1075522-1-tmricht@linux.ibm.com
Signed-off-by: Arnaldo Carvalho de Melo <acme@redhat.com>
2024-01-04 18:44:53 -03:00
..
base-record perf test: test case 'Setup struct perf_event_attr' fails on s390 on z/vm 2024-01-04 18:44:53 -03:00
base-record-spe perf test: Add perf_event_attr tests for the arm_spe event 2022-03-05 16:00:12 -03:00
base-stat perf test attr: Update no event/metric expectations 2023-05-19 10:36:25 -03:00
README perf evlist: Remove group option. 2022-12-14 15:28:18 -03:00
system-wide-dummy perf record: Move setting tracking events before record__init_thread_masks() 2023-09-12 17:31:37 -03:00
test-record-basic perf tools: Save bpf_prog_info and BTF of new BPF programs 2019-03-21 11:27:04 -03:00
test-record-branch-any perf tools: Save bpf_prog_info and BTF of new BPF programs 2019-03-21 11:27:04 -03:00
test-record-branch-filter-any perf tools: Save bpf_prog_info and BTF of new BPF programs 2019-03-21 11:27:04 -03:00
test-record-branch-filter-any_call perf tools: Save bpf_prog_info and BTF of new BPF programs 2019-03-21 11:27:04 -03:00
test-record-branch-filter-any_ret perf tools: Save bpf_prog_info and BTF of new BPF programs 2019-03-21 11:27:04 -03:00
test-record-branch-filter-hv perf tools: Save bpf_prog_info and BTF of new BPF programs 2019-03-21 11:27:04 -03:00
test-record-branch-filter-ind_call perf tools: Save bpf_prog_info and BTF of new BPF programs 2019-03-21 11:27:04 -03:00
test-record-branch-filter-k perf tools: Save bpf_prog_info and BTF of new BPF programs 2019-03-21 11:27:04 -03:00
test-record-branch-filter-u perf tools: Save bpf_prog_info and BTF of new BPF programs 2019-03-21 11:27:04 -03:00
test-record-C0 perf record: Move setting tracking events before record__init_thread_masks() 2023-09-12 17:31:37 -03:00
test-record-count perf tools: Save bpf_prog_info and BTF of new BPF programs 2019-03-21 11:27:04 -03:00
test-record-data perf tools: Save bpf_prog_info and BTF of new BPF programs 2019-03-21 11:27:04 -03:00
test-record-dummy-C0 perf test: Fix test-record-dummy-C0 failure for supported PERF_FORMAT_LOST feature kernel 2023-09-16 22:36:36 -07:00
test-record-freq perf tools: Save bpf_prog_info and BTF of new BPF programs 2019-03-21 11:27:04 -03:00
test-record-graph-default perf test: Fix arm64 perf_event_attr tests wrt --call-graph initialization 2022-02-16 13:51:47 -03:00
test-record-graph-default-aarch64 perf test: Fix arm64 perf_event_attr tests wrt --call-graph initialization 2022-02-16 13:51:47 -03:00
test-record-graph-dwarf perf tools: Save bpf_prog_info and BTF of new BPF programs 2019-03-21 11:27:04 -03:00
test-record-graph-fp perf test: Fix arm64 perf_event_attr tests wrt --call-graph initialization 2022-02-16 13:51:47 -03:00
test-record-graph-fp-aarch64 perf test: Fix arm64 perf_event_attr tests wrt --call-graph initialization 2022-02-16 13:51:47 -03:00
test-record-group1 perf test: Fix attr tests for PERF_FORMAT_LOST 2022-10-15 10:13:16 -03:00
test-record-group2 perf test: Fix attr tests for PERF_FORMAT_LOST 2022-10-15 10:13:16 -03:00
test-record-group-sampling perf test: Fix attr tests for PERF_FORMAT_LOST 2022-10-15 10:13:16 -03:00
test-record-no-buffering perf tools: Save bpf_prog_info and BTF of new BPF programs 2019-03-21 11:27:04 -03:00
test-record-no-inherit perf tools: Save bpf_prog_info and BTF of new BPF programs 2019-03-21 11:27:04 -03:00
test-record-no-samples perf tools: Save bpf_prog_info and BTF of new BPF programs 2019-03-21 11:27:04 -03:00
test-record-period perf tools: Save bpf_prog_info and BTF of new BPF programs 2019-03-21 11:27:04 -03:00
test-record-pfm-period perf test: Ensure sample_period is set libpfm4 events 2020-07-30 07:01:49 -03:00
test-record-raw perf tools: Save bpf_prog_info and BTF of new BPF programs 2019-03-21 11:27:04 -03:00
test-record-spe-period perf test: Add perf_event_attr tests for the arm_spe event 2022-03-05 16:00:12 -03:00
test-record-spe-period-term perf test: Add perf_event_attr tests for the arm_spe event 2022-03-05 16:00:12 -03:00
test-record-spe-physical-address perf test: Add perf_event_attr test for Arm SPE 2022-04-28 10:40:49 -03:00
test-record-user-regs-no-sve-aarch64 perf test record user-regs: Fix mask for vg register 2023-12-04 16:42:25 -03:00
test-record-user-regs-old-sve-aarch64 perf test arm64: Add attr tests for new VG register 2022-12-14 11:24:32 -03:00
test-record-user-regs-sve-aarch64 perf test record user-regs: Fix mask for vg register 2023-12-04 16:42:25 -03:00
test-stat-basic perf tests attr: Make hw events optional 2017-10-23 11:20:54 -03:00
test-stat-C0 perf tests attr: Make hw events optional 2017-10-23 11:20:54 -03:00
test-stat-default perf test attr: Update no event/metric expectations 2023-05-19 10:36:25 -03:00
test-stat-detailed-1 perf test attr: Update no event/metric expectations 2023-05-19 10:36:25 -03:00
test-stat-detailed-2 perf test attr: Update no event/metric expectations 2023-05-19 10:36:25 -03:00
test-stat-detailed-3 perf test attr: Update no event/metric expectations 2023-05-19 10:36:25 -03:00
test-stat-group1
test-stat-no-inherit perf tests attr: Make hw events optional 2017-10-23 11:20:54 -03:00

The struct perf_event_attr test (attr tests) support
====================================================
This testing support is embedded into perf directly and is governed
by the PERF_TEST_ATTR environment variable and hook inside the
sys_perf_event_open function.

The general idea is to store 'struct perf_event_attr' details for
each event created within single perf command. Each event details
are stored into separate text file. Once perf command is finished
these files are checked for values we expect for command.

The attr tests consist of following parts:

tests/attr.c
------------
This is the sys_perf_event_open hook implementation. The hook
is triggered when the PERF_TEST_ATTR environment variable is
defined. It must contain name of existing directory with access
and write permissions.

For each sys_perf_event_open call event details are stored in
separate file. Besides 'struct perf_event_attr' values we also
store 'fd' and 'group_fd' values to allow checking for groups.

tests/attr.py
-------------
This is the python script that does all the hard work. It reads
the test definition, executes it and checks results.

tests/attr/
-----------
Directory containing all attr test definitions.
Following tests are defined (with perf commands):

  perf record kill                              (test-record-basic)
  perf record -b kill                           (test-record-branch-any)
  perf record -j any kill                       (test-record-branch-filter-any)
  perf record -j any_call kill                  (test-record-branch-filter-any_call)
  perf record -j any_ret kill                   (test-record-branch-filter-any_ret)
  perf record -j hv kill                        (test-record-branch-filter-hv)
  perf record -j ind_call kill                  (test-record-branch-filter-ind_call)
  perf record -j k kill                         (test-record-branch-filter-k)
  perf record -j u kill                         (test-record-branch-filter-u)
  perf record -c 123 kill                       (test-record-count)
  perf record -d kill                           (test-record-data)
  perf record -F 100 kill                       (test-record-freq)
  perf record -g kill                           (test-record-graph-default)
  perf record -g kill                           (test-record-graph-default-aarch64)
  perf record --call-graph dwarf kill		(test-record-graph-dwarf)
  perf record --call-graph fp kill              (test-record-graph-fp)
  perf record --call-graph fp kill              (test-record-graph-fp-aarch64)
  perf record -e '{cycles,instructions}' kill   (test-record-group1)
  perf record -e '{cycles/period=1/,instructions/period=2/}:S' kill (test-record-group2)
  perf record -D kill                           (test-record-no-delay)
  perf record -i kill                           (test-record-no-inherit)
  perf record -n kill                           (test-record-no-samples)
  perf record -c 100 -P kill                    (test-record-period)
  perf record -c 1 --pfm-events=cycles:period=2 (test-record-pfm-period)
  perf record -R kill                           (test-record-raw)
  perf record -c 2 -e arm_spe_0// -- kill       (test-record-spe-period)
  perf record -e arm_spe_0/period=3/ -- kill    (test-record-spe-period-term)
  perf record -e arm_spe_0/pa_enable=1/ -- kill (test-record-spe-physical-address)
  perf stat -e cycles kill                      (test-stat-basic)
  perf stat kill                                (test-stat-default)
  perf stat -d kill                             (test-stat-detailed-1)
  perf stat -dd kill                            (test-stat-detailed-2)
  perf stat -ddd kill                           (test-stat-detailed-3)
  perf stat -e '{cycles,instructions}' kill     (test-stat-group1)
  perf stat -i -e cycles kill                   (test-stat-no-inherit)