xref: /OK3568_Linux_fs/kernel/tools/perf/Documentation/perf.txt (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyunperf(1)
2*4882a593Smuzhiyun=======
3*4882a593Smuzhiyun
4*4882a593SmuzhiyunNAME
5*4882a593Smuzhiyun----
6*4882a593Smuzhiyunperf - Performance analysis tools for Linux
7*4882a593Smuzhiyun
8*4882a593SmuzhiyunSYNOPSIS
9*4882a593Smuzhiyun--------
10*4882a593Smuzhiyun[verse]
11*4882a593Smuzhiyun'perf' [--version] [--help] [OPTIONS] COMMAND [ARGS]
12*4882a593Smuzhiyun
13*4882a593SmuzhiyunOPTIONS
14*4882a593Smuzhiyun-------
15*4882a593Smuzhiyun-h::
16*4882a593Smuzhiyun--help::
17*4882a593Smuzhiyun        Run perf help command.
18*4882a593Smuzhiyun
19*4882a593Smuzhiyun-v::
20*4882a593Smuzhiyun--version::
21*4882a593Smuzhiyun        Display perf version.
22*4882a593Smuzhiyun
23*4882a593Smuzhiyun-vv::
24*4882a593Smuzhiyun        Print the compiled-in status of libraries.
25*4882a593Smuzhiyun
26*4882a593Smuzhiyun--exec-path::
27*4882a593Smuzhiyun        Display or set exec path.
28*4882a593Smuzhiyun
29*4882a593Smuzhiyun--html-path::
30*4882a593Smuzhiyun        Display html documentation path.
31*4882a593Smuzhiyun
32*4882a593Smuzhiyun-p::
33*4882a593Smuzhiyun--paginate::
34*4882a593Smuzhiyun        Set up pager.
35*4882a593Smuzhiyun
36*4882a593Smuzhiyun--no-pager::
37*4882a593Smuzhiyun        Do not set pager.
38*4882a593Smuzhiyun
39*4882a593Smuzhiyun--buildid-dir::
40*4882a593Smuzhiyun        Setup buildid cache directory. It has higher priority
41*4882a593Smuzhiyun        than buildid.dir config file option.
42*4882a593Smuzhiyun
43*4882a593Smuzhiyun--list-cmds::
44*4882a593Smuzhiyun        List the most commonly used perf commands.
45*4882a593Smuzhiyun
46*4882a593Smuzhiyun--list-opts::
47*4882a593Smuzhiyun        List available perf options.
48*4882a593Smuzhiyun
49*4882a593Smuzhiyun--debugfs-dir::
50*4882a593Smuzhiyun        Set debugfs directory or set environment variable PERF_DEBUGFS_DIR.
51*4882a593Smuzhiyun
52*4882a593Smuzhiyun--debug::
53*4882a593Smuzhiyun        Setup debug variable (see list below) in value
54*4882a593Smuzhiyun        range (0, 10). Use like:
55*4882a593Smuzhiyun          --debug verbose   # sets verbose = 1
56*4882a593Smuzhiyun          --debug verbose=2 # sets verbose = 2
57*4882a593Smuzhiyun
58*4882a593Smuzhiyun        List of debug variables allowed to set:
59*4882a593Smuzhiyun          verbose          - general debug messages
60*4882a593Smuzhiyun          ordered-events   - ordered events object debug messages
61*4882a593Smuzhiyun          data-convert     - data convert command debug messages
62*4882a593Smuzhiyun          stderr           - write debug output (option -v) to stderr
63*4882a593Smuzhiyun                             in browser mode
64*4882a593Smuzhiyun          perf-event-open  - Print perf_event_open() arguments and
65*4882a593Smuzhiyun                             return value
66*4882a593Smuzhiyun
67*4882a593SmuzhiyunDESCRIPTION
68*4882a593Smuzhiyun-----------
69*4882a593SmuzhiyunPerformance counters for Linux are a new kernel-based subsystem
70*4882a593Smuzhiyunthat provide a framework for all things performance analysis. It
71*4882a593Smuzhiyuncovers hardware level (CPU/PMU, Performance Monitoring Unit) features
72*4882a593Smuzhiyunand software features (software counters, tracepoints) as well.
73*4882a593Smuzhiyun
74*4882a593SmuzhiyunSEE ALSO
75*4882a593Smuzhiyun--------
76*4882a593Smuzhiyunlinkperf:perf-stat[1], linkperf:perf-top[1],
77*4882a593Smuzhiyunlinkperf:perf-record[1], linkperf:perf-report[1],
78*4882a593Smuzhiyunlinkperf:perf-list[1]
79