xref: /openbmc/linux/tools/perf/tests/attr/README (revision 0a4cad9c)
1The struct perf_event_attr test (attr tests) support
2====================================================
3This testing support is embedded into perf directly and is governed
4by the PERF_TEST_ATTR environment variable and hook inside the
5sys_perf_event_open function.
6
7The general idea is to store 'struct perf_event_attr' details for
8each event created within single perf command. Each event details
9are stored into separate text file. Once perf command is finished
10these files are checked for values we expect for command.
11
12The attr tests consist of following parts:
13
14tests/attr.c
15------------
16This is the sys_perf_event_open hook implementation. The hook
17is triggered when the PERF_TEST_ATTR environment variable is
18defined. It must contain name of existing directory with access
19and write permissions.
20
21For each sys_perf_event_open call event details are stored in
22separate file. Besides 'struct perf_event_attr' values we also
23store 'fd' and 'group_fd' values to allow checking for groups.
24
25tests/attr.py
26-------------
27This is the python script that does all the hard work. It reads
28the test definition, executes it and checks results.
29
30tests/attr/
31-----------
32Directory containing all attr test definitions.
33Following tests are defined (with perf commands):
34
35  perf record kill                              (test-record-basic)
36  perf record -b kill                           (test-record-branch-any)
37  perf record -j any kill                       (test-record-branch-filter-any)
38  perf record -j any_call kill                  (test-record-branch-filter-any_call)
39  perf record -j any_ret kill                   (test-record-branch-filter-any_ret)
40  perf record -j hv kill                        (test-record-branch-filter-hv)
41  perf record -j ind_call kill                  (test-record-branch-filter-ind_call)
42  perf record -j k kill                         (test-record-branch-filter-k)
43  perf record -j u kill                         (test-record-branch-filter-u)
44  perf record -c 123 kill                       (test-record-count)
45  perf record -d kill                           (test-record-data)
46  perf record -F 100 kill                       (test-record-freq)
47  perf record -g kill                           (test-record-graph-default)
48  perf record -g kill                           (test-record-graph-default-aarch64)
49  perf record --call-graph dwarf kill		(test-record-graph-dwarf)
50  perf record --call-graph fp kill              (test-record-graph-fp)
51  perf record --call-graph fp kill              (test-record-graph-fp-aarch64)
52  perf record --group -e cycles,instructions kill (test-record-group)
53  perf record -e '{cycles,instructions}' kill   (test-record-group1)
54  perf record -e '{cycles/period=1/,instructions/period=2/}:S' kill (test-record-group2)
55  perf record -D kill                           (test-record-no-delay)
56  perf record -i kill                           (test-record-no-inherit)
57  perf record -n kill                           (test-record-no-samples)
58  perf record -c 100 -P kill                    (test-record-period)
59  perf record -c 1 --pfm-events=cycles:period=2 (test-record-pfm-period)
60  perf record -R kill                           (test-record-raw)
61  perf record -c 2 -e arm_spe_0// -- kill       (test-record-spe-period)
62  perf record -e arm_spe_0/period=3/ -- kill    (test-record-spe-period-term)
63  perf stat -e cycles kill                      (test-stat-basic)
64  perf stat kill                                (test-stat-default)
65  perf stat -d kill                             (test-stat-detailed-1)
66  perf stat -dd kill                            (test-stat-detailed-2)
67  perf stat -ddd kill                           (test-stat-detailed-3)
68  perf stat --group -e cycles,instructions kill (test-stat-group)
69  perf stat -e '{cycles,instructions}' kill     (test-stat-group1)
70  perf stat -i -e cycles kill                   (test-stat-no-inherit)
71