xref: /linux/tools/perf/Documentation/perf-mem.txt (revision b63940970492f5f187d546e191bc2c6831491fe3)
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-----------
15028f12eeSStephane Eranian"perf mem -t <TYPE> 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
18028f12eeSStephane Eranian"perf mem -t <TYPE> report" displays the result. It invokes perf report with the
19028f12eeSStephane Eranianright set of options to display a memory access profile.
20028f12eeSStephane Eranian
21*b6394097SAndi KleenNote that on Intel systems the memory latency reported is the use-latency,
22*b6394097SAndi Kleennot the pure load (or store latency). Use latency includes any pipeline
23*b6394097SAndi Kleenqueueing delays in addition to the memory subsystem latency.
24*b6394097SAndi Kleen
25028f12eeSStephane EranianOPTIONS
26028f12eeSStephane Eranian-------
27028f12eeSStephane Eranian<command>...::
28028f12eeSStephane Eranian	Any command you can specify in a shell.
29028f12eeSStephane Eranian
30028f12eeSStephane Eranian-t::
31028f12eeSStephane Eranian--type=::
32028f12eeSStephane Eranian	Select the memory operation type: load or store (default: load)
33028f12eeSStephane Eranian
34028f12eeSStephane Eranian-D::
35028f12eeSStephane Eranian--dump-raw-samples=::
36028f12eeSStephane Eranian	Dump the raw decoded samples on the screen in a format that is easy to parse with
37028f12eeSStephane Eranian	one sample per line.
38028f12eeSStephane Eranian
39028f12eeSStephane Eranian-x::
40028f12eeSStephane Eranian--field-separator::
41028f12eeSStephane Eranian	Specify the field separator used when dump raw samples (-D option). By default,
42028f12eeSStephane Eranian	The separator is the space character.
43028f12eeSStephane Eranian
44028f12eeSStephane Eranian-C::
45028f12eeSStephane Eranian--cpu-list::
46028f12eeSStephane Eranian	Restrict dump of raw samples to those provided via this option. Note that the same
47028f12eeSStephane Eranian	option can be passed in record mode. It will be interpreted the same way as perf
48028f12eeSStephane Eranian	record.
49028f12eeSStephane Eranian
50028f12eeSStephane EranianSEE ALSO
51028f12eeSStephane Eranian--------
52028f12eeSStephane Eranianlinkperf:perf-record[1], linkperf:perf-report[1]
53