xref: /linux/tools/perf/Documentation/perf-mem.txt (revision 3138a2ef62667b6ac8eb5fb33a9e0b84ec3ab165)
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
31*3138a2efSSangwon Hong-i::
32*3138a2efSSangwon Hong--input=<file>::
33*3138a2efSSangwon Hong	Input file name.
34*3138a2efSSangwon Hong
357e99b197SSangwon Hong-f::
367e99b197SSangwon Hong--force::
377e99b197SSangwon Hong	Don't do ownership validation
387e99b197SSangwon Hong
39028f12eeSStephane Eranian-t::
40*3138a2efSSangwon Hong--type=<type>::
4167121f85SStephane Eranian	Select the memory operation type: load or store (default: load,store)
42028f12eeSStephane Eranian
43028f12eeSStephane Eranian-D::
44*3138a2efSSangwon Hong--dump-raw-samples::
45028f12eeSStephane Eranian	Dump the raw decoded samples on the screen in a format that is easy to parse with
46028f12eeSStephane Eranian	one sample per line.
47028f12eeSStephane Eranian
48028f12eeSStephane Eranian-x::
49*3138a2efSSangwon Hong--field-separator=<separator>::
50028f12eeSStephane Eranian	Specify the field separator used when dump raw samples (-D option). By default,
51028f12eeSStephane Eranian	The separator is the space character.
52028f12eeSStephane Eranian
53028f12eeSStephane Eranian-C::
54*3138a2efSSangwon Hong--cpu=<cpu>::
55*3138a2efSSangwon Hong	Monitor only on the list of CPUs provided. Multiple CPUs can be provided as a
56*3138a2efSSangwon Hong        comma-separated list with no space: 0,1. Ranges of CPUs are specified with -: 0-2. Default
57*3138a2efSSangwon Hong        is to monitor all CPUS.
58*3138a2efSSangwon Hong-U::
59*3138a2efSSangwon Hong--hide-unresolved::
60*3138a2efSSangwon Hong	Only display entries resolved to a symbol.
61*3138a2efSSangwon Hong
62*3138a2efSSangwon Hong-p::
63*3138a2efSSangwon Hong--phys-data::
64*3138a2efSSangwon Hong	Record/Report sample physical addresses
65*3138a2efSSangwon Hong
66*3138a2efSSangwon HongRECORD OPTIONS
67*3138a2efSSangwon Hong--------------
68*3138a2efSSangwon Hong-e::
69*3138a2efSSangwon Hong--event <event>::
70*3138a2efSSangwon Hong	Event selector. Use 'perf mem record -e list' to list available events.
71028f12eeSStephane Eranian
72ad16511bSJiri Olsa-K::
73ad16511bSJiri Olsa--all-kernel::
74ad16511bSJiri Olsa	Configure all used events to run in kernel space.
75ad16511bSJiri Olsa
76ad16511bSJiri Olsa-U::
77ad16511bSJiri Olsa--all-user::
78ad16511bSJiri Olsa	Configure all used events to run in user space.
79ad16511bSJiri Olsa
80*3138a2efSSangwon Hong-v::
81*3138a2efSSangwon Hong--verbose::
82*3138a2efSSangwon Hong	Be more verbose (show counter open errors, etc)
83b0d745b3SJiri Olsa
84*3138a2efSSangwon Hong--ldlat <n>::
85*3138a2efSSangwon Hong	Specify desired latency for loads event.
86c35aeb9dSKan Liang
87a7e9eab3SAndi KleenIn addition, for report all perf report options are valid, and for record
88a7e9eab3SAndi Kleenall perf record options.
89a7e9eab3SAndi Kleen
90028f12eeSStephane EranianSEE ALSO
91028f12eeSStephane Eranian--------
92028f12eeSStephane Eranianlinkperf:perf-record[1], linkperf:perf-report[1]
93