1 perf-mem(1) 1 perf-mem(1)
2 =========== 2 ===========
3 3
4 NAME 4 NAME
5 ---- 5 ----
6 perf-mem - Profile memory accesses 6 perf-mem - Profile memory accesses
7 7
8 SYNOPSIS 8 SYNOPSIS
9 -------- 9 --------
10 [verse] 10 [verse]
11 'perf mem' [<options>] (record [<command>] | r 11 'perf mem' [<options>] (record [<command>] | report)
12 12
13 DESCRIPTION 13 DESCRIPTION
14 ----------- 14 -----------
15 "perf mem record" runs a command and gathers m 15 "perf mem record" runs a command and gathers memory operation data
16 from it, into perf.data. Perf record options a 16 from it, into perf.data. Perf record options are accepted and are passed through.
17 17
18 "perf mem report" displays the result. It invo 18 "perf mem report" displays the result. It invokes perf report with the
19 right set of options to display a memory acces 19 right set of options to display a memory access profile. By default, loads
20 and stores are sampled. Use the -t option to l 20 and stores are sampled. Use the -t option to limit to loads or stores.
21 21
22 Note that on Intel systems the memory latency 22 Note that on Intel systems the memory latency reported is the use-latency,
23 not the pure load (or store latency). Use late 23 not the pure load (or store latency). Use latency includes any pipeline
24 queuing delays in addition to the memory subsy !! 24 queueing delays in addition to the memory subsystem latency.
25 25
26 On Arm64 this uses SPE to sample load and stor 26 On Arm64 this uses SPE to sample load and store operations, therefore hardware
27 and kernel support is required. See linkperf:p 27 and kernel support is required. See linkperf:perf-arm-spe[1] for a setup guide.
28 Due to the statistical nature of SPE sampling, 28 Due to the statistical nature of SPE sampling, not every memory operation will
29 be sampled. 29 be sampled.
30 30
31 COMMON OPTIONS !! 31 OPTIONS
32 -------------- !! 32 -------
>> 33 <command>...::
>> 34 Any command you can specify in a shell.
>> 35
>> 36 -i::
>> 37 --input=<file>::
>> 38 Input file name.
>> 39
33 -f:: 40 -f::
34 --force:: 41 --force::
35 Don't do ownership validation 42 Don't do ownership validation
36 43
37 -t:: 44 -t::
38 --type=<type>:: 45 --type=<type>::
39 Select the memory operation type: load 46 Select the memory operation type: load or store (default: load,store)
40 47
41 -v:: !! 48 -D::
42 --verbose:: !! 49 --dump-raw-samples::
43 Be more verbose (show counter open err !! 50 Dump the raw decoded samples on the screen in a format that is easy to parse with
>> 51 one sample per line.
>> 52
>> 53 -x::
>> 54 --field-separator=<separator>::
>> 55 Specify the field separator used when dump raw samples (-D option). By default,
>> 56 The separator is the space character.
>> 57
>> 58 -C::
>> 59 --cpu=<cpu>::
>> 60 Monitor only on the list of CPUs provided. Multiple CPUs can be provided as a
>> 61 comma-separated list with no space: 0,1. Ranges of CPUs are specified with -: 0-2. Default
>> 62 is to monitor all CPUS.
>> 63 -U::
>> 64 --hide-unresolved::
>> 65 Only display entries resolved to a symbol.
44 66
45 -p:: 67 -p::
46 --phys-data:: 68 --phys-data::
47 Record/Report sample physical addresse 69 Record/Report sample physical addresses
48 70
49 --data-page-size:: 71 --data-page-size::
50 Record/Report sample data address page 72 Record/Report sample data address page size
51 73
52 RECORD OPTIONS 74 RECORD OPTIONS
53 -------------- 75 --------------
54 <command>...:: <<
55 Any command you can specify in a shell <<
56 <<
57 -e:: 76 -e::
58 --event <event>:: 77 --event <event>::
59 Event selector. Use 'perf mem record - 78 Event selector. Use 'perf mem record -e list' to list available events.
60 79
61 -K:: 80 -K::
62 --all-kernel:: 81 --all-kernel::
63 Configure all used events to run in ke 82 Configure all used events to run in kernel space.
64 83
65 -U:: 84 -U::
66 --all-user:: 85 --all-user::
67 Configure all used events to run in us 86 Configure all used events to run in user space.
68 87
>> 88 -v::
>> 89 --verbose::
>> 90 Be more verbose (show counter open errors, etc)
>> 91
69 --ldlat <n>:: 92 --ldlat <n>::
70 Specify desired latency for loads even 93 Specify desired latency for loads event. Supported on Intel and Arm64
71 processors only. Ignored on other arch 94 processors only. Ignored on other archs.
72 <<
73 REPORT OPTIONS <<
74 -------------- <<
75 -i:: <<
76 --input=<file>:: <<
77 Input file name. <<
78 <<
79 -C:: <<
80 --cpu=<cpu>:: <<
81 Monitor only on the list of CPUs provi <<
82 comma-separated list with no space: 0, <<
83 like 0-2. Default is to monitor all CP <<
84 <<
85 -D:: <<
86 --dump-raw-samples:: <<
87 Dump the raw decoded samples on the sc <<
88 one sample per line. <<
89 <<
90 -s:: <<
91 --sort=<key>:: <<
92 Group result by given key(s) - multipl <<
93 in CSV format. The keys are specific <<
94 symbol_daddr, symbol_iaddr, dso_daddr, <<
95 dcacheline, phys_daddr, data_page_size <<
96 <<
97 - symbol_daddr: name of data symbol be <<
98 - symbol_iaddr: name of code symbol be <<
99 - dso_daddr: name of library or module <<
100 on at the time of the sam <<
101 - locked: whether the bus was locked a <<
102 - tlb: type of tlb access for the data <<
103 - mem: type of memory access for the d <<
104 - snoop: type of snoop (if any) for th <<
105 - dcacheline: the cacheline the data a <<
106 - phys_daddr: physical address of data <<
107 - data_page_size: the data page size o <<
108 - blocked: reason of blocked load acce <<
109 <<
110 And the default sort keys are changed <<
111 symbol_daddr, dso_daddr, snoop, tlb, l <<
112 <<
113 -T:: <<
114 --type-profile:: <<
115 Show data-type profile result instead <<
116 the debug information and it will chan <<
117 mem, snoop, tlb, type. <<
118 <<
119 -U:: <<
120 --hide-unresolved:: <<
121 Only display entries resolved to a sym <<
122 <<
123 -x:: <<
124 --field-separator=<separator>:: <<
125 Specify the field separator used when <<
126 The separator is the space character. <<
127 95
128 In addition, for report all perf report option 96 In addition, for report all perf report options are valid, and for record
129 all perf record options. 97 all perf record options.
130 98
131 SEE ALSO 99 SEE ALSO
132 -------- 100 --------
133 linkperf:perf-record[1], linkperf:perf-report[ 101 linkperf:perf-record[1], linkperf:perf-report[1], linkperf:perf-arm-spe[1]
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.