tools/perf/Documentation/perf-diff.txt

   1 perf-diff(1)
   2 ============
   3
   4 NAME
   5 ----
   6 perf-diff - Read perf.data files and display the differential profile
   7
   8 SYNOPSIS
   9 --------
  10 [verse]
  11 'perf diff' [baseline file] [data file1] [[data file2] ... ]
  12
  13 DESCRIPTION
  14 -----------
  15 This command displays the performance difference amongst two or more perf.data
  16 files captured via perf record.
  17
  18 If no parameters are passed it will assume perf.data.old and perf.data.
  19
  20 The differential profile is displayed only for events matching both
  21 specified perf.data files.
  22
  23 If no parameters are passed the samples will be sorted by dso and symbol.
  24 As the perf.data files could come from different binaries, the symbols addresses
  25 could vary. So perf diff is based on the comparison of the files and
  26 symbols name.
  27
  28 OPTIONS
  29 -------
  30 -D::
  31 --dump-raw-trace::
  32         Dump raw trace in ASCII.
  33
  34 --kallsyms=<file>::
  35         kallsyms pathname
  36
  37 -m::
  38 --modules::
  39         Load module symbols. WARNING: use only with -k and LIVE kernel
  40
  41 -d::
  42 --dsos=::
  43         Only consider symbols in these dsos. CSV that understands
  44         file://filename entries.  This option will affect the percentage
  45         of the Baseline/Delta column.  See --percentage for more info.
  46
  47 -C::
  48 --comms=::
  49         Only consider symbols in these comms. CSV that understands
  50         file://filename entries.  This option will affect the percentage
  51         of the Baseline/Delta column.  See --percentage for more info.
  52
  53 -S::
  54 --symbols=::
  55         Only consider these symbols. CSV that understands
  56         file://filename entries.  This option will affect the percentage
  57         of the Baseline/Delta column.  See --percentage for more info.
  58
  59 -s::
  60 --sort=::
  61         Sort by key(s): pid, comm, dso, symbol, cpu, parent, srcline.
  62         Please see description of --sort in the perf-report man page.
  63
  64 -t::
  65 --field-separator=::
  66
  67         Use a special separator character and don't pad with spaces, replacing
  68         all occurrences of this separator in symbol names (and other output)
  69         with a '.' character, that thus it's the only non valid separator.
  70
  71 -v::
  72 --verbose::
  73         Be verbose, for instance, show the raw counts in addition to the
  74         diff.
  75
  76 -f::
  77 --force::
  78         Don't do ownership validation.
  79
  80 --symfs=<directory>::
  81         Look for files with symbols relative to this directory.
  82
  83 -b::
  84 --baseline-only::
  85         Show only items with match in baseline.
  86
  87 -c::
  88 --compute::
  89         Differential computation selection - delta,ratio,wdiff,delta-abs (default is delta).
  90         See COMPARISON METHODS section for more info.
  91
  92 -p::
  93 --period::
  94         Show period values for both compared hist entries.
  95
  96 -F::
  97 --formula::
  98         Show formula for given computation.
  99
 100 -o::
 101 --order::
 102        Specify compute sorting column number.  0 means sorting by baseline
 103        overhead (default) and 1 means sorting by computed value of column 1
 104        (data from the first file other base baseline).  Values more than 1
 105        can be used only if enough data files are provided.
 106        The default value can be set using the diff.order config option.
 107
 108 --percentage::
 109         Determine how to display the overhead percentage of filtered entries.
 110         Filters can be applied by --comms, --dsos and/or --symbols options.
 111
 112         "relative" means it's relative to filtered entries only so that the
 113         sum of shown entries will be always 100%.  "absolute" means it retains
 114         the original value before and after the filter is applied.
 115
 116 COMPARISON
 117 ----------
 118 The comparison is governed by the baseline file. The baseline perf.data
 119 file is iterated for samples. All other perf.data files specified on
 120 the command line are searched for the baseline sample pair. If the pair
 121 is found, specified computation is made and result is displayed.
 122
 123 All samples from non-baseline perf.data files, that do not match any
 124 baseline entry, are displayed with empty space within baseline column
 125 and possible computation results (delta) in their related column.
 126
 127 Example files samples:
 128 - file A with samples f1, f2, f3, f4,    f6
 129 - file B with samples     f2,     f4, f5
 130 - file C with samples f1, f2,         f5
 131
 132 Example output:
 133   x - computation takes place for pair
 134   b - baseline sample percentage
 135
 136 - perf diff A B C
 137
 138   baseline/A compute/B compute/C  samples
 139   ---------------------------------------
 140   b                    x          f1
 141   b          x         x          f2
 142   b                               f3
 143   b          x                    f4
 144   b                               f6
 145              x         x          f5
 146
 147 - perf diff B A C
 148
 149   baseline/B compute/A compute/C  samples
 150   ---------------------------------------
 151   b          x         x          f2
 152   b          x                    f4
 153   b                    x          f5
 154              x         x          f1
 155              x                    f3
 156              x                    f6
 157
 158 - perf diff C B A
 159
 160   baseline/C compute/B compute/A  samples
 161   ---------------------------------------
 162   b                    x          f1
 163   b          x         x          f2
 164   b          x                    f5
 165                        x          f3
 166              x         x          f4
 167                        x          f6
 168
 169 COMPARISON METHODS
 170 ------------------
 171 delta
 172 ~~~~~
 173 If specified the 'Delta' column is displayed with value 'd' computed as:
 174
 175   d = A->period_percent - B->period_percent
 176
 177 with:
 178   - A/B being matching hist entry from data/baseline file specified
 179     (or perf.data/perf.data.old) respectively.
 180
 181   - period_percent being the % of the hist entry period value within
 182     single data file
 183
 184   - with filtering by -C, -d and/or -S, period_percent might be changed
 185     relative to how entries are filtered.  Use --percentage=absolute to
 186     prevent such fluctuation.
 187
 188 delta-abs
 189 ~~~~~~~~~
 190 Same as 'delta` method, but sort the result with the absolute values.
 191
 192 ratio
 193 ~~~~~
 194 If specified the 'Ratio' column is displayed with value 'r' computed as:
 195
 196   r = A->period / B->period
 197
 198 with:
 199   - A/B being matching hist entry from data/baseline file specified
 200     (or perf.data/perf.data.old) respectively.
 201
 202   - period being the hist entry period value
 203
 204 wdiff:WEIGHT-B,WEIGHT-A
 205 ~~~~~~~~~~~~~~~~~~~~~~~
 206 If specified the 'Weighted diff' column is displayed with value 'd' computed as:
 207
 208    d = B->period * WEIGHT-A - A->period * WEIGHT-B
 209
 210   - A/B being matching hist entry from data/baseline file specified
 211     (or perf.data/perf.data.old) respectively.
 212
 213   - period being the hist entry period value
 214
 215   - WEIGHT-A/WEIGHT-B being user supplied weights in the the '-c' option
 216     behind ':' separator like '-c wdiff:1,2'.
 217     - WEIGHT-A being the weight of the data file
 218     - WEIGHT-B being the weight of the baseline data file
 219
 220 SEE ALSO
 221 --------
 222 linkperf:perf-record[1], linkperf:perf-report[1]