1 /* Copyright (C) 2003-2015 Free Software Foundation, Inc.
2 This file is part of the GNU C Library.
3 Contributed by Jakub Jelinek <jakub@redhat.com>, 2003.
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.
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.
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/>. */
19 #ifndef _LOWLEVELLOCK_H
20 #define _LOWLEVELLOCK_H 1
23 #include <sys/param.h>
24 #include <bits/pthreadtypes.h>
25 #include <ia64intrin.h>
27 #include <kernel-features.h>
29 #define __NR_futex 1230
32 #define FUTEX_REQUEUE 3
33 #define FUTEX_CMP_REQUEUE 4
34 #define FUTEX_WAKE_OP 5
35 #define FUTEX_OP_CLEAR_WAKE_IF_GT_ONE ((4 << 24) | 1)
36 #define FUTEX_LOCK_PI 6
37 #define FUTEX_UNLOCK_PI 7
38 #define FUTEX_TRYLOCK_PI 8
39 #define FUTEX_WAIT_BITSET 9
40 #define FUTEX_WAKE_BITSET 10
41 #define FUTEX_WAIT_REQUEUE_PI 11
42 #define FUTEX_CMP_REQUEUE_PI 12
43 #define FUTEX_PRIVATE_FLAG 128
44 #define FUTEX_CLOCK_REALTIME 256
46 #define FUTEX_BITSET_MATCH_ANY 0xffffffff
48 /* Values for 'private' parameter of locking macros. Yes, the
49 definition seems to be backwards. But it is not. The bit will be
50 reversed before passing to the system call. */
52 #define LLL_SHARED FUTEX_PRIVATE_FLAG
55 #if IS_IN (libc) || IS_IN (rtld)
56 /* In libc.so or ld.so all futexes are private. */
57 # ifdef __ASSUME_PRIVATE_FUTEX
58 # define __lll_private_flag(fl, private) \
59 ((fl) | FUTEX_PRIVATE_FLAG)
61 # define __lll_private_flag(fl, private) \
62 ((fl) | THREAD_GETMEM (THREAD_SELF, header.private_futex))
65 # ifdef __ASSUME_PRIVATE_FUTEX
66 # define __lll_private_flag(fl, private) \
67 (((fl) | FUTEX_PRIVATE_FLAG) ^ (private))
69 # define __lll_private_flag(fl, private) \
70 (__builtin_constant_p (private) \
72 ? ((fl) | THREAD_GETMEM (THREAD_SELF, header.private_futex)) \
74 : ((fl) | (((private) ^ FUTEX_PRIVATE_FLAG) \
75 & THREAD_GETMEM (THREAD_SELF, header.private_futex))))
80 /* Delay in spinlock loop. */
81 #define BUSY_WAIT_NOP asm ("hint @pause")
83 #define lll_futex_wait(futex, val, private) \
84 lll_futex_timed_wait (futex, val, NULL, private)
86 #define lll_futex_timed_wait(ftx, val, timespec, private) \
88 DO_INLINE_SYSCALL(futex, 4, (long) (ftx), \
89 __lll_private_flag (FUTEX_WAIT, private), \
90 (int) (val), (long) (timespec)); \
91 _r10 == -1 ? -_retval : _retval; \
94 #define lll_futex_timed_wait_bitset(ftx, val, timespec, clockbit, private) \
96 int __op = FUTEX_WAIT_BITSET | (clockbit); \
98 DO_INLINE_SYSCALL(futex, 6, (long) (ftx), \
99 __lll_private_flag (__op, private), \
100 (int) (val), (long) (timespec), NULL /* Unused. */, \
101 FUTEX_BITSET_MATCH_ANY); \
102 _r10 == -1 ? -_retval : _retval; \
105 #define lll_futex_wake(ftx, nr, private) \
107 DO_INLINE_SYSCALL(futex, 3, (long) (ftx), \
108 __lll_private_flag (FUTEX_WAKE, private), \
110 _r10 == -1 ? -_retval : _retval; \
113 /* Returns non-zero if error happened, zero if success. */
114 #define lll_futex_requeue(ftx, nr_wake, nr_move, mutex, val, private) \
116 DO_INLINE_SYSCALL(futex, 6, (long) (ftx), \
117 __lll_private_flag (FUTEX_CMP_REQUEUE, private), \
118 (int) (nr_wake), (int) (nr_move), (long) (mutex), \
124 /* Returns non-zero if error happened, zero if success. */
125 #define lll_futex_wake_unlock(ftx, nr_wake, nr_wake2, ftx2, private) \
127 DO_INLINE_SYSCALL(futex, 6, (long) (ftx), \
128 __lll_private_flag (FUTEX_WAKE_OP, private), \
129 (int) (nr_wake), (int) (nr_wake2), (long) (ftx2), \
130 FUTEX_OP_CLEAR_WAKE_IF_GT_ONE); \
135 /* Priority Inheritance support. */
136 #define lll_futex_wait_requeue_pi(futexp, val, mutex, private) \
137 lll_futex_timed_wait_requeue_pi (futexp, val, NULL, 0, mutex, private)
139 #define lll_futex_timed_wait_requeue_pi(futexp, val, timespec, clockbit, \
142 int __op = FUTEX_WAIT_REQUEUE_PI | (clockbit); \
144 DO_INLINE_SYSCALL(futex, 5, (long) (futexp), \
145 __lll_private_flag (__op, private), \
146 (val), (timespec), mutex); \
151 #define lll_futex_cmp_requeue_pi(futexp, nr_wake, nr_move, mutex, val, priv) \
153 DO_INLINE_SYSCALL(futex, 6, (long) (futexp), \
154 __lll_private_flag (FUTEX_CMP_REQUEUE_PI, priv), \
155 (nr_wake), (nr_move), (mutex), (val)); \
156 _r10 == -1 ? -_retval : _retval; \
160 #define __lll_trylock(futex) \
161 (atomic_compare_and_exchange_val_acq (futex, 1, 0) != 0)
162 #define lll_trylock(futex) __lll_trylock (&(futex))
165 #define __lll_cond_trylock(futex) \
166 (atomic_compare_and_exchange_val_acq (futex, 2, 0) != 0)
167 #define lll_cond_trylock(futex) __lll_cond_trylock (&(futex))
170 extern void __lll_lock_wait_private (int *futex
) attribute_hidden
;
171 extern void __lll_lock_wait (int *futex
, int private) attribute_hidden
;
172 extern int __lll_robust_lock_wait (int *futex
, int private) attribute_hidden
;
175 #define __lll_lock(futex, private) \
177 int *__futex = (futex); \
178 if (__builtin_expect (atomic_compare_and_exchange_bool_acq (__futex, \
181 if (__builtin_constant_p (private) && (private) == LLL_PRIVATE) \
182 __lll_lock_wait_private (__futex); \
184 __lll_lock_wait (__futex, private); \
187 #define lll_lock(futex, private) __lll_lock (&(futex), private)
190 #define __lll_robust_lock(futex, id, private) \
192 int *__futex = (futex); \
195 if (__builtin_expect (atomic_compare_and_exchange_bool_acq (__futex, id, \
197 __val = __lll_robust_lock_wait (__futex, private); \
200 #define lll_robust_lock(futex, id, private) \
201 __lll_robust_lock (&(futex), id, private)
204 #define __lll_cond_lock(futex, private) \
206 int *__futex = (futex); \
207 if (__builtin_expect (atomic_compare_and_exchange_bool_acq (__futex, 2, \
209 __lll_lock_wait (__futex, private); \
211 #define lll_cond_lock(futex, private) __lll_cond_lock (&(futex), private)
214 #define __lll_robust_cond_lock(futex, id, private) \
216 int *__futex = (futex); \
218 int __id = (id) | FUTEX_WAITERS; \
220 if (__builtin_expect (atomic_compare_and_exchange_bool_acq (__futex, \
222 __val = __lll_robust_lock_wait (__futex, private); \
225 #define lll_robust_cond_lock(futex, id, private) \
226 __lll_robust_cond_lock (&(futex), id, private)
229 extern int __lll_timedlock_wait (int *futex
, const struct timespec
*,
230 int private) attribute_hidden
;
231 extern int __lll_robust_timedlock_wait (int *futex
, const struct timespec
*,
232 int private) attribute_hidden
;
235 #define __lll_timedlock(futex, abstime, private) \
237 int *__futex = (futex); \
240 if (__builtin_expect (atomic_compare_and_exchange_bool_acq (__futex, 1, \
242 __val = __lll_timedlock_wait (__futex, abstime, private); \
245 #define lll_timedlock(futex, abstime, private) \
246 __lll_timedlock (&(futex), abstime, private)
249 #define __lll_robust_timedlock(futex, abstime, id, private) \
251 int *__futex = (futex); \
254 if (__builtin_expect (atomic_compare_and_exchange_bool_acq (__futex, id, \
256 __val = __lll_robust_timedlock_wait (__futex, abstime, private); \
259 #define lll_robust_timedlock(futex, abstime, id, private) \
260 __lll_robust_timedlock (&(futex), abstime, id, private)
263 #define __lll_unlock(futex, private) \
265 int *__futex = (futex); \
266 int __val = atomic_exchange_rel (__futex, 0); \
268 if (__builtin_expect (__val > 1, 0)) \
269 lll_futex_wake (__futex, 1, private); \
271 #define lll_unlock(futex, private) __lll_unlock(&(futex), private)
274 #define __lll_robust_unlock(futex, private) \
276 int *__futex = (futex); \
277 int __val = atomic_exchange_rel (__futex, 0); \
279 if (__builtin_expect (__val & FUTEX_WAITERS, 0)) \
280 lll_futex_wake (__futex, 1, private); \
282 #define lll_robust_unlock(futex, private) \
283 __lll_robust_unlock(&(futex), private)
286 #define lll_islocked(futex) \
289 /* Initializers for lock. */
290 #define LLL_LOCK_INITIALIZER (0)
291 #define LLL_LOCK_INITIALIZER_LOCKED (1)
293 /* The kernel notifies a process which uses CLONE_CHILD_CLEARTID via futex
294 wakeup when the clone terminates. The memory location contains the
295 thread ID while the clone is running and is reset to zero
297 #define lll_wait_tid(tid) \
300 __typeof (tid) __tid; \
301 while ((__tid = (tid)) != 0) \
302 lll_futex_wait (&(tid), __tid, LLL_SHARED); \
306 extern int __lll_timedwait_tid (int *, const struct timespec
*)
309 #define lll_timedwait_tid(tid, abstime) \
313 __res = __lll_timedwait_tid (&(tid), (abstime)); \
317 #endif /* lowlevellock.h */