xref: /linux/tools/perf/Documentation/perf-mem.txt (revision b0d745b3c34a7fd9ee0b78b929b94c706f84e341)
1028f12eeSStephane Eranianperf-mem(1)
2028f12eeSStephane Eranian===========
3028f12eeSStephane Eranian
4028f12eeSStephane EranianNAME
5028f12eeSStephane Eranian----
6028f12eeSStephane Eranianperf-mem - Profile memory accesses
7028f12eeSStephane Eranian
8028f12eeSStephane EranianSYNOPSIS
9028f12eeSStephane Eranian--------
10028f12eeSStephane Eranian[verse]
11028f12eeSStephane Eranian'perf mem' [<options>] (record [<command>] | report)
12028f12eeSStephane Eranian
13028f12eeSStephane EranianDESCRIPTION
14028f12eeSStephane Eranian-----------
1567121f85SStephane Eranian"perf mem record" runs a command and gathers memory operation data
16028f12eeSStephane Eranianfrom it, into perf.data. Perf record options are accepted and are passed through.
17028f12eeSStephane Eranian
1867121f85SStephane Eranian"perf mem report" displays the result. It invokes perf report with the
1967121f85SStephane Eranianright set of options to display a memory access profile. By default, loads
2067121f85SStephane Eranianand stores are sampled. Use the -t option to limit to loads or stores.
21028f12eeSStephane Eranian
22b6394097SAndi KleenNote that on Intel systems the memory latency reported is the use-latency,
23b6394097SAndi Kleennot the pure load (or store latency). Use latency includes any pipeline
24b6394097SAndi Kleenqueueing delays in addition to the memory subsystem latency.
25b6394097SAndi Kleen
26028f12eeSStephane EranianOPTIONS
27028f12eeSStephane Eranian-------
28028f12eeSStephane Eranian<command>...::
29028f12eeSStephane Eranian	Any command you can specify in a shell.
30028f12eeSStephane Eranian
31028f12eeSStephane Eranian-t::
32028f12eeSStephane Eranian--type=::
3367121f85SStephane Eranian	Select the memory operation type: load or store (default: load,store)
34028f12eeSStephane Eranian
35028f12eeSStephane Eranian-D::
36028f12eeSStephane Eranian--dump-raw-samples=::
37028f12eeSStephane Eranian	Dump the raw decoded samples on the screen in a format that is easy to parse with
38028f12eeSStephane Eranian	one sample per line.
39028f12eeSStephane Eranian
40028f12eeSStephane Eranian-x::
41028f12eeSStephane Eranian--field-separator::
42028f12eeSStephane Eranian	Specify the field separator used when dump raw samples (-D option). By default,
43028f12eeSStephane Eranian	The separator is the space character.
44028f12eeSStephane Eranian
45028f12eeSStephane Eranian-C::
46028f12eeSStephane Eranian--cpu-list::
47028f12eeSStephane Eranian	Restrict dump of raw samples to those provided via this option. Note that the same
48028f12eeSStephane Eranian	option can be passed in record mode. It will be interpreted the same way as perf
49028f12eeSStephane Eranian	record.
50028f12eeSStephane Eranian
51ad16511bSJiri Olsa-K::
52ad16511bSJiri Olsa--all-kernel::
53ad16511bSJiri Olsa	Configure all used events to run in kernel space.
54ad16511bSJiri Olsa
55ad16511bSJiri Olsa-U::
56ad16511bSJiri Olsa--all-user::
57ad16511bSJiri Olsa	Configure all used events to run in user space.
58ad16511bSJiri Olsa
59*b0d745b3SJiri Olsa--ldload::
60*b0d745b3SJiri Olsa	Specify desired latency for loads event.
61*b0d745b3SJiri Olsa
62028f12eeSStephane EranianSEE ALSO
63028f12eeSStephane Eranian--------
64028f12eeSStephane Eranianlinkperf:perf-record[1], linkperf:perf-report[1]
65