FreeBSD/Linux Kernel Cross Reference
sys/sys/umtx.h
1 /*-
2 * Copyright (c) 2002, Jeffrey Roberson <jeff@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 unmodified, this list of conditions, and the following
10 * disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 *
26 * $FreeBSD: releng/9.0/sys/sys/umtx.h 218970 2011-02-23 13:23:28Z jhb $
27 *
28 */
29
30 #ifndef _SYS_UMTX_H_
31 #define _SYS_UMTX_H_
32
33 #include <sys/_umtx.h>
34 #include <sys/limits.h>
35
36 #define UMTX_UNOWNED 0x0
37 #define UMTX_CONTESTED LONG_MIN
38
39 #define USYNC_PROCESS_SHARED 0x0001 /* Process shared sync objs */
40
41 #define UMUTEX_UNOWNED 0x0
42 #define UMUTEX_CONTESTED 0x80000000U
43
44 #define UMUTEX_ERROR_CHECK 0x0002 /* Error-checking mutex */
45 #define UMUTEX_PRIO_INHERIT 0x0004 /* Priority inherited mutex */
46 #define UMUTEX_PRIO_PROTECT 0x0008 /* Priority protect mutex */
47
48 /* urwlock flags */
49 #define URWLOCK_PREFER_READER 0x0002
50
51 #define URWLOCK_WRITE_OWNER 0x80000000U
52 #define URWLOCK_WRITE_WAITERS 0x40000000U
53 #define URWLOCK_READ_WAITERS 0x20000000U
54 #define URWLOCK_MAX_READERS 0x1fffffffU
55 #define URWLOCK_READER_COUNT(c) ((c) & URWLOCK_MAX_READERS)
56
57 /* _usem flags */
58 #define SEM_NAMED 0x0002
59
60 /* op code for _umtx_op */
61 #define UMTX_OP_LOCK 0
62 #define UMTX_OP_UNLOCK 1
63 #define UMTX_OP_WAIT 2
64 #define UMTX_OP_WAKE 3
65 #define UMTX_OP_MUTEX_TRYLOCK 4
66 #define UMTX_OP_MUTEX_LOCK 5
67 #define UMTX_OP_MUTEX_UNLOCK 6
68 #define UMTX_OP_SET_CEILING 7
69 #define UMTX_OP_CV_WAIT 8
70 #define UMTX_OP_CV_SIGNAL 9
71 #define UMTX_OP_CV_BROADCAST 10
72 #define UMTX_OP_WAIT_UINT 11
73 #define UMTX_OP_RW_RDLOCK 12
74 #define UMTX_OP_RW_WRLOCK 13
75 #define UMTX_OP_RW_UNLOCK 14
76 #define UMTX_OP_WAIT_UINT_PRIVATE 15
77 #define UMTX_OP_WAKE_PRIVATE 16
78 #define UMTX_OP_MUTEX_WAIT 17
79 #define UMTX_OP_MUTEX_WAKE 18
80 #define UMTX_OP_SEM_WAIT 19
81 #define UMTX_OP_SEM_WAKE 20
82 #define UMTX_OP_NWAKE_PRIVATE 21
83 #define UMTX_OP_MAX 22
84
85 /* Flags for UMTX_OP_CV_WAIT */
86 #define CVWAIT_CHECK_UNPARKING 0x01
87 #define CVWAIT_ABSTIME 0x02
88 #define CVWAIT_CLOCKID 0x04
89
90 #define UMTX_CHECK_UNPARKING CVWAIT_CHECK_UNPARKING
91
92 #ifndef _KERNEL
93
94 int _umtx_op(void *obj, int op, u_long val, void *uaddr, void *uaddr2);
95
96 /*
97 * Old (deprecated) userland mutex system calls.
98 */
99 int _umtx_lock(struct umtx *mtx);
100 int _umtx_unlock(struct umtx *mtx);
101
102 /*
103 * Standard api. Try uncontested acquire/release and asks the
104 * kernel to resolve failures.
105 */
106 static __inline void
107 umtx_init(struct umtx *umtx)
108 {
109 umtx->u_owner = UMTX_UNOWNED;
110 }
111
112 static __inline u_long
113 umtx_owner(struct umtx *umtx)
114 {
115 return (umtx->u_owner & ~LONG_MIN);
116 }
117
118 static __inline int
119 umtx_lock(struct umtx *umtx, u_long id)
120 {
121 if (atomic_cmpset_acq_long(&umtx->u_owner, UMTX_UNOWNED, id) == 0)
122 if (_umtx_lock(umtx) == -1)
123 return (errno);
124 return (0);
125 }
126
127 static __inline int
128 umtx_trylock(struct umtx *umtx, u_long id)
129 {
130 if (atomic_cmpset_acq_long(&umtx->u_owner, UMTX_UNOWNED, id) == 0)
131 return (EBUSY);
132 return (0);
133 }
134
135 static __inline int
136 umtx_timedlock(struct umtx *umtx, u_long id, const struct timespec *timeout)
137 {
138 if (atomic_cmpset_acq_long(&umtx->u_owner, UMTX_UNOWNED, id) == 0)
139 if (_umtx_op(umtx, UMTX_OP_LOCK, id, 0,
140 __DECONST(void *, timeout)) == -1)
141 return (errno);
142 return (0);
143 }
144
145 static __inline int
146 umtx_unlock(struct umtx *umtx, u_long id)
147 {
148 if (atomic_cmpset_rel_long(&umtx->u_owner, id, UMTX_UNOWNED) == 0)
149 if (_umtx_unlock(umtx) == -1)
150 return (errno);
151 return (0);
152 }
153
154 static __inline int
155 umtx_wait(u_long *p, long val, const struct timespec *timeout)
156 {
157 if (_umtx_op(p, UMTX_OP_WAIT, val, 0,
158 __DECONST(void *, timeout)) == -1)
159 return (errno);
160 return (0);
161 }
162
163 /* Wake threads waiting on a user address. */
164 static __inline int
165 umtx_wake(u_long *p, int nr_wakeup)
166 {
167 if (_umtx_op(p, UMTX_OP_WAKE, nr_wakeup, 0, 0) == -1)
168 return (errno);
169 return (0);
170 }
171
172 #else
173
174 /*
175 * The umtx_key structure is used by both the Linux futex code and the
176 * umtx implementation to map userland addresses to unique keys.
177 */
178
179 enum {
180 TYPE_SIMPLE_WAIT,
181 TYPE_CV,
182 TYPE_SEM,
183 TYPE_SIMPLE_LOCK,
184 TYPE_NORMAL_UMUTEX,
185 TYPE_PI_UMUTEX,
186 TYPE_PP_UMUTEX,
187 TYPE_RWLOCK,
188 TYPE_FUTEX
189 };
190
191 /* Key to represent a unique userland synchronous object */
192 struct umtx_key {
193 int hash;
194 int type;
195 int shared;
196 union {
197 struct {
198 struct vm_object *object;
199 uintptr_t offset;
200 } shared;
201 struct {
202 struct vmspace *vs;
203 uintptr_t addr;
204 } private;
205 struct {
206 void *a;
207 uintptr_t b;
208 } both;
209 } info;
210 };
211
212 #define THREAD_SHARE 0
213 #define PROCESS_SHARE 1
214 #define AUTO_SHARE 2
215
216 struct thread;
217
218 static inline int
219 umtx_key_match(const struct umtx_key *k1, const struct umtx_key *k2)
220 {
221 return (k1->type == k2->type &&
222 k1->info.both.a == k2->info.both.a &&
223 k1->info.both.b == k2->info.both.b);
224 }
225
226 int umtx_key_get(void *, int, int, struct umtx_key *);
227 void umtx_key_release(struct umtx_key *);
228 struct umtx_q *umtxq_alloc(void);
229 void umtxq_free(struct umtx_q *);
230 int kern_umtx_wake(struct thread *, void *, int, int);
231 void umtx_pi_adjust(struct thread *, u_char);
232 void umtx_thread_init(struct thread *);
233 void umtx_thread_fini(struct thread *);
234 void umtx_thread_alloc(struct thread *);
235 void umtx_thread_exit(struct thread *);
236 #endif /* !_KERNEL */
237 #endif /* !_SYS_UMTX_H_ */
Cache object: fad3e3213c8f8a5b4da1e2c9e17b1d1e
|