2 * Copyright (c) 2006 John Baldwin <jhb@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * This module holds the global variables and functions used to maintain
29 * lock_object structures.
32 #include <sys/cdefs.h>
33 __FBSDID("$FreeBSD$");
36 #include "opt_mprof.h"
38 #include <sys/param.h>
39 #include <sys/systm.h>
40 #include <sys/kernel.h>
43 #include <sys/lock_profile.h>
44 #include <sys/malloc.h>
45 #include <sys/mutex.h>
49 #include <sys/sched.h>
51 #include <sys/sysctl.h>
57 #include <machine/cpufunc.h>
59 CTASSERT(LOCK_CLASS_MAX == 15);
61 struct lock_class *lock_classes[LOCK_CLASS_MAX + 1] = {
63 &lock_class_mtx_sleep,
66 &lock_class_rm_sleepable,
72 lock_init(struct lock_object *lock, struct lock_class *class, const char *name,
73 const char *type, int flags)
77 /* Check for double-init and zero object. */
78 KASSERT(!lock_initalized(lock), ("lock \"%s\" %p already initialized",
81 /* Look up lock class to find its index. */
82 for (i = 0; i < LOCK_CLASS_MAX; i++)
83 if (lock_classes[i] == class) {
84 lock->lo_flags = i << LO_CLASSSHIFT;
87 KASSERT(i < LOCK_CLASS_MAX, ("unknown lock class %p", class));
89 /* Initialize the lock object. */
91 lock->lo_flags |= flags | LO_INITIALIZED;
92 LOCK_LOG_INIT(lock, 0);
93 WITNESS_INIT(lock, (type != NULL) ? type : name);
97 lock_destroy(struct lock_object *lock)
100 KASSERT(lock_initalized(lock), ("lock %p is not initialized", lock));
101 WITNESS_DESTROY(lock);
102 LOCK_LOG_DESTROY(lock, 0);
103 lock->lo_flags &= ~LO_INITIALIZED;
107 DB_SHOW_COMMAND(lock, db_show_lock)
109 struct lock_object *lock;
110 struct lock_class *class;
114 lock = (struct lock_object *)addr;
115 if (LO_CLASSINDEX(lock) > LOCK_CLASS_MAX) {
116 db_printf("Unknown lock class: %d\n", LO_CLASSINDEX(lock));
119 class = LOCK_CLASS(lock);
120 db_printf(" class: %s\n", class->lc_name);
121 db_printf(" name: %s\n", lock->lo_name);
122 class->lc_ddb_show(lock);
126 #ifdef LOCK_PROFILING
129 * One object per-thread for each lock the thread owns. Tracks individual
132 struct lock_profile_object {
133 LIST_ENTRY(lock_profile_object) lpo_link;
134 struct lock_object *lpo_obj;
135 const char *lpo_file;
139 uint64_t lpo_acqtime;
140 uint64_t lpo_waittime;
141 u_int lpo_contest_locking;
145 * One lock_prof for each (file, line, lock object) triple.
148 SLIST_ENTRY(lock_prof) link;
149 struct lock_class *class;
154 uintmax_t cnt_wait_max;
159 uintmax_t cnt_contest_locking;
162 SLIST_HEAD(lphead, lock_prof);
164 #define LPROF_HASH_SIZE 4096
165 #define LPROF_HASH_MASK (LPROF_HASH_SIZE - 1)
166 #define LPROF_CACHE_SIZE 4096
169 * Array of objects and profs for each type of object for each cpu. Spinlocks
170 * are handled separately because a thread may be preempted and acquire a
171 * spinlock while in the lock profiling code of a non-spinlock. In this way
172 * we only need a critical section to protect the per-cpu lists.
174 struct lock_prof_type {
175 struct lphead lpt_lpalloc;
176 struct lpohead lpt_lpoalloc;
177 struct lphead lpt_hash[LPROF_HASH_SIZE];
178 struct lock_prof lpt_prof[LPROF_CACHE_SIZE];
179 struct lock_profile_object lpt_objs[LPROF_CACHE_SIZE];
182 struct lock_prof_cpu {
183 struct lock_prof_type lpc_types[2]; /* One for spin one for other. */
186 struct lock_prof_cpu *lp_cpu[MAXCPU];
188 volatile int lock_prof_enable = 0;
189 static volatile int lock_prof_resetting;
191 #define LPROF_SBUF_SIZE 256
193 static int lock_prof_rejected;
194 static int lock_prof_skipspin;
195 static int lock_prof_skipcount;
197 #ifndef USE_CPU_NANOSECONDS
205 /* From bintime2timespec */
206 ns = bt.sec * (uint64_t)1000000000;
207 ns += ((uint64_t)1000000000 * (uint32_t)(bt.frac >> 32)) >> 32;
213 lock_prof_init_type(struct lock_prof_type *type)
217 SLIST_INIT(&type->lpt_lpalloc);
218 LIST_INIT(&type->lpt_lpoalloc);
219 for (i = 0; i < LPROF_CACHE_SIZE; i++) {
220 SLIST_INSERT_HEAD(&type->lpt_lpalloc, &type->lpt_prof[i],
222 LIST_INSERT_HEAD(&type->lpt_lpoalloc, &type->lpt_objs[i],
228 lock_prof_init(void *arg)
232 for (cpu = 0; cpu <= mp_maxid; cpu++) {
233 lp_cpu[cpu] = malloc(sizeof(*lp_cpu[cpu]), M_DEVBUF,
235 lock_prof_init_type(&lp_cpu[cpu]->lpc_types[0]);
236 lock_prof_init_type(&lp_cpu[cpu]->lpc_types[1]);
239 SYSINIT(lockprof, SI_SUB_SMP, SI_ORDER_ANY, lock_prof_init, NULL);
242 lock_prof_reset_wait(void)
246 * Spin relinquishing our cpu so that quiesce_all_cpus may
249 while (lock_prof_resetting)
250 sched_relinquish(curthread);
254 lock_prof_reset(void)
256 struct lock_prof_cpu *lpc;
260 * We not only race with acquiring and releasing locks but also
261 * thread exit. To be certain that threads exit without valid head
262 * pointers they must see resetting set before enabled is cleared.
263 * Otherwise a lock may not be removed from a per-thread list due
264 * to disabled being set but not wait for reset() to remove it below.
266 atomic_store_rel_int(&lock_prof_resetting, 1);
267 enabled = lock_prof_enable;
268 lock_prof_enable = 0;
269 quiesce_all_cpus("profreset", 0);
271 * Some objects may have migrated between CPUs. Clear all links
272 * before we zero the structures. Some items may still be linked
273 * into per-thread lists as well.
275 for (cpu = 0; cpu <= mp_maxid; cpu++) {
277 for (i = 0; i < LPROF_CACHE_SIZE; i++) {
278 LIST_REMOVE(&lpc->lpc_types[0].lpt_objs[i], lpo_link);
279 LIST_REMOVE(&lpc->lpc_types[1].lpt_objs[i], lpo_link);
282 for (cpu = 0; cpu <= mp_maxid; cpu++) {
284 bzero(lpc, sizeof(*lpc));
285 lock_prof_init_type(&lpc->lpc_types[0]);
286 lock_prof_init_type(&lpc->lpc_types[1]);
288 atomic_store_rel_int(&lock_prof_resetting, 0);
289 lock_prof_enable = enabled;
293 lock_prof_output(struct lock_prof *lp, struct sbuf *sb)
297 for (p = lp->file; p != NULL && strncmp(p, "../", 3) == 0; p += 3);
299 "%8ju %9ju %11ju %11ju %11ju %6ju %6ju %2ju %6ju %s:%d (%s:%s)\n",
300 lp->cnt_max / 1000, lp->cnt_wait_max / 1000, lp->cnt_tot / 1000,
301 lp->cnt_wait / 1000, lp->cnt_cur,
302 lp->cnt_cur == 0 ? (uintmax_t)0 :
303 lp->cnt_tot / (lp->cnt_cur * 1000),
304 lp->cnt_cur == 0 ? (uintmax_t)0 :
305 lp->cnt_wait / (lp->cnt_cur * 1000),
306 (uintmax_t)0, lp->cnt_contest_locking,
307 p, lp->line, lp->class->lc_name, lp->name);
311 lock_prof_sum(struct lock_prof *match, struct lock_prof *dst, int hash,
314 struct lock_prof_type *type;
318 dst->file = match->file;
319 dst->line = match->line;
320 dst->class = match->class;
321 dst->name = match->name;
323 for (cpu = 0; cpu <= mp_maxid; cpu++) {
324 if (lp_cpu[cpu] == NULL)
326 type = &lp_cpu[cpu]->lpc_types[spin];
327 SLIST_FOREACH(l, &type->lpt_hash[hash], link) {
330 if (l->file != match->file || l->line != match->line ||
331 l->name != match->name)
334 if (l->cnt_max > dst->cnt_max)
335 dst->cnt_max = l->cnt_max;
336 if (l->cnt_wait_max > dst->cnt_wait_max)
337 dst->cnt_wait_max = l->cnt_wait_max;
338 dst->cnt_tot += l->cnt_tot;
339 dst->cnt_wait += l->cnt_wait;
340 dst->cnt_cur += l->cnt_cur;
341 dst->cnt_contest_locking += l->cnt_contest_locking;
348 lock_prof_type_stats(struct lock_prof_type *type, struct sbuf *sb, int spin,
354 for (i = 0; i < LPROF_HASH_SIZE; ++i) {
355 SLIST_FOREACH(l, &type->lpt_hash[i], link) {
356 struct lock_prof lp = {};
360 lock_prof_sum(l, &lp, i, spin, t);
361 lock_prof_output(&lp, sb);
367 dump_lock_prof_stats(SYSCTL_HANDLER_ARGS)
373 error = sysctl_wire_old_buffer(req, 0);
376 sb = sbuf_new_for_sysctl(NULL, NULL, LPROF_SBUF_SIZE, req);
377 sbuf_printf(sb, "\n%8s %9s %11s %11s %11s %6s %6s %2s %6s %s\n",
378 "max", "wait_max", "total", "wait_total", "count", "avg", "wait_avg", "cnt_hold", "cnt_lock", "name");
379 enabled = lock_prof_enable;
380 lock_prof_enable = 0;
381 quiesce_all_cpus("profstat", 0);
383 for (cpu = 0; cpu <= mp_maxid; cpu++) {
384 if (lp_cpu[cpu] == NULL)
386 lock_prof_type_stats(&lp_cpu[cpu]->lpc_types[0], sb, 0, t);
387 lock_prof_type_stats(&lp_cpu[cpu]->lpc_types[1], sb, 1, t);
389 lock_prof_enable = enabled;
391 error = sbuf_finish(sb);
392 /* Output a trailing NUL. */
394 error = SYSCTL_OUT(req, "", 1);
400 enable_lock_prof(SYSCTL_HANDLER_ARGS)
404 v = lock_prof_enable;
405 error = sysctl_handle_int(oidp, &v, v, req);
408 if (req->newptr == NULL)
410 if (v == lock_prof_enable)
414 lock_prof_enable = !!v;
420 reset_lock_prof_stats(SYSCTL_HANDLER_ARGS)
425 error = sysctl_handle_int(oidp, &v, 0, req);
428 if (req->newptr == NULL)
437 static struct lock_prof *
438 lock_profile_lookup(struct lock_object *lo, int spin, const char *file,
441 const char *unknown = "(unknown)";
442 struct lock_prof_type *type;
443 struct lock_prof *lp;
449 if (p == NULL || *p == '\0')
451 hash = (uintptr_t)lo->lo_name * 31 + (uintptr_t)p * 31 + line;
452 hash &= LPROF_HASH_MASK;
453 type = &lp_cpu[PCPU_GET(cpuid)]->lpc_types[spin];
454 head = &type->lpt_hash[hash];
455 SLIST_FOREACH(lp, head, link) {
456 if (lp->line == line && lp->file == p &&
457 lp->name == lo->lo_name)
461 lp = SLIST_FIRST(&type->lpt_lpalloc);
463 lock_prof_rejected++;
466 SLIST_REMOVE_HEAD(&type->lpt_lpalloc, link);
469 lp->class = LOCK_CLASS(lo);
470 lp->name = lo->lo_name;
471 SLIST_INSERT_HEAD(&type->lpt_hash[hash], lp, link);
475 static struct lock_profile_object *
476 lock_profile_object_lookup(struct lock_object *lo, int spin, const char *file,
479 struct lock_profile_object *l;
480 struct lock_prof_type *type;
481 struct lpohead *head;
483 head = &curthread->td_lprof[spin];
484 LIST_FOREACH(l, head, lpo_link)
485 if (l->lpo_obj == lo && l->lpo_file == file &&
488 type = &lp_cpu[PCPU_GET(cpuid)]->lpc_types[spin];
489 l = LIST_FIRST(&type->lpt_lpoalloc);
491 lock_prof_rejected++;
494 LIST_REMOVE(l, lpo_link);
499 LIST_INSERT_HEAD(head, l, lpo_link);
505 lock_profile_obtain_lock_success(struct lock_object *lo, int contested,
506 uint64_t waittime, const char *file, int line)
508 static int lock_prof_count;
509 struct lock_profile_object *l;
512 if (SCHEDULER_STOPPED())
515 /* don't reset the timer when/if recursing */
516 if (!lock_prof_enable || (lo->lo_flags & LO_NOPROFILE))
518 if (lock_prof_skipcount &&
519 (++lock_prof_count % lock_prof_skipcount) != 0)
521 spin = (LOCK_CLASS(lo)->lc_flags & LC_SPINLOCK) ? 1 : 0;
522 if (spin && lock_prof_skipspin == 1)
525 /* Recheck enabled now that we're in a critical section. */
526 if (lock_prof_enable == 0)
528 l = lock_profile_object_lookup(lo, spin, file, line);
532 if (++l->lpo_ref > 1)
534 l->lpo_contest_locking = contested;
535 l->lpo_acqtime = nanoseconds();
536 if (waittime && (l->lpo_acqtime > waittime))
537 l->lpo_waittime = l->lpo_acqtime - waittime;
545 lock_profile_thread_exit(struct thread *td)
548 struct lock_profile_object *l;
550 MPASS(curthread->td_critnest == 0);
553 * If lock profiling was disabled we have to wait for reset to
554 * clear our pointers before we can exit safely.
556 lock_prof_reset_wait();
558 LIST_FOREACH(l, &td->td_lprof[0], lpo_link)
559 printf("thread still holds lock acquired at %s:%d\n",
560 l->lpo_file, l->lpo_line);
561 LIST_FOREACH(l, &td->td_lprof[1], lpo_link)
562 printf("thread still holds lock acquired at %s:%d\n",
563 l->lpo_file, l->lpo_line);
565 MPASS(LIST_FIRST(&td->td_lprof[0]) == NULL);
566 MPASS(LIST_FIRST(&td->td_lprof[1]) == NULL);
570 lock_profile_release_lock(struct lock_object *lo)
572 struct lock_profile_object *l;
573 struct lock_prof_type *type;
574 struct lock_prof *lp;
575 uint64_t curtime, holdtime;
576 struct lpohead *head;
579 if (SCHEDULER_STOPPED())
581 if (lo->lo_flags & LO_NOPROFILE)
583 spin = (LOCK_CLASS(lo)->lc_flags & LC_SPINLOCK) ? 1 : 0;
584 head = &curthread->td_lprof[spin];
585 if (LIST_FIRST(head) == NULL)
588 /* Recheck enabled now that we're in a critical section. */
589 if (lock_prof_enable == 0 && lock_prof_resetting == 1)
592 * If lock profiling is not enabled we still want to remove the
593 * lpo from our queue.
595 LIST_FOREACH(l, head, lpo_link)
596 if (l->lpo_obj == lo)
600 if (--l->lpo_ref > 0)
602 lp = lock_profile_lookup(lo, spin, l->lpo_file, l->lpo_line);
605 curtime = nanoseconds();
606 if (curtime < l->lpo_acqtime)
608 holdtime = curtime - l->lpo_acqtime;
611 * Record if the lock has been held longer now than ever
614 if (holdtime > lp->cnt_max)
615 lp->cnt_max = holdtime;
616 if (l->lpo_waittime > lp->cnt_wait_max)
617 lp->cnt_wait_max = l->lpo_waittime;
618 lp->cnt_tot += holdtime;
619 lp->cnt_wait += l->lpo_waittime;
620 lp->cnt_contest_locking += l->lpo_contest_locking;
621 lp->cnt_cur += l->lpo_cnt;
623 LIST_REMOVE(l, lpo_link);
624 type = &lp_cpu[PCPU_GET(cpuid)]->lpc_types[spin];
625 LIST_INSERT_HEAD(&type->lpt_lpoalloc, l, lpo_link);
630 static SYSCTL_NODE(_debug, OID_AUTO, lock, CTLFLAG_RD, NULL, "lock debugging");
631 static SYSCTL_NODE(_debug_lock, OID_AUTO, prof, CTLFLAG_RD, NULL,
633 SYSCTL_INT(_debug_lock_prof, OID_AUTO, skipspin, CTLFLAG_RW,
634 &lock_prof_skipspin, 0, "Skip profiling on spinlocks.");
635 SYSCTL_INT(_debug_lock_prof, OID_AUTO, skipcount, CTLFLAG_RW,
636 &lock_prof_skipcount, 0, "Sample approximately every N lock acquisitions.");
637 SYSCTL_INT(_debug_lock_prof, OID_AUTO, rejected, CTLFLAG_RD,
638 &lock_prof_rejected, 0, "Number of rejected profiling records");
639 SYSCTL_PROC(_debug_lock_prof, OID_AUTO, stats, CTLTYPE_STRING | CTLFLAG_RD,
640 NULL, 0, dump_lock_prof_stats, "A", "Lock profiling statistics");
641 SYSCTL_PROC(_debug_lock_prof, OID_AUTO, reset, CTLTYPE_INT | CTLFLAG_RW,
642 NULL, 0, reset_lock_prof_stats, "I", "Reset lock profiling statistics");
643 SYSCTL_PROC(_debug_lock_prof, OID_AUTO, enable, CTLTYPE_INT | CTLFLAG_RW,
644 NULL, 0, enable_lock_prof, "I", "Enable lock profiling");