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