diff options
Diffstat (limited to 'tools/perf/Documentation/perf-report.txt')
-rw-r--r-- | tools/perf/Documentation/perf-report.txt | 41 |
1 files changed, 38 insertions, 3 deletions
diff --git a/tools/perf/Documentation/perf-report.txt b/tools/perf/Documentation/perf-report.txt index f4d91bebd59d..02284a0067f0 100644 --- a/tools/perf/Documentation/perf-report.txt +++ b/tools/perf/Documentation/perf-report.txt | |||
@@ -57,11 +57,44 @@ OPTIONS | |||
57 | 57 | ||
58 | -s:: | 58 | -s:: |
59 | --sort=:: | 59 | --sort=:: |
60 | Sort by key(s): pid, comm, dso, symbol, parent, srcline. | 60 | Sort histogram entries by given key(s) - multiple keys can be specified |
61 | in CSV format. Following sort keys are available: | ||
62 | pid, comm, dso, symbol, parent, cpu, srcline. | ||
63 | |||
64 | Each key has following meaning: | ||
65 | |||
66 | - comm: command (name) of the task which can be read via /proc/<pid>/comm | ||
67 | - pid: command and tid of the task | ||
68 | - dso: name of library or module executed at the time of sample | ||
69 | - symbol: name of function executed at the time of sample | ||
70 | - parent: name of function matched to the parent regex filter. Unmatched | ||
71 | entries are displayed as "[other]". | ||
72 | - cpu: cpu number the task ran at the time of sample | ||
73 | - srcline: filename and line number executed at the time of sample. The | ||
74 | DWARF debuggin info must be provided. | ||
75 | |||
76 | By default, comm, dso and symbol keys are used. | ||
77 | (i.e. --sort comm,dso,symbol) | ||
78 | |||
79 | If --branch-stack option is used, following sort keys are also | ||
80 | available: | ||
81 | dso_from, dso_to, symbol_from, symbol_to, mispredict. | ||
82 | |||
83 | - dso_from: name of library or module branched from | ||
84 | - dso_to: name of library or module branched to | ||
85 | - symbol_from: name of function branched from | ||
86 | - symbol_to: name of function branched to | ||
87 | - mispredict: "N" for predicted branch, "Y" for mispredicted branch | ||
88 | |||
89 | And default sort keys are changed to comm, dso_from, symbol_from, dso_to | ||
90 | and symbol_to, see '--branch-stack'. | ||
61 | 91 | ||
62 | -p:: | 92 | -p:: |
63 | --parent=<regex>:: | 93 | --parent=<regex>:: |
64 | regex filter to identify parent, see: '--sort parent' | 94 | A regex filter to identify parent. The parent is a caller of this |
95 | function and searched through the callchain, thus it requires callchain | ||
96 | information recorded. The pattern is in the exteneded regex format and | ||
97 | defaults to "\^sys_|^do_page_fault", see '--sort parent'. | ||
65 | 98 | ||
66 | -x:: | 99 | -x:: |
67 | --exclude-other:: | 100 | --exclude-other:: |
@@ -74,7 +107,6 @@ OPTIONS | |||
74 | 107 | ||
75 | -t:: | 108 | -t:: |
76 | --field-separator=:: | 109 | --field-separator=:: |
77 | |||
78 | Use a special separator character and don't pad with spaces, replacing | 110 | Use a special separator character and don't pad with spaces, replacing |
79 | all occurrences of this separator in symbol names (and other output) | 111 | all occurrences of this separator in symbol names (and other output) |
80 | with a '.' character, that thus it's the only non valid separator. | 112 | with a '.' character, that thus it's the only non valid separator. |
@@ -171,6 +203,9 @@ OPTIONS | |||
171 | --objdump=<path>:: | 203 | --objdump=<path>:: |
172 | Path to objdump binary. | 204 | Path to objdump binary. |
173 | 205 | ||
206 | --group:: | ||
207 | Show event group information together. | ||
208 | |||
174 | SEE ALSO | 209 | SEE ALSO |
175 | -------- | 210 | -------- |
176 | linkperf:perf-stat[1], linkperf:perf-annotate[1] | 211 | linkperf:perf-stat[1], linkperf:perf-annotate[1] |