sys/kern/kern_lock.c

   1 /*
   2  * Copyright (c) 1995
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * Copyright (C) 1997
   6  *      John S. Dyson.  All rights reserved.
   7  *
   8  * This code contains ideas from software contributed to Berkeley by
   9  * Avadis Tevanian, Jr., Michael Wayne Young, and the Mach Operating
  10  * System project at Carnegie-Mellon University.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. All advertising materials mentioning features or use of this software
  21  *    must display the following acknowledgement:
  22  *      This product includes software developed by the University of
  23  *      California, Berkeley and its contributors.
  24  * 4. Neither the name of the University nor the names of its contributors
  25  *    may be used to endorse or promote products derived from this software
  26  *    without specific prior written permission.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  29  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  30  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  31  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  32  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  37  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  38  * SUCH DAMAGE.
  39  *
  40  *      @(#)kern_lock.c 8.18 (Berkeley) 5/21/95
  41  * $FreeBSD: src/sys/kern/kern_lock.c,v 1.31.2.3 2001/12/25 01:44:44 dillon Exp $
  42  * $DragonFly: src/sys/kern/kern_lock.c,v 1.18 2006/04/23 03:08:02 dillon Exp $
  43  */
  44
  45 #include "opt_lint.h"
  46
  47 #include <sys/param.h>
  48 #include <sys/systm.h>
  49 #include <sys/kernel.h>
  50 #include <sys/proc.h>
  51 #include <sys/lock.h>
  52 #include <sys/sysctl.h>
  53 #include <sys/spinlock.h>
  54 #include <sys/thread2.h>
  55 #include <sys/spinlock2.h>
  56
  57 /*
  58  * 0: no warnings, 1: warnings, 2: panic
  59  */
  60 static int lockmgr_from_int = 1;
  61 SYSCTL_INT(_debug, OID_AUTO, lockmgr_from_int, CTLFLAG_RW, &lockmgr_from_int, 0, "");
  62
  63 /*
  64  * Locking primitives implementation.
  65  * Locks provide shared/exclusive sychronization.
  66  */
  67
  68 #ifdef SIMPLELOCK_DEBUG
  69 #define COUNT(td, x) (td)->td_locks += (x)
  70 #else
  71 #define COUNT(td, x)
  72 #endif
  73
  74 #define LOCK_WAIT_TIME 100
  75 #define LOCK_SAMPLE_WAIT 7
  76
  77 #if defined(DIAGNOSTIC)
  78 #define LOCK_INLINE
  79 #else
  80 #define LOCK_INLINE __inline
  81 #endif
  82
  83 #define LK_ALL (LK_HAVE_EXCL | LK_WANT_EXCL | LK_WANT_UPGRADE | \
  84         LK_SHARE_NONZERO | LK_WAIT_NONZERO)
  85
  86 static int acquire(struct lock *lkp, int extflags, int wanted);
  87
  88 static LOCK_INLINE void
  89 sharelock(struct lock *lkp, int incr) {
  90         lkp->lk_flags |= LK_SHARE_NONZERO;
  91         lkp->lk_sharecount += incr;
  92 }
  93
  94 static LOCK_INLINE void
  95 shareunlock(struct lock *lkp, int decr) {
  96
  97         KASSERT(lkp->lk_sharecount >= decr, ("shareunlock: count < decr"));
  98
  99         if (lkp->lk_sharecount == decr) {
 100                 lkp->lk_flags &= ~LK_SHARE_NONZERO;
 101                 if (lkp->lk_flags & (LK_WANT_UPGRADE | LK_WANT_EXCL)) {
 102                         wakeup(lkp);
 103                 }
 104                 lkp->lk_sharecount = 0;
 105         } else {
 106                 lkp->lk_sharecount -= decr;
 107         }
 108 }
 109
 110 /*
 111  * lock acquisition helper routine.  Called with the lock's spinlock held.
 112  */
 113 static int
 114 acquire(struct lock *lkp, int extflags, int wanted)
 115 {
 116         int error;
 117
 118         if ((extflags & LK_NOWAIT) && (lkp->lk_flags & wanted)) {
 119                 return EBUSY;
 120         }
 121
 122         if (((lkp->lk_flags | extflags) & LK_NOPAUSE) == 0) {
 123                 if ((lkp->lk_flags & wanted) == 0)
 124                         return 0;
 125         }
 126
 127         while ((lkp->lk_flags & wanted) != 0) {
 128                 lkp->lk_flags |= LK_WAIT_NONZERO;
 129                 lkp->lk_waitcount++;
 130
 131                 /*
 132                  * Use the _quick version so the critical section is left
 133                  * intact, protecting the tsleep interlock.  See
 134                  * tsleep_interlock() for a description of what is
 135                  * happening here.
 136                  */
 137                 tsleep_interlock(lkp);
 138                 spin_unlock_quick(&lkp->lk_spinlock);
 139                 error = tsleep(lkp,
 140                                ((extflags & LK_PCATCH) ? PCATCH : 0),
 141                                lkp->lk_wmesg,
 142                                ((extflags & LK_TIMELOCK) ? lkp->lk_timo : 0));
 143                 spin_lock_quick(&lkp->lk_spinlock);
 144                 if (lkp->lk_waitcount == 1) {
 145                         lkp->lk_flags &= ~LK_WAIT_NONZERO;
 146                         lkp->lk_waitcount = 0;
 147                 } else {
 148                         lkp->lk_waitcount--;
 149                 }
 150                 if (error)
 151                         return error;
 152                 if (extflags & LK_SLEEPFAIL)
 153                         return ENOLCK;
 154         }
 155         return 0;
 156 }
 157
 158 /*
 159  * Set, change, or release a lock.
 160  *
 161  * Shared requests increment the shared count. Exclusive requests set the
 162  * LK_WANT_EXCL flag (preventing further shared locks), and wait for already
 163  * accepted shared locks and shared-to-exclusive upgrades to go away.
 164  *
 165  * A spinlock is held for most of the procedure.  We must not do anything
 166  * fancy while holding the spinlock.
 167  */
 168 int
 169 #ifndef DEBUG_LOCKS
 170 lockmgr(struct lock *lkp, u_int flags, struct thread *td)
 171 #else
 172 debuglockmgr(struct lock *lkp, u_int flags, struct thread *td,
 173              const char *name, const char *file, int line)
 174 #endif
 175 {
 176         int error;
 177         int extflags;
 178         static int didpanic;
 179
 180         error = 0;
 181
 182         if (lockmgr_from_int && mycpu->gd_intr_nesting_level &&
 183             (flags & LK_NOWAIT) == 0 &&
 184             (flags & LK_TYPE_MASK) != LK_RELEASE && didpanic == 0) {
 185 #ifndef DEBUG_LOCKS
 186                     if (lockmgr_from_int == 2) {
 187                             didpanic = 1;
 188                             panic(
 189                                 "lockmgr %s from %p: called from interrupt",
 190                                 lkp->lk_wmesg, ((int **)&lkp)[-1]);
 191                             didpanic = 0;
 192                     } else {
 193                             printf(
 194                                 "lockmgr %s from %p: called from interrupt\n",
 195                                 lkp->lk_wmesg, ((int **)&lkp)[-1]);
 196                     }
 197 #else
 198                     if (lockmgr_from_int == 2) {
 199                             didpanic = 1;
 200                             panic(
 201                                 "lockmgr %s from %s:%d: called from interrupt",
 202                                 lkp->lk_wmesg, file, line);
 203                             didpanic = 0;
 204                     } else {
 205                             printf(
 206                                 "lockmgr %s from %s:%d: called from interrupt\n",
 207                                 lkp->lk_wmesg, file, line);
 208                     }
 209 #endif
 210         }
 211
 212         spin_lock(&lkp->lk_spinlock);
 213
 214         extflags = (flags | lkp->lk_flags) & LK_EXTFLG_MASK;
 215
 216         switch (flags & LK_TYPE_MASK) {
 217         case LK_SHARED:
 218                 /*
 219                  * If we are not the exclusive lock holder, we have to block
 220                  * while there is an exclusive lock holder or while an
 221                  * exclusive lock request or upgrade request is in progress.
 222                  *
 223                  * However, if P_DEADLKTREAT is set, we override exclusive
 224                  * lock requests or upgrade requests ( but not the exclusive
 225                  * lock itself ).
 226                  */
 227                 if (lkp->lk_lockholder != td) {
 228                         if (td->td_flags & TDF_DEADLKTREAT) {
 229                                 error = acquire(
 230                                             lkp,
 231                                             extflags,
 232                                             LK_HAVE_EXCL
 233                                         );
 234                         } else {
 235                                 error = acquire(
 236                                             lkp,
 237                                             extflags,
 238                                             LK_HAVE_EXCL | LK_WANT_EXCL |
 239                                              LK_WANT_UPGRADE
 240                                         );
 241                         }
 242                         if (error)
 243                                 break;
 244                         sharelock(lkp, 1);
 245                         COUNT(td, 1);
 246                         break;
 247                 }
 248                 /*
 249                  * We hold an exclusive lock, so downgrade it to shared.
 250                  * An alternative would be to fail with EDEADLK.
 251                  */
 252                 sharelock(lkp, 1);
 253                 COUNT(td, 1);
 254                 /* fall into downgrade */
 255
 256         case LK_DOWNGRADE:
 257                 if (lkp->lk_lockholder != td || lkp->lk_exclusivecount == 0) {
 258                         spin_unlock(&lkp->lk_spinlock);
 259                         panic("lockmgr: not holding exclusive lock");
 260                 }
 261                 sharelock(lkp, lkp->lk_exclusivecount);
 262                 lkp->lk_exclusivecount = 0;
 263                 lkp->lk_flags &= ~LK_HAVE_EXCL;
 264                 lkp->lk_lockholder = LK_NOTHREAD;
 265                 if (lkp->lk_waitcount)
 266                         wakeup((void *)lkp);
 267                 break;
 268
 269         case LK_EXCLUPGRADE:
 270                 /*
 271                  * If another process is ahead of us to get an upgrade,
 272                  * then we want to fail rather than have an intervening
 273                  * exclusive access.
 274                  */
 275                 if (lkp->lk_flags & LK_WANT_UPGRADE) {
 276                         shareunlock(lkp, 1);
 277                         COUNT(td, -1);
 278                         error = EBUSY;
 279                         break;
 280                 }
 281                 /* fall into normal upgrade */
 282
 283         case LK_UPGRADE:
 284                 /*
 285                  * Upgrade a shared lock to an exclusive one. If another
 286                  * shared lock has already requested an upgrade to an
 287                  * exclusive lock, our shared lock is released and an
 288                  * exclusive lock is requested (which will be granted
 289                  * after the upgrade). If we return an error, the file
 290                  * will always be unlocked.
 291                  */
 292                 if ((lkp->lk_lockholder == td) || (lkp->lk_sharecount <= 0)) {
 293                         spin_unlock(&lkp->lk_spinlock);
 294                         panic("lockmgr: upgrade exclusive lock");
 295                 }
 296                 shareunlock(lkp, 1);
 297                 COUNT(td, -1);
 298                 /*
 299                  * If we are just polling, check to see if we will block.
 300                  */
 301                 if ((extflags & LK_NOWAIT) &&
 302                     ((lkp->lk_flags & LK_WANT_UPGRADE) ||
 303                      lkp->lk_sharecount > 1)) {
 304                         error = EBUSY;
 305                         break;
 306                 }
 307                 if ((lkp->lk_flags & LK_WANT_UPGRADE) == 0) {
 308                         /*
 309                          * We are first shared lock to request an upgrade, so
 310                          * request upgrade and wait for the shared count to
 311                          * drop to zero, then take exclusive lock.
 312                          */
 313                         lkp->lk_flags |= LK_WANT_UPGRADE;
 314                         error = acquire(lkp, extflags, LK_SHARE_NONZERO);
 315                         lkp->lk_flags &= ~LK_WANT_UPGRADE;
 316
 317                         if (error)
 318                                 break;
 319                         lkp->lk_flags |= LK_HAVE_EXCL;
 320                         lkp->lk_lockholder = td;
 321                         if (lkp->lk_exclusivecount != 0) {
 322                                 spin_unlock(&lkp->lk_spinlock);
 323                                 panic("lockmgr: non-zero exclusive count");
 324                         }
 325                         lkp->lk_exclusivecount = 1;
 326 #if defined(DEBUG_LOCKS)
 327                         lkp->lk_filename = file;
 328                         lkp->lk_lineno = line;
 329                         lkp->lk_lockername = name;
 330 #endif
 331                         COUNT(td, 1);
 332                         break;
 333                 }
 334                 /*
 335                  * Someone else has requested upgrade. Release our shared
 336                  * lock, awaken upgrade requestor if we are the last shared
 337                  * lock, then request an exclusive lock.
 338                  */
 339                 if ( (lkp->lk_flags & (LK_SHARE_NONZERO|LK_WAIT_NONZERO)) ==
 340                         LK_WAIT_NONZERO)
 341                         wakeup((void *)lkp);
 342                 /* fall into exclusive request */
 343
 344         case LK_EXCLUSIVE:
 345                 if (lkp->lk_lockholder == td && td != LK_KERNTHREAD) {
 346                         /*
 347                          *      Recursive lock.
 348                          */
 349                         if ((extflags & (LK_NOWAIT | LK_CANRECURSE)) == 0) {
 350                                 spin_unlock(&lkp->lk_spinlock);
 351                                 panic("lockmgr: locking against myself");
 352                         }
 353                         if ((extflags & LK_CANRECURSE) != 0) {
 354                                 lkp->lk_exclusivecount++;
 355                                 COUNT(td, 1);
 356                                 break;
 357                         }
 358                 }
 359                 /*
 360                  * If we are just polling, check to see if we will sleep.
 361                  */
 362                 if ((extflags & LK_NOWAIT) &&
 363                     (lkp->lk_flags & (LK_HAVE_EXCL | LK_WANT_EXCL | LK_WANT_UPGRADE | LK_SHARE_NONZERO))) {
 364                         error = EBUSY;
 365                         break;
 366                 }
 367                 /*
 368                  * Try to acquire the want_exclusive flag.
 369                  */
 370                 error = acquire(lkp, extflags, (LK_HAVE_EXCL | LK_WANT_EXCL));
 371                 if (error)
 372                         break;
 373                 lkp->lk_flags |= LK_WANT_EXCL;
 374                 /*
 375                  * Wait for shared locks and upgrades to finish.
 376                  */
 377                 error = acquire(lkp, extflags, LK_WANT_UPGRADE | LK_SHARE_NONZERO);
 378                 lkp->lk_flags &= ~LK_WANT_EXCL;
 379                 if (error)
 380                         break;
 381                 lkp->lk_flags |= LK_HAVE_EXCL;
 382                 lkp->lk_lockholder = td;
 383                 if (lkp->lk_exclusivecount != 0) {
 384                         spin_unlock(&lkp->lk_spinlock);
 385                         panic("lockmgr: non-zero exclusive count");
 386                 }
 387                 lkp->lk_exclusivecount = 1;
 388 #if defined(DEBUG_LOCKS)
 389                         lkp->lk_filename = file;
 390                         lkp->lk_lineno = line;
 391                         lkp->lk_lockername = name;
 392 #endif
 393                 COUNT(td, 1);
 394                 break;
 395
 396         case LK_RELEASE:
 397                 if (lkp->lk_exclusivecount != 0) {
 398                         if (lkp->lk_lockholder != td &&
 399                             lkp->lk_lockholder != LK_KERNTHREAD) {
 400                                 spin_unlock(&lkp->lk_spinlock);
 401                                 panic("lockmgr: pid %d, not %s thr %p unlocking",
 402                                     (td->td_proc ? td->td_proc->p_pid : -99),
 403                                     "exclusive lock holder",
 404                                     lkp->lk_lockholder);
 405                         }
 406                         if (lkp->lk_lockholder != LK_KERNTHREAD) {
 407                                 COUNT(td, -1);
 408                         }
 409                         if (lkp->lk_exclusivecount == 1) {
 410                                 lkp->lk_flags &= ~LK_HAVE_EXCL;
 411                                 lkp->lk_lockholder = LK_NOTHREAD;
 412                                 lkp->lk_exclusivecount = 0;
 413                         } else {
 414                                 lkp->lk_exclusivecount--;
 415                         }
 416                 } else if (lkp->lk_flags & LK_SHARE_NONZERO) {
 417                         shareunlock(lkp, 1);
 418                         COUNT(td, -1);
 419                 }
 420                 if (lkp->lk_flags & LK_WAIT_NONZERO)
 421                         wakeup((void *)lkp);
 422                 break;
 423
 424         default:
 425                 spin_unlock(&lkp->lk_spinlock);
 426                 panic("lockmgr: unknown locktype request %d",
 427                     flags & LK_TYPE_MASK);
 428                 /* NOTREACHED */
 429         }
 430         spin_unlock(&lkp->lk_spinlock);
 431         return (error);
 432 }
 433
 434 /*
 435  * Initialize a lock; required before use.
 436  */
 437 void
 438 lockinit(struct lock *lkp, char *wmesg, int timo, int flags)
 439 {
 440         spin_init(&lkp->lk_spinlock);
 441         lkp->lk_flags = (flags & LK_EXTFLG_MASK);
 442         lkp->lk_sharecount = 0;
 443         lkp->lk_waitcount = 0;
 444         lkp->lk_exclusivecount = 0;
 445         lkp->lk_wmesg = wmesg;
 446         lkp->lk_timo = timo;
 447         lkp->lk_lockholder = LK_NOTHREAD;
 448 }
 449
 450 /*
 451  * Reinitialize a lock that is being reused for a different purpose, but
 452  * which may have pending (blocked) threads sitting on it.  The caller
 453  * must already hold the interlock.
 454  */
 455 void
 456 lockreinit(struct lock *lkp, char *wmesg, int timo, int flags)
 457 {
 458         lkp->lk_flags = (lkp->lk_flags & ~LK_EXTFLG_MASK) |
 459                         (flags & LK_EXTFLG_MASK);
 460         lkp->lk_wmesg = wmesg;
 461         lkp->lk_timo = timo;
 462 }
 463
 464 /*
 465  * Determine the status of a lock.
 466  */
 467 int
 468 lockstatus(struct lock *lkp, struct thread *td)
 469 {
 470         int lock_type = 0;
 471
 472         spin_lock(&lkp->lk_spinlock);
 473         if (lkp->lk_exclusivecount != 0) {
 474                 if (td == NULL || lkp->lk_lockholder == td)
 475                         lock_type = LK_EXCLUSIVE;
 476                 else
 477                         lock_type = LK_EXCLOTHER;
 478         } else if (lkp->lk_sharecount != 0) {
 479                 lock_type = LK_SHARED;
 480         }
 481         spin_unlock(&lkp->lk_spinlock);
 482         return (lock_type);
 483 }
 484
 485 /*
 486  * Determine the number of holders of a lock.
 487  *
 488  * The non-blocking version can usually be used for assertions.
 489  */
 490 int
 491 lockcount(struct lock *lkp)
 492 {
 493         int count;
 494
 495         spin_lock(&lkp->lk_spinlock);
 496         count = lkp->lk_exclusivecount + lkp->lk_sharecount;
 497         spin_unlock(&lkp->lk_spinlock);
 498         return (count);
 499 }
 500
 501 int
 502 lockcountnb(struct lock *lkp)
 503 {
 504         return (lkp->lk_exclusivecount + lkp->lk_sharecount);
 505 }
 506
 507 /*
 508  * Print out information about state of a lock. Used by VOP_PRINT
 509  * routines to display status about contained locks.
 510  */
 511 void
 512 lockmgr_printinfo(struct lock *lkp)
 513 {
 514         struct thread *td = lkp->lk_lockholder;
 515         struct proc *p;
 516
 517         if (td && td != LK_KERNTHREAD && td != LK_NOTHREAD)
 518                 p = td->td_proc;
 519         else
 520                 p = NULL;
 521
 522         if (lkp->lk_sharecount)
 523                 printf(" lock type %s: SHARED (count %d)", lkp->lk_wmesg,
 524                     lkp->lk_sharecount);
 525         else if (lkp->lk_flags & LK_HAVE_EXCL)
 526                 printf(" lock type %s: EXCL (count %d) by td %p pid %d",
 527                     lkp->lk_wmesg, lkp->lk_exclusivecount, td,
 528                     p ? p->p_pid : -99);
 529         if (lkp->lk_waitcount > 0)
 530                 printf(" with %d pending", lkp->lk_waitcount);
 531 }
 532