1 perf-lock(1)
2 ============
3
4 NAME
5 ----
6 perf-lock - Analyze lock events
7
8 SYNOPSIS
9 --------
10 [verse]
11 'perf lock' {record|report|script|info|content
12
13 DESCRIPTION
14 -----------
15 You can analyze various lock behaviours
16 and statistics with this 'perf lock' command.
17
18 'perf lock record <command>' records lock ev
19 between start and end <command>. And this co
20 produces the file "perf.data" which contains
21 results of lock events.
22
23 'perf lock report' reports statistical data.
24
25 'perf lock script' shows raw lock events.
26
27 'perf lock info' shows metadata like threads
28 of lock instances.
29
30 'perf lock contention' shows contention stat
31
32 COMMON OPTIONS
33 --------------
34
35 -i::
36 --input=<file>::
37 Input file name. (default: perf.data u
38
39 --output=<file>::
40 Output file name for perf lock content
41
42 -v::
43 --verbose::
44 Be more verbose (show symbol address,
45
46 -q::
47 --quiet::
48 Do not show any warnings or messages.
49
50 -D::
51 --dump-raw-trace::
52 Dump raw trace in ASCII.
53
54 -f::
55 --force::
56 Don't complain, do it.
57
58 --vmlinux=<file>::
59 vmlinux pathname
60
61 --kallsyms=<file>::
62 kallsyms pathname
63
64
65 REPORT OPTIONS
66 --------------
67
68 -k::
69 --key=<value>::
70 Sorting key. Possible values: acquired
71 avg_wait, wait_total, wait_max, wait_m
72
73 -F::
74 --field=<value>::
75 Output fields. By default it shows all
76 customize that using this. Possible v
77 avg_wait, wait_total, wait_max, wait_m
78
79 -c::
80 --combine-locks::
81 Merge lock instances in the same class
82
83 -t::
84 --threads::
85 The -t option is to show per-thread lock s
86
87 $ perf lock report -t -F acquired,conten
88
89 Name acquired contended
90
91 perf 240569 9
92 swapper 106610 19
93 :15789 17370 2
94 ContainerMgr 8981 6
95 sleep 5275 1
96 ContainerThread 4416 4
97 RootPressureThr 3215 5
98 rcu_preempt 2954 0
99 ContainerMgr 2560 0
100 unnamed 1873 0
101 EventManager_De 1845 1
102 futex-default-S 1609 0
103
104 -E::
105 --entries=<value>::
106 Display this many entries.
107
108
109 INFO OPTIONS
110 ------------
111
112 -t::
113 --threads::
114 dump only the thread list in perf.data
115
116 -m::
117 --map::
118 dump only the map of lock instances (a
119
120
121 CONTENTION OPTIONS
122 ------------------
123
124 -k::
125 --key=<value>::
126 Sorting key. Possible values: contende
127 wait_max, wait_min, avg_wait.
128
129 -F::
130 --field=<value>::
131 Output fields. By default it shows all
132 and users can customize that using thi
133 contended, wait_total, wait_max, wait_
134
135 -t::
136 --threads::
137 Show per-thread lock contention stat
138
139 -b::
140 --use-bpf::
141 Use BPF program to collect lock conten
142 using the input data.
143
144 -a::
145 --all-cpus::
146 System-wide collection from all CPUs.
147
148 -C::
149 --cpu=<value>::
150 Collect samples only on the list of CP
151 provided as a comma-separated list wit
152 are specified with -: 0-2. Default is
153
154 -p::
155 --pid=<value>::
156 Record events on existing process ID (
157
158 --tid=<value>::
159 Record events on existing thread ID (c
160
161 -M::
162 --map-nr-entries=<value>::
163 Maximum number of BPF map entries (def
164 This will be aligned to a power of 2.
165
166 --max-stack=<value>::
167 Maximum stack depth when collecting lo
168
169 --stack-skip=<value>::
170 Number of stack depth to skip when fin
171
172 -E::
173 --entries=<value>::
174 Display this many entries.
175
176 -l::
177 --lock-addr::
178 Show lock contention stat by address
179
180 -o::
181 --lock-owner::
182 Show lock contention stat by owners.
183 requires --use-bpf.
184
185 -Y::
186 --type-filter=<value>::
187 Show lock contention only for given lo
188 Available values are:
189 semaphore, spinlock, rwlock, rwlock:
190 rtmutex, rwlock-rt, rwlock-rt:R, rwl
191 mutex
192
193 Note that RW-variant of locks have :R
194 suffix are shortcuts for the both vari
195
196 -L::
197 --lock-filter=<value>::
198 Show lock contention only for given lo
199
200 -S::
201 --callstack-filter=<value>::
202 Show lock contention only if the calls
203 Note that it matches the substring so
204 and 'irq_enter_rcu'.
205
206 -x::
207 --field-separator=<SEP>::
208 Show results using a CSV-style output
209 into spreadsheets. Columns are separat
210
211 --lock-cgroup::
212 Show lock contention stat by cgroup.
213
214 -G::
215 --cgroup-filter=<value>::
216 Show lock contention only in the given
217
218
219 SEE ALSO
220 --------
221 linkperf:perf[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.