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_sched.h"
  43
  44 #include <sys/param.h>
  45 #include <sys/systm.h>
  46 #include <sys/bus.h>
  47 #include <sys/conf.h>
  48 #include <sys/kdb.h>
  49 #include <sys/kernel.h>
  50 #include <sys/ktr.h>
  51 #include <sys/lock.h>
  52 #include <sys/malloc.h>
  53 #include <sys/mutex.h>
  54 #include <sys/proc.h>
  55 #include <sys/resourcevar.h>
  56 #include <sys/sched.h>
  57 #include <sys/sbuf.h>
  58 #include <sys/sysctl.h>
  59 #include <sys/turnstile.h>
  60 #include <sys/vmmeter.h>
  61 #include <sys/lock_profile.h>
  62
  63 #include <machine/atomic.h>
  64 #include <machine/bus.h>
  65 #include <machine/cpu.h>
  66
  67 #include <ddb/ddb.h>
  68
  69 #include <fs/devfs/devfs_int.h>
  70
  71 #include <vm/vm.h>
  72 #include <vm/vm_extern.h>
  73
  74 #if defined(SMP) && !defined(NO_ADAPTIVE_MUTEXES)
  75 #define ADAPTIVE_MUTEXES
  76 #endif
  77
  78 /*
  79  * Internal utility macros.
  80  */
  81 #define mtx_unowned(m)  ((m)->mtx_lock == MTX_UNOWNED)
  82
  83 #define mtx_destroyed(m) ((m)->mtx_lock == MTX_DESTROYED)
  84
  85 #define mtx_owner(m)    ((struct thread *)((m)->mtx_lock & ~MTX_FLAGMASK))
  86
  87 static void     assert_mtx(struct lock_object *lock, int what);
  88 #ifdef DDB
  89 static void     db_show_mtx(struct lock_object *lock);
  90 #endif
  91 static void     lock_mtx(struct lock_object *lock, int how);
  92 static void     lock_spin(struct lock_object *lock, int how);
  93 static int      unlock_mtx(struct lock_object *lock);
  94 static int      unlock_spin(struct lock_object *lock);
  95
  96 /*
  97  * Lock classes for sleep and spin mutexes.
  98  */
  99 struct lock_class lock_class_mtx_sleep = {
 100         .lc_name = "sleep mutex",
 101         .lc_flags = LC_SLEEPLOCK | LC_RECURSABLE,
 102         .lc_assert = assert_mtx,
 103 #ifdef DDB
 104         .lc_ddb_show = db_show_mtx,
 105 #endif
 106         .lc_lock = lock_mtx,
 107         .lc_unlock = unlock_mtx,
 108 };
 109 struct lock_class lock_class_mtx_spin = {
 110         .lc_name = "spin mutex",
 111         .lc_flags = LC_SPINLOCK | LC_RECURSABLE,
 112         .lc_assert = assert_mtx,
 113 #ifdef DDB
 114         .lc_ddb_show = db_show_mtx,
 115 #endif
 116         .lc_lock = lock_spin,
 117         .lc_unlock = unlock_spin,
 118 };
 119
 120 /*
 121  * System-wide mutexes
 122  */
 123 struct mtx blocked_lock;
 124 struct mtx Giant;
 125
 126 void
 127 assert_mtx(struct lock_object *lock, int what)
 128 {
 129
 130         mtx_assert((struct mtx *)lock, what);
 131 }
 132
 133 void
 134 lock_mtx(struct lock_object *lock, int how)
 135 {
 136
 137         mtx_lock((struct mtx *)lock);
 138 }
 139
 140 void
 141 lock_spin(struct lock_object *lock, int how)
 142 {
 143
 144         panic("spin locks can only use msleep_spin");
 145 }
 146
 147 int
 148 unlock_mtx(struct lock_object *lock)
 149 {
 150         struct mtx *m;
 151
 152         m = (struct mtx *)lock;
 153         mtx_assert(m, MA_OWNED | MA_NOTRECURSED);
 154         mtx_unlock(m);
 155         return (0);
 156 }
 157
 158 int
 159 unlock_spin(struct lock_object *lock)
 160 {
 161
 162         panic("spin locks can only use msleep_spin");
 163 }
 164
 165 /*
 166  * Function versions of the inlined __mtx_* macros.  These are used by
 167  * modules and can also be called from assembly language if needed.
 168  */
 169 void
 170 _mtx_lock_flags(struct mtx *m, int opts, const char *file, int line)
 171 {
 172
 173         MPASS(curthread != NULL);
 174         KASSERT(m->mtx_lock != MTX_DESTROYED,
 175             ("mtx_lock() of destroyed mutex @ %s:%d", file, line));
 176         KASSERT(LOCK_CLASS(&m->lock_object) == &lock_class_mtx_sleep,
 177             ("mtx_lock() of spin mutex %s @ %s:%d", m->lock_object.lo_name,
 178             file, line));
 179         WITNESS_CHECKORDER(&m->lock_object, opts | LOP_NEWORDER | LOP_EXCLUSIVE,
 180             file, line);
 181
 182         _get_sleep_lock(m, curthread, opts, file, line);
 183         LOCK_LOG_LOCK("LOCK", &m->lock_object, opts, m->mtx_recurse, file,
 184             line);
 185         WITNESS_LOCK(&m->lock_object, opts | LOP_EXCLUSIVE, file, line);
 186         curthread->td_locks++;
 187 }
 188
 189 void
 190 _mtx_unlock_flags(struct mtx *m, int opts, const char *file, int line)
 191 {
 192         MPASS(curthread != NULL);
 193         KASSERT(m->mtx_lock != MTX_DESTROYED,
 194             ("mtx_unlock() of destroyed mutex @ %s:%d", file, line));
 195         KASSERT(LOCK_CLASS(&m->lock_object) == &lock_class_mtx_sleep,
 196             ("mtx_unlock() of spin mutex %s @ %s:%d", m->lock_object.lo_name,
 197             file, line));
 198         curthread->td_locks--;
 199         WITNESS_UNLOCK(&m->lock_object, opts | LOP_EXCLUSIVE, file, line);
 200         LOCK_LOG_LOCK("UNLOCK", &m->lock_object, opts, m->mtx_recurse, file,
 201             line);
 202         mtx_assert(m, MA_OWNED);
 203
 204         if (m->mtx_recurse == 0)
 205                 lock_profile_release_lock(&m->lock_object);
 206         _rel_sleep_lock(m, curthread, opts, file, line);
 207 }
 208
 209 void
 210 _mtx_lock_spin_flags(struct mtx *m, int opts, const char *file, int line)
 211 {
 212
 213         MPASS(curthread != NULL);
 214         KASSERT(m->mtx_lock != MTX_DESTROYED,
 215             ("mtx_lock_spin() of destroyed mutex @ %s:%d", file, line));
 216         KASSERT(LOCK_CLASS(&m->lock_object) == &lock_class_mtx_spin,
 217             ("mtx_lock_spin() of sleep mutex %s @ %s:%d",
 218             m->lock_object.lo_name, file, line));
 219         WITNESS_CHECKORDER(&m->lock_object, opts | LOP_NEWORDER | LOP_EXCLUSIVE,
 220             file, line);
 221         _get_spin_lock(m, curthread, opts, file, line);
 222         LOCK_LOG_LOCK("LOCK", &m->lock_object, opts, m->mtx_recurse, file,
 223             line);
 224         WITNESS_LOCK(&m->lock_object, opts | LOP_EXCLUSIVE, file, line);
 225 }
 226
 227 void
 228 _mtx_unlock_spin_flags(struct mtx *m, int opts, const char *file, int line)
 229 {
 230
 231         MPASS(curthread != NULL);
 232         KASSERT(m->mtx_lock != MTX_DESTROYED,
 233             ("mtx_unlock_spin() of destroyed mutex @ %s:%d", file, line));
 234         KASSERT(LOCK_CLASS(&m->lock_object) == &lock_class_mtx_spin,
 235             ("mtx_unlock_spin() of sleep mutex %s @ %s:%d",
 236             m->lock_object.lo_name, file, line));
 237         WITNESS_UNLOCK(&m->lock_object, opts | LOP_EXCLUSIVE, file, line);
 238         LOCK_LOG_LOCK("UNLOCK", &m->lock_object, opts, m->mtx_recurse, file,
 239             line);
 240         mtx_assert(m, MA_OWNED);
 241
 242         _rel_spin_lock(m);
 243 }
 244
 245 /*
 246  * The important part of mtx_trylock{,_flags}()
 247  * Tries to acquire lock `m.'  If this function is called on a mutex that
 248  * is already owned, it will recursively acquire the lock.
 249  */
 250 int
 251 _mtx_trylock(struct mtx *m, int opts, const char *file, int line)
 252 {
 253         int rval, contested = 0;
 254         uint64_t waittime = 0;
 255
 256         MPASS(curthread != NULL);
 257         KASSERT(m->mtx_lock != MTX_DESTROYED,
 258             ("mtx_trylock() of destroyed mutex @ %s:%d", file, line));
 259         KASSERT(LOCK_CLASS(&m->lock_object) == &lock_class_mtx_sleep,
 260             ("mtx_trylock() of spin mutex %s @ %s:%d", m->lock_object.lo_name,
 261             file, line));
 262
 263         if (mtx_owned(m) && (m->lock_object.lo_flags & LO_RECURSABLE) != 0) {
 264                 m->mtx_recurse++;
 265                 atomic_set_ptr(&m->mtx_lock, MTX_RECURSED);
 266                 rval = 1;
 267         } else
 268                 rval = _obtain_lock(m, (uintptr_t)curthread);
 269
 270         LOCK_LOG_TRY("LOCK", &m->lock_object, opts, rval, file, line);
 271         if (rval) {
 272                 WITNESS_LOCK(&m->lock_object, opts | LOP_EXCLUSIVE | LOP_TRYLOCK,
 273                     file, line);
 274                 curthread->td_locks++;
 275                 if (m->mtx_recurse == 0)
 276                         lock_profile_obtain_lock_success(&m->lock_object, contested,
 277                             waittime, file, line);
 278
 279         }
 280
 281         return (rval);
 282 }
 283
 284 /*
 285  * _mtx_lock_sleep: the tougher part of acquiring an MTX_DEF lock.
 286  *
 287  * We call this if the lock is either contested (i.e. we need to go to
 288  * sleep waiting for it), or if we need to recurse on it.
 289  */
 290 void
 291 _mtx_lock_sleep(struct mtx *m, uintptr_t tid, int opts, const char *file,
 292     int line)
 293 {
 294         struct turnstile *ts;
 295 #ifdef ADAPTIVE_MUTEXES
 296         volatile struct thread *owner;
 297 #endif
 298 #ifdef KTR
 299         int cont_logged = 0;
 300 #endif
 301         int contested = 0;
 302         uint64_t waittime = 0;
 303         uintptr_t v;
 304
 305         if (mtx_owned(m)) {
 306                 KASSERT((m->lock_object.lo_flags & LO_RECURSABLE) != 0,
 307             ("_mtx_lock_sleep: recursed on non-recursive mutex %s @ %s:%d\n",
 308                     m->lock_object.lo_name, file, line));
 309                 m->mtx_recurse++;
 310                 atomic_set_ptr(&m->mtx_lock, MTX_RECURSED);
 311                 if (LOCK_LOG_TEST(&m->lock_object, opts))
 312                         CTR1(KTR_LOCK, "_mtx_lock_sleep: %p recursing", m);
 313                 return;
 314         }
 315
 316         lock_profile_obtain_lock_failed(&m->lock_object,
 317                     &contested, &waittime);
 318         if (LOCK_LOG_TEST(&m->lock_object, opts))
 319                 CTR4(KTR_LOCK,
 320                     "_mtx_lock_sleep: %s contested (lock=%p) at %s:%d",
 321                     m->lock_object.lo_name, (void *)m->mtx_lock, file, line);
 322
 323         while (!_obtain_lock(m, tid)) {
 324 #ifdef ADAPTIVE_MUTEXES
 325                 /*
 326                  * If the owner is running on another CPU, spin until the
 327                  * owner stops running or the state of the lock changes.
 328                  */
 329                 v = m->mtx_lock;
 330                 if (v != MTX_UNOWNED) {
 331                         owner = (struct thread *)(v & ~MTX_FLAGMASK);
 332                         if (TD_IS_RUNNING(owner)) {
 333                                 if (LOCK_LOG_TEST(&m->lock_object, 0))
 334                                         CTR3(KTR_LOCK,
 335                                             "%s: spinning on %p held by %p",
 336                                             __func__, m, owner);
 337                                 while (mtx_owner(m) == owner &&
 338                                     TD_IS_RUNNING(owner))
 339                                         cpu_spinwait();
 340                                 continue;
 341                         }
 342                 }
 343 #endif
 344
 345                 ts = turnstile_trywait(&m->lock_object);
 346                 v = m->mtx_lock;
 347
 348                 /*
 349                  * Check if the lock has been released while spinning for
 350                  * the turnstile chain lock.
 351                  */
 352                 if (v == MTX_UNOWNED) {
 353                         turnstile_cancel(ts);
 354                         cpu_spinwait();
 355                         continue;
 356                 }
 357
 358                 MPASS(v != MTX_CONTESTED);
 359
 360 #ifdef ADAPTIVE_MUTEXES
 361                 /*
 362                  * If the current owner of the lock is executing on another
 363                  * CPU quit the hard path and try to spin.
 364                  */
 365                 owner = (struct thread *)(v & ~MTX_FLAGMASK);
 366                 if (TD_IS_RUNNING(owner)) {
 367                         turnstile_cancel(ts);
 368                         cpu_spinwait();
 369                         continue;
 370                 }
 371 #endif
 372
 373                 /*
 374                  * If the mutex isn't already contested and a failure occurs
 375                  * setting the contested bit, the mutex was either released
 376                  * or the state of the MTX_RECURSED bit changed.
 377                  */
 378                 if ((v & MTX_CONTESTED) == 0 &&
 379                     !atomic_cmpset_ptr(&m->mtx_lock, v, v | MTX_CONTESTED)) {
 380                         turnstile_cancel(ts);
 381                         cpu_spinwait();
 382                         continue;
 383                 }
 384
 385                 /*
 386                  * We definitely must sleep for this lock.
 387                  */
 388                 mtx_assert(m, MA_NOTOWNED);
 389
 390 #ifdef KTR
 391                 if (!cont_logged) {
 392                         CTR6(KTR_CONTENTION,
 393                             "contention: %p at %s:%d wants %s, taken by %s:%d",
 394                             (void *)tid, file, line, m->lock_object.lo_name,
 395                             WITNESS_FILE(&m->lock_object),
 396                             WITNESS_LINE(&m->lock_object));
 397                         cont_logged = 1;
 398                 }
 399 #endif
 400
 401                 /*
 402                  * Block on the turnstile.
 403                  */
 404                 turnstile_wait(ts, mtx_owner(m), TS_EXCLUSIVE_QUEUE);
 405         }
 406 #ifdef KTR
 407         if (cont_logged) {
 408                 CTR4(KTR_CONTENTION,
 409                     "contention end: %s acquired by %p at %s:%d",
 410                     m->lock_object.lo_name, (void *)tid, file, line);
 411         }
 412 #endif
 413         lock_profile_obtain_lock_success(&m->lock_object, contested,
 414             waittime, file, line);
 415 }
 416
 417 static void
 418 _mtx_lock_spin_failed(struct mtx *m)
 419 {
 420         struct thread *td;
 421
 422         td = mtx_owner(m);
 423
 424         /* If the mutex is unlocked, try again. */
 425         if (td == NULL)
 426                 return;
 427
 428         printf( "spin lock %p (%s) held by %p (tid %d) too long\n",
 429             m, m->lock_object.lo_name, td, td->td_tid);
 430 #ifdef WITNESS
 431         witness_display_spinlock(&m->lock_object, td);
 432 #endif
 433         panic("spin lock held too long");
 434 }
 435
 436 #ifdef SMP
 437 /*
 438  * _mtx_lock_spin: the tougher part of acquiring an MTX_SPIN lock.
 439  *
 440  * This is only called if we need to actually spin for the lock. Recursion
 441  * is handled inline.
 442  */
 443 void
 444 _mtx_lock_spin(struct mtx *m, uintptr_t tid, int opts, const char *file,
 445     int line)
 446 {
 447         int i = 0, contested = 0;
 448         uint64_t waittime = 0;
 449
 450         if (LOCK_LOG_TEST(&m->lock_object, opts))
 451                 CTR1(KTR_LOCK, "_mtx_lock_spin: %p spinning", m);
 452
 453         lock_profile_obtain_lock_failed(&m->lock_object, &contested, &waittime);
 454         while (!_obtain_lock(m, tid)) {
 455
 456                 /* Give interrupts a chance while we spin. */
 457                 spinlock_exit();
 458                 while (m->mtx_lock != MTX_UNOWNED) {
 459                         if (i++ < 10000000) {
 460                                 cpu_spinwait();
 461                                 continue;
 462                         }
 463                         if (i < 60000000 || kdb_active || panicstr != NULL)
 464                                 DELAY(1);
 465                         else
 466                                 _mtx_lock_spin_failed(m);
 467                         cpu_spinwait();
 468                 }
 469                 spinlock_enter();
 470         }
 471
 472         if (LOCK_LOG_TEST(&m->lock_object, opts))
 473                 CTR1(KTR_LOCK, "_mtx_lock_spin: %p spin done", m);
 474
 475         lock_profile_obtain_lock_success(&m->lock_object, contested,
 476             waittime, (file), (line));
 477 }
 478 #endif /* SMP */
 479
 480 void
 481 _thread_lock_flags(struct thread *td, int opts, const char *file, int line)
 482 {
 483         struct mtx *m;
 484         uintptr_t tid;
 485         int i, contested;
 486         uint64_t waittime;
 487
 488         contested = i = 0;
 489         waittime = 0;
 490         tid = (uintptr_t)curthread;
 491         for (;;) {
 492 retry:
 493                 spinlock_enter();
 494                 m = td->td_lock;
 495                 KASSERT(m->mtx_lock != MTX_DESTROYED,
 496                     ("thread_lock() of destroyed mutex @ %s:%d", file, line));
 497                 KASSERT(LOCK_CLASS(&m->lock_object) == &lock_class_mtx_spin,
 498                     ("thread_lock() of sleep mutex %s @ %s:%d",
 499                     m->lock_object.lo_name, file, line));
 500                 WITNESS_CHECKORDER(&m->lock_object,
 501                     opts | LOP_NEWORDER | LOP_EXCLUSIVE, file, line);
 502                 while (!_obtain_lock(m, tid)) {
 503                         if (m->mtx_lock == tid) {
 504                                 m->mtx_recurse++;
 505                                 break;
 506                         }
 507                         lock_profile_obtain_lock_failed(&m->lock_object,
 508                             &contested, &waittime);
 509                         /* Give interrupts a chance while we spin. */
 510                         spinlock_exit();
 511                         while (m->mtx_lock != MTX_UNOWNED) {
 512                                 if (i++ < 10000000)
 513                                         cpu_spinwait();
 514                                 else if (i < 60000000 ||
 515                                     kdb_active || panicstr != NULL)
 516                                         DELAY(1);
 517                                 else
 518                                         _mtx_lock_spin_failed(m);
 519                                 cpu_spinwait();
 520                                 if (m != td->td_lock)
 521                                         goto retry;
 522                         }
 523                         spinlock_enter();
 524                 }
 525                 if (m == td->td_lock)
 526                         break;
 527                 _rel_spin_lock(m);      /* does spinlock_exit() */
 528         }
 529         if (m->mtx_recurse == 0)
 530                 lock_profile_obtain_lock_success(&m->lock_object, contested,
 531                     waittime, (file), (line));
 532         LOCK_LOG_LOCK("LOCK", &m->lock_object, opts, m->mtx_recurse, file,
 533             line);
 534         WITNESS_LOCK(&m->lock_object, opts | LOP_EXCLUSIVE, file, line);
 535 }
 536
 537 struct mtx *
 538 thread_lock_block(struct thread *td)
 539 {
 540         struct mtx *lock;
 541
 542         spinlock_enter();
 543         THREAD_LOCK_ASSERT(td, MA_OWNED);
 544         lock = td->td_lock;
 545         td->td_lock = &blocked_lock;
 546         mtx_unlock_spin(lock);
 547
 548         return (lock);
 549 }
 550
 551 void
 552 thread_lock_unblock(struct thread *td, struct mtx *new)
 553 {
 554         mtx_assert(new, MA_OWNED);
 555         MPASS(td->td_lock == &blocked_lock);
 556         atomic_store_rel_ptr((volatile void *)&td->td_lock, (uintptr_t)new);
 557         spinlock_exit();
 558 }
 559
 560 void
 561 thread_lock_set(struct thread *td, struct mtx *new)
 562 {
 563         struct mtx *lock;
 564
 565         mtx_assert(new, MA_OWNED);
 566         THREAD_LOCK_ASSERT(td, MA_OWNED);
 567         lock = td->td_lock;
 568         td->td_lock = new;
 569         mtx_unlock_spin(lock);
 570 }
 571
 572 /*
 573  * _mtx_unlock_sleep: the tougher part of releasing an MTX_DEF lock.
 574  *
 575  * We are only called here if the lock is recursed or contested (i.e. we
 576  * need to wake up a blocked thread).
 577  */
 578 void
 579 _mtx_unlock_sleep(struct mtx *m, int opts, const char *file, int line)
 580 {
 581         struct turnstile *ts;
 582
 583         if (mtx_recursed(m)) {
 584                 if (--(m->mtx_recurse) == 0)
 585                         atomic_clear_ptr(&m->mtx_lock, MTX_RECURSED);
 586                 if (LOCK_LOG_TEST(&m->lock_object, opts))
 587                         CTR1(KTR_LOCK, "_mtx_unlock_sleep: %p unrecurse", m);
 588                 return;
 589         }
 590
 591         /*
 592          * We have to lock the chain before the turnstile so this turnstile
 593          * can be removed from the hash list if it is empty.
 594          */
 595         turnstile_chain_lock(&m->lock_object);
 596         ts = turnstile_lookup(&m->lock_object);
 597         if (LOCK_LOG_TEST(&m->lock_object, opts))
 598                 CTR1(KTR_LOCK, "_mtx_unlock_sleep: %p contested", m);
 599
 600         MPASS(ts != NULL);
 601         turnstile_broadcast(ts, TS_EXCLUSIVE_QUEUE);
 602         _release_lock_quick(m);
 603         /*
 604          * This turnstile is now no longer associated with the mutex.  We can
 605          * unlock the chain lock so a new turnstile may take it's place.
 606          */
 607         turnstile_unpend(ts, TS_EXCLUSIVE_LOCK);
 608         turnstile_chain_unlock(&m->lock_object);
 609 }
 610
 611 /*
 612  * All the unlocking of MTX_SPIN locks is done inline.
 613  * See the _rel_spin_lock() macro for the details.
 614  */
 615
 616 /*
 617  * The backing function for the INVARIANTS-enabled mtx_assert()
 618  */
 619 #ifdef INVARIANT_SUPPORT
 620 void
 621 _mtx_assert(struct mtx *m, int what, const char *file, int line)
 622 {
 623
 624         if (panicstr != NULL || dumping)
 625                 return;
 626         switch (what) {
 627         case MA_OWNED:
 628         case MA_OWNED | MA_RECURSED:
 629         case MA_OWNED | MA_NOTRECURSED:
 630                 if (!mtx_owned(m))
 631                         panic("mutex %s not owned at %s:%d",
 632                             m->lock_object.lo_name, file, line);
 633                 if (mtx_recursed(m)) {
 634                         if ((what & MA_NOTRECURSED) != 0)
 635                                 panic("mutex %s recursed at %s:%d",
 636                                     m->lock_object.lo_name, file, line);
 637                 } else if ((what & MA_RECURSED) != 0) {
 638                         panic("mutex %s unrecursed at %s:%d",
 639                             m->lock_object.lo_name, file, line);
 640                 }
 641                 break;
 642         case MA_NOTOWNED:
 643                 if (mtx_owned(m))
 644                         panic("mutex %s owned at %s:%d",
 645                             m->lock_object.lo_name, file, line);
 646                 break;
 647         default:
 648                 panic("unknown mtx_assert at %s:%d", file, line);
 649         }
 650 }
 651 #endif
 652
 653 /*
 654  * The MUTEX_DEBUG-enabled mtx_validate()
 655  *
 656  * Most of these checks have been moved off into the LO_INITIALIZED flag
 657  * maintained by the witness code.
 658  */
 659 #ifdef MUTEX_DEBUG
 660
 661 void    mtx_validate(struct mtx *);
 662
 663 void
 664 mtx_validate(struct mtx *m)
 665 {
 666
 667 /*
 668  * XXX: When kernacc() does not require Giant we can reenable this check
 669  */
 670 #ifdef notyet
 671         /*
 672          * Can't call kernacc() from early init386(), especially when
 673          * initializing Giant mutex, because some stuff in kernacc()
 674          * requires Giant itself.
 675          */
 676         if (!cold)
 677                 if (!kernacc((caddr_t)m, sizeof(m),
 678                     VM_PROT_READ | VM_PROT_WRITE))
 679                         panic("Can't read and write to mutex %p", m);
 680 #endif
 681 }
 682 #endif
 683
 684 /*
 685  * General init routine used by the MTX_SYSINIT() macro.
 686  */
 687 void
 688 mtx_sysinit(void *arg)
 689 {
 690         struct mtx_args *margs = arg;
 691
 692         mtx_init(margs->ma_mtx, margs->ma_desc, NULL, margs->ma_opts);
 693 }
 694
 695 /*
 696  * Mutex initialization routine; initialize lock `m' of type contained in
 697  * `opts' with options contained in `opts' and name `name.'  The optional
 698  * lock type `type' is used as a general lock category name for use with
 699  * witness.
 700  */
 701 void
 702 mtx_init(struct mtx *m, const char *name, const char *type, int opts)
 703 {
 704         struct lock_class *class;
 705         int flags;
 706
 707         MPASS((opts & ~(MTX_SPIN | MTX_QUIET | MTX_RECURSE |
 708                 MTX_NOWITNESS | MTX_DUPOK | MTX_NOPROFILE)) == 0);
 709
 710 #ifdef MUTEX_DEBUG
 711         /* Diagnostic and error correction */
 712         mtx_validate(m);
 713 #endif
 714
 715         /* Determine lock class and lock flags. */
 716         if (opts & MTX_SPIN)
 717                 class = &lock_class_mtx_spin;
 718         else
 719                 class = &lock_class_mtx_sleep;
 720         flags = 0;
 721         if (opts & MTX_QUIET)
 722                 flags |= LO_QUIET;
 723         if (opts & MTX_RECURSE)
 724                 flags |= LO_RECURSABLE;
 725         if ((opts & MTX_NOWITNESS) == 0)
 726                 flags |= LO_WITNESS;
 727         if (opts & MTX_DUPOK)
 728                 flags |= LO_DUPOK;
 729         if (opts & MTX_NOPROFILE)
 730                 flags |= LO_NOPROFILE;
 731
 732         /* Initialize mutex. */
 733         m->mtx_lock = MTX_UNOWNED;
 734         m->mtx_recurse = 0;
 735
 736         lock_init(&m->lock_object, class, name, type, flags);
 737 }
 738
 739 /*
 740  * Remove lock `m' from all_mtx queue.  We don't allow MTX_QUIET to be
 741  * passed in as a flag here because if the corresponding mtx_init() was
 742  * called with MTX_QUIET set, then it will already be set in the mutex's
 743  * flags.
 744  */
 745 void
 746 mtx_destroy(struct mtx *m)
 747 {
 748
 749         if (!mtx_owned(m))
 750                 MPASS(mtx_unowned(m));
 751         else {
 752                 MPASS((m->mtx_lock & (MTX_RECURSED|MTX_CONTESTED)) == 0);
 753
 754                 /* Perform the non-mtx related part of mtx_unlock_spin(). */
 755                 if (LOCK_CLASS(&m->lock_object) == &lock_class_mtx_spin)
 756                         spinlock_exit();
 757                 else
 758                         curthread->td_locks--;
 759
 760                 /* Tell witness this isn't locked to make it happy. */
 761                 WITNESS_UNLOCK(&m->lock_object, LOP_EXCLUSIVE, __FILE__,
 762                     __LINE__);
 763         }
 764
 765         m->mtx_lock = MTX_DESTROYED;
 766         lock_destroy(&m->lock_object);
 767 }
 768
 769 /*
 770  * Intialize the mutex code and system mutexes.  This is called from the MD
 771  * startup code prior to mi_startup().  The per-CPU data space needs to be
 772  * setup before this is called.
 773  */
 774 void
 775 mutex_init(void)
 776 {
 777
 778         /* Setup turnstiles so that sleep mutexes work. */
 779         init_turnstiles();
 780
 781         /*
 782          * Initialize mutexes.
 783          */
 784         mtx_init(&Giant, "Giant", NULL, MTX_DEF | MTX_RECURSE);
 785         mtx_init(&blocked_lock, "blocked lock", NULL, MTX_SPIN);
 786         blocked_lock.mtx_lock = 0xdeadc0de;     /* Always blocked. */
 787         mtx_init(&proc0.p_mtx, "process lock", NULL, MTX_DEF | MTX_DUPOK);
 788         mtx_init(&proc0.p_slock, "process slock", NULL, MTX_SPIN | MTX_RECURSE);
 789         mtx_init(&devmtx, "cdev", NULL, MTX_DEF);
 790         mtx_lock(&Giant);
 791 }
 792
 793 #ifdef DDB
 794 void
 795 db_show_mtx(struct lock_object *lock)
 796 {
 797         struct thread *td;
 798         struct mtx *m;
 799
 800         m = (struct mtx *)lock;
 801
 802         db_printf(" flags: {");
 803         if (LOCK_CLASS(lock) == &lock_class_mtx_spin)
 804                 db_printf("SPIN");
 805         else
 806                 db_printf("DEF");
 807         if (m->lock_object.lo_flags & LO_RECURSABLE)
 808                 db_printf(", RECURSE");
 809         if (m->lock_object.lo_flags & LO_DUPOK)
 810                 db_printf(", DUPOK");
 811         db_printf("}\n");
 812         db_printf(" state: {");
 813         if (mtx_unowned(m))
 814                 db_printf("UNOWNED");
 815         else if (mtx_destroyed(m))
 816                 db_printf("DESTROYED");
 817         else {
 818                 db_printf("OWNED");
 819                 if (m->mtx_lock & MTX_CONTESTED)
 820                         db_printf(", CONTESTED");
 821                 if (m->mtx_lock & MTX_RECURSED)
 822                         db_printf(", RECURSED");
 823         }
 824         db_printf("}\n");
 825         if (!mtx_unowned(m) && !mtx_destroyed(m)) {
 826                 td = mtx_owner(m);
 827                 db_printf(" owner: %p (tid %d, pid %d, \"%s\")\n", td,
 828                     td->td_tid, td->td_proc->p_pid, td->td_name);
 829                 if (mtx_recursed(m))
 830                         db_printf(" recursed: %d\n", m->mtx_recurse);
 831         }
 832 }
 833 #endif