1 perf(1) 1 perf(1)
2 ======= 2 =======
3 3
4 NAME 4 NAME
5 ---- 5 ----
6 perf - Performance analysis tools for Linux 6 perf - Performance analysis tools for Linux
7 7
8 SYNOPSIS 8 SYNOPSIS
9 -------- 9 --------
10 [verse] 10 [verse]
11 'perf' [--version] [--help] [OPTIONS] COMMAND 11 'perf' [--version] [--help] [OPTIONS] COMMAND [ARGS]
12 12
13 OPTIONS 13 OPTIONS
14 ------- 14 -------
15 -h:: 15 -h::
16 --help:: 16 --help::
17 Run perf help command. 17 Run perf help command.
18 18
19 -v:: 19 -v::
20 --version:: 20 --version::
21 Display perf version. 21 Display perf version.
22 22
23 -vv:: 23 -vv::
24 Print the compiled-in status of librar 24 Print the compiled-in status of libraries.
25 25
26 --exec-path:: 26 --exec-path::
27 Display or set exec path. 27 Display or set exec path.
28 28
29 --html-path:: 29 --html-path::
30 Display html documentation path. 30 Display html documentation path.
31 31
32 -p:: 32 -p::
33 --paginate:: 33 --paginate::
34 Set up pager. 34 Set up pager.
35 35
36 --no-pager:: 36 --no-pager::
37 Do not set pager. 37 Do not set pager.
38 38
39 --buildid-dir:: 39 --buildid-dir::
40 Setup buildid cache directory. It has 40 Setup buildid cache directory. It has higher priority
41 than buildid.dir config file option. 41 than buildid.dir config file option.
42 42
43 --list-cmds:: 43 --list-cmds::
44 List the most commonly used perf comma 44 List the most commonly used perf commands.
45 45
46 --list-opts:: 46 --list-opts::
47 List available perf options. 47 List available perf options.
48 48
49 --debugfs-dir:: 49 --debugfs-dir::
50 Set debugfs directory or set environme 50 Set debugfs directory or set environment variable PERF_DEBUGFS_DIR.
51 51
52 --debug:: 52 --debug::
53 Setup debug variable (see list below) 53 Setup debug variable (see list below) in value
54 range (0, 10). Use like: 54 range (0, 10). Use like:
55 --debug verbose # sets verbose = 1 55 --debug verbose # sets verbose = 1
56 --debug verbose=2 # sets verbose = 2 56 --debug verbose=2 # sets verbose = 2
57 57
58 List of debug variables allowed to set 58 List of debug variables allowed to set:
59 verbose - general debug mes 59 verbose - general debug messages
60 ordered-events - ordered events ob 60 ordered-events - ordered events object debug messages
61 data-convert - data convert comm 61 data-convert - data convert command debug messages
62 stderr - write debug outpu 62 stderr - write debug output (option -v) to stderr
63 in browser mode 63 in browser mode
64 perf-event-open - Print perf_event_ 64 perf-event-open - Print perf_event_open() arguments and
65 return value 65 return value
66 kmaps - Print kernel and 66 kmaps - Print kernel and module maps (perf script
67 and perf report w 67 and perf report without browser)
68 68
69 --debug-file:: 69 --debug-file::
70 Write debug output to a specified file 70 Write debug output to a specified file.
71 71
72 DESCRIPTION 72 DESCRIPTION
73 ----------- 73 -----------
74 Performance counters for Linux are a new kerne 74 Performance counters for Linux are a new kernel-based subsystem
75 that provide a framework for all things perfor 75 that provide a framework for all things performance analysis. It
76 covers hardware level (CPU/PMU, Performance Mo 76 covers hardware level (CPU/PMU, Performance Monitoring Unit) features
77 and software features (software counters, trac 77 and software features (software counters, tracepoints) as well.
78 78
79 SEE ALSO 79 SEE ALSO
80 -------- 80 --------
81 linkperf:perf-stat[1], linkperf:perf-top[1], 81 linkperf:perf-stat[1], linkperf:perf-top[1],
82 linkperf:perf-record[1], linkperf:perf-report[ 82 linkperf:perf-record[1], linkperf:perf-report[1],
83 linkperf:perf-list[1] 83 linkperf:perf-list[1]
84 84
85 linkperf:perf-amd-ibs[1], linkperf:perf-annota 85 linkperf:perf-amd-ibs[1], linkperf:perf-annotate[1],
86 linkperf:perf-archive[1], linkperf:perf-arm-sp 86 linkperf:perf-archive[1], linkperf:perf-arm-spe[1],
87 linkperf:perf-bench[1], linkperf:perf-buildid- 87 linkperf:perf-bench[1], linkperf:perf-buildid-cache[1],
88 linkperf:perf-buildid-list[1], linkperf:perf-c 88 linkperf:perf-buildid-list[1], linkperf:perf-c2c[1],
89 linkperf:perf-config[1], linkperf:perf-data[1] 89 linkperf:perf-config[1], linkperf:perf-data[1], linkperf:perf-diff[1],
90 linkperf:perf-evlist[1], linkperf:perf-ftrace[ 90 linkperf:perf-evlist[1], linkperf:perf-ftrace[1],
91 linkperf:perf-help[1], linkperf:perf-inject[1] 91 linkperf:perf-help[1], linkperf:perf-inject[1],
92 linkperf:perf-intel-pt[1], linkperf:perf-iosta 92 linkperf:perf-intel-pt[1], linkperf:perf-iostat[1], linkperf:perf-kallsyms[1],
93 linkperf:perf-kmem[1], linkperf:perf-kvm[1], l 93 linkperf:perf-kmem[1], linkperf:perf-kvm[1], linkperf:perf-lock[1],
94 linkperf:perf-mem[1], linkperf:perf-probe[1], 94 linkperf:perf-mem[1], linkperf:perf-probe[1], linkperf:perf-sched[1],
95 linkperf:perf-script[1], linkperf:perf-test[1] 95 linkperf:perf-script[1], linkperf:perf-test[1],
96 linkperf:perf-trace[1], linkperf:perf-version[ 96 linkperf:perf-trace[1], linkperf:perf-version[1]
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.