1 // SPDX-License-Identifier: GPL-2.0
3 * kernel/lockdep_proc.c
5 * Runtime locking correctness validator
7 * Started by Ingo Molnar:
9 * Copyright (C) 2006,2007 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
10 * Copyright (C) 2007 Red Hat, Inc., Peter Zijlstra
12 * Code for /proc/lockdep and /proc/lockdep_stats:
15 #include <linux/export.h>
16 #include <linux/proc_fs.h>
17 #include <linux/seq_file.h>
18 #include <linux/kallsyms.h>
19 #include <linux/debug_locks.h>
20 #include <linux/vmalloc.h>
21 #include <linux/sort.h>
22 #include <linux/uaccess.h>
23 #include <asm/div64.h>
25 #include "lockdep_internals.h"
27 static void *l_next(struct seq_file
*m
, void *v
, loff_t
*pos
)
29 return seq_list_next(v
, &all_lock_classes
, pos
);
32 static void *l_start(struct seq_file
*m
, loff_t
*pos
)
34 return seq_list_start_head(&all_lock_classes
, *pos
);
37 static void l_stop(struct seq_file
*m
, void *v
)
41 static void print_name(struct seq_file
*m
, struct lock_class
*class)
43 char str
[KSYM_NAME_LEN
];
44 const char *name
= class->name
;
47 name
= __get_key_name(class->key
, str
);
48 seq_printf(m
, "%s", name
);
50 seq_printf(m
, "%s", name
);
51 if (class->name_version
> 1)
52 seq_printf(m
, "#%d", class->name_version
);
54 seq_printf(m
, "/%d", class->subclass
);
58 static int l_show(struct seq_file
*m
, void *v
)
60 struct lock_class
*class = list_entry(v
, struct lock_class
, lock_entry
);
61 struct lock_list
*entry
;
62 char usage
[LOCK_USAGE_CHARS
];
64 if (v
== &all_lock_classes
) {
65 seq_printf(m
, "all lock classes:\n");
69 seq_printf(m
, "%p", class->key
);
70 #ifdef CONFIG_DEBUG_LOCKDEP
71 seq_printf(m
, " OPS:%8ld", debug_class_ops_read(class));
73 #ifdef CONFIG_PROVE_LOCKING
74 seq_printf(m
, " FD:%5ld", lockdep_count_forward_deps(class));
75 seq_printf(m
, " BD:%5ld", lockdep_count_backward_deps(class));
78 get_usage_chars(class, usage
);
79 seq_printf(m
, " %s", usage
);
85 list_for_each_entry(entry
, &class->locks_after
, entry
) {
86 if (entry
->distance
== 1) {
87 seq_printf(m
, " -> [%p] ", entry
->class->key
);
88 print_name(m
, entry
->class);
97 static const struct seq_operations lockdep_ops
= {
104 #ifdef CONFIG_PROVE_LOCKING
105 static void *lc_start(struct seq_file
*m
, loff_t
*pos
)
111 return SEQ_START_TOKEN
;
113 return lock_chains
+ (*pos
- 1);
116 static void *lc_next(struct seq_file
*m
, void *v
, loff_t
*pos
)
118 *pos
= lockdep_next_lockchain(*pos
- 1) + 1;
119 return lc_start(m
, pos
);
122 static void lc_stop(struct seq_file
*m
, void *v
)
126 static int lc_show(struct seq_file
*m
, void *v
)
128 struct lock_chain
*chain
= v
;
129 struct lock_class
*class;
132 if (v
== SEQ_START_TOKEN
) {
133 if (nr_chain_hlocks
> MAX_LOCKDEP_CHAIN_HLOCKS
)
134 seq_printf(m
, "(buggered) ");
135 seq_printf(m
, "all lock chains:\n");
139 seq_printf(m
, "irq_context: %d\n", chain
->irq_context
);
141 for (i
= 0; i
< chain
->depth
; i
++) {
142 class = lock_chain_get_class(chain
, i
);
146 seq_printf(m
, "[%p] ", class->key
);
147 print_name(m
, class);
155 static const struct seq_operations lockdep_chains_ops
= {
161 #endif /* CONFIG_PROVE_LOCKING */
163 static void lockdep_stats_debug_show(struct seq_file
*m
)
165 #ifdef CONFIG_DEBUG_LOCKDEP
166 unsigned long long hi1
= debug_atomic_read(hardirqs_on_events
),
167 hi2
= debug_atomic_read(hardirqs_off_events
),
168 hr1
= debug_atomic_read(redundant_hardirqs_on
),
169 hr2
= debug_atomic_read(redundant_hardirqs_off
),
170 si1
= debug_atomic_read(softirqs_on_events
),
171 si2
= debug_atomic_read(softirqs_off_events
),
172 sr1
= debug_atomic_read(redundant_softirqs_on
),
173 sr2
= debug_atomic_read(redundant_softirqs_off
);
175 seq_printf(m
, " chain lookup misses: %11llu\n",
176 debug_atomic_read(chain_lookup_misses
));
177 seq_printf(m
, " chain lookup hits: %11llu\n",
178 debug_atomic_read(chain_lookup_hits
));
179 seq_printf(m
, " cyclic checks: %11llu\n",
180 debug_atomic_read(nr_cyclic_checks
));
181 seq_printf(m
, " redundant checks: %11llu\n",
182 debug_atomic_read(nr_redundant_checks
));
183 seq_printf(m
, " redundant links: %11llu\n",
184 debug_atomic_read(nr_redundant
));
185 seq_printf(m
, " find-mask forwards checks: %11llu\n",
186 debug_atomic_read(nr_find_usage_forwards_checks
));
187 seq_printf(m
, " find-mask backwards checks: %11llu\n",
188 debug_atomic_read(nr_find_usage_backwards_checks
));
190 seq_printf(m
, " hardirq on events: %11llu\n", hi1
);
191 seq_printf(m
, " hardirq off events: %11llu\n", hi2
);
192 seq_printf(m
, " redundant hardirq ons: %11llu\n", hr1
);
193 seq_printf(m
, " redundant hardirq offs: %11llu\n", hr2
);
194 seq_printf(m
, " softirq on events: %11llu\n", si1
);
195 seq_printf(m
, " softirq off events: %11llu\n", si2
);
196 seq_printf(m
, " redundant softirq ons: %11llu\n", sr1
);
197 seq_printf(m
, " redundant softirq offs: %11llu\n", sr2
);
201 static int lockdep_stats_show(struct seq_file
*m
, void *v
)
203 unsigned long nr_unused
= 0, nr_uncategorized
= 0,
204 nr_irq_safe
= 0, nr_irq_unsafe
= 0,
205 nr_softirq_safe
= 0, nr_softirq_unsafe
= 0,
206 nr_hardirq_safe
= 0, nr_hardirq_unsafe
= 0,
207 nr_irq_read_safe
= 0, nr_irq_read_unsafe
= 0,
208 nr_softirq_read_safe
= 0, nr_softirq_read_unsafe
= 0,
209 nr_hardirq_read_safe
= 0, nr_hardirq_read_unsafe
= 0,
210 sum_forward_deps
= 0;
212 #ifdef CONFIG_PROVE_LOCKING
213 struct lock_class
*class;
215 list_for_each_entry(class, &all_lock_classes
, lock_entry
) {
217 if (class->usage_mask
== 0)
219 if (class->usage_mask
== LOCKF_USED
)
221 if (class->usage_mask
& LOCKF_USED_IN_IRQ
)
223 if (class->usage_mask
& LOCKF_ENABLED_IRQ
)
225 if (class->usage_mask
& LOCKF_USED_IN_SOFTIRQ
)
227 if (class->usage_mask
& LOCKF_ENABLED_SOFTIRQ
)
229 if (class->usage_mask
& LOCKF_USED_IN_HARDIRQ
)
231 if (class->usage_mask
& LOCKF_ENABLED_HARDIRQ
)
233 if (class->usage_mask
& LOCKF_USED_IN_IRQ_READ
)
235 if (class->usage_mask
& LOCKF_ENABLED_IRQ_READ
)
236 nr_irq_read_unsafe
++;
237 if (class->usage_mask
& LOCKF_USED_IN_SOFTIRQ_READ
)
238 nr_softirq_read_safe
++;
239 if (class->usage_mask
& LOCKF_ENABLED_SOFTIRQ_READ
)
240 nr_softirq_read_unsafe
++;
241 if (class->usage_mask
& LOCKF_USED_IN_HARDIRQ_READ
)
242 nr_hardirq_read_safe
++;
243 if (class->usage_mask
& LOCKF_ENABLED_HARDIRQ_READ
)
244 nr_hardirq_read_unsafe
++;
246 sum_forward_deps
+= lockdep_count_forward_deps(class);
248 #ifdef CONFIG_DEBUG_LOCKDEP
249 DEBUG_LOCKS_WARN_ON(debug_atomic_read(nr_unused_locks
) != nr_unused
);
253 seq_printf(m
, " lock-classes: %11lu [max: %lu]\n",
254 nr_lock_classes
, MAX_LOCKDEP_KEYS
);
255 seq_printf(m
, " direct dependencies: %11lu [max: %lu]\n",
256 nr_list_entries
, MAX_LOCKDEP_ENTRIES
);
257 seq_printf(m
, " indirect dependencies: %11lu\n",
261 * Total number of dependencies:
263 * All irq-safe locks may nest inside irq-unsafe locks,
264 * plus all the other known dependencies:
266 seq_printf(m
, " all direct dependencies: %11lu\n",
267 nr_irq_unsafe
* nr_irq_safe
+
268 nr_hardirq_unsafe
* nr_hardirq_safe
+
271 #ifdef CONFIG_PROVE_LOCKING
272 seq_printf(m
, " dependency chains: %11lu [max: %lu]\n",
273 lock_chain_count(), MAX_LOCKDEP_CHAINS
);
274 seq_printf(m
, " dependency chain hlocks: %11d [max: %lu]\n",
275 nr_chain_hlocks
, MAX_LOCKDEP_CHAIN_HLOCKS
);
278 #ifdef CONFIG_TRACE_IRQFLAGS
279 seq_printf(m
, " in-hardirq chains: %11u\n",
281 seq_printf(m
, " in-softirq chains: %11u\n",
284 seq_printf(m
, " in-process chains: %11u\n",
286 seq_printf(m
, " stack-trace entries: %11lu [max: %lu]\n",
287 nr_stack_trace_entries
, MAX_STACK_TRACE_ENTRIES
);
288 #if defined(CONFIG_TRACE_IRQFLAGS) && defined(CONFIG_PROVE_LOCKING)
289 seq_printf(m
, " number of stack traces: %11llu\n",
290 lockdep_stack_trace_count());
291 seq_printf(m
, " number of stack hash chains: %11llu\n",
292 lockdep_stack_hash_count());
294 seq_printf(m
, " combined max dependencies: %11u\n",
295 (nr_hardirq_chains
+ 1) *
296 (nr_softirq_chains
+ 1) *
297 (nr_process_chains
+ 1)
299 seq_printf(m
, " hardirq-safe locks: %11lu\n",
301 seq_printf(m
, " hardirq-unsafe locks: %11lu\n",
303 seq_printf(m
, " softirq-safe locks: %11lu\n",
305 seq_printf(m
, " softirq-unsafe locks: %11lu\n",
307 seq_printf(m
, " irq-safe locks: %11lu\n",
309 seq_printf(m
, " irq-unsafe locks: %11lu\n",
312 seq_printf(m
, " hardirq-read-safe locks: %11lu\n",
313 nr_hardirq_read_safe
);
314 seq_printf(m
, " hardirq-read-unsafe locks: %11lu\n",
315 nr_hardirq_read_unsafe
);
316 seq_printf(m
, " softirq-read-safe locks: %11lu\n",
317 nr_softirq_read_safe
);
318 seq_printf(m
, " softirq-read-unsafe locks: %11lu\n",
319 nr_softirq_read_unsafe
);
320 seq_printf(m
, " irq-read-safe locks: %11lu\n",
322 seq_printf(m
, " irq-read-unsafe locks: %11lu\n",
325 seq_printf(m
, " uncategorized locks: %11lu\n",
327 seq_printf(m
, " unused locks: %11lu\n",
329 seq_printf(m
, " max locking depth: %11u\n",
331 #ifdef CONFIG_PROVE_LOCKING
332 seq_printf(m
, " max bfs queue depth: %11u\n",
333 max_bfs_queue_depth
);
335 lockdep_stats_debug_show(m
);
336 seq_printf(m
, " debug_locks: %11u\n",
342 #ifdef CONFIG_LOCK_STAT
344 struct lock_stat_data
{
345 struct lock_class
*class;
346 struct lock_class_stats stats
;
349 struct lock_stat_seq
{
350 struct lock_stat_data
*iter_end
;
351 struct lock_stat_data stats
[MAX_LOCKDEP_KEYS
];
355 * sort on absolute number of contentions
357 static int lock_stat_cmp(const void *l
, const void *r
)
359 const struct lock_stat_data
*dl
= l
, *dr
= r
;
360 unsigned long nl
, nr
;
362 nl
= dl
->stats
.read_waittime
.nr
+ dl
->stats
.write_waittime
.nr
;
363 nr
= dr
->stats
.read_waittime
.nr
+ dr
->stats
.write_waittime
.nr
;
368 static void seq_line(struct seq_file
*m
, char c
, int offset
, int length
)
372 for (i
= 0; i
< offset
; i
++)
374 for (i
= 0; i
< length
; i
++)
375 seq_printf(m
, "%c", c
);
379 static void snprint_time(char *buf
, size_t bufsiz
, s64 nr
)
384 nr
+= 5; /* for display rounding */
385 div
= div_s64_rem(nr
, 1000, &rem
);
386 snprintf(buf
, bufsiz
, "%lld.%02d", (long long)div
, (int)rem
/10);
389 static void seq_time(struct seq_file
*m
, s64 time
)
393 snprint_time(num
, sizeof(num
), time
);
394 seq_printf(m
, " %14s", num
);
397 static void seq_lock_time(struct seq_file
*m
, struct lock_time
*lt
)
399 seq_printf(m
, "%14lu", lt
->nr
);
400 seq_time(m
, lt
->min
);
401 seq_time(m
, lt
->max
);
402 seq_time(m
, lt
->total
);
403 seq_time(m
, lt
->nr
? div_s64(lt
->total
, lt
->nr
) : 0);
406 static void seq_stats(struct seq_file
*m
, struct lock_stat_data
*data
)
408 const struct lockdep_subclass_key
*ckey
;
409 struct lock_class_stats
*stats
;
410 struct lock_class
*class;
416 stats
= &data
->stats
;
419 if (class->name_version
> 1)
420 namelen
-= 2; /* XXX truncates versions > 9 */
424 rcu_read_lock_sched();
425 cname
= rcu_dereference_sched(class->name
);
426 ckey
= rcu_dereference_sched(class->key
);
428 if (!cname
&& !ckey
) {
429 rcu_read_unlock_sched();
433 char str
[KSYM_NAME_LEN
];
434 const char *key_name
;
436 key_name
= __get_key_name(ckey
, str
);
437 snprintf(name
, namelen
, "%s", key_name
);
439 snprintf(name
, namelen
, "%s", cname
);
441 rcu_read_unlock_sched();
443 namelen
= strlen(name
);
444 if (class->name_version
> 1) {
445 snprintf(name
+namelen
, 3, "#%d", class->name_version
);
448 if (class->subclass
) {
449 snprintf(name
+namelen
, 3, "/%d", class->subclass
);
453 if (stats
->write_holdtime
.nr
) {
454 if (stats
->read_holdtime
.nr
)
455 seq_printf(m
, "%38s-W:", name
);
457 seq_printf(m
, "%40s:", name
);
459 seq_printf(m
, "%14lu ", stats
->bounces
[bounce_contended_write
]);
460 seq_lock_time(m
, &stats
->write_waittime
);
461 seq_printf(m
, " %14lu ", stats
->bounces
[bounce_acquired_write
]);
462 seq_lock_time(m
, &stats
->write_holdtime
);
466 if (stats
->read_holdtime
.nr
) {
467 seq_printf(m
, "%38s-R:", name
);
468 seq_printf(m
, "%14lu ", stats
->bounces
[bounce_contended_read
]);
469 seq_lock_time(m
, &stats
->read_waittime
);
470 seq_printf(m
, " %14lu ", stats
->bounces
[bounce_acquired_read
]);
471 seq_lock_time(m
, &stats
->read_holdtime
);
475 if (stats
->read_waittime
.nr
+ stats
->write_waittime
.nr
== 0)
478 if (stats
->read_holdtime
.nr
)
481 for (i
= 0; i
< LOCKSTAT_POINTS
; i
++) {
484 if (class->contention_point
[i
] == 0)
488 seq_line(m
, '-', 40-namelen
, namelen
);
490 snprintf(ip
, sizeof(ip
), "[<%p>]",
491 (void *)class->contention_point
[i
]);
492 seq_printf(m
, "%40s %14lu %29s %pS\n",
493 name
, stats
->contention_point
[i
],
494 ip
, (void *)class->contention_point
[i
]);
496 for (i
= 0; i
< LOCKSTAT_POINTS
; i
++) {
499 if (class->contending_point
[i
] == 0)
503 seq_line(m
, '-', 40-namelen
, namelen
);
505 snprintf(ip
, sizeof(ip
), "[<%p>]",
506 (void *)class->contending_point
[i
]);
507 seq_printf(m
, "%40s %14lu %29s %pS\n",
508 name
, stats
->contending_point
[i
],
509 ip
, (void *)class->contending_point
[i
]);
513 seq_line(m
, '.', 0, 40 + 1 + 12 * (14 + 1));
518 static void seq_header(struct seq_file
*m
)
520 seq_puts(m
, "lock_stat version 0.4\n");
522 if (unlikely(!debug_locks
))
523 seq_printf(m
, "*WARNING* lock debugging disabled!! - possibly due to a lockdep warning\n");
525 seq_line(m
, '-', 0, 40 + 1 + 12 * (14 + 1));
526 seq_printf(m
, "%40s %14s %14s %14s %14s %14s %14s %14s %14s %14s %14s "
541 seq_line(m
, '-', 0, 40 + 1 + 12 * (14 + 1));
545 static void *ls_start(struct seq_file
*m
, loff_t
*pos
)
547 struct lock_stat_seq
*data
= m
->private;
548 struct lock_stat_data
*iter
;
551 return SEQ_START_TOKEN
;
553 iter
= data
->stats
+ (*pos
- 1);
554 if (iter
>= data
->iter_end
)
560 static void *ls_next(struct seq_file
*m
, void *v
, loff_t
*pos
)
563 return ls_start(m
, pos
);
566 static void ls_stop(struct seq_file
*m
, void *v
)
570 static int ls_show(struct seq_file
*m
, void *v
)
572 if (v
== SEQ_START_TOKEN
)
580 static const struct seq_operations lockstat_ops
= {
587 static int lock_stat_open(struct inode
*inode
, struct file
*file
)
590 struct lock_class
*class;
591 struct lock_stat_seq
*data
= vmalloc(sizeof(struct lock_stat_seq
));
596 res
= seq_open(file
, &lockstat_ops
);
598 struct lock_stat_data
*iter
= data
->stats
;
599 struct seq_file
*m
= file
->private_data
;
601 list_for_each_entry(class, &all_lock_classes
, lock_entry
) {
603 iter
->stats
= lock_stats(class);
606 data
->iter_end
= iter
;
608 sort(data
->stats
, data
->iter_end
- data
->stats
,
609 sizeof(struct lock_stat_data
),
610 lock_stat_cmp
, NULL
);
619 static ssize_t
lock_stat_write(struct file
*file
, const char __user
*buf
,
620 size_t count
, loff_t
*ppos
)
622 struct lock_class
*class;
626 if (get_user(c
, buf
))
632 list_for_each_entry(class, &all_lock_classes
, lock_entry
)
633 clear_lock_stats(class);
638 static int lock_stat_release(struct inode
*inode
, struct file
*file
)
640 struct seq_file
*seq
= file
->private_data
;
643 return seq_release(inode
, file
);
646 static const struct proc_ops lock_stat_proc_ops
= {
647 .proc_open
= lock_stat_open
,
648 .proc_write
= lock_stat_write
,
649 .proc_read
= seq_read
,
650 .proc_lseek
= seq_lseek
,
651 .proc_release
= lock_stat_release
,
653 #endif /* CONFIG_LOCK_STAT */
655 static int __init
lockdep_proc_init(void)
657 proc_create_seq("lockdep", S_IRUSR
, NULL
, &lockdep_ops
);
658 #ifdef CONFIG_PROVE_LOCKING
659 proc_create_seq("lockdep_chains", S_IRUSR
, NULL
, &lockdep_chains_ops
);
661 proc_create_single("lockdep_stats", S_IRUSR
, NULL
, lockdep_stats_show
);
662 #ifdef CONFIG_LOCK_STAT
663 proc_create("lock_stat", S_IRUSR
| S_IWUSR
, NULL
, &lock_stat_proc_ops
);
669 __initcall(lockdep_proc_init
);