sys/kern/kern_rmlock.c

   1 /*-
   2  * Copyright (c) 2007 Stephan Uphoff <ups@FreeBSD.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   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.
  13  * 3. Neither the name of the author nor the names of any co-contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29
  30 /*
  31  * Machine independent bits of reader/writer lock implementation.
  32  */
  33
  34 #include <sys/cdefs.h>
  35 __FBSDID("$FreeBSD$");
  36
  37 #include "opt_ddb.h"
  38
  39 #include <sys/param.h>
  40 #include <sys/systm.h>
  41
  42 #include <sys/kernel.h>
  43 #include <sys/kdb.h>
  44 #include <sys/ktr.h>
  45 #include <sys/lock.h>
  46 #include <sys/mutex.h>
  47 #include <sys/proc.h>
  48 #include <sys/rmlock.h>
  49 #include <sys/sched.h>
  50 #include <sys/smp.h>
  51 #include <sys/turnstile.h>
  52 #include <sys/lock_profile.h>
  53 #include <machine/cpu.h>
  54
  55 #ifdef DDB
  56 #include <ddb/ddb.h>
  57 #endif
  58
  59 /*
  60  * A cookie to mark destroyed rmlocks.  This is stored in the head of
  61  * rm_activeReaders.
  62  */
  63 #define RM_DESTROYED    ((void *)0xdead)
  64
  65 #define rm_destroyed(rm)                                                \
  66         (LIST_FIRST(&(rm)->rm_activeReaders) == RM_DESTROYED)
  67
  68 #define RMPF_ONQUEUE    1
  69 #define RMPF_SIGNAL     2
  70
  71 #ifndef INVARIANTS
  72 #define _rm_assert(c, what, file, line)
  73 #endif
  74
  75 static void     assert_rm(const struct lock_object *lock, int what);
  76 #ifdef DDB
  77 static void     db_show_rm(const struct lock_object *lock);
  78 #endif
  79 static void     lock_rm(struct lock_object *lock, uintptr_t how);
  80 #ifdef KDTRACE_HOOKS
  81 static int      owner_rm(const struct lock_object *lock, struct thread **owner);
  82 #endif
  83 static uintptr_t unlock_rm(struct lock_object *lock);
  84
  85 struct lock_class lock_class_rm = {
  86         .lc_name = "rm",
  87         .lc_flags = LC_SLEEPLOCK | LC_RECURSABLE,
  88         .lc_assert = assert_rm,
  89 #ifdef DDB
  90         .lc_ddb_show = db_show_rm,
  91 #endif
  92         .lc_lock = lock_rm,
  93         .lc_unlock = unlock_rm,
  94 #ifdef KDTRACE_HOOKS
  95         .lc_owner = owner_rm,
  96 #endif
  97 };
  98
  99 struct lock_class lock_class_rm_sleepable = {
 100         .lc_name = "sleepable rm",
 101         .lc_flags = LC_SLEEPLOCK | LC_SLEEPABLE | LC_RECURSABLE,
 102         .lc_assert = assert_rm,
 103 #ifdef DDB
 104         .lc_ddb_show = db_show_rm,
 105 #endif
 106         .lc_lock = lock_rm,
 107         .lc_unlock = unlock_rm,
 108 #ifdef KDTRACE_HOOKS
 109         .lc_owner = owner_rm,
 110 #endif
 111 };
 112
 113 static void
 114 assert_rm(const struct lock_object *lock, int what)
 115 {
 116
 117         rm_assert((const struct rmlock *)lock, what);
 118 }
 119
 120 static void
 121 lock_rm(struct lock_object *lock, uintptr_t how)
 122 {
 123         struct rmlock *rm;
 124         struct rm_priotracker *tracker;
 125
 126         rm = (struct rmlock *)lock;
 127         if (how == 0)
 128                 rm_wlock(rm);
 129         else {
 130                 tracker = (struct rm_priotracker *)how;
 131                 rm_rlock(rm, tracker);
 132         }
 133 }
 134
 135 static uintptr_t
 136 unlock_rm(struct lock_object *lock)
 137 {
 138         struct thread *td;
 139         struct pcpu *pc;
 140         struct rmlock *rm;
 141         struct rm_queue *queue;
 142         struct rm_priotracker *tracker;
 143         uintptr_t how;
 144
 145         rm = (struct rmlock *)lock;
 146         tracker = NULL;
 147         how = 0;
 148         rm_assert(rm, RA_LOCKED | RA_NOTRECURSED);
 149         if (rm_wowned(rm))
 150                 rm_wunlock(rm);
 151         else {
 152                 /*
 153                  * Find the right rm_priotracker structure for curthread.
 154                  * The guarantee about its uniqueness is given by the fact
 155                  * we already asserted the lock wasn't recursively acquired.
 156                  */
 157                 critical_enter();
 158                 td = curthread;
 159                 pc = pcpu_find(curcpu);
 160                 for (queue = pc->pc_rm_queue.rmq_next;
 161                     queue != &pc->pc_rm_queue; queue = queue->rmq_next) {
 162                         tracker = (struct rm_priotracker *)queue;
 163                                 if ((tracker->rmp_rmlock == rm) &&
 164                                     (tracker->rmp_thread == td)) {
 165                                         how = (uintptr_t)tracker;
 166                                         break;
 167                                 }
 168                 }
 169                 KASSERT(tracker != NULL,
 170                     ("rm_priotracker is non-NULL when lock held in read mode"));
 171                 critical_exit();
 172                 rm_runlock(rm, tracker);
 173         }
 174         return (how);
 175 }
 176
 177 #ifdef KDTRACE_HOOKS
 178 static int
 179 owner_rm(const struct lock_object *lock, struct thread **owner)
 180 {
 181         const struct rmlock *rm;
 182         struct lock_class *lc;
 183
 184         rm = (const struct rmlock *)lock;
 185         lc = LOCK_CLASS(&rm->rm_wlock_object);
 186         return (lc->lc_owner(&rm->rm_wlock_object, owner));
 187 }
 188 #endif
 189
 190 static struct mtx rm_spinlock;
 191
 192 MTX_SYSINIT(rm_spinlock, &rm_spinlock, "rm_spinlock", MTX_SPIN);
 193
 194 /*
 195  * Add or remove tracker from per-cpu list.
 196  *
 197  * The per-cpu list can be traversed at any time in forward direction from an
 198  * interrupt on the *local* cpu.
 199  */
 200 static void inline
 201 rm_tracker_add(struct pcpu *pc, struct rm_priotracker *tracker)
 202 {
 203         struct rm_queue *next;
 204
 205         /* Initialize all tracker pointers */
 206         tracker->rmp_cpuQueue.rmq_prev = &pc->pc_rm_queue;
 207         next = pc->pc_rm_queue.rmq_next;
 208         tracker->rmp_cpuQueue.rmq_next = next;
 209
 210         /* rmq_prev is not used during froward traversal. */
 211         next->rmq_prev = &tracker->rmp_cpuQueue;
 212
 213         /* Update pointer to first element. */
 214         pc->pc_rm_queue.rmq_next = &tracker->rmp_cpuQueue;
 215 }
 216
 217 /*
 218  * Return a count of the number of trackers the thread 'td' already
 219  * has on this CPU for the lock 'rm'.
 220  */
 221 static int
 222 rm_trackers_present(const struct pcpu *pc, const struct rmlock *rm,
 223     const struct thread *td)
 224 {
 225         struct rm_queue *queue;
 226         struct rm_priotracker *tracker;
 227         int count;
 228
 229         count = 0;
 230         for (queue = pc->pc_rm_queue.rmq_next; queue != &pc->pc_rm_queue;
 231             queue = queue->rmq_next) {
 232                 tracker = (struct rm_priotracker *)queue;
 233                 if ((tracker->rmp_rmlock == rm) && (tracker->rmp_thread == td))
 234                         count++;
 235         }
 236         return (count);
 237 }
 238
 239 static void inline
 240 rm_tracker_remove(struct pcpu *pc, struct rm_priotracker *tracker)
 241 {
 242         struct rm_queue *next, *prev;
 243
 244         next = tracker->rmp_cpuQueue.rmq_next;
 245         prev = tracker->rmp_cpuQueue.rmq_prev;
 246
 247         /* Not used during forward traversal. */
 248         next->rmq_prev = prev;
 249
 250         /* Remove from list. */
 251         prev->rmq_next = next;
 252 }
 253
 254 static void
 255 rm_cleanIPI(void *arg)
 256 {
 257         struct pcpu *pc;
 258         struct rmlock *rm = arg;
 259         struct rm_priotracker *tracker;
 260         struct rm_queue *queue;
 261         pc = pcpu_find(curcpu);
 262
 263         for (queue = pc->pc_rm_queue.rmq_next; queue != &pc->pc_rm_queue;
 264             queue = queue->rmq_next) {
 265                 tracker = (struct rm_priotracker *)queue;
 266                 if (tracker->rmp_rmlock == rm && tracker->rmp_flags == 0) {
 267                         tracker->rmp_flags = RMPF_ONQUEUE;
 268                         mtx_lock_spin(&rm_spinlock);
 269                         LIST_INSERT_HEAD(&rm->rm_activeReaders, tracker,
 270                             rmp_qentry);
 271                         mtx_unlock_spin(&rm_spinlock);
 272                 }
 273         }
 274 }
 275
 276 void
 277 rm_init_flags(struct rmlock *rm, const char *name, int opts)
 278 {
 279         struct lock_class *lc;
 280         int liflags, xflags;
 281
 282         liflags = 0;
 283         if (!(opts & RM_NOWITNESS))
 284                 liflags |= LO_WITNESS;
 285         if (opts & RM_RECURSE)
 286                 liflags |= LO_RECURSABLE;
 287         if (opts & RM_NEW)
 288                 liflags |= LO_NEW;
 289         rm->rm_writecpus = all_cpus;
 290         LIST_INIT(&rm->rm_activeReaders);
 291         if (opts & RM_SLEEPABLE) {
 292                 liflags |= LO_SLEEPABLE;
 293                 lc = &lock_class_rm_sleepable;
 294                 xflags = (opts & RM_NEW ? SX_NEW : 0);
 295                 sx_init_flags(&rm->rm_lock_sx, "rmlock_sx",
 296                     xflags | SX_NOWITNESS);
 297         } else {
 298                 lc = &lock_class_rm;
 299                 xflags = (opts & RM_NEW ? MTX_NEW : 0);
 300                 mtx_init(&rm->rm_lock_mtx, name, "rmlock_mtx",
 301                     xflags | MTX_NOWITNESS);
 302         }
 303         lock_init(&rm->lock_object, lc, name, NULL, liflags);
 304 }
 305
 306 void
 307 rm_init(struct rmlock *rm, const char *name)
 308 {
 309
 310         rm_init_flags(rm, name, 0);
 311 }
 312
 313 void
 314 rm_destroy(struct rmlock *rm)
 315 {
 316
 317         rm_assert(rm, RA_UNLOCKED);
 318         LIST_FIRST(&rm->rm_activeReaders) = RM_DESTROYED;
 319         if (rm->lock_object.lo_flags & LO_SLEEPABLE)
 320                 sx_destroy(&rm->rm_lock_sx);
 321         else
 322                 mtx_destroy(&rm->rm_lock_mtx);
 323         lock_destroy(&rm->lock_object);
 324 }
 325
 326 int
 327 rm_wowned(const struct rmlock *rm)
 328 {
 329
 330         if (rm->lock_object.lo_flags & LO_SLEEPABLE)
 331                 return (sx_xlocked(&rm->rm_lock_sx));
 332         else
 333                 return (mtx_owned(&rm->rm_lock_mtx));
 334 }
 335
 336 void
 337 rm_sysinit(void *arg)
 338 {
 339         struct rm_args *args = arg;
 340
 341         rm_init(args->ra_rm, args->ra_desc);
 342 }
 343
 344 void
 345 rm_sysinit_flags(void *arg)
 346 {
 347         struct rm_args_flags *args = arg;
 348
 349         rm_init_flags(args->ra_rm, args->ra_desc, args->ra_opts);
 350 }
 351
 352 static int
 353 _rm_rlock_hard(struct rmlock *rm, struct rm_priotracker *tracker, int trylock)
 354 {
 355         struct pcpu *pc;
 356
 357         critical_enter();
 358         pc = pcpu_find(curcpu);
 359
 360         /* Check if we just need to do a proper critical_exit. */
 361         if (!CPU_ISSET(pc->pc_cpuid, &rm->rm_writecpus)) {
 362                 critical_exit();
 363                 return (1);
 364         }
 365
 366         /* Remove our tracker from the per-cpu list. */
 367         rm_tracker_remove(pc, tracker);
 368
 369         /* Check to see if the IPI granted us the lock after all. */
 370         if (tracker->rmp_flags) {
 371                 /* Just add back tracker - we hold the lock. */
 372                 rm_tracker_add(pc, tracker);
 373                 critical_exit();
 374                 return (1);
 375         }
 376
 377         /*
 378          * We allow readers to aquire a lock even if a writer is blocked if
 379          * the lock is recursive and the reader already holds the lock.
 380          */
 381         if ((rm->lock_object.lo_flags & LO_RECURSABLE) != 0) {
 382                 /*
 383                  * Just grant the lock if this thread already has a tracker
 384                  * for this lock on the per-cpu queue.
 385                  */
 386                 if (rm_trackers_present(pc, rm, curthread) != 0) {
 387                         mtx_lock_spin(&rm_spinlock);
 388                         LIST_INSERT_HEAD(&rm->rm_activeReaders, tracker,
 389                             rmp_qentry);
 390                         tracker->rmp_flags = RMPF_ONQUEUE;
 391                         mtx_unlock_spin(&rm_spinlock);
 392                         rm_tracker_add(pc, tracker);
 393                         critical_exit();
 394                         return (1);
 395                 }
 396         }
 397
 398         sched_unpin();
 399         critical_exit();
 400
 401         if (trylock) {
 402                 if (rm->lock_object.lo_flags & LO_SLEEPABLE) {
 403                         if (!sx_try_xlock(&rm->rm_lock_sx))
 404                                 return (0);
 405                 } else {
 406                         if (!mtx_trylock(&rm->rm_lock_mtx))
 407                                 return (0);
 408                 }
 409         } else {
 410                 if (rm->lock_object.lo_flags & LO_SLEEPABLE)
 411                         sx_xlock(&rm->rm_lock_sx);
 412                 else
 413                         mtx_lock(&rm->rm_lock_mtx);
 414         }
 415
 416         critical_enter();
 417         pc = pcpu_find(curcpu);
 418         CPU_CLR(pc->pc_cpuid, &rm->rm_writecpus);
 419         rm_tracker_add(pc, tracker);
 420         sched_pin();
 421         critical_exit();
 422
 423         if (rm->lock_object.lo_flags & LO_SLEEPABLE)
 424                 sx_xunlock(&rm->rm_lock_sx);
 425         else
 426                 mtx_unlock(&rm->rm_lock_mtx);
 427
 428         return (1);
 429 }
 430
 431 int
 432 _rm_rlock(struct rmlock *rm, struct rm_priotracker *tracker, int trylock)
 433 {
 434         struct thread *td = curthread;
 435         struct pcpu *pc;
 436
 437         if (SCHEDULER_STOPPED())
 438                 return (1);
 439
 440         tracker->rmp_flags  = 0;
 441         tracker->rmp_thread = td;
 442         tracker->rmp_rmlock = rm;
 443
 444         if (rm->lock_object.lo_flags & LO_SLEEPABLE)
 445                 THREAD_NO_SLEEPING();
 446
 447         td->td_critnest++;      /* critical_enter(); */
 448
 449         __compiler_membar();
 450
 451         pc = cpuid_to_pcpu[td->td_oncpu]; /* pcpu_find(td->td_oncpu); */
 452
 453         rm_tracker_add(pc, tracker);
 454
 455         sched_pin();
 456
 457         __compiler_membar();
 458
 459         td->td_critnest--;
 460
 461         /*
 462          * Fast path to combine two common conditions into a single
 463          * conditional jump.
 464          */
 465         if (0 == (td->td_owepreempt |
 466             CPU_ISSET(pc->pc_cpuid, &rm->rm_writecpus)))
 467                 return (1);
 468
 469         /* We do not have a read token and need to acquire one. */
 470         return _rm_rlock_hard(rm, tracker, trylock);
 471 }
 472
 473 static void
 474 _rm_unlock_hard(struct thread *td,struct rm_priotracker *tracker)
 475 {
 476
 477         if (td->td_owepreempt) {
 478                 td->td_critnest++;
 479                 critical_exit();
 480         }
 481
 482         if (!tracker->rmp_flags)
 483                 return;
 484
 485         mtx_lock_spin(&rm_spinlock);
 486         LIST_REMOVE(tracker, rmp_qentry);
 487
 488         if (tracker->rmp_flags & RMPF_SIGNAL) {
 489                 struct rmlock *rm;
 490                 struct turnstile *ts;
 491
 492                 rm = tracker->rmp_rmlock;
 493
 494                 turnstile_chain_lock(&rm->lock_object);
 495                 mtx_unlock_spin(&rm_spinlock);
 496
 497                 ts = turnstile_lookup(&rm->lock_object);
 498
 499                 turnstile_signal(ts, TS_EXCLUSIVE_QUEUE);
 500                 turnstile_unpend(ts, TS_EXCLUSIVE_LOCK);
 501                 turnstile_chain_unlock(&rm->lock_object);
 502         } else
 503                 mtx_unlock_spin(&rm_spinlock);
 504 }
 505
 506 void
 507 _rm_runlock(struct rmlock *rm, struct rm_priotracker *tracker)
 508 {
 509         struct pcpu *pc;
 510         struct thread *td = tracker->rmp_thread;
 511
 512         if (SCHEDULER_STOPPED())
 513                 return;
 514
 515         td->td_critnest++;      /* critical_enter(); */
 516         pc = cpuid_to_pcpu[td->td_oncpu]; /* pcpu_find(td->td_oncpu); */
 517         rm_tracker_remove(pc, tracker);
 518         td->td_critnest--;
 519         sched_unpin();
 520
 521         if (rm->lock_object.lo_flags & LO_SLEEPABLE)
 522                 THREAD_SLEEPING_OK();
 523
 524         if (0 == (td->td_owepreempt | tracker->rmp_flags))
 525                 return;
 526
 527         _rm_unlock_hard(td, tracker);
 528 }
 529
 530 void
 531 _rm_wlock(struct rmlock *rm)
 532 {
 533         struct rm_priotracker *prio;
 534         struct turnstile *ts;
 535         cpuset_t readcpus;
 536
 537         if (SCHEDULER_STOPPED())
 538                 return;
 539
 540         if (rm->lock_object.lo_flags & LO_SLEEPABLE)
 541                 sx_xlock(&rm->rm_lock_sx);
 542         else
 543                 mtx_lock(&rm->rm_lock_mtx);
 544
 545         if (CPU_CMP(&rm->rm_writecpus, &all_cpus)) {
 546                 /* Get all read tokens back */
 547                 readcpus = all_cpus;
 548                 CPU_NAND(&readcpus, &rm->rm_writecpus);
 549                 rm->rm_writecpus = all_cpus;
 550
 551                 /*
 552                  * Assumes rm->rm_writecpus update is visible on other CPUs
 553                  * before rm_cleanIPI is called.
 554                  */
 555 #ifdef SMP
 556                 smp_rendezvous_cpus(readcpus,
 557                     smp_no_rendevous_barrier,
 558                     rm_cleanIPI,
 559                     smp_no_rendevous_barrier,
 560                     rm);
 561
 562 #else
 563                 rm_cleanIPI(rm);
 564 #endif
 565
 566                 mtx_lock_spin(&rm_spinlock);
 567                 while ((prio = LIST_FIRST(&rm->rm_activeReaders)) != NULL) {
 568                         ts = turnstile_trywait(&rm->lock_object);
 569                         prio->rmp_flags = RMPF_ONQUEUE | RMPF_SIGNAL;
 570                         mtx_unlock_spin(&rm_spinlock);
 571                         turnstile_wait(ts, prio->rmp_thread,
 572                             TS_EXCLUSIVE_QUEUE);
 573                         mtx_lock_spin(&rm_spinlock);
 574                 }
 575                 mtx_unlock_spin(&rm_spinlock);
 576         }
 577 }
 578
 579 void
 580 _rm_wunlock(struct rmlock *rm)
 581 {
 582
 583         if (rm->lock_object.lo_flags & LO_SLEEPABLE)
 584                 sx_xunlock(&rm->rm_lock_sx);
 585         else
 586                 mtx_unlock(&rm->rm_lock_mtx);
 587 }
 588
 589 #if LOCK_DEBUG > 0
 590
 591 void
 592 _rm_wlock_debug(struct rmlock *rm, const char *file, int line)
 593 {
 594
 595         if (SCHEDULER_STOPPED())
 596                 return;
 597
 598         KASSERT(kdb_active != 0 || !TD_IS_IDLETHREAD(curthread),
 599             ("rm_wlock() by idle thread %p on rmlock %s @ %s:%d",
 600             curthread, rm->lock_object.lo_name, file, line));
 601         KASSERT(!rm_destroyed(rm),
 602             ("rm_wlock() of destroyed rmlock @ %s:%d", file, line));
 603         _rm_assert(rm, RA_UNLOCKED, file, line);
 604
 605         WITNESS_CHECKORDER(&rm->lock_object, LOP_NEWORDER | LOP_EXCLUSIVE,
 606             file, line, NULL);
 607
 608         _rm_wlock(rm);
 609
 610         LOCK_LOG_LOCK("RMWLOCK", &rm->lock_object, 0, 0, file, line);
 611         WITNESS_LOCK(&rm->lock_object, LOP_EXCLUSIVE, file, line);
 612         TD_LOCKS_INC(curthread);
 613 }
 614
 615 void
 616 _rm_wunlock_debug(struct rmlock *rm, const char *file, int line)
 617 {
 618
 619         if (SCHEDULER_STOPPED())
 620                 return;
 621
 622         KASSERT(!rm_destroyed(rm),
 623             ("rm_wunlock() of destroyed rmlock @ %s:%d", file, line));
 624         _rm_assert(rm, RA_WLOCKED, file, line);
 625         WITNESS_UNLOCK(&rm->lock_object, LOP_EXCLUSIVE, file, line);
 626         LOCK_LOG_LOCK("RMWUNLOCK", &rm->lock_object, 0, 0, file, line);
 627         _rm_wunlock(rm);
 628         TD_LOCKS_DEC(curthread);
 629 }
 630
 631 int
 632 _rm_rlock_debug(struct rmlock *rm, struct rm_priotracker *tracker,
 633     int trylock, const char *file, int line)
 634 {
 635
 636         if (SCHEDULER_STOPPED())
 637                 return (1);
 638
 639 #ifdef INVARIANTS
 640         if (!(rm->lock_object.lo_flags & LO_RECURSABLE) && !trylock) {
 641                 critical_enter();
 642                 KASSERT(rm_trackers_present(pcpu_find(curcpu), rm,
 643                     curthread) == 0,
 644                     ("rm_rlock: recursed on non-recursive rmlock %s @ %s:%d\n",
 645                     rm->lock_object.lo_name, file, line));
 646                 critical_exit();
 647         }
 648 #endif
 649         KASSERT(kdb_active != 0 || !TD_IS_IDLETHREAD(curthread),
 650             ("rm_rlock() by idle thread %p on rmlock %s @ %s:%d",
 651             curthread, rm->lock_object.lo_name, file, line));
 652         KASSERT(!rm_destroyed(rm),
 653             ("rm_rlock() of destroyed rmlock @ %s:%d", file, line));
 654         if (!trylock) {
 655                 KASSERT(!rm_wowned(rm),
 656                     ("rm_rlock: wlock already held for %s @ %s:%d",
 657                     rm->lock_object.lo_name, file, line));
 658                 WITNESS_CHECKORDER(&rm->lock_object, LOP_NEWORDER, file, line,
 659                     NULL);
 660         }
 661
 662         if (_rm_rlock(rm, tracker, trylock)) {
 663                 if (trylock)
 664                         LOCK_LOG_TRY("RMRLOCK", &rm->lock_object, 0, 1, file,
 665                             line);
 666                 else
 667                         LOCK_LOG_LOCK("RMRLOCK", &rm->lock_object, 0, 0, file,
 668                             line);
 669                 WITNESS_LOCK(&rm->lock_object, 0, file, line);
 670                 TD_LOCKS_INC(curthread);
 671                 return (1);
 672         } else if (trylock)
 673                 LOCK_LOG_TRY("RMRLOCK", &rm->lock_object, 0, 0, file, line);
 674
 675         return (0);
 676 }
 677
 678 void
 679 _rm_runlock_debug(struct rmlock *rm, struct rm_priotracker *tracker,
 680     const char *file, int line)
 681 {
 682
 683         if (SCHEDULER_STOPPED())
 684                 return;
 685
 686         KASSERT(!rm_destroyed(rm),
 687             ("rm_runlock() of destroyed rmlock @ %s:%d", file, line));
 688         _rm_assert(rm, RA_RLOCKED, file, line);
 689         WITNESS_UNLOCK(&rm->lock_object, 0, file, line);
 690         LOCK_LOG_LOCK("RMRUNLOCK", &rm->lock_object, 0, 0, file, line);
 691         _rm_runlock(rm, tracker);
 692         TD_LOCKS_DEC(curthread);
 693 }
 694
 695 #else
 696
 697 /*
 698  * Just strip out file and line arguments if no lock debugging is enabled in
 699  * the kernel - we are called from a kernel module.
 700  */
 701 void
 702 _rm_wlock_debug(struct rmlock *rm, const char *file, int line)
 703 {
 704
 705         _rm_wlock(rm);
 706 }
 707
 708 void
 709 _rm_wunlock_debug(struct rmlock *rm, const char *file, int line)
 710 {
 711
 712         _rm_wunlock(rm);
 713 }
 714
 715 int
 716 _rm_rlock_debug(struct rmlock *rm, struct rm_priotracker *tracker,
 717     int trylock, const char *file, int line)
 718 {
 719
 720         return _rm_rlock(rm, tracker, trylock);
 721 }
 722
 723 void
 724 _rm_runlock_debug(struct rmlock *rm, struct rm_priotracker *tracker,
 725     const char *file, int line)
 726 {
 727
 728         _rm_runlock(rm, tracker);
 729 }
 730
 731 #endif
 732
 733 #ifdef INVARIANT_SUPPORT
 734 #ifndef INVARIANTS
 735 #undef _rm_assert
 736 #endif
 737
 738 /*
 739  * Note that this does not need to use witness_assert() for read lock
 740  * assertions since an exact count of read locks held by this thread
 741  * is computable.
 742  */
 743 void
 744 _rm_assert(const struct rmlock *rm, int what, const char *file, int line)
 745 {
 746         int count;
 747
 748         if (panicstr != NULL)
 749                 return;
 750         switch (what) {
 751         case RA_LOCKED:
 752         case RA_LOCKED | RA_RECURSED:
 753         case RA_LOCKED | RA_NOTRECURSED:
 754         case RA_RLOCKED:
 755         case RA_RLOCKED | RA_RECURSED:
 756         case RA_RLOCKED | RA_NOTRECURSED:
 757                 /*
 758                  * Handle the write-locked case.  Unlike other
 759                  * primitives, writers can never recurse.
 760                  */
 761                 if (rm_wowned(rm)) {
 762                         if (what & RA_RLOCKED)
 763                                 panic("Lock %s exclusively locked @ %s:%d\n",
 764                                     rm->lock_object.lo_name, file, line);
 765                         if (what & RA_RECURSED)
 766                                 panic("Lock %s not recursed @ %s:%d\n",
 767                                     rm->lock_object.lo_name, file, line);
 768                         break;
 769                 }
 770
 771                 critical_enter();
 772                 count = rm_trackers_present(pcpu_find(curcpu), rm, curthread);
 773                 critical_exit();
 774
 775                 if (count == 0)
 776                         panic("Lock %s not %slocked @ %s:%d\n",
 777                             rm->lock_object.lo_name, (what & RA_RLOCKED) ?
 778                             "read " : "", file, line);
 779                 if (count > 1) {
 780                         if (what & RA_NOTRECURSED)
 781                                 panic("Lock %s recursed @ %s:%d\n",
 782                                     rm->lock_object.lo_name, file, line);
 783                 } else if (what & RA_RECURSED)
 784                         panic("Lock %s not recursed @ %s:%d\n",
 785                             rm->lock_object.lo_name, file, line);
 786                 break;
 787         case RA_WLOCKED:
 788                 if (!rm_wowned(rm))
 789                         panic("Lock %s not exclusively locked @ %s:%d\n",
 790                             rm->lock_object.lo_name, file, line);
 791                 break;
 792         case RA_UNLOCKED:
 793                 if (rm_wowned(rm))
 794                         panic("Lock %s exclusively locked @ %s:%d\n",
 795                             rm->lock_object.lo_name, file, line);
 796
 797                 critical_enter();
 798                 count = rm_trackers_present(pcpu_find(curcpu), rm, curthread);
 799                 critical_exit();
 800
 801                 if (count != 0)
 802                         panic("Lock %s read locked @ %s:%d\n",
 803                             rm->lock_object.lo_name, file, line);
 804                 break;
 805         default:
 806                 panic("Unknown rm lock assertion: %d @ %s:%d", what, file,
 807                     line);
 808         }
 809 }
 810 #endif /* INVARIANT_SUPPORT */
 811
 812 #ifdef DDB
 813 static void
 814 print_tracker(struct rm_priotracker *tr)
 815 {
 816         struct thread *td;
 817
 818         td = tr->rmp_thread;
 819         db_printf("   thread %p (tid %d, pid %d, \"%s\") {", td, td->td_tid,
 820             td->td_proc->p_pid, td->td_name);
 821         if (tr->rmp_flags & RMPF_ONQUEUE) {
 822                 db_printf("ONQUEUE");
 823                 if (tr->rmp_flags & RMPF_SIGNAL)
 824                         db_printf(",SIGNAL");
 825         } else
 826                 db_printf("0");
 827         db_printf("}\n");
 828 }
 829
 830 static void
 831 db_show_rm(const struct lock_object *lock)
 832 {
 833         struct rm_priotracker *tr;
 834         struct rm_queue *queue;
 835         const struct rmlock *rm;
 836         struct lock_class *lc;
 837         struct pcpu *pc;
 838
 839         rm = (const struct rmlock *)lock;
 840         db_printf(" writecpus: ");
 841         ddb_display_cpuset(__DEQUALIFY(const cpuset_t *, &rm->rm_writecpus));
 842         db_printf("\n");
 843         db_printf(" per-CPU readers:\n");
 844         STAILQ_FOREACH(pc, &cpuhead, pc_allcpu)
 845                 for (queue = pc->pc_rm_queue.rmq_next;
 846                     queue != &pc->pc_rm_queue; queue = queue->rmq_next) {
 847                         tr = (struct rm_priotracker *)queue;
 848                         if (tr->rmp_rmlock == rm)
 849                                 print_tracker(tr);
 850                 }
 851         db_printf(" active readers:\n");
 852         LIST_FOREACH(tr, &rm->rm_activeReaders, rmp_qentry)
 853                 print_tracker(tr);
 854         lc = LOCK_CLASS(&rm->rm_wlock_object);
 855         db_printf("Backing write-lock (%s):\n", lc->lc_name);
 856         lc->lc_ddb_show(&rm->rm_wlock_object);
 857 }
 858 #endif