Merge branches 'x86-alternatives-for-linus', 'x86-fpu-for-linus', 'x86-hwmon-for...
[cascardo/linux.git] / tools / perf / Documentation / perf-report.txt
1 perf-report(1)
2 ==============
3
4 NAME
5 ----
6 perf-report - Read perf.data (created by perf record) and display the profile
7
8 SYNOPSIS
9 --------
10 [verse]
11 'perf report' [-i <file> | --input=file]
12
13 DESCRIPTION
14 -----------
15 This command displays the performance counter profile information recorded
16 via perf record.
17
18 OPTIONS
19 -------
20 -i::
21 --input=::
22         Input file name. (default: perf.data)
23
24 -v::
25 --verbose::
26         Be more verbose. (show symbol address, etc)
27
28 -d::
29 --dsos=::
30         Only consider symbols in these dsos. CSV that understands
31         file://filename entries.
32 -n::
33 --show-nr-samples::
34         Show the number of samples for each symbol
35
36 --showcpuutilization::
37         Show sample percentage for different cpu modes.
38
39 -T::
40 --threads::
41         Show per-thread event counters
42 -C::
43 --comms=::
44         Only consider symbols in these comms. CSV that understands
45         file://filename entries.
46 -S::
47 --symbols=::
48         Only consider these symbols. CSV that understands
49         file://filename entries.
50
51 -U::
52 --hide-unresolved::
53         Only display entries resolved to a symbol.
54
55 -s::
56 --sort=::
57         Sort by key(s): pid, comm, dso, symbol, parent.
58
59 -p::
60 --parent=<regex>::
61         regex filter to identify parent, see: '--sort parent'
62
63 -x::
64 --exclude-other::
65         Only display entries with parent-match.
66
67 -w::
68 --column-widths=<width[,width...]>::
69         Force each column width to the provided list, for large terminal
70         readability.
71
72 -t::
73 --field-separator=::
74
75         Use a special separator character and don't pad with spaces, replacing
76         all occurrences of this separator in symbol names (and other output)
77         with a '.' character, that thus it's the only non valid separator.
78
79 -D::
80 --dump-raw-trace::
81         Dump raw trace in ASCII.
82
83 -g [type,min]::
84 --call-graph::
85         Display call chains using type and min percent threshold.
86         type can be either:
87         - flat: single column, linear exposure of call chains.
88         - graph: use a graph tree, displaying absolute overhead rates.
89         - fractal: like graph, but displays relative rates. Each branch of
90                  the tree is considered as a new profiled object. +
91         Default: fractal,0.5.
92
93 --pretty=<key>::
94         Pretty printing style.  key: normal, raw
95
96 --stdio:: Use the stdio interface.
97
98 --tui:: Use the TUI interface, that is integrated with annotate and allows
99         zooming into DSOs or threads, among other features. Use of --tui
100         requires a tty, if one is not present, as when piping to other
101         commands, the stdio interface is used.
102
103 -k::
104 --vmlinux=<file>::
105         vmlinux pathname
106
107 --kallsyms=<file>::
108         kallsyms pathname
109
110 -m::
111 --modules::
112         Load module symbols. WARNING: This should only be used with -k and
113         a LIVE kernel.
114
115 -f::
116 --force::
117         Don't complain, do it.
118
119 --symfs=<directory>::
120         Look for files with symbols relative to this directory.
121
122 SEE ALSO
123 --------
124 linkperf:perf-stat[1]