initial commit
[freebsd-arm:freebsd-arm.git] / cddl / compat / opensolaris / sys / mutex.h
1 /*-
2  * Copyright (c) 2007 Pawel Jakub Dawidek <pjd@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  *
14  * THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24  * SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28
29 #ifndef _OPENSOLARIS_SYS_MUTEX_H_
30 #define _OPENSOLARIS_SYS_MUTEX_H_
31
32 #ifdef _KERNEL
33
34 #include <sys/param.h>
35 #include <sys/lock.h>
36 #include_next <sys/mutex.h>
37 #include <sys/proc.h>
38 #include <sys/sx.h>
39
40 typedef enum {
41         MUTEX_DEFAULT = 6       /* kernel default mutex */
42 } kmutex_type_t;
43
44 #define MUTEX_HELD(x)           (mutex_owned(x))
45 #define MUTEX_NOT_HELD(x)       (!mutex_owned(x) || panicstr)
46
47 typedef struct sx       kmutex_t;
48
49 #ifndef DEBUG
50 #define MUTEX_FLAGS     (SX_DUPOK | SX_NOWITNESS)
51 #else
52 #define MUTEX_FLAGS     (SX_DUPOK)
53 #endif
54
55 #define mutex_init(lock, desc, type, arg)       do {                    \
56         const char *_name;                                              \
57         ASSERT((type) == MUTEX_DEFAULT);                                \
58         KASSERT(((lock)->lock_object.lo_flags & LO_ALLMASK) !=          \
59             LO_EXPECTED, ("lock %s already initialized", #lock));       \
60         bzero((lock), sizeof(struct sx));                               \
61         for (_name = #lock; *_name != '\0'; _name++) {                  \
62                 if (*_name >= 'a' && *_name <= 'z')                     \
63                         break;                                          \
64         }                                                               \
65         if (*_name == '\0')                                             \
66                 _name = #lock;                                          \
67         sx_init_flags((lock), _name, MUTEX_FLAGS);                      \
68 } while (0)
69 #define mutex_destroy(lock)     sx_destroy(lock)
70 #define mutex_enter(lock)       sx_xlock(lock)
71 #define mutex_tryenter(lock)    sx_try_xlock(lock)
72 #define mutex_exit(lock)        sx_xunlock(lock)
73 #define mutex_owned(lock)       sx_xlocked(lock)
74 /* TODO: Change to sx_xholder() once it is moved from kern_sx.c to sx.h. */
75 #define mutex_owner(lock)       ((lock)->sx_lock & SX_LOCK_SHARED ? NULL : (struct thread *)SX_OWNER((lock)->sx_lock))
76
77 #endif  /* _KERNEL */
78
79 #endif  /* _OPENSOLARIS_SYS_MUTEX_H_ */