xref: /linux/tools/perf/Documentation/perf-test.txt (revision 63af040b0b4067d75e59df9fa093f3f5dbc5899e)
1perf-test(1)
2============
3
4NAME
5----
6perf-test - Runs sanity tests.
7
8SYNOPSIS
9--------
10[verse]
11'perf test [<options>] [{list <test-name-fragment>|[<test-name-fragments>|<test-numbers>]}]'
12
13DESCRIPTION
14-----------
15This command does assorted sanity tests, initially through linked routines but
16also will look for a directory with more tests in the form of scripts.
17
18To get a list of available tests use 'perf test list', specifying a test name
19fragment will show all tests that have it.
20
21To run just specific tests, inform test name fragments or the numbers obtained
22from 'perf test list'.
23
24OPTIONS
25-------
26-s::
27--skip::
28	Tests to skip (comma separated numeric list).
29
30-v::
31-vv::
32-vvv::
33--verbose::
34	With a single '-v', verbose level 1, only failing test output
35	is displayed. With '-vv' and higher all test output is shown.
36
37-S::
38--sequential::
39	Run all tests one after the other. By default "exclusive"
40	tests are run sequentially, but other tests are run in
41	parallel to speed execution.
42
43-r::
44--runs-per-test::
45	Run each test the given number of times, by default once. This
46	option can be useful to determine if a test is flaky.
47
48-F::
49--dont-fork::
50	Do not fork child for each test, run all tests within single process, this
51	sets sequential mode.
52
53--dso::
54	Specify a DSO for the "Symbols" test.
55
56-w::
57--workload=::
58	Run a built-in workload, to list them use '--list-workloads', current
59	ones include: noploop, thloop, leafloop, sqrtloop, brstack, datasym,
60	context_switch_loop, deterministic, named_threads and landlock.
61
62	Used with the shell script regression tests.
63
64	Some accept an extra parameter:
65
66		seconds: leafloop, noploop, sqrtloop, thloop
67		nrloops: brstack, context_switch_loop
68
69	'named_threads' accepts the number of threads and the number of loops to
70	do in each thread.
71
72	The datasym, landlock and deterministic workloads don't accept any.
73
74--list-workloads::
75	List the available workloads to use with -w/--workload.
76
77--record-ctl=fifo:ctl-fifo[,ack-fifo]::
78	This option is used to communicate with a perf record session in order
79	to control the recording scope to only the workload and avoid recording
80	setup and teardown code. When specifying this option, the same FIFO path
81	must be specified in the record session via:
82
83	  perf record -D -1 --control=fifo:ctl-fifo[,ack-fifo] ...
84
85	Perf test sends 'enable' and 'disable' commands through ctl-fifo to
86	control event recording. If 'ack-fifo' is provided, the workload runner
87	waits for an 'ack' response after each command.
88