sys/kern/kern_mutex.c

   1 /*-
   2  * Copyright (c) 1998 Berkeley Software Design, Inc. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  * 3. Berkeley Software Design Inc's name may not be used to endorse or
  13  *    promote products derived from this software without specific prior
  14  *    written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY BERKELEY SOFTWARE DESIGN INC ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL BERKELEY SOFTWARE DESIGN INC BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  *      from BSDI $Id: mutex_witness.c,v 1.1.2.20 2000/04/27 03:10:27 cp Exp $
  29  *      and BSDI $Id: synch_machdep.c,v 2.3.2.39 2000/04/27 03:10:25 cp Exp $
  30  */
  31
  32 /*
  33  * Machine independent bits of mutex implementation.
  34  */
  35
  36 #include <sys/cdefs.h>
  37 __FBSDID("$FreeBSD$");
  38
  39 #include "opt_adaptive_mutexes.h"
  40 #include "opt_ddb.h"
  41 #include "opt_global.h"
  42 #include "opt_hwpmc_hooks.h"
  43 #include "opt_kdtrace.h"
  44 #include "opt_sched.h"
  45
  46 #include <sys/param.h>
  47 #include <sys/systm.h>
  48 #include <sys/bus.h>
  49 #include <sys/conf.h>
  50 #include <sys/kdb.h>
  51 #include <sys/kernel.h>
  52 #include <sys/ktr.h>
  53 #include <sys/lock.h>
  54 #include <sys/malloc.h>
  55 #include <sys/mutex.h>
  56 #include <sys/proc.h>
  57 #include <sys/resourcevar.h>
  58 #include <sys/sched.h>
  59 #include <sys/sbuf.h>
  60 #include <sys/sysctl.h>
  61 #include <sys/turnstile.h>
  62 #include <sys/vmmeter.h>
  63 #include <sys/lock_profile.h>
  64
  65 #include <machine/atomic.h>
  66 #include <machine/bus.h>
  67 #include <machine/cpu.h>
  68
  69 #include <ddb/ddb.h>
  70
  71 #include <fs/devfs/devfs_int.h>
  72
  73 #include <vm/vm.h>
  74 #include <vm/vm_extern.h>
  75
  76 #if defined(SMP) && !defined(NO_ADAPTIVE_MUTEXES)
  77 #define ADAPTIVE_MUTEXES
  78 #endif
  79
  80 #ifdef HWPMC_HOOKS
  81 #include <sys/pmckern.h>
  82 PMC_SOFT_DEFINE( , , lock, failed);
  83 #endif
  84
  85 /*
  86  * Return the mutex address when the lock cookie address is provided.
  87  * This functionality assumes that struct mtx* have a member named mtx_lock.
  88  */
  89 #define mtxlock2mtx(c)  (__containerof(c, struct mtx, mtx_lock))
  90
  91 /*
  92  * Internal utility macros.
  93  */
  94 #define mtx_unowned(m)  ((m)->mtx_lock == MTX_UNOWNED)
  95
  96 #define mtx_destroyed(m) ((m)->mtx_lock == MTX_DESTROYED)
  97
  98 #define mtx_owner(m)    ((struct thread *)((m)->mtx_lock & ~MTX_FLAGMASK))
  99
 100 static void     assert_mtx(const struct lock_object *lock, int what);
 101 #ifdef DDB
 102 static void     db_show_mtx(const struct lock_object *lock);
 103 #endif
 104 static void     lock_mtx(struct lock_object *lock, uintptr_t how);
 105 static void     lock_spin(struct lock_object *lock, uintptr_t how);
 106 #ifdef KDTRACE_HOOKS
 107 static int      owner_mtx(const struct lock_object *lock,
 108                     struct thread **owner);
 109 #endif
 110 static uintptr_t unlock_mtx(struct lock_object *lock);
 111 static uintptr_t unlock_spin(struct lock_object *lock);
 112
 113 /*
 114  * Lock classes for sleep and spin mutexes.
 115  */
 116 struct lock_class lock_class_mtx_sleep = {
 117         .lc_name = "sleep mutex",
 118         .lc_flags = LC_SLEEPLOCK | LC_RECURSABLE,
 119         .lc_assert = assert_mtx,
 120 #ifdef DDB
 121         .lc_ddb_show = db_show_mtx,
 122 #endif
 123         .lc_lock = lock_mtx,
 124         .lc_unlock = unlock_mtx,
 125 #ifdef KDTRACE_HOOKS
 126         .lc_owner = owner_mtx,
 127 #endif
 128 };
 129 struct lock_class lock_class_mtx_spin = {
 130         .lc_name = "spin mutex",
 131         .lc_flags = LC_SPINLOCK | LC_RECURSABLE,
 132         .lc_assert = assert_mtx,
 133 #ifdef DDB
 134         .lc_ddb_show = db_show_mtx,
 135 #endif
 136         .lc_lock = lock_spin,
 137         .lc_unlock = unlock_spin,
 138 #ifdef KDTRACE_HOOKS
 139         .lc_owner = owner_mtx,
 140 #endif
 141 };
 142
 143 /*
 144  * System-wide mutexes
 145  */
 146 struct mtx blocked_lock;
 147 struct mtx Giant;
 148
 149 void
 150 assert_mtx(const struct lock_object *lock, int what)
 151 {
 152
 153         mtx_assert((const struct mtx *)lock, what);
 154 }
 155
 156 void
 157 lock_mtx(struct lock_object *lock, uintptr_t how)
 158 {
 159
 160         mtx_lock((struct mtx *)lock);
 161 }
 162
 163 void
 164 lock_spin(struct lock_object *lock, uintptr_t how)
 165 {
 166
 167         panic("spin locks can only use msleep_spin");
 168 }
 169
 170 uintptr_t
 171 unlock_mtx(struct lock_object *lock)
 172 {
 173         struct mtx *m;
 174
 175         m = (struct mtx *)lock;
 176         mtx_assert(m, MA_OWNED | MA_NOTRECURSED);
 177         mtx_unlock(m);
 178         return (0);
 179 }
 180
 181 uintptr_t
 182 unlock_spin(struct lock_object *lock)
 183 {
 184
 185         panic("spin locks can only use msleep_spin");
 186 }
 187
 188 #ifdef KDTRACE_HOOKS
 189 int
 190 owner_mtx(const struct lock_object *lock, struct thread **owner)
 191 {
 192         const struct mtx *m = (const struct mtx *)lock;
 193
 194         *owner = mtx_owner(m);
 195         return (mtx_unowned(m) == 0);
 196 }
 197 #endif
 198
 199 /*
 200  * Function versions of the inlined __mtx_* macros.  These are used by
 201  * modules and can also be called from assembly language if needed.
 202  */
 203 void
 204 __mtx_lock_flags(volatile uintptr_t *c, int opts, const char *file, int line)
 205 {
 206         struct mtx *m;
 207
 208         if (SCHEDULER_STOPPED())
 209                 return;
 210
 211         m = mtxlock2mtx(c);
 212
 213         KASSERT(kdb_active != 0 || !TD_IS_IDLETHREAD(curthread),
 214             ("mtx_lock() by idle thread %p on sleep mutex %s @ %s:%d",
 215             curthread, m->lock_object.lo_name, file, line));
 216         KASSERT(m->mtx_lock != MTX_DESTROYED,
 217             ("mtx_lock() of destroyed mutex @ %s:%d", file, line));
 218         KASSERT(LOCK_CLASS(&m->lock_object) == &lock_class_mtx_sleep,
 219             ("mtx_lock() of spin mutex %s @ %s:%d", m->lock_object.lo_name,
 220             file, line));
 221         WITNESS_CHECKORDER(&m->lock_object, (opts & ~MTX_RECURSE) |
 222             LOP_NEWORDER | LOP_EXCLUSIVE, file, line, NULL);
 223
 224         __mtx_lock(m, curthread, opts, file, line);
 225         LOCK_LOG_LOCK("LOCK", &m->lock_object, opts, m->mtx_recurse, file,
 226             line);
 227         WITNESS_LOCK(&m->lock_object, (opts & ~MTX_RECURSE) | LOP_EXCLUSIVE,
 228             file, line);
 229         curthread->td_locks++;
 230 }
 231
 232 void
 233 __mtx_unlock_flags(volatile uintptr_t *c, int opts, const char *file, int line)
 234 {
 235         struct mtx *m;
 236
 237         if (SCHEDULER_STOPPED())
 238                 return;
 239
 240         m = mtxlock2mtx(c);
 241
 242         KASSERT(m->mtx_lock != MTX_DESTROYED,
 243             ("mtx_unlock() of destroyed mutex @ %s:%d", file, line));
 244         KASSERT(LOCK_CLASS(&m->lock_object) == &lock_class_mtx_sleep,
 245             ("mtx_unlock() of spin mutex %s @ %s:%d", m->lock_object.lo_name,
 246             file, line));
 247         WITNESS_UNLOCK(&m->lock_object, opts | LOP_EXCLUSIVE, file, line);
 248         LOCK_LOG_LOCK("UNLOCK", &m->lock_object, opts, m->mtx_recurse, file,
 249             line);
 250         mtx_assert(m, MA_OWNED);
 251
 252         if (m->mtx_recurse == 0)
 253                 LOCKSTAT_PROFILE_RELEASE_LOCK(LS_MTX_UNLOCK_RELEASE, m);
 254         __mtx_unlock(m, curthread, opts, file, line);
 255         curthread->td_locks--;
 256 }
 257
 258 void
 259 __mtx_lock_spin_flags(volatile uintptr_t *c, int opts, const char *file,
 260     int line)
 261 {
 262         struct mtx *m;
 263
 264         if (SCHEDULER_STOPPED())
 265                 return;
 266
 267         m = mtxlock2mtx(c);
 268
 269         KASSERT(m->mtx_lock != MTX_DESTROYED,
 270             ("mtx_lock_spin() of destroyed mutex @ %s:%d", file, line));
 271         KASSERT(LOCK_CLASS(&m->lock_object) == &lock_class_mtx_spin,
 272             ("mtx_lock_spin() of sleep mutex %s @ %s:%d",
 273             m->lock_object.lo_name, file, line));
 274         if (mtx_owned(m))
 275                 KASSERT((m->lock_object.lo_flags & LO_RECURSABLE) != 0 ||
 276                     (opts & MTX_RECURSE) != 0,
 277             ("mtx_lock_spin: recursed on non-recursive mutex %s @ %s:%d\n",
 278                     m->lock_object.lo_name, file, line));
 279         opts &= ~MTX_RECURSE;
 280         WITNESS_CHECKORDER(&m->lock_object, opts | LOP_NEWORDER | LOP_EXCLUSIVE,
 281             file, line, NULL);
 282         __mtx_lock_spin(m, curthread, opts, file, line);
 283         LOCK_LOG_LOCK("LOCK", &m->lock_object, opts, m->mtx_recurse, file,
 284             line);
 285         WITNESS_LOCK(&m->lock_object, opts | LOP_EXCLUSIVE, file, line);
 286 }
 287
 288 int
 289 __mtx_trylock_spin_flags(volatile uintptr_t *c, int opts, const char *file,
 290     int line)
 291 {
 292         struct mtx *m;
 293
 294         if (SCHEDULER_STOPPED())
 295                 return (1);
 296
 297         m = mtxlock2mtx(c);
 298
 299         KASSERT(m->mtx_lock != MTX_DESTROYED,
 300             ("mtx_trylock_spin() of destroyed mutex @ %s:%d", file, line));
 301         KASSERT(LOCK_CLASS(&m->lock_object) == &lock_class_mtx_spin,
 302             ("mtx_trylock_spin() of sleep mutex %s @ %s:%d",
 303             m->lock_object.lo_name, file, line));
 304         KASSERT((opts & MTX_RECURSE) == 0,
 305             ("mtx_trylock_spin: unsupp. opt MTX_RECURSE on mutex %s @ %s:%d\n",
 306             m->lock_object.lo_name, file, line));
 307         if (__mtx_trylock_spin(m, curthread, opts, file, line)) {
 308                 LOCK_LOG_TRY("LOCK", &m->lock_object, opts, 1, file, line);
 309                 WITNESS_LOCK(&m->lock_object, opts | LOP_EXCLUSIVE, file, line);
 310                 return (1);
 311         }
 312         LOCK_LOG_TRY("LOCK", &m->lock_object, opts, 0, file, line);
 313         return (0);
 314 }
 315
 316 void
 317 __mtx_unlock_spin_flags(volatile uintptr_t *c, int opts, const char *file,
 318     int line)
 319 {
 320         struct mtx *m;
 321
 322         if (SCHEDULER_STOPPED())
 323                 return;
 324
 325         m = mtxlock2mtx(c);
 326
 327         KASSERT(m->mtx_lock != MTX_DESTROYED,
 328             ("mtx_unlock_spin() of destroyed mutex @ %s:%d", file, line));
 329         KASSERT(LOCK_CLASS(&m->lock_object) == &lock_class_mtx_spin,
 330             ("mtx_unlock_spin() of sleep mutex %s @ %s:%d",
 331             m->lock_object.lo_name, file, line));
 332         WITNESS_UNLOCK(&m->lock_object, opts | LOP_EXCLUSIVE, file, line);
 333         LOCK_LOG_LOCK("UNLOCK", &m->lock_object, opts, m->mtx_recurse, file,
 334             line);
 335         mtx_assert(m, MA_OWNED);
 336
 337         __mtx_unlock_spin(m);
 338 }
 339
 340 /*
 341  * The important part of mtx_trylock{,_flags}()
 342  * Tries to acquire lock `m.'  If this function is called on a mutex that
 343  * is already owned, it will recursively acquire the lock.
 344  */
 345 int
 346 _mtx_trylock_flags_(volatile uintptr_t *c, int opts, const char *file, int line)
 347 {
 348         struct mtx *m;
 349 #ifdef LOCK_PROFILING
 350         uint64_t waittime = 0;
 351         int contested = 0;
 352 #endif
 353         int rval;
 354
 355         if (SCHEDULER_STOPPED())
 356                 return (1);
 357
 358         m = mtxlock2mtx(c);
 359
 360         KASSERT(kdb_active != 0 || !TD_IS_IDLETHREAD(curthread),
 361             ("mtx_trylock() by idle thread %p on sleep mutex %s @ %s:%d",
 362             curthread, m->lock_object.lo_name, file, line));
 363         KASSERT(m->mtx_lock != MTX_DESTROYED,
 364             ("mtx_trylock() of destroyed mutex @ %s:%d", file, line));
 365         KASSERT(LOCK_CLASS(&m->lock_object) == &lock_class_mtx_sleep,
 366             ("mtx_trylock() of spin mutex %s @ %s:%d", m->lock_object.lo_name,
 367             file, line));
 368
 369         if (mtx_owned(m) && ((m->lock_object.lo_flags & LO_RECURSABLE) != 0 ||
 370             (opts & MTX_RECURSE) != 0)) {
 371                 m->mtx_recurse++;
 372                 atomic_set_ptr(&m->mtx_lock, MTX_RECURSED);
 373                 rval = 1;
 374         } else
 375                 rval = _mtx_obtain_lock(m, (uintptr_t)curthread);
 376         opts &= ~MTX_RECURSE;
 377
 378         LOCK_LOG_TRY("LOCK", &m->lock_object, opts, rval, file, line);
 379         if (rval) {
 380                 WITNESS_LOCK(&m->lock_object, opts | LOP_EXCLUSIVE | LOP_TRYLOCK,
 381                     file, line);
 382                 curthread->td_locks++;
 383                 if (m->mtx_recurse == 0)
 384                         LOCKSTAT_PROFILE_OBTAIN_LOCK_SUCCESS(LS_MTX_LOCK_ACQUIRE,
 385                             m, contested, waittime, file, line);
 386
 387         }
 388
 389         return (rval);
 390 }
 391
 392 /*
 393  * __mtx_lock_sleep: the tougher part of acquiring an MTX_DEF lock.
 394  *
 395  * We call this if the lock is either contested (i.e. we need to go to
 396  * sleep waiting for it), or if we need to recurse on it.
 397  */
 398 void
 399 __mtx_lock_sleep(volatile uintptr_t *c, uintptr_t tid, int opts,
 400     const char *file, int line)
 401 {
 402         struct mtx *m;
 403         struct turnstile *ts;
 404         uintptr_t v;
 405 #ifdef ADAPTIVE_MUTEXES
 406         volatile struct thread *owner;
 407 #endif
 408 #ifdef KTR
 409         int cont_logged = 0;
 410 #endif
 411 #ifdef LOCK_PROFILING
 412         int contested = 0;
 413         uint64_t waittime = 0;
 414 #endif
 415 #ifdef KDTRACE_HOOKS
 416         uint64_t spin_cnt = 0;
 417         uint64_t sleep_cnt = 0;
 418         int64_t sleep_time = 0;
 419         int64_t all_time = 0;
 420 #endif
 421
 422         if (SCHEDULER_STOPPED())
 423                 return;
 424
 425         m = mtxlock2mtx(c);
 426
 427         if (mtx_owned(m)) {
 428                 KASSERT((m->lock_object.lo_flags & LO_RECURSABLE) != 0 ||
 429                     (opts & MTX_RECURSE) != 0,
 430             ("_mtx_lock_sleep: recursed on non-recursive mutex %s @ %s:%d\n",
 431                     m->lock_object.lo_name, file, line));
 432                 opts &= ~MTX_RECURSE;
 433                 m->mtx_recurse++;
 434                 atomic_set_ptr(&m->mtx_lock, MTX_RECURSED);
 435                 if (LOCK_LOG_TEST(&m->lock_object, opts))
 436                         CTR1(KTR_LOCK, "_mtx_lock_sleep: %p recursing", m);
 437                 return;
 438         }
 439         opts &= ~MTX_RECURSE;
 440
 441 #ifdef HWPMC_HOOKS
 442         PMC_SOFT_CALL( , , lock, failed);
 443 #endif
 444         lock_profile_obtain_lock_failed(&m->lock_object,
 445                     &contested, &waittime);
 446         if (LOCK_LOG_TEST(&m->lock_object, opts))
 447                 CTR4(KTR_LOCK,
 448                     "_mtx_lock_sleep: %s contested (lock=%p) at %s:%d",
 449                     m->lock_object.lo_name, (void *)m->mtx_lock, file, line);
 450 #ifdef KDTRACE_HOOKS
 451         all_time -= lockstat_nsecs(&m->lock_object);
 452 #endif
 453
 454         for (;;) {
 455                 if (m->mtx_lock == MTX_UNOWNED && _mtx_obtain_lock(m, tid))
 456                         break;
 457 #ifdef KDTRACE_HOOKS
 458                 spin_cnt++;
 459 #endif
 460 #ifdef ADAPTIVE_MUTEXES
 461                 /*
 462                  * If the owner is running on another CPU, spin until the
 463                  * owner stops running or the state of the lock changes.
 464                  */
 465                 v = m->mtx_lock;
 466                 if (v != MTX_UNOWNED) {
 467                         owner = (struct thread *)(v & ~MTX_FLAGMASK);
 468                         if (TD_IS_RUNNING(owner)) {
 469                                 if (LOCK_LOG_TEST(&m->lock_object, 0))
 470                                         CTR3(KTR_LOCK,
 471                                             "%s: spinning on %p held by %p",
 472                                             __func__, m, owner);
 473                                 KTR_STATE1(KTR_SCHED, "thread",
 474                                     sched_tdname((struct thread *)tid),
 475                                     "spinning", "lockname:\"%s\"",
 476                                     m->lock_object.lo_name);
 477                                 while (mtx_owner(m) == owner &&
 478                                     TD_IS_RUNNING(owner)) {
 479                                         cpu_spinwait();
 480 #ifdef KDTRACE_HOOKS
 481                                         spin_cnt++;
 482 #endif
 483                                 }
 484                                 KTR_STATE0(KTR_SCHED, "thread",
 485                                     sched_tdname((struct thread *)tid),
 486                                     "running");
 487                                 continue;
 488                         }
 489                 }
 490 #endif
 491
 492                 ts = turnstile_trywait(&m->lock_object);
 493                 v = m->mtx_lock;
 494
 495                 /*
 496                  * Check if the lock has been released while spinning for
 497                  * the turnstile chain lock.
 498                  */
 499                 if (v == MTX_UNOWNED) {
 500                         turnstile_cancel(ts);
 501                         continue;
 502                 }
 503
 504 #ifdef ADAPTIVE_MUTEXES
 505                 /*
 506                  * The current lock owner might have started executing
 507                  * on another CPU (or the lock could have changed
 508                  * owners) while we were waiting on the turnstile
 509                  * chain lock.  If so, drop the turnstile lock and try
 510                  * again.
 511                  */
 512                 owner = (struct thread *)(v & ~MTX_FLAGMASK);
 513                 if (TD_IS_RUNNING(owner)) {
 514                         turnstile_cancel(ts);
 515                         continue;
 516                 }
 517 #endif
 518
 519                 /*
 520                  * If the mutex isn't already contested and a failure occurs
 521                  * setting the contested bit, the mutex was either released
 522                  * or the state of the MTX_RECURSED bit changed.
 523                  */
 524                 if ((v & MTX_CONTESTED) == 0 &&
 525                     !atomic_cmpset_ptr(&m->mtx_lock, v, v | MTX_CONTESTED)) {
 526                         turnstile_cancel(ts);
 527                         continue;
 528                 }
 529
 530                 /*
 531                  * We definitely must sleep for this lock.
 532                  */
 533                 mtx_assert(m, MA_NOTOWNED);
 534
 535 #ifdef KTR
 536                 if (!cont_logged) {
 537                         CTR6(KTR_CONTENTION,
 538                             "contention: %p at %s:%d wants %s, taken by %s:%d",
 539                             (void *)tid, file, line, m->lock_object.lo_name,
 540                             WITNESS_FILE(&m->lock_object),
 541                             WITNESS_LINE(&m->lock_object));
 542                         cont_logged = 1;
 543                 }
 544 #endif
 545
 546                 /*
 547                  * Block on the turnstile.
 548                  */
 549 #ifdef KDTRACE_HOOKS
 550                 sleep_time -= lockstat_nsecs(&m->lock_object);
 551 #endif
 552                 turnstile_wait(ts, mtx_owner(m), TS_EXCLUSIVE_QUEUE);
 553 #ifdef KDTRACE_HOOKS
 554                 sleep_time += lockstat_nsecs(&m->lock_object);
 555                 sleep_cnt++;
 556 #endif
 557         }
 558 #ifdef KDTRACE_HOOKS
 559         all_time += lockstat_nsecs(&m->lock_object);
 560 #endif
 561 #ifdef KTR
 562         if (cont_logged) {
 563                 CTR4(KTR_CONTENTION,
 564                     "contention end: %s acquired by %p at %s:%d",
 565                     m->lock_object.lo_name, (void *)tid, file, line);
 566         }
 567 #endif
 568         LOCKSTAT_PROFILE_OBTAIN_LOCK_SUCCESS(LS_MTX_LOCK_ACQUIRE, m, contested,
 569             waittime, file, line);
 570 #ifdef KDTRACE_HOOKS
 571         if (sleep_time)
 572                 LOCKSTAT_RECORD1(LS_MTX_LOCK_BLOCK, m, sleep_time);
 573
 574         /*
 575          * Only record the loops spinning and not sleeping.
 576          */
 577         if (spin_cnt > sleep_cnt)
 578                 LOCKSTAT_RECORD1(LS_MTX_LOCK_SPIN, m, (all_time - sleep_time));
 579 #endif
 580 }
 581
 582 static void
 583 _mtx_lock_spin_failed(struct mtx *m)
 584 {
 585         struct thread *td;
 586
 587         td = mtx_owner(m);
 588
 589         /* If the mutex is unlocked, try again. */
 590         if (td == NULL)
 591                 return;
 592
 593         printf( "spin lock %p (%s) held by %p (tid %d) too long\n",
 594             m, m->lock_object.lo_name, td, td->td_tid);
 595 #ifdef WITNESS
 596         witness_display_spinlock(&m->lock_object, td, printf);
 597 #endif
 598         panic("spin lock held too long");
 599 }
 600
 601 #ifdef SMP
 602 /*
 603  * _mtx_lock_spin_cookie: the tougher part of acquiring an MTX_SPIN lock.
 604  *
 605  * This is only called if we need to actually spin for the lock. Recursion
 606  * is handled inline.
 607  */
 608 void
 609 _mtx_lock_spin_cookie(volatile uintptr_t *c, uintptr_t tid, int opts,
 610     const char *file, int line)
 611 {
 612         struct mtx *m;
 613         int i = 0;
 614 #ifdef LOCK_PROFILING
 615         int contested = 0;
 616         uint64_t waittime = 0;
 617 #endif
 618 #ifdef KDTRACE_HOOKS
 619         int64_t spin_time = 0;
 620 #endif
 621
 622         if (SCHEDULER_STOPPED())
 623                 return;
 624
 625         m = mtxlock2mtx(c);
 626
 627         if (LOCK_LOG_TEST(&m->lock_object, opts))
 628                 CTR1(KTR_LOCK, "_mtx_lock_spin: %p spinning", m);
 629         KTR_STATE1(KTR_SCHED, "thread", sched_tdname((struct thread *)tid),
 630             "spinning", "lockname:\"%s\"", m->lock_object.lo_name);
 631
 632 #ifdef HWPMC_HOOKS
 633         PMC_SOFT_CALL( , , lock, failed);
 634 #endif
 635         lock_profile_obtain_lock_failed(&m->lock_object, &contested, &waittime);
 636 #ifdef KDTRACE_HOOKS
 637         spin_time -= lockstat_nsecs(&m->lock_object);
 638 #endif
 639         for (;;) {
 640                 if (m->mtx_lock == MTX_UNOWNED && _mtx_obtain_lock(m, tid))
 641                         break;
 642                 /* Give interrupts a chance while we spin. */
 643                 spinlock_exit();
 644                 while (m->mtx_lock != MTX_UNOWNED) {
 645                         if (i++ < 10000000) {
 646                                 cpu_spinwait();
 647                                 continue;
 648                         }
 649                         if (i < 60000000 || kdb_active || panicstr != NULL)
 650                                 DELAY(1);
 651                         else
 652                                 _mtx_lock_spin_failed(m);
 653                         cpu_spinwait();
 654                 }
 655                 spinlock_enter();
 656         }
 657 #ifdef KDTRACE_HOOKS
 658         spin_time += lockstat_nsecs(&m->lock_object);
 659 #endif
 660
 661         if (LOCK_LOG_TEST(&m->lock_object, opts))
 662                 CTR1(KTR_LOCK, "_mtx_lock_spin: %p spin done", m);
 663         KTR_STATE0(KTR_SCHED, "thread", sched_tdname((struct thread *)tid),
 664             "running");
 665
 666         LOCKSTAT_PROFILE_OBTAIN_LOCK_SUCCESS(LS_MTX_SPIN_LOCK_ACQUIRE, m,
 667             contested, waittime, (file), (line));
 668 #ifdef KDTRACE_HOOKS
 669         if (spin_time != 0)
 670                 LOCKSTAT_RECORD1(LS_MTX_SPIN_LOCK_SPIN, m, spin_time);
 671 #endif
 672 }
 673 #endif /* SMP */
 674
 675 void
 676 thread_lock_flags_(struct thread *td, int opts, const char *file, int line)
 677 {
 678         struct mtx *m;
 679         uintptr_t tid;
 680         int i;
 681 #ifdef LOCK_PROFILING
 682         int contested = 0;
 683         uint64_t waittime = 0;
 684 #endif
 685 #ifdef KDTRACE_HOOKS
 686         int64_t spin_time = 0;
 687 #endif
 688
 689         i = 0;
 690         tid = (uintptr_t)curthread;
 691
 692         if (SCHEDULER_STOPPED()) {
 693                 /*
 694                  * Ensure that spinlock sections are balanced even when the
 695                  * scheduler is stopped, since we may otherwise inadvertently
 696                  * re-enable interrupts while dumping core.
 697                  */
 698                 spinlock_enter();
 699                 return;
 700         }
 701
 702 #ifdef KDTRACE_HOOKS
 703         spin_time -= lockstat_nsecs(&td->td_lock->lock_object);
 704 #endif
 705         for (;;) {
 706 retry:
 707                 spinlock_enter();
 708                 m = td->td_lock;
 709                 KASSERT(m->mtx_lock != MTX_DESTROYED,
 710                     ("thread_lock() of destroyed mutex @ %s:%d", file, line));
 711                 KASSERT(LOCK_CLASS(&m->lock_object) == &lock_class_mtx_spin,
 712                     ("thread_lock() of sleep mutex %s @ %s:%d",
 713                     m->lock_object.lo_name, file, line));
 714                 if (mtx_owned(m))
 715                         KASSERT((m->lock_object.lo_flags & LO_RECURSABLE) != 0,
 716             ("thread_lock: recursed on non-recursive mutex %s @ %s:%d\n",
 717                             m->lock_object.lo_name, file, line));
 718                 WITNESS_CHECKORDER(&m->lock_object,
 719                     opts | LOP_NEWORDER | LOP_EXCLUSIVE, file, line, NULL);
 720                 for (;;) {
 721                         if (m->mtx_lock == MTX_UNOWNED && _mtx_obtain_lock(m, tid))
 722                                 break;
 723                         if (m->mtx_lock == tid) {
 724                                 m->mtx_recurse++;
 725                                 break;
 726                         }
 727 #ifdef HWPMC_HOOKS
 728                         PMC_SOFT_CALL( , , lock, failed);
 729 #endif
 730                         lock_profile_obtain_lock_failed(&m->lock_object,
 731                             &contested, &waittime);
 732                         /* Give interrupts a chance while we spin. */
 733                         spinlock_exit();
 734                         while (m->mtx_lock != MTX_UNOWNED) {
 735                                 if (i++ < 10000000)
 736                                         cpu_spinwait();
 737                                 else if (i < 60000000 ||
 738                                     kdb_active || panicstr != NULL)
 739                                         DELAY(1);
 740                                 else
 741                                         _mtx_lock_spin_failed(m);
 742                                 cpu_spinwait();
 743                                 if (m != td->td_lock)
 744                                         goto retry;
 745                         }
 746                         spinlock_enter();
 747                 }
 748                 if (m == td->td_lock)
 749                         break;
 750                 __mtx_unlock_spin(m);   /* does spinlock_exit() */
 751         }
 752 #ifdef KDTRACE_HOOKS
 753         spin_time += lockstat_nsecs(&m->lock_object);
 754 #endif
 755         if (m->mtx_recurse == 0)
 756                 LOCKSTAT_PROFILE_OBTAIN_LOCK_SUCCESS(LS_MTX_SPIN_LOCK_ACQUIRE,
 757                     m, contested, waittime, (file), (line));
 758         LOCK_LOG_LOCK("LOCK", &m->lock_object, opts, m->mtx_recurse, file,
 759             line);
 760         WITNESS_LOCK(&m->lock_object, opts | LOP_EXCLUSIVE, file, line);
 761         LOCKSTAT_RECORD1(LS_THREAD_LOCK_SPIN, m, spin_time);
 762 }
 763
 764 struct mtx *
 765 thread_lock_block(struct thread *td)
 766 {
 767         struct mtx *lock;
 768
 769         THREAD_LOCK_ASSERT(td, MA_OWNED);
 770         lock = td->td_lock;
 771         td->td_lock = &blocked_lock;
 772         mtx_unlock_spin(lock);
 773
 774         return (lock);
 775 }
 776
 777 void
 778 thread_lock_unblock(struct thread *td, struct mtx *new)
 779 {
 780         mtx_assert(new, MA_OWNED);
 781         MPASS(td->td_lock == &blocked_lock);
 782         atomic_store_rel_ptr((volatile void *)&td->td_lock, (uintptr_t)new);
 783 }
 784
 785 void
 786 thread_lock_set(struct thread *td, struct mtx *new)
 787 {
 788         struct mtx *lock;
 789
 790         mtx_assert(new, MA_OWNED);
 791         THREAD_LOCK_ASSERT(td, MA_OWNED);
 792         lock = td->td_lock;
 793         td->td_lock = new;
 794         mtx_unlock_spin(lock);
 795 }
 796
 797 /*
 798  * __mtx_unlock_sleep: the tougher part of releasing an MTX_DEF lock.
 799  *
 800  * We are only called here if the lock is recursed or contested (i.e. we
 801  * need to wake up a blocked thread).
 802  */
 803 void
 804 __mtx_unlock_sleep(volatile uintptr_t *c, int opts, const char *file, int line)
 805 {
 806         struct mtx *m;
 807         struct turnstile *ts;
 808
 809         if (SCHEDULER_STOPPED())
 810                 return;
 811
 812         m = mtxlock2mtx(c);
 813
 814         if (mtx_recursed(m)) {
 815                 if (--(m->mtx_recurse) == 0)
 816                         atomic_clear_ptr(&m->mtx_lock, MTX_RECURSED);
 817                 if (LOCK_LOG_TEST(&m->lock_object, opts))
 818                         CTR1(KTR_LOCK, "_mtx_unlock_sleep: %p unrecurse", m);
 819                 return;
 820         }
 821
 822         /*
 823          * We have to lock the chain before the turnstile so this turnstile
 824          * can be removed from the hash list if it is empty.
 825          */
 826         turnstile_chain_lock(&m->lock_object);
 827         ts = turnstile_lookup(&m->lock_object);
 828         if (LOCK_LOG_TEST(&m->lock_object, opts))
 829                 CTR1(KTR_LOCK, "_mtx_unlock_sleep: %p contested", m);
 830         MPASS(ts != NULL);
 831         turnstile_broadcast(ts, TS_EXCLUSIVE_QUEUE);
 832         _mtx_release_lock_quick(m);
 833
 834         /*
 835          * This turnstile is now no longer associated with the mutex.  We can
 836          * unlock the chain lock so a new turnstile may take it's place.
 837          */
 838         turnstile_unpend(ts, TS_EXCLUSIVE_LOCK);
 839         turnstile_chain_unlock(&m->lock_object);
 840 }
 841
 842 /*
 843  * All the unlocking of MTX_SPIN locks is done inline.
 844  * See the __mtx_unlock_spin() macro for the details.
 845  */
 846
 847 /*
 848  * The backing function for the INVARIANTS-enabled mtx_assert()
 849  */
 850 #ifdef INVARIANT_SUPPORT
 851 void
 852 __mtx_assert(const volatile uintptr_t *c, int what, const char *file, int line)
 853 {
 854         const struct mtx *m;
 855
 856         if (panicstr != NULL || dumping || SCHEDULER_STOPPED())
 857                 return;
 858
 859         m = mtxlock2mtx(c);
 860
 861         switch (what) {
 862         case MA_OWNED:
 863         case MA_OWNED | MA_RECURSED:
 864         case MA_OWNED | MA_NOTRECURSED:
 865                 if (!mtx_owned(m))
 866                         panic("mutex %s not owned at %s:%d",
 867                             m->lock_object.lo_name, file, line);
 868                 if (mtx_recursed(m)) {
 869                         if ((what & MA_NOTRECURSED) != 0)
 870                                 panic("mutex %s recursed at %s:%d",
 871                                     m->lock_object.lo_name, file, line);
 872                 } else if ((what & MA_RECURSED) != 0) {
 873                         panic("mutex %s unrecursed at %s:%d",
 874                             m->lock_object.lo_name, file, line);
 875                 }
 876                 break;
 877         case MA_NOTOWNED:
 878                 if (mtx_owned(m))
 879                         panic("mutex %s owned at %s:%d",
 880                             m->lock_object.lo_name, file, line);
 881                 break;
 882         default:
 883                 panic("unknown mtx_assert at %s:%d", file, line);
 884         }
 885 }
 886 #endif
 887
 888 /*
 889  * The MUTEX_DEBUG-enabled mtx_validate()
 890  *
 891  * Most of these checks have been moved off into the LO_INITIALIZED flag
 892  * maintained by the witness code.
 893  */
 894 #ifdef MUTEX_DEBUG
 895
 896 void    mtx_validate(struct mtx *);
 897
 898 void
 899 mtx_validate(struct mtx *m)
 900 {
 901
 902 /*
 903  * XXX: When kernacc() does not require Giant we can reenable this check
 904  */
 905 #ifdef notyet
 906         /*
 907          * Can't call kernacc() from early init386(), especially when
 908          * initializing Giant mutex, because some stuff in kernacc()
 909          * requires Giant itself.
 910          */
 911         if (!cold)
 912                 if (!kernacc((caddr_t)m, sizeof(m),
 913                     VM_PROT_READ | VM_PROT_WRITE))
 914                         panic("Can't read and write to mutex %p", m);
 915 #endif
 916 }
 917 #endif
 918
 919 /*
 920  * General init routine used by the MTX_SYSINIT() macro.
 921  */
 922 void
 923 mtx_sysinit(void *arg)
 924 {
 925         struct mtx_args *margs = arg;
 926
 927         mtx_init((struct mtx *)margs->ma_mtx, margs->ma_desc, NULL,
 928             margs->ma_opts);
 929 }
 930
 931 /*
 932  * Mutex initialization routine; initialize lock `m' of type contained in
 933  * `opts' with options contained in `opts' and name `name.'  The optional
 934  * lock type `type' is used as a general lock category name for use with
 935  * witness.
 936  */
 937 void
 938 _mtx_init(volatile uintptr_t *c, const char *name, const char *type, int opts)
 939 {
 940         struct mtx *m;
 941         struct lock_class *class;
 942         int flags;
 943
 944         m = mtxlock2mtx(c);
 945
 946         MPASS((opts & ~(MTX_SPIN | MTX_QUIET | MTX_RECURSE |
 947                 MTX_NOWITNESS | MTX_DUPOK | MTX_NOPROFILE)) == 0);
 948         ASSERT_ATOMIC_LOAD_PTR(m->mtx_lock,
 949             ("%s: mtx_lock not aligned for %s: %p", __func__, name,
 950             &m->mtx_lock));
 951
 952 #ifdef MUTEX_DEBUG
 953         /* Diagnostic and error correction */
 954         mtx_validate(m);
 955 #endif
 956
 957         /* Determine lock class and lock flags. */
 958         if (opts & MTX_SPIN)
 959                 class = &lock_class_mtx_spin;
 960         else
 961                 class = &lock_class_mtx_sleep;
 962         flags = 0;
 963         if (opts & MTX_QUIET)
 964                 flags |= LO_QUIET;
 965         if (opts & MTX_RECURSE)
 966                 flags |= LO_RECURSABLE;
 967         if ((opts & MTX_NOWITNESS) == 0)
 968                 flags |= LO_WITNESS;
 969         if (opts & MTX_DUPOK)
 970                 flags |= LO_DUPOK;
 971         if (opts & MTX_NOPROFILE)
 972                 flags |= LO_NOPROFILE;
 973
 974         /* Initialize mutex. */
 975         lock_init(&m->lock_object, class, name, type, flags);
 976
 977         m->mtx_lock = MTX_UNOWNED;
 978         m->mtx_recurse = 0;
 979 }
 980
 981 /*
 982  * Remove lock `m' from all_mtx queue.  We don't allow MTX_QUIET to be
 983  * passed in as a flag here because if the corresponding mtx_init() was
 984  * called with MTX_QUIET set, then it will already be set in the mutex's
 985  * flags.
 986  */
 987 void
 988 _mtx_destroy(volatile uintptr_t *c)
 989 {
 990         struct mtx *m;
 991
 992         m = mtxlock2mtx(c);
 993
 994         if (!mtx_owned(m))
 995                 MPASS(mtx_unowned(m));
 996         else {
 997                 MPASS((m->mtx_lock & (MTX_RECURSED|MTX_CONTESTED)) == 0);
 998
 999                 /* Perform the non-mtx related part of mtx_unlock_spin(). */
1000                 if (LOCK_CLASS(&m->lock_object) == &lock_class_mtx_spin)
1001                         spinlock_exit();
1002                 else
1003                         curthread->td_locks--;
1004
1005                 lock_profile_release_lock(&m->lock_object);
1006                 /* Tell witness this isn't locked to make it happy. */
1007                 WITNESS_UNLOCK(&m->lock_object, LOP_EXCLUSIVE, __FILE__,
1008                     __LINE__);
1009         }
1010
1011         m->mtx_lock = MTX_DESTROYED;
1012         lock_destroy(&m->lock_object);
1013 }
1014
1015 /*
1016  * Intialize the mutex code and system mutexes.  This is called from the MD
1017  * startup code prior to mi_startup().  The per-CPU data space needs to be
1018  * setup before this is called.
1019  */
1020 void
1021 mutex_init(void)
1022 {
1023
1024         /* Setup turnstiles so that sleep mutexes work. */
1025         init_turnstiles();
1026
1027         /*
1028          * Initialize mutexes.
1029          */
1030         mtx_init(&Giant, "Giant", NULL, MTX_DEF | MTX_RECURSE);
1031         mtx_init(&blocked_lock, "blocked lock", NULL, MTX_SPIN);
1032         blocked_lock.mtx_lock = 0xdeadc0de;     /* Always blocked. */
1033         mtx_init(&proc0.p_mtx, "process lock", NULL, MTX_DEF | MTX_DUPOK);
1034         mtx_init(&proc0.p_slock, "process slock", NULL, MTX_SPIN | MTX_RECURSE);
1035         mtx_init(&devmtx, "cdev", NULL, MTX_DEF);
1036         mtx_lock(&Giant);
1037 }
1038
1039 #ifdef DDB
1040 void
1041 db_show_mtx(const struct lock_object *lock)
1042 {
1043         struct thread *td;
1044         const struct mtx *m;
1045
1046         m = (const struct mtx *)lock;
1047
1048         db_printf(" flags: {");
1049         if (LOCK_CLASS(lock) == &lock_class_mtx_spin)
1050                 db_printf("SPIN");
1051         else
1052                 db_printf("DEF");
1053         if (m->lock_object.lo_flags & LO_RECURSABLE)
1054                 db_printf(", RECURSE");
1055         if (m->lock_object.lo_flags & LO_DUPOK)
1056                 db_printf(", DUPOK");
1057         db_printf("}\n");
1058         db_printf(" state: {");
1059         if (mtx_unowned(m))
1060                 db_printf("UNOWNED");
1061         else if (mtx_destroyed(m))
1062                 db_printf("DESTROYED");
1063         else {
1064                 db_printf("OWNED");
1065                 if (m->mtx_lock & MTX_CONTESTED)
1066                         db_printf(", CONTESTED");
1067                 if (m->mtx_lock & MTX_RECURSED)
1068                         db_printf(", RECURSED");
1069         }
1070         db_printf("}\n");
1071         if (!mtx_unowned(m) && !mtx_destroyed(m)) {
1072                 td = mtx_owner(m);
1073                 db_printf(" owner: %p (tid %d, pid %d, \"%s\")\n", td,
1074                     td->td_tid, td->td_proc->p_pid, td->td_name);
1075                 if (mtx_recursed(m))
1076                         db_printf(" recursed: %d\n", m->mtx_recurse);
1077         }
1078 }
1079 #endif