perf diff: Add option to sort entries based on diff computation
[deliverable/linux.git] / tools / perf / Documentation / perf-diff.txt
CommitLineData
86a9eee0 1perf-diff(1)
4778e0e8 2============
86a9eee0
ACM
3
4NAME
5----
d30531c6 6perf-diff - Read two perf.data files and display the differential profile
86a9eee0
ACM
7
8SYNOPSIS
9--------
10[verse]
11'perf diff' [oldfile] [newfile]
12
13DESCRIPTION
14-----------
d30531c6 15This command displays the performance difference amongst two perf.data files
86a9eee0
ACM
16captured via perf record.
17
18If no parameters are passed it will assume perf.data.old and perf.data.
19
863e451f
JO
20The differential profile is displayed only for events matching both
21specified perf.data files.
22
86a9eee0
ACM
23OPTIONS
24-------
5ea4f857
SB
25-M::
26--displacement::
27 Show position displacement relative to baseline.
28
29-D::
30--dump-raw-trace::
31 Dump raw trace in ASCII.
32
33-m::
34--modules::
35 Load module symbols. WARNING: use only with -k and LIVE kernel
36
c351c281
ACM
37-d::
38--dsos=::
39 Only consider symbols in these dsos. CSV that understands
40 file://filename entries.
41
42-C::
43--comms=::
44 Only consider symbols in these comms. CSV that understands
45 file://filename entries.
46
47-S::
48--symbols=::
49 Only consider these symbols. CSV that understands
50 file://filename entries.
51
52-s::
53--sort=::
54 Sort by key(s): pid, comm, dso, symbol.
55
56-t::
57--field-separator=::
58
59 Use a special separator character and don't pad with spaces, replacing
5ea4f857 60 all occurrences of this separator in symbol names (and other output)
c351c281
ACM
61 with a '.' character, that thus it's the only non valid separator.
62
86a9eee0
ACM
63-v::
64--verbose::
d30531c6 65 Be verbose, for instance, show the raw counts in addition to the
86a9eee0 66 diff.
cdccc690 67
5ea4f857
SB
68-f::
69--force::
70 Don't complain, do it.
71
ec5761ea
DA
72--symfs=<directory>::
73 Look for files with symbols relative to this directory.
5ea4f857 74
a06d143e
JO
75-b::
76--baseline-only::
77 Show only items with match in baseline.
78
7aaf6b35
JO
79-c::
80--compute::
81 Differential computation selection - delta,ratio (default is delta).
96c47f19
JO
82 If '+' is specified as a first character, the output is sorted based
83 on the computation results.
7aaf6b35
JO
84 See COMPARISON METHODS section for more info.
85
86COMPARISON METHODS
87------------------
88delta
89~~~~~
90If specified the 'Delta' column is displayed with value 'd' computed as:
91
92 d = A->period_percent - B->period_percent
93
94with:
95 - A/B being matching hist entry from first/second file specified
96 (or perf.data/perf.data.old) respectively.
97
98 - period_percent being the % of the hist entry period value within
99 single data file
100
101ratio
102~~~~~
103If specified the 'Ratio' column is displayed with value 'r' computed as:
104
105 r = A->period / B->period
106
107with:
108 - A/B being matching hist entry from first/second file specified
109 (or perf.data/perf.data.old) respectively.
110
111 - period being the hist entry period value
112
113
86a9eee0
ACM
114SEE ALSO
115--------
116linkperf:perf-record[1]
This page took 0.266022 seconds and 5 git commands to generate.