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 * $FreeBSD: stable/10/sys/sys/rmlock.h 323870 2017-09-21 19:24:11Z marius $ 30 */ 31 32#ifndef _SYS_RMLOCK_H_ 33#define _SYS_RMLOCK_H_ 34 35#include <sys/mutex.h> 36#include <sys/sx.h> 37#include <sys/_lock.h> 38#include <sys/_rmlock.h> 39 40#ifdef _KERNEL 41 42/* 43 * Flags passed to rm_init_flags(9). 44 */ 45#define RM_NOWITNESS 0x00000001 46#define RM_RECURSE 0x00000002 47#define RM_SLEEPABLE 0x00000004 48#define RM_NEW 0x00000008 49 50void rm_init(struct rmlock *rm, const char *name); 51void rm_init_flags(struct rmlock *rm, const char *name, int opts); 52void rm_destroy(struct rmlock *rm); 53int rm_wowned(const struct rmlock *rm); 54void rm_sysinit(void *arg); 55void rm_sysinit_flags(void *arg); 56 57void _rm_wlock_debug(struct rmlock *rm, const char *file, int line); 58void _rm_wunlock_debug(struct rmlock *rm, const char *file, int line); 59int _rm_rlock_debug(struct rmlock *rm, struct rm_priotracker *tracker, 60 int trylock, const char *file, int line); 61void _rm_runlock_debug(struct rmlock *rm, struct rm_priotracker *tracker, 62 const char *file, int line); 63 64void _rm_wlock(struct rmlock *rm); 65void _rm_wunlock(struct rmlock *rm); 66int _rm_rlock(struct rmlock *rm, struct rm_priotracker *tracker, 67 int trylock); 68void _rm_runlock(struct rmlock *rm, struct rm_priotracker *tracker); 69#if defined(INVARIANTS) || defined(INVARIANT_SUPPORT) 70void _rm_assert(const struct rmlock *rm, int what, const char *file, 71 int line); 72#endif 73 74/* 75 * Public interface for lock operations. 76 */ 77#ifndef LOCK_DEBUG 78#error LOCK_DEBUG not defined, include <sys/lock.h> before <sys/rmlock.h> 79#endif 80 81#if LOCK_DEBUG > 0 82#define rm_wlock(rm) _rm_wlock_debug((rm), LOCK_FILE, LOCK_LINE) 83#define rm_wunlock(rm) _rm_wunlock_debug((rm), LOCK_FILE, LOCK_LINE) 84#define rm_rlock(rm,tracker) \ 85 ((void)_rm_rlock_debug((rm),(tracker), 0, LOCK_FILE, LOCK_LINE )) 86#define rm_try_rlock(rm,tracker) \ 87 _rm_rlock_debug((rm),(tracker), 1, LOCK_FILE, LOCK_LINE ) 88#define rm_runlock(rm,tracker) \ 89 _rm_runlock_debug((rm), (tracker), LOCK_FILE, LOCK_LINE ) 90#else 91#define rm_wlock(rm) _rm_wlock((rm)) 92#define rm_wunlock(rm) _rm_wunlock((rm)) 93#define rm_rlock(rm,tracker) ((void)_rm_rlock((rm),(tracker), 0)) 94#define rm_try_rlock(rm,tracker) _rm_rlock((rm),(tracker), 1) 95#define rm_runlock(rm,tracker) _rm_runlock((rm), (tracker)) 96#endif 97#define rm_sleep(chan, rm, pri, wmesg, timo) \ 98 _sleep((chan), &(rm)->lock_object, (pri), (wmesg), \ 99 tick_sbt * (timo), 0, C_HARDCLOCK) 100 101struct rm_args { 102 struct rmlock *ra_rm; 103 const char *ra_desc; 104}; 105 106struct rm_args_flags { 107 struct rmlock *ra_rm; 108 const char *ra_desc; 109 int ra_opts; 110}; 111 112#define RM_SYSINIT(name, rm, desc) \ 113 static struct rm_args name##_args = { \ 114 (rm), \ 115 (desc), \ 116 }; \ 117 SYSINIT(name##_rm_sysinit, SI_SUB_LOCK, SI_ORDER_MIDDLE, \ 118 rm_sysinit, &name##_args); \ 119 SYSUNINIT(name##_rm_sysuninit, SI_SUB_LOCK, SI_ORDER_MIDDLE, \ 120 rm_destroy, (rm)) 121 122 123#define RM_SYSINIT_FLAGS(name, rm, desc, opts) \ 124 static struct rm_args name##_args = { \ 125 (rm), \ 126 (desc), \ 127 (opts), \ 128 }; \ 129 SYSINIT(name##_rm_sysinit, SI_SUB_LOCK, SI_ORDER_MIDDLE, \ 130 rm_sysinit_flags, &name##_args); \ 131 SYSUNINIT(name##_rm_sysuninit, SI_SUB_LOCK, SI_ORDER_MIDDLE, \ 132 rm_destroy, (rm)) 133 134#if defined(INVARIANTS) || defined(INVARIANT_SUPPORT) 135#define RA_LOCKED LA_LOCKED 136#define RA_RLOCKED LA_SLOCKED 137#define RA_WLOCKED LA_XLOCKED 138#define RA_UNLOCKED LA_UNLOCKED 139#define RA_RECURSED LA_RECURSED 140#define RA_NOTRECURSED LA_NOTRECURSED 141#endif 142 143#ifdef INVARIANTS 144#define rm_assert(rm, what) _rm_assert((rm), (what), LOCK_FILE, LOCK_LINE) 145#else 146#define rm_assert(rm, what) 147#endif 148 149#endif /* _KERNEL */ 150#endif /* !_SYS_RMLOCK_H_ */ 151