diff options
Diffstat (limited to 'tools/perf/Documentation')
-rw-r--r-- | tools/perf/Documentation/Makefile | 4 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-annotate.txt | 7 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-buildid-cache.txt | 7 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-diff.txt | 4 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-evlist.txt | 4 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-report.txt | 41 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-script-python.txt | 2 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-stat.txt | 11 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-test.txt | 4 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-top.txt | 2 |
10 files changed, 75 insertions, 11 deletions
diff --git a/tools/perf/Documentation/Makefile b/tools/perf/Documentation/Makefile index ef6d22e879eb..eb30044a922a 100644 --- a/tools/perf/Documentation/Makefile +++ b/tools/perf/Documentation/Makefile | |||
@@ -222,10 +222,14 @@ install-pdf: pdf | |||
222 | #install-html: html | 222 | #install-html: html |
223 | # '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir) | 223 | # '$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir) |
224 | 224 | ||
225 | ifneq ($(MAKECMDGOALS),clean) | ||
226 | ifneq ($(MAKECMDGOALS),tags) | ||
225 | $(OUTPUT)PERF-VERSION-FILE: .FORCE-PERF-VERSION-FILE | 227 | $(OUTPUT)PERF-VERSION-FILE: .FORCE-PERF-VERSION-FILE |
226 | $(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) $(OUTPUT)PERF-VERSION-FILE | 228 | $(QUIET_SUBDIR0)../ $(QUIET_SUBDIR1) $(OUTPUT)PERF-VERSION-FILE |
227 | 229 | ||
228 | -include $(OUTPUT)PERF-VERSION-FILE | 230 | -include $(OUTPUT)PERF-VERSION-FILE |
231 | endif | ||
232 | endif | ||
229 | 233 | ||
230 | # | 234 | # |
231 | # Determine "include::" file references in asciidoc files. | 235 | # Determine "include::" file references in asciidoc files. |
diff --git a/tools/perf/Documentation/perf-annotate.txt b/tools/perf/Documentation/perf-annotate.txt index c8ffd9fd5c6a..5ad07ef417f0 100644 --- a/tools/perf/Documentation/perf-annotate.txt +++ b/tools/perf/Documentation/perf-annotate.txt | |||
@@ -61,11 +61,13 @@ OPTIONS | |||
61 | 61 | ||
62 | --stdio:: Use the stdio interface. | 62 | --stdio:: Use the stdio interface. |
63 | 63 | ||
64 | --tui:: Use the TUI interface Use of --tui requires a tty, if one is not | 64 | --tui:: Use the TUI interface. Use of --tui requires a tty, if one is not |
65 | present, as when piping to other commands, the stdio interface is | 65 | present, as when piping to other commands, the stdio interface is |
66 | used. This interfaces starts by centering on the line with more | 66 | used. This interfaces starts by centering on the line with more |
67 | samples, TAB/UNTAB cycles through the lines with more samples. | 67 | samples, TAB/UNTAB cycles through the lines with more samples. |
68 | 68 | ||
69 | --gtk:: Use the GTK interface. | ||
70 | |||
69 | -C:: | 71 | -C:: |
70 | --cpu:: Only report samples for the list of CPUs provided. Multiple CPUs can | 72 | --cpu:: Only report samples for the list of CPUs provided. Multiple CPUs can |
71 | be provided as a comma-separated list with no space: 0,1. Ranges of | 73 | be provided as a comma-separated list with no space: 0,1. Ranges of |
@@ -88,6 +90,9 @@ OPTIONS | |||
88 | --objdump=<path>:: | 90 | --objdump=<path>:: |
89 | Path to objdump binary. | 91 | Path to objdump binary. |
90 | 92 | ||
93 | --skip-missing:: | ||
94 | Skip symbols that cannot be annotated. | ||
95 | |||
91 | SEE ALSO | 96 | SEE ALSO |
92 | -------- | 97 | -------- |
93 | linkperf:perf-record[1], linkperf:perf-report[1] | 98 | linkperf:perf-record[1], linkperf:perf-report[1] |
diff --git a/tools/perf/Documentation/perf-buildid-cache.txt b/tools/perf/Documentation/perf-buildid-cache.txt index c1057701a7dc..e9a8349a7172 100644 --- a/tools/perf/Documentation/perf-buildid-cache.txt +++ b/tools/perf/Documentation/perf-buildid-cache.txt | |||
@@ -24,6 +24,13 @@ OPTIONS | |||
24 | -r:: | 24 | -r:: |
25 | --remove=:: | 25 | --remove=:: |
26 | Remove specified file from the cache. | 26 | Remove specified file from the cache. |
27 | -M:: | ||
28 | --missing=:: | ||
29 | List missing build ids in the cache for the specified file. | ||
30 | -u:: | ||
31 | --update:: | ||
32 | Update specified file of the cache. It can be used to update kallsyms | ||
33 | kernel dso to vmlinux in order to support annotation. | ||
27 | -v:: | 34 | -v:: |
28 | --verbose:: | 35 | --verbose:: |
29 | Be more verbose. | 36 | Be more verbose. |
diff --git a/tools/perf/Documentation/perf-diff.txt b/tools/perf/Documentation/perf-diff.txt index 194f37d635df..5b3123d5721f 100644 --- a/tools/perf/Documentation/perf-diff.txt +++ b/tools/perf/Documentation/perf-diff.txt | |||
@@ -22,10 +22,6 @@ specified perf.data files. | |||
22 | 22 | ||
23 | OPTIONS | 23 | OPTIONS |
24 | ------- | 24 | ------- |
25 | -M:: | ||
26 | --displacement:: | ||
27 | Show position displacement relative to baseline. | ||
28 | |||
29 | -D:: | 25 | -D:: |
30 | --dump-raw-trace:: | 26 | --dump-raw-trace:: |
31 | Dump raw trace in ASCII. | 27 | Dump raw trace in ASCII. |
diff --git a/tools/perf/Documentation/perf-evlist.txt b/tools/perf/Documentation/perf-evlist.txt index 15217345c2fa..1ceb3700ffbb 100644 --- a/tools/perf/Documentation/perf-evlist.txt +++ b/tools/perf/Documentation/perf-evlist.txt | |||
@@ -28,6 +28,10 @@ OPTIONS | |||
28 | --verbose=:: | 28 | --verbose=:: |
29 | Show all fields. | 29 | Show all fields. |
30 | 30 | ||
31 | -g:: | ||
32 | --group:: | ||
33 | Show event group information. | ||
34 | |||
31 | SEE ALSO | 35 | SEE ALSO |
32 | -------- | 36 | -------- |
33 | linkperf:perf-record[1], linkperf:perf-list[1], | 37 | linkperf:perf-record[1], linkperf:perf-list[1], |
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] |
diff --git a/tools/perf/Documentation/perf-script-python.txt b/tools/perf/Documentation/perf-script-python.txt index a4027f221a53..9f1f054b8432 100644 --- a/tools/perf/Documentation/perf-script-python.txt +++ b/tools/perf/Documentation/perf-script-python.txt | |||
@@ -336,7 +336,6 @@ scripts listed by the 'perf script -l' command e.g.: | |||
336 | ---- | 336 | ---- |
337 | root@tropicana:~# perf script -l | 337 | root@tropicana:~# perf script -l |
338 | List of available trace scripts: | 338 | List of available trace scripts: |
339 | workqueue-stats workqueue stats (ins/exe/create/destroy) | ||
340 | wakeup-latency system-wide min/max/avg wakeup latency | 339 | wakeup-latency system-wide min/max/avg wakeup latency |
341 | rw-by-file <comm> r/w activity for a program, by file | 340 | rw-by-file <comm> r/w activity for a program, by file |
342 | rw-by-pid system-wide r/w activity | 341 | rw-by-pid system-wide r/w activity |
@@ -402,7 +401,6 @@ should show a new entry for your script: | |||
402 | ---- | 401 | ---- |
403 | root@tropicana:~# perf script -l | 402 | root@tropicana:~# perf script -l |
404 | List of available trace scripts: | 403 | List of available trace scripts: |
405 | workqueue-stats workqueue stats (ins/exe/create/destroy) | ||
406 | wakeup-latency system-wide min/max/avg wakeup latency | 404 | wakeup-latency system-wide min/max/avg wakeup latency |
407 | rw-by-file <comm> r/w activity for a program, by file | 405 | rw-by-file <comm> r/w activity for a program, by file |
408 | rw-by-pid system-wide r/w activity | 406 | rw-by-pid system-wide r/w activity |
diff --git a/tools/perf/Documentation/perf-stat.txt b/tools/perf/Documentation/perf-stat.txt index cf0c3107e06e..faf4f4feebcc 100644 --- a/tools/perf/Documentation/perf-stat.txt +++ b/tools/perf/Documentation/perf-stat.txt | |||
@@ -114,6 +114,17 @@ with it. --append may be used here. Examples: | |||
114 | 114 | ||
115 | perf stat --repeat 10 --null --sync --pre 'make -s O=defconfig-build/clean' -- make -s -j64 O=defconfig-build/ bzImage | 115 | perf stat --repeat 10 --null --sync --pre 'make -s O=defconfig-build/clean' -- make -s -j64 O=defconfig-build/ bzImage |
116 | 116 | ||
117 | -I msecs:: | ||
118 | --interval-print msecs:: | ||
119 | Print count deltas every N milliseconds (minimum: 100ms) | ||
120 | example: perf stat -I 1000 -e cycles -a sleep 5 | ||
121 | |||
122 | --aggr-socket:: | ||
123 | Aggregate counts per processor socket for system-wide mode measurements. This | ||
124 | is a useful mode to detect imbalance between sockets. To enable this mode, | ||
125 | use --aggr-socket in addition to -a. (system-wide). The output includes the | ||
126 | socket number and the number of online processors on that socket. This is | ||
127 | useful to gauge the amount of aggregation. | ||
117 | 128 | ||
118 | EXAMPLES | 129 | EXAMPLES |
119 | -------- | 130 | -------- |
diff --git a/tools/perf/Documentation/perf-test.txt b/tools/perf/Documentation/perf-test.txt index b24ac40fcd58..d1d3e5121f89 100644 --- a/tools/perf/Documentation/perf-test.txt +++ b/tools/perf/Documentation/perf-test.txt | |||
@@ -23,6 +23,10 @@ from 'perf test list'. | |||
23 | 23 | ||
24 | OPTIONS | 24 | OPTIONS |
25 | ------- | 25 | ------- |
26 | -s:: | ||
27 | --skip:: | ||
28 | Tests to skip (comma separater numeric list). | ||
29 | |||
26 | -v:: | 30 | -v:: |
27 | --verbose:: | 31 | --verbose:: |
28 | Be more verbose. | 32 | Be more verbose. |
diff --git a/tools/perf/Documentation/perf-top.txt b/tools/perf/Documentation/perf-top.txt index 5b80d84d6b4a..a414bc95fd52 100644 --- a/tools/perf/Documentation/perf-top.txt +++ b/tools/perf/Documentation/perf-top.txt | |||
@@ -60,7 +60,7 @@ Default is to monitor all CPUS. | |||
60 | 60 | ||
61 | -i:: | 61 | -i:: |
62 | --inherit:: | 62 | --inherit:: |
63 | Child tasks inherit counters, only makes sens with -p option. | 63 | Child tasks do not inherit counters. |
64 | 64 | ||
65 | -k <path>:: | 65 | -k <path>:: |
66 | --vmlinux=<path>:: | 66 | --vmlinux=<path>:: |