sys/sys/lock.h

   1 /*-
   2  * Copyright (c) 1997 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.h,v 2.7.2.35 2000/04/27 03:10:26 cp Exp $
  29  * $FreeBSD$
  30  */
  31
  32 #ifndef _SYS_LOCK_H_
  33 #define _SYS_LOCK_H_
  34
  35 /*
  36  * XXX - compatability until lockmgr() goes away or all the #includes are
  37  * updated.
  38  */
  39 #include <sys/lockmgr.h>
  40
  41 #include <sys/queue.h>
  42 #include <sys/_lock.h>
  43
  44 /*
  45  * Lock classes.  Each lock has a class which describes characteristics
  46  * common to all types of locks of a given class.
  47  *
  48  * Spin locks in general must always protect against preemption, as it is
  49  * an error to perform any type of context switch while holding a spin lock.
  50  * Also, for an individual lock to be recursable, its class must allow
  51  * recursion and the lock itself must explicitly allow recursion.
  52  */
  53
  54 struct lock_class {
  55         const   char *lc_name;
  56         u_int   lc_flags;
  57 };
  58
  59 #define LC_SLEEPLOCK    0x00000001      /* Sleep lock. */
  60 #define LC_SPINLOCK     0x00000002      /* Spin lock. */
  61 #define LC_SLEEPABLE    0x00000004      /* Sleeping allowed with this lock. */
  62 #define LC_RECURSABLE   0x00000008      /* Locks of this type may recurse. */
  63 #define LC_UPGRADABLE   0x00000010      /* Upgrades and downgrades permitted. */
  64
  65 #define LO_CLASSFLAGS   0x0000ffff      /* Class specific flags. */
  66 #define LO_INITIALIZED  0x00010000      /* Lock has been initialized. */
  67 #define LO_WITNESS      0x00020000      /* Should witness monitor this lock. */
  68 #define LO_QUIET        0x00040000      /* Don't log locking operations. */
  69 #define LO_RECURSABLE   0x00080000      /* Lock may recurse. */
  70 #define LO_SLEEPABLE    0x00100000      /* Lock may be held while sleeping. */
  71 #define LO_UPGRADABLE   0x00200000      /* Lock may be upgraded/downgraded. */
  72
  73 #define LI_RECURSEMASK  0x0000ffff      /* Recursion depth of lock instance. */
  74 #define LI_SLEPT        0x00010000      /* Lock instance has been slept with. */
  75 #define LI_EXCLUSIVE    0x00020000      /* Exclusive lock instance. */
  76
  77 /*
  78  * Option flags passed to lock operations that witness also needs to know
  79  * about or that are generic across all locks.
  80  */
  81 #define LOP_QUIET       0x00000002      /* Don't log locking operations. */
  82 #define LOP_TRYLOCK     0x00000004      /* Don't check lock order. */
  83 #define LOP_EXCLUSIVE   0x00000008      /* Exclusive lock. */
  84
  85 /* Flags passed to witness_assert. */
  86 #define LA_UNLOCKED     0x00000000      /* Lock is unlocked. */
  87 #define LA_LOCKED       0x00000001      /* Lock is at least share locked. */
  88 #define LA_SLOCKED      0x00000002      /* Lock is exactly share locked. */
  89 #define LA_XLOCKED      0x00000004      /* Lock is exclusively locked. */
  90 #define LA_RECURSED     0x00000008      /* Lock is recursed. */
  91 #define LA_NOTRECURSED  0x00000010      /* Lock is not recursed. */
  92
  93 #ifdef _KERNEL
  94 /*
  95  * Lock instances.  A lock instance is the data associated with a lock while
  96  * it is held by witness.  For example, a lock instance will hold the
  97  * recursion count of a lock.  Lock instances are held in lists.  Spin locks
  98  * are held in a per-cpu list while sleep locks are held in per-process list.
  99  */
 100 struct lock_instance {
 101         struct  lock_object *li_lock;
 102         const   char *li_file;          /* File and line of last acquire. */
 103         int     li_line;
 104         u_int   li_flags;               /* Recursion count and LI_* flags. */
 105 };
 106
 107 /*
 108  * A simple list type used to build the list of locks held by a process
 109  * or CPU.  We can't simply embed the list in struct lock_object since a
 110  * lock may be held by more than one process if it is a shared lock.  Locks
 111  * are added to the head of the list, so we fill up each list entry from
 112  * "the back" logically.  To ease some of the arithmetic, we actually fill
 113  * in each list entry the normal way (childer[0] then children[1], etc.) but
 114  * when we traverse the list we read children[count-1] as the first entry
 115  * down to children[0] as the final entry.
 116  */
 117 #define LOCK_NCHILDREN  3
 118
 119 struct lock_list_entry {
 120         struct  lock_list_entry *ll_next;
 121         struct  lock_instance ll_children[LOCK_NCHILDREN];
 122         u_int   ll_count;
 123 };
 124
 125 /*
 126  * If any of WITNESS, INVARIANTS, or KTR_LOCK KTR tracing has been enabled,
 127  * then turn on LOCK_DEBUG.  When this option is on, extra debugging
 128  * facilities such as tracking the file and line number of lock operations
 129  * are enabled.  Also, mutex locking operations are not inlined to avoid
 130  * bloat from all the extra debugging code.  We also have to turn on all the
 131  * calling conventions for this debugging code in modules so that modules can
 132  * work with both debug and non-debug kernels.
 133  */
 134 #if defined(KLD_MODULE) || defined(WITNESS) || defined(INVARIANTS) || defined(INVARIANT_SUPPORT) || defined(KTR)
 135 #define LOCK_DEBUG      1
 136 #else
 137 #define LOCK_DEBUG      0
 138 #endif
 139
 140 /*
 141  * In the LOCK_DEBUG case, use the filename and line numbers for debugging
 142  * operations.  Otherwise, use default values to avoid the unneeded bloat.
 143  */
 144 #if LOCK_DEBUG > 0
 145 #define LOCK_FILE       __FILE__
 146 #define LOCK_LINE       __LINE__
 147 #else
 148 #define LOCK_FILE       NULL
 149 #define LOCK_LINE       0
 150 #endif
 151
 152 /*
 153  * Macros for KTR_LOCK tracing.
 154  *
 155  * opname  - name of this operation (LOCK/UNLOCK/SLOCK, etc.)
 156  * lo      - struct lock_object * for this lock
 157  * flags   - flags passed to the lock operation
 158  * recurse - this locks recursion level (or 0 if class is not recursable)
 159  * result  - result of a try lock operation
 160  * file    - file name
 161  * line    - line number
 162  */
 163 #define LOCK_LOG_TEST(lo, flags)                                        \
 164         (((flags) & LOP_QUIET) == 0 && ((lo)->lo_flags & LO_QUIET) == 0)
 165
 166 #define LOCK_LOG_LOCK(opname, lo, flags, recurse, file, line) do {      \
 167         if (LOCK_LOG_TEST((lo), (flags)))                               \
 168                 CTR5(KTR_LOCK, opname " (%s) %s r = %d at %s:%d",       \
 169                     (lo)->lo_class->lc_name, (lo)->lo_name,             \
 170                     (u_int)(recurse), (file), (line));                  \
 171 } while (0)
 172
 173 #define LOCK_LOG_TRY(opname, lo, flags, result, file, line) do {        \
 174         if (LOCK_LOG_TEST((lo), (flags)))                               \
 175                 CTR5(KTR_LOCK, "TRY_" opname " (%s) %s result=%d at %s:%d",\
 176                     (lo)->lo_class->lc_name, (lo)->lo_name,             \
 177                     (u_int)(result), (file), (line));                   \
 178 } while (0)
 179
 180 #define LOCK_LOG_INIT(lo, flags) do {                                   \
 181         if (LOCK_LOG_TEST((lo), (flags)))                               \
 182                 CTR4(KTR_LOCK, "%s: %p (%s) %s", __func__, (lo),        \
 183                     (lo)->lo_class->lc_name, (lo)->lo_name);            \
 184 } while (0)
 185
 186 #define LOCK_LOG_DESTROY(lo, flags)     LOCK_LOG_INIT(lo, flags)
 187
 188 /*
 189  * Helpful macros for quickly coming up with assertions with informative
 190  * panic messages.
 191  */
 192 #define MPASS(ex)               MPASS4(ex, #ex, __FILE__, __LINE__)
 193 #define MPASS2(ex, what)        MPASS4(ex, what, __FILE__, __LINE__)
 194 #define MPASS3(ex, file, line)  MPASS4(ex, #ex, file, line)
 195 #define MPASS4(ex, what, file, line)                                    \
 196         KASSERT((ex), ("Assertion %s failed at %s:%d", what, file, line))
 197
 198 extern struct lock_class lock_class_mtx_sleep;
 199 extern struct lock_class lock_class_mtx_spin;
 200 extern struct lock_class lock_class_sx;
 201
 202 void    witness_init(struct lock_object *);
 203 void    witness_destroy(struct lock_object *);
 204 void    witness_lock(struct lock_object *, int, const char *, int);
 205 void    witness_upgrade(struct lock_object *, int, const char *, int);
 206 void    witness_downgrade(struct lock_object *, int, const char *, int);
 207 void    witness_unlock(struct lock_object *, int, const char *, int);
 208 void    witness_save(struct lock_object *, const char **, int *);
 209 void    witness_restore(struct lock_object *, const char *, int);
 210 int     witness_list_locks(struct lock_list_entry **);
 211 int     witness_list(struct thread *);
 212 int     witness_sleep(int, struct lock_object *, const char *, int);
 213 void    witness_assert(struct lock_object *, int, const char *, int);
 214
 215 #ifdef  WITNESS
 216 #define WITNESS_INIT(lock)                                              \
 217         witness_init((lock))
 218
 219 #define WITNESS_DESTROY(lock)                                           \
 220         witness_destroy(lock)
 221
 222 #define WITNESS_LOCK(lock, flags, file, line)                           \
 223         witness_lock((lock), (flags), (file), (line))
 224
 225 #define WITNESS_UPGRADE(lock, flags, file, line)                        \
 226         witness_upgrade((lock), (flags), (file), (line))
 227
 228 #define WITNESS_DOWNGRADE(lock, flags, file, line)                      \
 229         witness_downgrade((lock), (flags), (file), (line))
 230
 231 #define WITNESS_UNLOCK(lock, flags, file, line)                         \
 232         witness_unlock((lock), (flags), (file), (line))
 233
 234 #define WITNESS_SLEEP(check, lock)                                      \
 235         witness_sleep((check), (lock), __FILE__, __LINE__)
 236
 237 #define WITNESS_SAVE_DECL(n)                                            \
 238         const char * __CONCAT(n, __wf);                                 \
 239         int __CONCAT(n, __wl)
 240
 241 #define WITNESS_SAVE(lock, n)                                           \
 242         witness_save((lock), &__CONCAT(n, __wf), &__CONCAT(n, __wl))
 243
 244 #define WITNESS_RESTORE(lock, n)                                        \
 245         witness_restore((lock), __CONCAT(n, __wf), __CONCAT(n, __wl))
 246
 247 #else   /* WITNESS */
 248 #define WITNESS_INIT(lock)      (lock)->lo_flags |= LO_INITIALIZED
 249 #define WITNESS_DESTROY(lock)   (lock)->lo_flags &= ~LO_INITIALIZED
 250 #define WITNESS_LOCK(lock, flags, file, line)
 251 #define WITNESS_UPGRADE(lock, flags, file, line)
 252 #define WITNESS_DOWNGRADE(lock, flags, file, line)
 253 #define WITNESS_UNLOCK(lock, flags, file, line)
 254 #define WITNESS_SLEEP(check, lock)
 255 #define WITNESS_SAVE_DECL(n)
 256 #define WITNESS_SAVE(lock, n)
 257 #define WITNESS_RESTORE(lock, n)
 258 #endif  /* WITNESS */
 259
 260 #endif  /* _KERNEL */
 261 #endif  /* _SYS_LOCK_H_ */