diff options
Diffstat (limited to 'tools/perf/Documentation')
-rw-r--r-- | tools/perf/Documentation/perf-annotate.txt | 3 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-mem.txt | 48 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-record.txt | 6 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-report.txt | 6 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-stat.txt | 12 | ||||
-rw-r--r-- | tools/perf/Documentation/perf-top.txt | 2 |
6 files changed, 72 insertions, 5 deletions
diff --git a/tools/perf/Documentation/perf-annotate.txt b/tools/perf/Documentation/perf-annotate.txt index 5ad07ef417f0..e9cd39a92dc2 100644 --- a/tools/perf/Documentation/perf-annotate.txt +++ b/tools/perf/Documentation/perf-annotate.txt | |||
@@ -93,6 +93,9 @@ OPTIONS | |||
93 | --skip-missing:: | 93 | --skip-missing:: |
94 | Skip symbols that cannot be annotated. | 94 | Skip symbols that cannot be annotated. |
95 | 95 | ||
96 | --group:: | ||
97 | Show event group information together | ||
98 | |||
96 | SEE ALSO | 99 | SEE ALSO |
97 | -------- | 100 | -------- |
98 | linkperf:perf-record[1], linkperf:perf-report[1] | 101 | linkperf:perf-record[1], linkperf:perf-report[1] |
diff --git a/tools/perf/Documentation/perf-mem.txt b/tools/perf/Documentation/perf-mem.txt new file mode 100644 index 000000000000..888d51137fbe --- /dev/null +++ b/tools/perf/Documentation/perf-mem.txt | |||
@@ -0,0 +1,48 @@ | |||
1 | perf-mem(1) | ||
2 | =========== | ||
3 | |||
4 | NAME | ||
5 | ---- | ||
6 | perf-mem - Profile memory accesses | ||
7 | |||
8 | SYNOPSIS | ||
9 | -------- | ||
10 | [verse] | ||
11 | 'perf mem' [<options>] (record [<command>] | report) | ||
12 | |||
13 | DESCRIPTION | ||
14 | ----------- | ||
15 | "perf mem -t <TYPE> record" runs a command and gathers memory operation data | ||
16 | from it, into perf.data. Perf record options are accepted and are passed through. | ||
17 | |||
18 | "perf mem -t <TYPE> report" displays the result. It invokes perf report with the | ||
19 | right set of options to display a memory access profile. | ||
20 | |||
21 | OPTIONS | ||
22 | ------- | ||
23 | <command>...:: | ||
24 | Any command you can specify in a shell. | ||
25 | |||
26 | -t:: | ||
27 | --type=:: | ||
28 | Select the memory operation type: load or store (default: load) | ||
29 | |||
30 | -D:: | ||
31 | --dump-raw-samples=:: | ||
32 | Dump the raw decoded samples on the screen in a format that is easy to parse with | ||
33 | one sample per line. | ||
34 | |||
35 | -x:: | ||
36 | --field-separator:: | ||
37 | Specify the field separator used when dump raw samples (-D option). By default, | ||
38 | The separator is the space character. | ||
39 | |||
40 | -C:: | ||
41 | --cpu-list:: | ||
42 | Restrict dump of raw samples to those provided via this option. Note that the same | ||
43 | option can be passed in record mode. It will be interpreted the same way as perf | ||
44 | record. | ||
45 | |||
46 | SEE ALSO | ||
47 | -------- | ||
48 | linkperf:perf-record[1], linkperf:perf-report[1] | ||
diff --git a/tools/perf/Documentation/perf-record.txt b/tools/perf/Documentation/perf-record.txt index 938e8904f64d..d4da111ef53d 100644 --- a/tools/perf/Documentation/perf-record.txt +++ b/tools/perf/Documentation/perf-record.txt | |||
@@ -182,6 +182,12 @@ is enabled for all the sampling events. The sampled branch type is the same for | |||
182 | The various filters must be specified as a comma separated list: --branch-filter any_ret,u,k | 182 | The various filters must be specified as a comma separated list: --branch-filter any_ret,u,k |
183 | Note that this feature may not be available on all processors. | 183 | Note that this feature may not be available on all processors. |
184 | 184 | ||
185 | -W:: | ||
186 | --weight:: | ||
187 | Enable weightened sampling. An additional weight is recorded per sample and can be | ||
188 | displayed with the weight and local_weight sort keys. This currently works for TSX | ||
189 | abort events and some memory events in precise mode on modern Intel CPUs. | ||
190 | |||
185 | SEE ALSO | 191 | SEE ALSO |
186 | -------- | 192 | -------- |
187 | linkperf:perf-stat[1], linkperf:perf-list[1] | 193 | linkperf:perf-stat[1], linkperf:perf-list[1] |
diff --git a/tools/perf/Documentation/perf-report.txt b/tools/perf/Documentation/perf-report.txt index 02284a0067f0..7d5f4f38aa52 100644 --- a/tools/perf/Documentation/perf-report.txt +++ b/tools/perf/Documentation/perf-report.txt | |||
@@ -59,7 +59,7 @@ OPTIONS | |||
59 | --sort=:: | 59 | --sort=:: |
60 | Sort histogram entries by given key(s) - multiple keys can be specified | 60 | Sort histogram entries by given key(s) - multiple keys can be specified |
61 | in CSV format. Following sort keys are available: | 61 | in CSV format. Following sort keys are available: |
62 | pid, comm, dso, symbol, parent, cpu, srcline. | 62 | pid, comm, dso, symbol, parent, cpu, srcline, weight, local_weight. |
63 | 63 | ||
64 | Each key has following meaning: | 64 | Each key has following meaning: |
65 | 65 | ||
@@ -206,6 +206,10 @@ OPTIONS | |||
206 | --group:: | 206 | --group:: |
207 | Show event group information together. | 207 | Show event group information together. |
208 | 208 | ||
209 | --demangle:: | ||
210 | Demangle symbol names to human readable form. It's enabled by default, | ||
211 | disable with --no-demangle. | ||
212 | |||
209 | SEE ALSO | 213 | SEE ALSO |
210 | -------- | 214 | -------- |
211 | linkperf:perf-stat[1], linkperf:perf-annotate[1] | 215 | linkperf:perf-stat[1], linkperf:perf-annotate[1] |
diff --git a/tools/perf/Documentation/perf-stat.txt b/tools/perf/Documentation/perf-stat.txt index faf4f4feebcc..2fe87fb558f0 100644 --- a/tools/perf/Documentation/perf-stat.txt +++ b/tools/perf/Documentation/perf-stat.txt | |||
@@ -52,7 +52,7 @@ OPTIONS | |||
52 | 52 | ||
53 | -r:: | 53 | -r:: |
54 | --repeat=<n>:: | 54 | --repeat=<n>:: |
55 | repeat command and print average + stddev (max: 100) | 55 | repeat command and print average + stddev (max: 100). 0 means forever. |
56 | 56 | ||
57 | -B:: | 57 | -B:: |
58 | --big-num:: | 58 | --big-num:: |
@@ -119,13 +119,19 @@ perf stat --repeat 10 --null --sync --pre 'make -s O=defconfig-build/clean' -- m | |||
119 | Print count deltas every N milliseconds (minimum: 100ms) | 119 | Print count deltas every N milliseconds (minimum: 100ms) |
120 | example: perf stat -I 1000 -e cycles -a sleep 5 | 120 | example: perf stat -I 1000 -e cycles -a sleep 5 |
121 | 121 | ||
122 | --aggr-socket:: | 122 | --per-socket:: |
123 | Aggregate counts per processor socket for system-wide mode measurements. This | 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, | 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 | 125 | use --per-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 | 126 | socket number and the number of online processors on that socket. This is |
127 | useful to gauge the amount of aggregation. | 127 | useful to gauge the amount of aggregation. |
128 | 128 | ||
129 | --per-core:: | ||
130 | Aggregate counts per physical processor for system-wide mode measurements. This | ||
131 | is a useful mode to detect imbalance between physical cores. To enable this mode, | ||
132 | use --per-core in addition to -a. (system-wide). The output includes the | ||
133 | core number and the number of online logical processors on that physical processor. | ||
134 | |||
129 | EXAMPLES | 135 | EXAMPLES |
130 | -------- | 136 | -------- |
131 | 137 | ||
diff --git a/tools/perf/Documentation/perf-top.txt b/tools/perf/Documentation/perf-top.txt index a414bc95fd52..9f1a2fe54757 100644 --- a/tools/perf/Documentation/perf-top.txt +++ b/tools/perf/Documentation/perf-top.txt | |||
@@ -112,7 +112,7 @@ Default is to monitor all CPUS. | |||
112 | 112 | ||
113 | -s:: | 113 | -s:: |
114 | --sort:: | 114 | --sort:: |
115 | Sort by key(s): pid, comm, dso, symbol, parent, srcline. | 115 | Sort by key(s): pid, comm, dso, symbol, parent, srcline, weight, local_weight. |
116 | 116 | ||
117 | -n:: | 117 | -n:: |
118 | --show-nr-samples:: | 118 | --show-nr-samples:: |