xref: /openbmc/linux/tools/perf/Documentation/perf-mem.txt (revision e33bbe69149b802c0c77bfb822685772f85388ca)
1perf-mem(1)
2===========
3
4NAME
5----
6perf-mem - Profile memory accesses
7
8SYNOPSIS
9--------
10[verse]
11'perf mem' [<options>] (record [<command>] | report)
12
13DESCRIPTION
14-----------
15"perf mem record" runs a command and gathers memory operation data
16from it, into perf.data. Perf record options are accepted and are passed through.
17
18"perf mem report" displays the result. It invokes perf report with the
19right set of options to display a memory access profile. By default, loads
20and stores are sampled. Use the -t option to limit to loads or stores.
21
22Note that on Intel systems the memory latency reported is the use-latency,
23not the pure load (or store latency). Use latency includes any pipeline
24queueing delays in addition to the memory subsystem latency.
25
26OPTIONS
27-------
28<command>...::
29	Any command you can specify in a shell.
30
31-f::
32--force::
33	Don't do ownership validation
34
35-t::
36--type=::
37	Select the memory operation type: load or store (default: load,store)
38
39-D::
40--dump-raw-samples=::
41	Dump the raw decoded samples on the screen in a format that is easy to parse with
42	one sample per line.
43
44-x::
45--field-separator::
46	Specify the field separator used when dump raw samples (-D option). By default,
47	The separator is the space character.
48
49-C::
50--cpu-list::
51	Restrict dump of raw samples to those provided via this option. Note that the same
52	option can be passed in record mode. It will be interpreted the same way as perf
53	record.
54
55-K::
56--all-kernel::
57	Configure all used events to run in kernel space.
58
59-U::
60--all-user::
61	Configure all used events to run in user space.
62
63--ldload::
64	Specify desired latency for loads event.
65
66-p::
67--phys-data::
68	Record/Report sample physical addresses
69
70In addition, for report all perf report options are valid, and for record
71all perf record options.
72
73SEE ALSO
74--------
75linkperf:perf-record[1], linkperf:perf-report[1]
76