sys/sys/lockmgr.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-2-Clause
   3  *
   4  * Copyright (c) 2008 Attilio Rao <attilio@FreeBSD.org>
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice(s), this list of conditions and the following disclaimer as
  12  *    the first lines of this file unmodified other than the possible
  13  *    addition of one or more copyright notices.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice(s), this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER(S) ``AS IS'' AND ANY
  19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  21  * DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) BE LIABLE FOR ANY
  22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  24  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  25  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  26  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  27  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
  28  * DAMAGE.
  29  */
  30
  31 #ifndef _SYS_LOCKMGR_H_
  32 #define _SYS_LOCKMGR_H_
  33
  34 #include <sys/_lock.h>
  35 #include <sys/_lockmgr.h>
  36 #include <sys/_mutex.h>
  37 #include <sys/_rwlock.h>
  38
  39 #define LK_SHARE                        0x01
  40 #define LK_SHARED_WAITERS               0x02
  41 #define LK_EXCLUSIVE_WAITERS            0x04
  42 #define LK_EXCLUSIVE_SPINNERS           0x08
  43 #define LK_WRITER_RECURSED              0x10
  44 #define LK_ALL_WAITERS                                                  \
  45         (LK_SHARED_WAITERS | LK_EXCLUSIVE_WAITERS)
  46 #define LK_FLAGMASK                                                     \
  47         (LK_SHARE | LK_ALL_WAITERS | LK_EXCLUSIVE_SPINNERS | LK_WRITER_RECURSED)
  48
  49 #define LK_HOLDER(x)                    ((x) & ~LK_FLAGMASK)
  50 #define LK_SHARERS_SHIFT                5
  51 #define LK_SHARERS(x)                   (LK_HOLDER(x) >> LK_SHARERS_SHIFT)
  52 #define LK_SHARERS_LOCK(x)              ((x) << LK_SHARERS_SHIFT | LK_SHARE)
  53 #define LK_ONE_SHARER                   (1 << LK_SHARERS_SHIFT)
  54 #define LK_UNLOCKED                     LK_SHARERS_LOCK(0)
  55 #define LK_KERNPROC                     ((uintptr_t)(-1) & ~LK_FLAGMASK)
  56
  57 #ifdef _KERNEL
  58
  59 #if !defined(LOCK_FILE) || !defined(LOCK_LINE)
  60 #error  "LOCK_FILE and LOCK_LINE not defined, include <sys/lock.h> before"
  61 #endif
  62
  63 struct thread;
  64 #define lk_recurse      lock_object.lo_data
  65
  66 /*
  67  * Function prototipes.  Routines that start with an underscore are not part
  68  * of the public interface and might be wrappered with a macro.
  69  */
  70 int      __lockmgr_args(struct lock *lk, u_int flags, struct lock_object *ilk,
  71             const char *wmesg, int prio, int timo, const char *file, int line);
  72 int      lockmgr_lock_flags(struct lock *lk, u_int flags,
  73             struct lock_object *ilk, const char *file, int line);
  74 int     lockmgr_slock(struct lock *lk, u_int flags, const char *file, int line);
  75 int     lockmgr_xlock(struct lock *lk, u_int flags, const char *file, int line);
  76 int     lockmgr_unlock(struct lock *lk);
  77
  78 #if defined(INVARIANTS) || defined(INVARIANT_SUPPORT)
  79 void     _lockmgr_assert(const struct lock *lk, int what, const char *file, int line);
  80 #endif
  81 void     _lockmgr_disown(struct lock *lk, const char *file, int line);
  82
  83 void     lockallowrecurse(struct lock *lk);
  84 void     lockallowshare(struct lock *lk);
  85 void     lockdestroy(struct lock *lk);
  86 void     lockdisablerecurse(struct lock *lk);
  87 void     lockdisableshare(struct lock *lk);
  88 void     lockinit(struct lock *lk, int prio, const char *wmesg, int timo,
  89             int flags);
  90 #ifdef DDB
  91 int      lockmgr_chain(struct thread *td, struct thread **ownerp);
  92 #endif
  93 void     lockmgr_printinfo(const struct lock *lk);
  94 int      lockstatus(const struct lock *lk);
  95
  96 /*
  97  * As far as the ilk can be a static NULL pointer these functions need a
  98  * strict prototype in order to safely use the lock_object member.
  99  */
 100 static __inline int
 101 _lockmgr_args(struct lock *lk, u_int flags, struct mtx *ilk, const char *wmesg,
 102     int prio, int timo, const char *file, int line)
 103 {
 104
 105         return (__lockmgr_args(lk, flags, (ilk != NULL) ? &ilk->lock_object :
 106             NULL, wmesg, prio, timo, file, line));
 107 }
 108
 109 static __inline int
 110 _lockmgr_args_rw(struct lock *lk, u_int flags, struct rwlock *ilk,
 111     const char *wmesg, int prio, int timo, const char *file, int line)
 112 {
 113
 114         return (__lockmgr_args(lk, flags, (ilk != NULL) ? &ilk->lock_object :
 115             NULL, wmesg, prio, timo, file, line));
 116 }
 117
 118 /*
 119  * Define aliases in order to complete lockmgr KPI.
 120  */
 121 #define lockmgr_read_value(lk)  ((lk)->lk_lock)
 122 #define lockmgr(lk, flags, ilk)                                         \
 123         _lockmgr_args((lk), (flags), (ilk), LK_WMESG_DEFAULT,           \
 124             LK_PRIO_DEFAULT, LK_TIMO_DEFAULT, LOCK_FILE, LOCK_LINE)
 125 #define lockmgr_args(lk, flags, ilk, wmesg, prio, timo)                 \
 126         _lockmgr_args((lk), (flags), (ilk), (wmesg), (prio), (timo),    \
 127             LOCK_FILE, LOCK_LINE)
 128 #define lockmgr_args_rw(lk, flags, ilk, wmesg, prio, timo)              \
 129         _lockmgr_args_rw((lk), (flags), (ilk), (wmesg), (prio), (timo), \
 130             LOCK_FILE, LOCK_LINE)
 131 #define lockmgr_disown(lk)                                              \
 132         _lockmgr_disown((lk), LOCK_FILE, LOCK_LINE)
 133 #define lockmgr_recursed_v(v)                                           \
 134         (v & LK_WRITER_RECURSED)
 135 #define lockmgr_recursed(lk)                                            \
 136         lockmgr_recursed_v((lk)->lk_lock)
 137 #define lockmgr_rw(lk, flags, ilk)                                      \
 138         _lockmgr_args_rw((lk), (flags), (ilk), LK_WMESG_DEFAULT,        \
 139             LK_PRIO_DEFAULT, LK_TIMO_DEFAULT, LOCK_FILE, LOCK_LINE)
 140 #ifdef INVARIANTS
 141 #define lockmgr_assert(lk, what)                                        \
 142         _lockmgr_assert((lk), (what), LOCK_FILE, LOCK_LINE)
 143 #else
 144 #define lockmgr_assert(lk, what)
 145 #endif
 146
 147 /*
 148  * Flags for lockinit().
 149  */
 150 #define LK_INIT_MASK    0x0001FF
 151 #define LK_CANRECURSE   0x000001
 152 #define LK_NODUP        0x000002
 153 #define LK_NOPROFILE    0x000004
 154 #define LK_NOSHARE      0x000008
 155 #define LK_NOWITNESS    0x000010
 156 #define LK_QUIET        0x000020
 157 #define LK_UNUSED0      0x000040        /* Was LK_ADAPTIVE */
 158 #define LK_IS_VNODE     0x000080        /* Tell WITNESS about a VNODE lock */
 159 #define LK_NEW          0x000100
 160
 161 /*
 162  * Additional attributes to be used in lockmgr().
 163  */
 164 #define LK_EATTR_MASK   0x00FF00
 165 #define LK_INTERLOCK    0x000100
 166 #define LK_NOWAIT       0x000200
 167 #define LK_RETRY        0x000400
 168 #define LK_SLEEPFAIL    0x000800
 169 #define LK_TIMELOCK     0x001000
 170 #define LK_NODDLKTREAT  0x002000
 171 #define LK_ADAPTIVE     0x004000
 172
 173 /*
 174  * Operations for lockmgr().
 175  */
 176 #define LK_TYPE_MASK    0xFF0000
 177 #define LK_DOWNGRADE    0x010000
 178 #define LK_DRAIN        0x020000
 179 #define LK_EXCLOTHER    0x040000
 180 #define LK_EXCLUSIVE    0x080000
 181 #define LK_RELEASE      0x100000
 182 #define LK_SHARED       0x200000
 183 #define LK_UPGRADE      0x400000
 184 #define LK_TRYUPGRADE   0x800000
 185
 186 #define LK_TOTAL_MASK   (LK_INIT_MASK | LK_EATTR_MASK | LK_TYPE_MASK)
 187
 188 /*
 189  * Default values for lockmgr_args().
 190  */
 191 #define LK_WMESG_DEFAULT        (NULL)
 192 #define LK_PRIO_DEFAULT         (0)
 193 #define LK_TIMO_DEFAULT         (0)
 194
 195 /*
 196  * Assertion flags.
 197  */
 198 #if defined(INVARIANTS) || defined(INVARIANT_SUPPORT)
 199 #define KA_LOCKED       LA_LOCKED
 200 #define KA_SLOCKED      LA_SLOCKED
 201 #define KA_XLOCKED      LA_XLOCKED
 202 #define KA_UNLOCKED     LA_UNLOCKED
 203 #define KA_RECURSED     LA_RECURSED
 204 #define KA_NOTRECURSED  LA_NOTRECURSED
 205 #endif
 206
 207 #endif /* _KERNEL */
 208
 209 #endif /* !_SYS_LOCKMGR_H_ */