1
/* Copyright (C) 2005, 2006, 2007, 2008, 2009-2012
2
Free Software Foundation, Inc.
4
This file is part of the GNU C Library.
6
The GNU C Library is free software; you can redistribute it and/or
7
modify it under the terms of the GNU Lesser General Public
8
License as published by the Free Software Foundation; either
9
version 2.1 of the License, or (at your option) any later version.
11
The GNU C Library is distributed in the hope that it will be useful,
12
but WITHOUT ANY WARRANTY; without even the implied warranty of
13
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14
Lesser General Public License for more details.
16
You should have received a copy of the GNU Lesser General Public
17
License along with the GNU C Library; if not, see
18
<http://www.gnu.org/licenses/>. */
20
#ifndef _LOWLEVELLOCK_H
21
#define _LOWLEVELLOCK_H 1
24
#include <sys/param.h>
25
#include <bits/pthreadtypes.h>
28
#include <kernel-features.h>
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_PRIVATE_FLAG 128
42
#define FUTEX_CLOCK_REALTIME 256
44
#define FUTEX_BITSET_MATCH_ANY 0xffffffff
46
/* Values for 'private' parameter of locking macros. Yes, the
47
definition seems to be backwards. But it is not. The bit will be
48
reversed before passing to the system call. */
50
#define LLL_SHARED FUTEX_PRIVATE_FLAG
53
#if !defined NOT_IN_libc || defined IS_IN_rtld
54
/* In libc.so or ld.so all futexes are private. */
55
# ifdef __ASSUME_PRIVATE_FUTEX
56
# define __lll_private_flag(fl, private) \
57
((fl) | FUTEX_PRIVATE_FLAG)
59
# define __lll_private_flag(fl, private) \
60
((fl) | THREAD_GETMEM (THREAD_SELF, header.private_futex))
63
# ifdef __ASSUME_PRIVATE_FUTEX
64
# define __lll_private_flag(fl, private) \
65
(((fl) | FUTEX_PRIVATE_FLAG) ^ (private))
67
# define __lll_private_flag(fl, private) \
68
(__builtin_constant_p (private) \
70
? ((fl) | THREAD_GETMEM (THREAD_SELF, header.private_futex)) \
72
: ((fl) | (((private) ^ FUTEX_PRIVATE_FLAG) \
73
& THREAD_GETMEM (THREAD_SELF, header.private_futex))))
78
#define lll_futex_wait(futexp, val, private) \
79
lll_futex_timed_wait(futexp, val, NULL, private)
81
#define lll_futex_timed_wait(futexp, val, timespec, private) \
83
INTERNAL_SYSCALL_DECL (__err); \
85
__ret = INTERNAL_SYSCALL (futex, __err, 4, (futexp), \
86
__lll_private_flag (FUTEX_WAIT, private), \
91
#define lll_futex_wake(futexp, nr, private) \
93
INTERNAL_SYSCALL_DECL (__err); \
95
__ret = INTERNAL_SYSCALL (futex, __err, 4, (futexp), \
96
__lll_private_flag (FUTEX_WAKE, private), \
101
#define lll_robust_dead(futexv, private) \
104
int *__futexp = &(futexv); \
105
atomic_or (__futexp, FUTEX_OWNER_DIED); \
106
lll_futex_wake (__futexp, 1, private); \
110
/* Returns non-zero if error happened, zero if success. */
111
#define lll_futex_requeue(futexp, nr_wake, nr_move, mutex, val, private) \
113
INTERNAL_SYSCALL_DECL (__err); \
115
__ret = INTERNAL_SYSCALL (futex, __err, 6, (futexp), \
116
__lll_private_flag (FUTEX_CMP_REQUEUE, private),\
117
(nr_wake), (nr_move), (mutex), (val)); \
118
INTERNAL_SYSCALL_ERROR_P (__ret, __err); \
122
/* Returns non-zero if error happened, zero if success. */
123
#define lll_futex_wake_unlock(futexp, nr_wake, nr_wake2, futexp2, private) \
125
INTERNAL_SYSCALL_DECL (__err); \
127
__ret = INTERNAL_SYSCALL (futex, __err, 6, (futexp), \
128
__lll_private_flag (FUTEX_WAKE_OP, private), \
129
(nr_wake), (nr_wake2), (futexp2), \
130
FUTEX_OP_CLEAR_WAKE_IF_GT_ONE); \
131
INTERNAL_SYSCALL_ERROR_P (__ret, __err); \
135
#define lll_trylock(lock) \
136
atomic_compare_and_exchange_val_acq(&(lock), 1, 0)
138
#define lll_cond_trylock(lock) \
139
atomic_compare_and_exchange_val_acq(&(lock), 2, 0)
141
#define __lll_robust_trylock(futex, id) \
142
(atomic_compare_and_exchange_val_acq (futex, id, 0) != 0)
143
#define lll_robust_trylock(lock, id) \
144
__lll_robust_trylock (&(lock), id)
146
extern void __lll_lock_wait_private (int *futex) attribute_hidden;
147
extern void __lll_lock_wait (int *futex, int private) attribute_hidden;
148
extern int __lll_robust_lock_wait (int *futex, int private) attribute_hidden;
150
#define __lll_lock(futex, private) \
152
int *__futex = (futex); \
153
if (__builtin_expect (atomic_compare_and_exchange_val_acq (__futex, \
156
if (__builtin_constant_p (private) && (private) == LLL_PRIVATE) \
157
__lll_lock_wait_private (__futex); \
159
__lll_lock_wait (__futex, private); \
162
#define lll_lock(futex, private) __lll_lock (&(futex), private)
165
#define __lll_robust_lock(futex, id, private) \
167
int *__futex = (futex); \
170
if (__builtin_expect (atomic_compare_and_exchange_bool_acq (__futex, id, \
172
__val = __lll_robust_lock_wait (__futex, private); \
175
#define lll_robust_lock(futex, id, private) \
176
__lll_robust_lock (&(futex), id, private)
179
#define __lll_cond_lock(futex, private) \
181
int *__futex = (futex); \
182
if (__builtin_expect (atomic_exchange_acq (__futex, 2), 0)) \
183
__lll_lock_wait (__futex, private); \
185
#define lll_cond_lock(futex, private) __lll_cond_lock (&(futex), private)
188
#define lll_robust_cond_lock(futex, id, private) \
189
__lll_robust_lock (&(futex), (id) | FUTEX_WAITERS, private)
192
extern int __lll_timedlock_wait (int *futex, const struct timespec *,
193
int private) attribute_hidden;
194
extern int __lll_robust_timedlock_wait (int *futex, const struct timespec *,
195
int private) attribute_hidden;
197
#define __lll_timedlock(futex, abstime, private) \
199
int *__futex = (futex); \
202
if (__builtin_expect (atomic_exchange_acq (__futex, 1), 0)) \
203
__val = __lll_timedlock_wait (__futex, abstime, private); \
206
#define lll_timedlock(futex, abstime, private) \
207
__lll_timedlock (&(futex), abstime, private)
210
#define __lll_robust_timedlock(futex, abstime, id, private) \
212
int *__futex = (futex); \
215
if (__builtin_expect (atomic_compare_and_exchange_bool_acq (__futex, id, \
217
__val = __lll_robust_timedlock_wait (__futex, abstime, private); \
220
#define lll_robust_timedlock(futex, abstime, id, private) \
221
__lll_robust_timedlock (&(futex), abstime, id, private)
224
#define __lll_unlock(futex, private) \
226
({ int *__futex = (futex); \
227
int __oldval = atomic_exchange_rel (__futex, 0); \
228
if (__builtin_expect (__oldval > 1, 0)) \
229
lll_futex_wake (__futex, 1, private); \
232
#define lll_unlock(futex, private) __lll_unlock(&(futex), private)
235
#define __lll_robust_unlock(futex, private) \
237
({ int *__futex = (futex); \
238
int __oldval = atomic_exchange_rel (__futex, 0); \
239
if (__builtin_expect (__oldval & FUTEX_WAITERS, 0)) \
240
lll_futex_wake (__futex, 1, private); \
242
#define lll_robust_unlock(futex, private) \
243
__lll_robust_unlock(&(futex), private)
246
#define lll_islocked(futex) \
250
/* Our internal lock implementation is identical to the binary-compatible
251
mutex implementation. */
253
/* Initializers for lock. */
254
#define LLL_LOCK_INITIALIZER (0)
255
#define LLL_LOCK_INITIALIZER_LOCKED (1)
257
/* The states of a lock are:
259
1 - taken by one user
260
>1 - taken by more users */
262
/* The kernel notifies a process which uses CLONE_CLEARTID via futex
263
wakeup when the clone terminates. The memory location contains the
264
thread ID while the clone is running and is reset to zero
266
#define lll_wait_tid(tid) \
268
__typeof (tid) __tid; \
269
while ((__tid = (tid)) != 0) \
270
lll_futex_wait (&(tid), __tid, LLL_SHARED);\
273
extern int __lll_timedwait_tid (int *, const struct timespec *)
276
#define lll_timedwait_tid(tid, abstime) \
280
__res = __lll_timedwait_tid (&(tid), (abstime)); \
284
#endif /* lowlevellock.h */