2 * Copyright (c) 2007 Stephan Uphoff <ups@FreeBSD.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
32 #ifndef _SYS_RMLOCK_H_
33 #define _SYS_RMLOCK_H_
35 #include <sys/mutex.h>
37 #include <sys/_lock.h>
38 #include <sys/_rmlock.h>
43 * Flags passed to rm_init_flags(9).
45 #define RM_NOWITNESS 0x00000001
46 #define RM_RECURSE 0x00000002
47 #define RM_SLEEPABLE 0x00000004
48 #define RM_NEW 0x00000008
50 void rm_init(struct rmlock *rm, const char *name);
51 void rm_init_flags(struct rmlock *rm, const char *name, int opts);
52 void rm_destroy(struct rmlock *rm);
53 int rm_wowned(const struct rmlock *rm);
54 void rm_sysinit(void *arg);
55 void rm_sysinit_flags(void *arg);
57 void _rm_wlock_debug(struct rmlock *rm, const char *file, int line);
58 void _rm_wunlock_debug(struct rmlock *rm, const char *file, int line);
59 int _rm_rlock_debug(struct rmlock *rm, struct rm_priotracker *tracker,
60 int trylock, const char *file, int line);
61 void _rm_runlock_debug(struct rmlock *rm, struct rm_priotracker *tracker,
62 const char *file, int line);
64 void _rm_wlock(struct rmlock *rm);
65 void _rm_wunlock(struct rmlock *rm);
66 int _rm_rlock(struct rmlock *rm, struct rm_priotracker *tracker,
68 void _rm_runlock(struct rmlock *rm, struct rm_priotracker *tracker);
69 #if defined(INVARIANTS) || defined(INVARIANT_SUPPORT)
70 void _rm_assert(const struct rmlock *rm, int what, const char *file,
75 * Public interface for lock operations.
78 #error LOCK_DEBUG not defined, include <sys/lock.h> before <sys/rmlock.h>
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 )
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))
97 #define rm_sleep(chan, rm, pri, wmesg, timo) \
98 _sleep((chan), &(rm)->lock_object, (pri), (wmesg), \
99 tick_sbt * (timo), 0, C_HARDCLOCK)
102 struct rmlock *ra_rm;
106 struct rm_args_flags {
107 struct rmlock *ra_rm;
112 #define RM_SYSINIT(name, rm, desc) \
113 static struct rm_args name##_args = { \
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, \
123 #define RM_SYSINIT_FLAGS(name, rm, desc, opts) \
124 static struct rm_args name##_args = { \
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, \
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
144 #define rm_assert(rm, what) _rm_assert((rm), (what), LOCK_FILE, LOCK_LINE)
146 #define rm_assert(rm, what)
150 #endif /* !_SYS_RMLOCK_H_ */