?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
MIPS: Consolidate NPTL/non versions of clone
[glibc.git] / sysdeps / unix / sysv / linux / aarch64 / nptl / lowlevellock.h
blob69a5f278eb5b74efaf918dc827ca7cbd5e9fb6e2
1 /* Copyright (C) 2005-2014 Free Software Foundation, Inc.
2
3 This file is part of the GNU C Library.
4
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Lesser General Public
7 License as published by the Free Software Foundation; either
8 version 2.1 of the License, or (at your option) any later version.
9
10 The GNU C Library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Lesser General Public License for more details.
14
15 You should have received a copy of the GNU Lesser General Public
16 License along with the GNU C Library; if not, see
17 <http://www.gnu.org/licenses/>. */
18
19 #ifndef _LOWLEVELLOCK_H
20 #define _LOWLEVELLOCK_H 1
21
22 #include <time.h>
23 #include <sys/param.h>
24 #include <bits/pthreadtypes.h>
25 #include <atomic.h>
26 #include <sysdep.h>
27 #include <kernel-features.h>
28
29 #define FUTEX_WAIT 0
30 #define FUTEX_WAKE 1
31 #define FUTEX_REQUEUE 3
32 #define FUTEX_CMP_REQUEUE 4
33 #define FUTEX_WAKE_OP 5
34 #define FUTEX_OP_CLEAR_WAKE_IF_GT_ONE ((4 << 24) | 1)
35 #define FUTEX_LOCK_PI 6
36 #define FUTEX_UNLOCK_PI 7
37 #define FUTEX_TRYLOCK_PI 8
38 #define FUTEX_WAIT_BITSET 9
39 #define FUTEX_WAKE_BITSET 10
40 #define FUTEX_WAIT_REQUEUE_PI 11
41 #define FUTEX_CMP_REQUEUE_PI 12
42 #define FUTEX_PRIVATE_FLAG 128
43 #define FUTEX_CLOCK_REALTIME 256
44
45 #define FUTEX_BITSET_MATCH_ANY 0xffffffff
46
47 /* Values for 'private' parameter of locking macros. Yes, the
48 definition seems to be backwards. But it is not. The bit will be
49 reversed before passing to the system call. */
50 #define LLL_PRIVATE 0
51 #define LLL_SHARED FUTEX_PRIVATE_FLAG
52
53
54 #if !defined NOT_IN_libc || defined IS_IN_rtld
55 /* In libc.so or ld.so all futexes are private. */
56 # ifdef __ASSUME_PRIVATE_FUTEX
57 # define __lll_private_flag(fl, private) \
58 ((fl) | FUTEX_PRIVATE_FLAG)
59 # else
60 # define __lll_private_flag(fl, private) \
61 ((fl) | THREAD_GETMEM (THREAD_SELF, header.private_futex))
62 # endif
63 #else
64 # ifdef __ASSUME_PRIVATE_FUTEX
65 # define __lll_private_flag(fl, private) \
66 (((fl) | FUTEX_PRIVATE_FLAG) ^ (private))
67 # else
68 # define __lll_private_flag(fl, private) \
69 (__builtin_constant_p (private) \
70 ? ((private) == 0 \
71 ? ((fl) | THREAD_GETMEM (THREAD_SELF, header.private_futex)) \
72 : (fl)) \
73 : ((fl) | (((private) ^ FUTEX_PRIVATE_FLAG) \
74 & THREAD_GETMEM (THREAD_SELF, header.private_futex))))
75 # endif
76 #endif
77
78
79 #define lll_futex_wait(futexp, val, private) \
80 lll_futex_timed_wait(futexp, val, NULL, private)
81
82 #define lll_futex_timed_wait(futexp, val, timespec, private) \
83 ({ \
84 INTERNAL_SYSCALL_DECL (__err); \
85 long int __ret; \
86 __ret = INTERNAL_SYSCALL (futex, __err, 4, (futexp), \
87 __lll_private_flag (FUTEX_WAIT, private), \
88 (val), (timespec)); \
89 __ret; \
90 })
91
92 #define lll_futex_timed_wait_bitset(futexp, val, timespec, clockbit, private) \
93 ({ \
94 INTERNAL_SYSCALL_DECL (__err); \
95 long int __ret; \
96 int __op = FUTEX_WAIT_BITSET | clockbit; \
97 __ret = INTERNAL_SYSCALL (futex, __err, 6, (long) (futexp), \
98 __lll_private_flag (__op, private), \
99 (val), (timespec), NULL /* Unused. */, \
100 FUTEX_BITSET_MATCH_ANY); \
101 __ret; \
102 })
103
104 #define lll_futex_wake(futexp, nr, private) \
105 ({ \
106 INTERNAL_SYSCALL_DECL (__err); \
107 long int __ret; \
108 __ret = INTERNAL_SYSCALL (futex, __err, 4, (futexp), \
109 __lll_private_flag (FUTEX_WAKE, private), \
110 (nr), 0); \
111 __ret; \
112 })
113
114 #define lll_robust_dead(futexv, private) \
115 do \
116 { \
117 int *__futexp = &(futexv); \
118 atomic_or (__futexp, FUTEX_OWNER_DIED); \
119 lll_futex_wake (__futexp, 1, private); \
120 } \
121 while (0)
122
123 /* Returns non-zero if error happened, zero if success. */
124 #define lll_futex_requeue(futexp, nr_wake, nr_move, mutex, val, private) \
125 ({ \
126 INTERNAL_SYSCALL_DECL (__err); \
127 long int __ret; \
128 __ret = INTERNAL_SYSCALL (futex, __err, 6, (futexp), \
129 __lll_private_flag (FUTEX_CMP_REQUEUE, private),\
130 (nr_wake), (nr_move), (mutex), (val)); \
131 INTERNAL_SYSCALL_ERROR_P (__ret, __err); \
132 })
133
134
135 /* Returns non-zero if error happened, zero if success. */
136 #define lll_futex_wake_unlock(futexp, nr_wake, nr_wake2, futexp2, private) \
137 ({ \
138 INTERNAL_SYSCALL_DECL (__err); \
139 long int __ret; \
140 __ret = INTERNAL_SYSCALL (futex, __err, 6, (futexp), \
141 __lll_private_flag (FUTEX_WAKE_OP, private), \
142 (nr_wake), (nr_wake2), (futexp2), \
143 FUTEX_OP_CLEAR_WAKE_IF_GT_ONE); \
144 INTERNAL_SYSCALL_ERROR_P (__ret, __err); \
145 })
146
147
148 /* Priority Inheritance support. */
149 #define lll_futex_wait_requeue_pi(futexp, val, mutex, private) \
150 lll_futex_timed_wait_requeue_pi (futexp, val, NULL, 0, mutex, private)
151
152 #define lll_futex_timed_wait_requeue_pi(futexp, val, timespec, clockbit, \
153 mutex, private) \
154 ({ \
155 INTERNAL_SYSCALL_DECL (__err); \
156 long int __ret; \
157 int __op = FUTEX_WAIT_REQUEUE_PI | clockbit; \
158 \
159 __ret = INTERNAL_SYSCALL (futex, __err, 5, (futexp), \
160 __lll_private_flag (__op, private), \
161 (val), (timespec), mutex); \
162 INTERNAL_SYSCALL_ERROR_P (__ret, __err) ? -__ret : __ret; \
163 })
164
165 #define lll_futex_cmp_requeue_pi(futexp, nr_wake, nr_move, mutex, val, priv) \
166 ({ \
167 INTERNAL_SYSCALL_DECL (__err); \
168 long int __ret; \
169 \
170 __ret = INTERNAL_SYSCALL (futex, __err, 6, (futexp), \
171 __lll_private_flag (FUTEX_CMP_REQUEUE_PI, priv),\
172 (nr_wake), (nr_move), (mutex), (val)); \
173 INTERNAL_SYSCALL_ERROR_P (__ret, __err); \
174 })
175
176
177 #define lll_trylock(lock) \
178 atomic_compare_and_exchange_val_acq(&(lock), 1, 0)
179
180 #define lll_cond_trylock(lock) \
181 atomic_compare_and_exchange_val_acq(&(lock), 2, 0)
182
183 #define __lll_robust_trylock(futex, id) \
184 (atomic_compare_and_exchange_val_acq (futex, id, 0) != 0)
185 #define lll_robust_trylock(lock, id) \
186 __lll_robust_trylock (&(lock), id)
187
188 extern void __lll_lock_wait_private (int *futex) attribute_hidden;
189 extern void __lll_lock_wait (int *futex, int private) attribute_hidden;
190 extern int __lll_robust_lock_wait (int *futex, int private) attribute_hidden;
191
192 #define __lll_lock(futex, private) \
193 ((void) ({ \
194 int *__futex = (futex); \
195 if (__builtin_expect (atomic_compare_and_exchange_val_acq (__futex, \
196 1, 0), 0)) \
197 { \
198 if (__builtin_constant_p (private) && (private) == LLL_PRIVATE) \
199 __lll_lock_wait_private (__futex); \
200 else \
201 __lll_lock_wait (__futex, private); \
202 } \
203 }))
204 #define lll_lock(futex, private) __lll_lock (&(futex), private)
205
206
207 #define __lll_robust_lock(futex, id, private) \
208 ({ \
209 int *__futex = (futex); \
210 int __val = 0; \
211 \
212 if (__builtin_expect (atomic_compare_and_exchange_bool_acq (__futex, id, \
213 0), 0)) \
214 __val = __lll_robust_lock_wait (__futex, private); \
215 __val; \
216 })
217 #define lll_robust_lock(futex, id, private) \
218 __lll_robust_lock (&(futex), id, private)
219
220
221 #define __lll_cond_lock(futex, private) \
222 ((void) ({ \
223 int *__futex = (futex); \
224 if (__builtin_expect (atomic_exchange_acq (__futex, 2), 0)) \
225 __lll_lock_wait (__futex, private); \
226 }))
227 #define lll_cond_lock(futex, private) __lll_cond_lock (&(futex), private)
228
229
230 #define lll_robust_cond_lock(futex, id, private) \
231 __lll_robust_lock (&(futex), (id) | FUTEX_WAITERS, private)
232
233
234 extern int __lll_timedlock_wait (int *futex, const struct timespec *,
235 int private) attribute_hidden;
236 extern int __lll_robust_timedlock_wait (int *futex, const struct timespec *,
237 int private) attribute_hidden;
238
239 #define __lll_timedlock(futex, abstime, private) \
240 ({ \
241 int *__futex = (futex); \
242 int __val = 0; \
243 \
244 if (__builtin_expect (atomic_exchange_acq (__futex, 1), 0)) \
245 __val = __lll_timedlock_wait (__futex, abstime, private); \
246 __val; \
247 })
248 #define lll_timedlock(futex, abstime, private) \
249 __lll_timedlock (&(futex), abstime, private)
250
251
252 #define __lll_robust_timedlock(futex, abstime, id, private) \
253 ({ \
254 int *__futex = (futex); \
255 int __val = 0; \
256 \
257 if (__builtin_expect (atomic_compare_and_exchange_bool_acq (__futex, id, \
258 0), 0)) \
259 __val = __lll_robust_timedlock_wait (__futex, abstime, private); \
260 __val; \
261 })
262 #define lll_robust_timedlock(futex, abstime, id, private) \
263 __lll_robust_timedlock (&(futex), abstime, id, private)
264
265
266 #define __lll_unlock(futex, private) \
267 (void) \
268 ({ int *__futex = (futex); \
269 int __oldval = atomic_exchange_rel (__futex, 0); \
270 if (__builtin_expect (__oldval > 1, 0)) \
271 lll_futex_wake (__futex, 1, private); \
272 })
273
274 #define lll_unlock(futex, private) __lll_unlock(&(futex), private)
275
276
277 #define __lll_robust_unlock(futex, private) \
278 (void) \
279 ({ int *__futex = (futex); \
280 int __oldval = atomic_exchange_rel (__futex, 0); \
281 if (__builtin_expect (__oldval & FUTEX_WAITERS, 0)) \
282 lll_futex_wake (__futex, 1, private); \
283 })
284 #define lll_robust_unlock(futex, private) \
285 __lll_robust_unlock(&(futex), private)
286
287
288 #define lll_islocked(futex) \
289 (futex != 0)
290
291
292 /* Our internal lock implementation is identical to the binary-compatible
293 mutex implementation. */
294
295 /* Initializers for lock. */
296 #define LLL_LOCK_INITIALIZER (0)
297 #define LLL_LOCK_INITIALIZER_LOCKED (1)
298
299 /* The states of a lock are:
300 0 - untaken
301 1 - taken by one user
302 >1 - taken by more users */
303
304 /* The kernel notifies a process which uses CLONE_CHILD_CLEARTID via futex
305 wakeup when the clone terminates. The memory location contains the
306 thread ID while the clone is running and is reset to zero
307 afterwards. */
308 #define lll_wait_tid(tid) \
309 do { \
310 __typeof (tid) __tid; \
311 while ((__tid = (tid)) != 0) \
312 lll_futex_wait (&(tid), __tid, LLL_SHARED);\
313 } while (0)
314
315 extern int __lll_timedwait_tid (int *, const struct timespec *)
316 attribute_hidden;
317
318 #define lll_timedwait_tid(tid, abstime) \
319 ({ \
320 int __res = 0; \
321 if ((tid) != 0) \
322 __res = __lll_timedwait_tid (&(tid), (abstime)); \
323 __res; \
324 })
325
326 #endif /* lowlevellock.h */
sources.redhat.com git mirror of glibc CVS