rmlock.h revision 173520 
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: head/sys/sys/rmlock.h 173520 2007-11-10 15:06:30Z rwatson $
30 */
31
32#ifndef _SYS_RMLOCK_H_
33#define _SYS_RMLOCK_H_
34
35#include <sys/mutex.h>
36
37#include <sys/_lock.h>
38#include <sys/_rmlock.h>
39
40#ifdef _KERNEL
41
42
43void	rm_init(struct rmlock *rm, const char *name, int opts);
44void	rm_destroy(struct rmlock *rm);
45int	rm_wowned(struct rmlock *rm);
46void	rm_sysinit(void *arg);
47
48
49void	_rm_wlock_debug(struct rmlock *rm, const char *file, int line);
50void	_rm_wunlock_debug(struct rmlock *rm, const char *file, int line);
51void	_rm_rlock_debug(struct rmlock *rm, struct rm_priotracker *tracker,
52    const char *file, int line);
53void	_rm_runlock_debug(struct rmlock *rm,  struct rm_priotracker *tracker,
54    const char *file, int line);
55
56
57void	_rm_wlock(struct rmlock *rm);
58void	_rm_wunlock(struct rmlock *rm);
59void	_rm_rlock(struct rmlock *rm, struct rm_priotracker *tracker);
60void	_rm_runlock(struct rmlock *rm,  struct rm_priotracker *tracker);
61
62/*
63 * Public interface for lock operations.
64 *
65 */
66
67#ifndef LOCK_DEBUG
68#error LOCK_DEBUG not defined, include <sys/lock.h> before <sys/rmlock.h>
69#endif
70
71#if LOCK_DEBUG > 0
72
73#define	rm_wlock(rm)	_rm_wlock_debug((rm), LOCK_FILE, LOCK_LINE)
74#define	rm_wunlock(rm)	_rm_wunlock_debug((rm), LOCK_FILE, LOCK_LINE)
75#define	rm_rlock(rm,tracker)  \
76    _rm_rlock_debug((rm),(tracker), LOCK_FILE, LOCK_LINE )
77#define	rm_runlock(rm,tracker)	\
78    _rm_runlock_debug((rm), (tracker), LOCK_FILE, LOCK_LINE )
79
80#else
81
82#define	rm_wlock(rm)		_rm_wlock((rm))
83#define	rm_wunlock(rm)		_rm_wunlock((rm))
84#define	rm_rlock(rm,tracker)   	_rm_rlock((rm),(tracker))
85#define	rm_runlock(rm,tracker)	_rm_runlock((rm), (tracker))
86
87#endif
88
89#define	rm_initialized(rm)	lock_initalized(&(rm)->lock_object)
90
91struct rm_args {
92	struct rmlock	*ra_rm;
93	const char 	*ra_desc;
94	int		ra_opts;
95};
96
97#define	RM_SYSINIT(name, rm, desc, opts)       				\
98	static struct rm_args name##_args = {				\
99		(rm),							\
100		(desc),							\
101                (opts),							\
102	};								\
103	SYSINIT(name##_rm_sysinit, SI_SUB_LOCK, SI_ORDER_MIDDLE,	\
104	    rm_sysinit, &name##_args);					\
105	SYSUNINIT(name##_rm_sysuninit, SI_SUB_LOCK, SI_ORDER_MIDDLE,	\
106	    rm_destroy, (rm))
107
108
109#endif /* _KERNEL */
110#endif /* !_SYS_RMLOCK_H_ */
111