2 * Fast Userspace Mutexes (which I call "Futexes!").
3 * (C) Rusty Russell, IBM 2002
5 * Generalized futexes, futex requeueing, misc fixes by Ingo Molnar
6 * (C) Copyright 2003 Red Hat Inc, All Rights Reserved
8 * Removed page pinning, fix privately mapped COW pages and other cleanups
9 * (C) Copyright 2003, 2004 Jamie Lokier
11 * Robust futex support started by Ingo Molnar
12 * (C) Copyright 2006 Red Hat Inc, All Rights Reserved
13 * Thanks to Thomas Gleixner for suggestions, analysis and fixes.
15 * PI-futex support started by Ingo Molnar and Thomas Gleixner
16 * Copyright (C) 2006 Red Hat, Inc., Ingo Molnar <mingo@redhat.com>
17 * Copyright (C) 2006 Timesys Corp., Thomas Gleixner <tglx@timesys.com>
19 * PRIVATE futexes by Eric Dumazet
20 * Copyright (C) 2007 Eric Dumazet <dada1@cosmosbay.com>
22 * Requeue-PI support by Darren Hart <dvhltc@us.ibm.com>
23 * Copyright (C) IBM Corporation, 2009
24 * Thanks to Thomas Gleixner for conceptual design and careful reviews.
26 * Thanks to Ben LaHaise for yelling "hashed waitqueues" loudly
27 * enough at me, Linus for the original (flawed) idea, Matthew
28 * Kirkwood for proof-of-concept implementation.
30 * "The futexes are also cursed."
31 * "But they come in a choice of three flavours!"
33 * This program is free software; you can redistribute it and/or modify
34 * it under the terms of the GNU General Public License as published by
35 * the Free Software Foundation; either version 2 of the License, or
36 * (at your option) any later version.
38 * This program is distributed in the hope that it will be useful,
39 * but WITHOUT ANY WARRANTY; without even the implied warranty of
40 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
41 * GNU General Public License for more details.
43 * You should have received a copy of the GNU General Public License
44 * along with this program; if not, write to the Free Software
45 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
47 #include <linux/slab.h>
48 #include <linux/poll.h>
50 #include <linux/file.h>
51 #include <linux/jhash.h>
52 #include <linux/init.h>
53 #include <linux/futex.h>
54 #include <linux/mount.h>
55 #include <linux/pagemap.h>
56 #include <linux/syscalls.h>
57 #include <linux/signal.h>
58 #include <linux/module.h>
59 #include <linux/magic.h>
60 #include <linux/pid.h>
61 #include <linux/nsproxy.h>
63 #include <asm/futex.h>
65 #include "rtmutex_common.h"
67 int __read_mostly futex_cmpxchg_enabled
;
69 #define FUTEX_HASHBITS (CONFIG_BASE_SMALL ? 4 : 8)
72 * Priority Inheritance state:
74 struct futex_pi_state
{
76 * list of 'owned' pi_state instances - these have to be
77 * cleaned up in do_exit() if the task exits prematurely:
79 struct list_head list
;
84 struct rt_mutex pi_mutex
;
86 struct task_struct
*owner
;
93 * struct futex_q - The hashed futex queue entry, one per waiting task
94 * @task: the task waiting on the futex
95 * @lock_ptr: the hash bucket lock
96 * @key: the key the futex is hashed on
97 * @pi_state: optional priority inheritance state
98 * @rt_waiter: rt_waiter storage for use with requeue_pi
99 * @requeue_pi_key: the requeue_pi target futex key
100 * @bitset: bitset for the optional bitmasked wakeup
102 * We use this hashed waitqueue, instead of a normal wait_queue_t, so
103 * we can wake only the relevant ones (hashed queues may be shared).
105 * A futex_q has a woken state, just like tasks have TASK_RUNNING.
106 * It is considered woken when plist_node_empty(&q->list) || q->lock_ptr == 0.
107 * The order of wakup is always to make the first condition true, then
110 * PI futexes are typically woken before they are removed from the hash list via
111 * the rt_mutex code. See unqueue_me_pi().
114 struct plist_node list
;
116 struct task_struct
*task
;
117 spinlock_t
*lock_ptr
;
119 struct futex_pi_state
*pi_state
;
120 struct rt_mutex_waiter
*rt_waiter
;
121 union futex_key
*requeue_pi_key
;
126 * Hash buckets are shared by all the futex_keys that hash to the same
127 * location. Each key may have multiple futex_q structures, one for each task
128 * waiting on a futex.
130 struct futex_hash_bucket
{
132 struct plist_head chain
;
135 static struct futex_hash_bucket futex_queues
[1<<FUTEX_HASHBITS
];
138 * We hash on the keys returned from get_futex_key (see below).
140 static struct futex_hash_bucket
*hash_futex(union futex_key
*key
)
142 u32 hash
= jhash2((u32
*)&key
->both
.word
,
143 (sizeof(key
->both
.word
)+sizeof(key
->both
.ptr
))/4,
145 return &futex_queues
[hash
& ((1 << FUTEX_HASHBITS
)-1)];
149 * Return 1 if two futex_keys are equal, 0 otherwise.
151 static inline int match_futex(union futex_key
*key1
, union futex_key
*key2
)
154 && key1
->both
.word
== key2
->both
.word
155 && key1
->both
.ptr
== key2
->both
.ptr
156 && key1
->both
.offset
== key2
->both
.offset
);
160 * Take a reference to the resource addressed by a key.
161 * Can be called while holding spinlocks.
164 static void get_futex_key_refs(union futex_key
*key
)
169 switch (key
->both
.offset
& (FUT_OFF_INODE
|FUT_OFF_MMSHARED
)) {
171 atomic_inc(&key
->shared
.inode
->i_count
);
173 case FUT_OFF_MMSHARED
:
174 atomic_inc(&key
->private.mm
->mm_count
);
180 * Drop a reference to the resource addressed by a key.
181 * The hash bucket spinlock must not be held.
183 static void drop_futex_key_refs(union futex_key
*key
)
185 if (!key
->both
.ptr
) {
186 /* If we're here then we tried to put a key we failed to get */
191 switch (key
->both
.offset
& (FUT_OFF_INODE
|FUT_OFF_MMSHARED
)) {
193 iput(key
->shared
.inode
);
195 case FUT_OFF_MMSHARED
:
196 mmdrop(key
->private.mm
);
202 * get_futex_key() - Get parameters which are the keys for a futex
203 * @uaddr: virtual address of the futex
204 * @fshared: 0 for a PROCESS_PRIVATE futex, 1 for PROCESS_SHARED
205 * @key: address where result is stored.
207 * Returns a negative error code or 0
208 * The key words are stored in *key on success.
210 * For shared mappings, it's (page->index, vma->vm_file->f_path.dentry->d_inode,
211 * offset_within_page). For private mappings, it's (uaddr, current->mm).
212 * We can usually work out the index without swapping in the page.
214 * lock_page() might sleep, the caller should not hold a spinlock.
217 get_futex_key(u32 __user
*uaddr
, int fshared
, union futex_key
*key
)
219 unsigned long address
= (unsigned long)uaddr
;
220 struct mm_struct
*mm
= current
->mm
;
225 * The futex address must be "naturally" aligned.
227 key
->both
.offset
= address
% PAGE_SIZE
;
228 if (unlikely((address
% sizeof(u32
)) != 0))
230 address
-= key
->both
.offset
;
233 * PROCESS_PRIVATE futexes are fast.
234 * As the mm cannot disappear under us and the 'key' only needs
235 * virtual address, we dont even have to find the underlying vma.
236 * Note : We do have to check 'uaddr' is a valid user address,
237 * but access_ok() should be faster than find_vma()
240 if (unlikely(!access_ok(VERIFY_WRITE
, uaddr
, sizeof(u32
))))
242 key
->private.mm
= mm
;
243 key
->private.address
= address
;
244 get_futex_key_refs(key
);
249 err
= get_user_pages_fast(address
, 1, 1, &page
);
253 page
= compound_head(page
);
255 if (!page
->mapping
) {
262 * Private mappings are handled in a simple way.
264 * NOTE: When userspace waits on a MAP_SHARED mapping, even if
265 * it's a read-only handle, it's expected that futexes attach to
266 * the object not the particular process.
268 if (PageAnon(page
)) {
269 key
->both
.offset
|= FUT_OFF_MMSHARED
; /* ref taken on mm */
270 key
->private.mm
= mm
;
271 key
->private.address
= address
;
273 key
->both
.offset
|= FUT_OFF_INODE
; /* inode-based key */
274 key
->shared
.inode
= page
->mapping
->host
;
275 key
->shared
.pgoff
= page
->index
;
278 get_futex_key_refs(key
);
286 void put_futex_key(int fshared
, union futex_key
*key
)
288 drop_futex_key_refs(key
);
292 * fault_in_user_writeable() - Fault in user address and verify RW access
293 * @uaddr: pointer to faulting user space address
295 * Slow path to fixup the fault we just took in the atomic write
298 * We have no generic implementation of a non destructive write to the
299 * user address. We know that we faulted in the atomic pagefault
300 * disabled section so we can as well avoid the #PF overhead by
301 * calling get_user_pages() right away.
303 static int fault_in_user_writeable(u32 __user
*uaddr
)
305 struct mm_struct
*mm
= current
->mm
;
308 down_read(&mm
->mmap_sem
);
309 ret
= get_user_pages(current
, mm
, (unsigned long)uaddr
,
310 1, 1, 0, NULL
, NULL
);
311 up_read(&mm
->mmap_sem
);
313 return ret
< 0 ? ret
: 0;
317 * futex_top_waiter() - Return the highest priority waiter on a futex
318 * @hb: the hash bucket the futex_q's reside in
319 * @key: the futex key (to distinguish it from other futex futex_q's)
321 * Must be called with the hb lock held.
323 static struct futex_q
*futex_top_waiter(struct futex_hash_bucket
*hb
,
324 union futex_key
*key
)
326 struct futex_q
*this;
328 plist_for_each_entry(this, &hb
->chain
, list
) {
329 if (match_futex(&this->key
, key
))
335 static u32
cmpxchg_futex_value_locked(u32 __user
*uaddr
, u32 uval
, u32 newval
)
340 curval
= futex_atomic_cmpxchg_inatomic(uaddr
, uval
, newval
);
346 static int get_futex_value_locked(u32
*dest
, u32 __user
*from
)
351 ret
= __copy_from_user_inatomic(dest
, from
, sizeof(u32
));
354 return ret
? -EFAULT
: 0;
361 static int refill_pi_state_cache(void)
363 struct futex_pi_state
*pi_state
;
365 if (likely(current
->pi_state_cache
))
368 pi_state
= kzalloc(sizeof(*pi_state
), GFP_KERNEL
);
373 INIT_LIST_HEAD(&pi_state
->list
);
374 /* pi_mutex gets initialized later */
375 pi_state
->owner
= NULL
;
376 atomic_set(&pi_state
->refcount
, 1);
377 pi_state
->key
= FUTEX_KEY_INIT
;
379 current
->pi_state_cache
= pi_state
;
384 static struct futex_pi_state
* alloc_pi_state(void)
386 struct futex_pi_state
*pi_state
= current
->pi_state_cache
;
389 current
->pi_state_cache
= NULL
;
394 static void free_pi_state(struct futex_pi_state
*pi_state
)
396 if (!atomic_dec_and_test(&pi_state
->refcount
))
400 * If pi_state->owner is NULL, the owner is most probably dying
401 * and has cleaned up the pi_state already
403 if (pi_state
->owner
) {
404 raw_spin_lock_irq(&pi_state
->owner
->pi_lock
);
405 list_del_init(&pi_state
->list
);
406 raw_spin_unlock_irq(&pi_state
->owner
->pi_lock
);
408 rt_mutex_proxy_unlock(&pi_state
->pi_mutex
, pi_state
->owner
);
411 if (current
->pi_state_cache
)
415 * pi_state->list is already empty.
416 * clear pi_state->owner.
417 * refcount is at 0 - put it back to 1.
419 pi_state
->owner
= NULL
;
420 atomic_set(&pi_state
->refcount
, 1);
421 current
->pi_state_cache
= pi_state
;
426 * Look up the task based on what TID userspace gave us.
429 static struct task_struct
* futex_find_get_task(pid_t pid
)
431 struct task_struct
*p
;
432 const struct cred
*cred
= current_cred(), *pcred
;
435 p
= find_task_by_vpid(pid
);
439 pcred
= __task_cred(p
);
440 if (cred
->euid
!= pcred
->euid
&&
441 cred
->euid
!= pcred
->uid
)
453 * This task is holding PI mutexes at exit time => bad.
454 * Kernel cleans up PI-state, but userspace is likely hosed.
455 * (Robust-futex cleanup is separate and might save the day for userspace.)
457 void exit_pi_state_list(struct task_struct
*curr
)
459 struct list_head
*next
, *head
= &curr
->pi_state_list
;
460 struct futex_pi_state
*pi_state
;
461 struct futex_hash_bucket
*hb
;
462 union futex_key key
= FUTEX_KEY_INIT
;
464 if (!futex_cmpxchg_enabled
)
467 * We are a ZOMBIE and nobody can enqueue itself on
468 * pi_state_list anymore, but we have to be careful
469 * versus waiters unqueueing themselves:
471 raw_spin_lock_irq(&curr
->pi_lock
);
472 while (!list_empty(head
)) {
475 pi_state
= list_entry(next
, struct futex_pi_state
, list
);
477 hb
= hash_futex(&key
);
478 raw_spin_unlock_irq(&curr
->pi_lock
);
480 spin_lock(&hb
->lock
);
482 raw_spin_lock_irq(&curr
->pi_lock
);
484 * We dropped the pi-lock, so re-check whether this
485 * task still owns the PI-state:
487 if (head
->next
!= next
) {
488 spin_unlock(&hb
->lock
);
492 WARN_ON(pi_state
->owner
!= curr
);
493 WARN_ON(list_empty(&pi_state
->list
));
494 list_del_init(&pi_state
->list
);
495 pi_state
->owner
= NULL
;
496 raw_spin_unlock_irq(&curr
->pi_lock
);
498 rt_mutex_unlock(&pi_state
->pi_mutex
);
500 spin_unlock(&hb
->lock
);
502 raw_spin_lock_irq(&curr
->pi_lock
);
504 raw_spin_unlock_irq(&curr
->pi_lock
);
508 lookup_pi_state(u32 uval
, struct futex_hash_bucket
*hb
,
509 union futex_key
*key
, struct futex_pi_state
**ps
)
511 struct futex_pi_state
*pi_state
= NULL
;
512 struct futex_q
*this, *next
;
513 struct plist_head
*head
;
514 struct task_struct
*p
;
515 pid_t pid
= uval
& FUTEX_TID_MASK
;
519 plist_for_each_entry_safe(this, next
, head
, list
) {
520 if (match_futex(&this->key
, key
)) {
522 * Another waiter already exists - bump up
523 * the refcount and return its pi_state:
525 pi_state
= this->pi_state
;
527 * Userspace might have messed up non PI and PI futexes
529 if (unlikely(!pi_state
))
532 WARN_ON(!atomic_read(&pi_state
->refcount
));
535 * When pi_state->owner is NULL then the owner died
536 * and another waiter is on the fly. pi_state->owner
537 * is fixed up by the task which acquires
538 * pi_state->rt_mutex.
540 * We do not check for pid == 0 which can happen when
541 * the owner died and robust_list_exit() cleared the
544 if (pid
&& pi_state
->owner
) {
546 * Bail out if user space manipulated the
549 if (pid
!= task_pid_vnr(pi_state
->owner
))
553 atomic_inc(&pi_state
->refcount
);
561 * We are the first waiter - try to look up the real owner and attach
562 * the new pi_state to it, but bail out when TID = 0
566 p
= futex_find_get_task(pid
);
571 * We need to look at the task state flags to figure out,
572 * whether the task is exiting. To protect against the do_exit
573 * change of the task flags, we do this protected by
576 raw_spin_lock_irq(&p
->pi_lock
);
577 if (unlikely(p
->flags
& PF_EXITING
)) {
579 * The task is on the way out. When PF_EXITPIDONE is
580 * set, we know that the task has finished the
583 int ret
= (p
->flags
& PF_EXITPIDONE
) ? -ESRCH
: -EAGAIN
;
585 raw_spin_unlock_irq(&p
->pi_lock
);
590 pi_state
= alloc_pi_state();
593 * Initialize the pi_mutex in locked state and make 'p'
596 rt_mutex_init_proxy_locked(&pi_state
->pi_mutex
, p
);
598 /* Store the key for possible exit cleanups: */
599 pi_state
->key
= *key
;
601 WARN_ON(!list_empty(&pi_state
->list
));
602 list_add(&pi_state
->list
, &p
->pi_state_list
);
604 raw_spin_unlock_irq(&p
->pi_lock
);
614 * futex_lock_pi_atomic() - Atomic work required to acquire a pi aware futex
615 * @uaddr: the pi futex user address
616 * @hb: the pi futex hash bucket
617 * @key: the futex key associated with uaddr and hb
618 * @ps: the pi_state pointer where we store the result of the
620 * @task: the task to perform the atomic lock work for. This will
621 * be "current" except in the case of requeue pi.
622 * @set_waiters: force setting the FUTEX_WAITERS bit (1) or not (0)
626 * 1 - acquired the lock
629 * The hb->lock and futex_key refs shall be held by the caller.
631 static int futex_lock_pi_atomic(u32 __user
*uaddr
, struct futex_hash_bucket
*hb
,
632 union futex_key
*key
,
633 struct futex_pi_state
**ps
,
634 struct task_struct
*task
, int set_waiters
)
636 int lock_taken
, ret
, ownerdied
= 0;
637 u32 uval
, newval
, curval
;
640 ret
= lock_taken
= 0;
643 * To avoid races, we attempt to take the lock here again
644 * (by doing a 0 -> TID atomic cmpxchg), while holding all
645 * the locks. It will most likely not succeed.
647 newval
= task_pid_vnr(task
);
649 newval
|= FUTEX_WAITERS
;
651 curval
= cmpxchg_futex_value_locked(uaddr
, 0, newval
);
653 if (unlikely(curval
== -EFAULT
))
659 if ((unlikely((curval
& FUTEX_TID_MASK
) == task_pid_vnr(task
))))
663 * Surprise - we got the lock. Just return to userspace:
665 if (unlikely(!curval
))
671 * Set the FUTEX_WAITERS flag, so the owner will know it has someone
672 * to wake at the next unlock.
674 newval
= curval
| FUTEX_WAITERS
;
677 * There are two cases, where a futex might have no owner (the
678 * owner TID is 0): OWNER_DIED. We take over the futex in this
679 * case. We also do an unconditional take over, when the owner
682 * This is safe as we are protected by the hash bucket lock !
684 if (unlikely(ownerdied
|| !(curval
& FUTEX_TID_MASK
))) {
685 /* Keep the OWNER_DIED bit */
686 newval
= (curval
& ~FUTEX_TID_MASK
) | task_pid_vnr(task
);
691 curval
= cmpxchg_futex_value_locked(uaddr
, uval
, newval
);
693 if (unlikely(curval
== -EFAULT
))
695 if (unlikely(curval
!= uval
))
699 * We took the lock due to owner died take over.
701 if (unlikely(lock_taken
))
705 * We dont have the lock. Look up the PI state (or create it if
706 * we are the first waiter):
708 ret
= lookup_pi_state(uval
, hb
, key
, ps
);
714 * No owner found for this futex. Check if the
715 * OWNER_DIED bit is set to figure out whether
716 * this is a robust futex or not.
718 if (get_futex_value_locked(&curval
, uaddr
))
722 * We simply start over in case of a robust
723 * futex. The code above will take the futex
726 if (curval
& FUTEX_OWNER_DIED
) {
739 * The hash bucket lock must be held when this is called.
740 * Afterwards, the futex_q must not be accessed.
742 static void wake_futex(struct futex_q
*q
)
744 struct task_struct
*p
= q
->task
;
747 * We set q->lock_ptr = NULL _before_ we wake up the task. If
748 * a non futex wake up happens on another CPU then the task
749 * might exit and p would dereference a non existing task
750 * struct. Prevent this by holding a reference on p across the
755 plist_del(&q
->list
, &q
->list
.plist
);
757 * The waiting task can free the futex_q as soon as
758 * q->lock_ptr = NULL is written, without taking any locks. A
759 * memory barrier is required here to prevent the following
760 * store to lock_ptr from getting ahead of the plist_del.
765 wake_up_state(p
, TASK_NORMAL
);
769 static int wake_futex_pi(u32 __user
*uaddr
, u32 uval
, struct futex_q
*this)
771 struct task_struct
*new_owner
;
772 struct futex_pi_state
*pi_state
= this->pi_state
;
779 * If current does not own the pi_state then the futex is
780 * inconsistent and user space fiddled with the futex value.
782 if (pi_state
->owner
!= current
)
785 raw_spin_lock(&pi_state
->pi_mutex
.wait_lock
);
786 new_owner
= rt_mutex_next_owner(&pi_state
->pi_mutex
);
789 * This happens when we have stolen the lock and the original
790 * pending owner did not enqueue itself back on the rt_mutex.
791 * Thats not a tragedy. We know that way, that a lock waiter
792 * is on the fly. We make the futex_q waiter the pending owner.
795 new_owner
= this->task
;
798 * We pass it to the next owner. (The WAITERS bit is always
799 * kept enabled while there is PI state around. We must also
800 * preserve the owner died bit.)
802 if (!(uval
& FUTEX_OWNER_DIED
)) {
805 newval
= FUTEX_WAITERS
| task_pid_vnr(new_owner
);
807 curval
= cmpxchg_futex_value_locked(uaddr
, uval
, newval
);
809 if (curval
== -EFAULT
)
811 else if (curval
!= uval
)
814 raw_spin_unlock(&pi_state
->pi_mutex
.wait_lock
);
819 raw_spin_lock_irq(&pi_state
->owner
->pi_lock
);
820 WARN_ON(list_empty(&pi_state
->list
));
821 list_del_init(&pi_state
->list
);
822 raw_spin_unlock_irq(&pi_state
->owner
->pi_lock
);
824 raw_spin_lock_irq(&new_owner
->pi_lock
);
825 WARN_ON(!list_empty(&pi_state
->list
));
826 list_add(&pi_state
->list
, &new_owner
->pi_state_list
);
827 pi_state
->owner
= new_owner
;
828 raw_spin_unlock_irq(&new_owner
->pi_lock
);
830 raw_spin_unlock(&pi_state
->pi_mutex
.wait_lock
);
831 rt_mutex_unlock(&pi_state
->pi_mutex
);
836 static int unlock_futex_pi(u32 __user
*uaddr
, u32 uval
)
841 * There is no waiter, so we unlock the futex. The owner died
842 * bit has not to be preserved here. We are the owner:
844 oldval
= cmpxchg_futex_value_locked(uaddr
, uval
, 0);
846 if (oldval
== -EFAULT
)
855 * Express the locking dependencies for lockdep:
858 double_lock_hb(struct futex_hash_bucket
*hb1
, struct futex_hash_bucket
*hb2
)
861 spin_lock(&hb1
->lock
);
863 spin_lock_nested(&hb2
->lock
, SINGLE_DEPTH_NESTING
);
864 } else { /* hb1 > hb2 */
865 spin_lock(&hb2
->lock
);
866 spin_lock_nested(&hb1
->lock
, SINGLE_DEPTH_NESTING
);
871 double_unlock_hb(struct futex_hash_bucket
*hb1
, struct futex_hash_bucket
*hb2
)
873 spin_unlock(&hb1
->lock
);
875 spin_unlock(&hb2
->lock
);
879 * Wake up waiters matching bitset queued on this futex (uaddr).
881 static int futex_wake(u32 __user
*uaddr
, int fshared
, int nr_wake
, u32 bitset
)
883 struct futex_hash_bucket
*hb
;
884 struct futex_q
*this, *next
;
885 struct plist_head
*head
;
886 union futex_key key
= FUTEX_KEY_INIT
;
892 ret
= get_futex_key(uaddr
, fshared
, &key
);
893 if (unlikely(ret
!= 0))
896 hb
= hash_futex(&key
);
897 spin_lock(&hb
->lock
);
900 plist_for_each_entry_safe(this, next
, head
, list
) {
901 if (match_futex (&this->key
, &key
)) {
902 if (this->pi_state
|| this->rt_waiter
) {
907 /* Check if one of the bits is set in both bitsets */
908 if (!(this->bitset
& bitset
))
912 if (++ret
>= nr_wake
)
917 spin_unlock(&hb
->lock
);
918 put_futex_key(fshared
, &key
);
924 * Wake up all waiters hashed on the physical page that is mapped
925 * to this virtual address:
928 futex_wake_op(u32 __user
*uaddr1
, int fshared
, u32 __user
*uaddr2
,
929 int nr_wake
, int nr_wake2
, int op
)
931 union futex_key key1
= FUTEX_KEY_INIT
, key2
= FUTEX_KEY_INIT
;
932 struct futex_hash_bucket
*hb1
, *hb2
;
933 struct plist_head
*head
;
934 struct futex_q
*this, *next
;
938 ret
= get_futex_key(uaddr1
, fshared
, &key1
);
939 if (unlikely(ret
!= 0))
941 ret
= get_futex_key(uaddr2
, fshared
, &key2
);
942 if (unlikely(ret
!= 0))
945 hb1
= hash_futex(&key1
);
946 hb2
= hash_futex(&key2
);
949 double_lock_hb(hb1
, hb2
);
950 op_ret
= futex_atomic_op_inuser(op
, uaddr2
);
951 if (unlikely(op_ret
< 0)) {
953 double_unlock_hb(hb1
, hb2
);
957 * we don't get EFAULT from MMU faults if we don't have an MMU,
958 * but we might get them from range checking
964 if (unlikely(op_ret
!= -EFAULT
)) {
969 ret
= fault_in_user_writeable(uaddr2
);
976 put_futex_key(fshared
, &key2
);
977 put_futex_key(fshared
, &key1
);
983 plist_for_each_entry_safe(this, next
, head
, list
) {
984 if (match_futex (&this->key
, &key1
)) {
986 if (++ret
>= nr_wake
)
995 plist_for_each_entry_safe(this, next
, head
, list
) {
996 if (match_futex (&this->key
, &key2
)) {
998 if (++op_ret
>= nr_wake2
)
1005 double_unlock_hb(hb1
, hb2
);
1007 put_futex_key(fshared
, &key2
);
1009 put_futex_key(fshared
, &key1
);
1015 * requeue_futex() - Requeue a futex_q from one hb to another
1016 * @q: the futex_q to requeue
1017 * @hb1: the source hash_bucket
1018 * @hb2: the target hash_bucket
1019 * @key2: the new key for the requeued futex_q
1022 void requeue_futex(struct futex_q
*q
, struct futex_hash_bucket
*hb1
,
1023 struct futex_hash_bucket
*hb2
, union futex_key
*key2
)
1027 * If key1 and key2 hash to the same bucket, no need to
1030 if (likely(&hb1
->chain
!= &hb2
->chain
)) {
1031 plist_del(&q
->list
, &hb1
->chain
);
1032 plist_add(&q
->list
, &hb2
->chain
);
1033 q
->lock_ptr
= &hb2
->lock
;
1034 #ifdef CONFIG_DEBUG_PI_LIST
1035 q
->list
.plist
.spinlock
= &hb2
->lock
;
1038 get_futex_key_refs(key2
);
1043 * requeue_pi_wake_futex() - Wake a task that acquired the lock during requeue
1045 * @key: the key of the requeue target futex
1046 * @hb: the hash_bucket of the requeue target futex
1048 * During futex_requeue, with requeue_pi=1, it is possible to acquire the
1049 * target futex if it is uncontended or via a lock steal. Set the futex_q key
1050 * to the requeue target futex so the waiter can detect the wakeup on the right
1051 * futex, but remove it from the hb and NULL the rt_waiter so it can detect
1052 * atomic lock acquisition. Set the q->lock_ptr to the requeue target hb->lock
1053 * to protect access to the pi_state to fixup the owner later. Must be called
1054 * with both q->lock_ptr and hb->lock held.
1057 void requeue_pi_wake_futex(struct futex_q
*q
, union futex_key
*key
,
1058 struct futex_hash_bucket
*hb
)
1060 get_futex_key_refs(key
);
1063 WARN_ON(plist_node_empty(&q
->list
));
1064 plist_del(&q
->list
, &q
->list
.plist
);
1066 WARN_ON(!q
->rt_waiter
);
1067 q
->rt_waiter
= NULL
;
1069 q
->lock_ptr
= &hb
->lock
;
1070 #ifdef CONFIG_DEBUG_PI_LIST
1071 q
->list
.plist
.spinlock
= &hb
->lock
;
1074 wake_up_state(q
->task
, TASK_NORMAL
);
1078 * futex_proxy_trylock_atomic() - Attempt an atomic lock for the top waiter
1079 * @pifutex: the user address of the to futex
1080 * @hb1: the from futex hash bucket, must be locked by the caller
1081 * @hb2: the to futex hash bucket, must be locked by the caller
1082 * @key1: the from futex key
1083 * @key2: the to futex key
1084 * @ps: address to store the pi_state pointer
1085 * @set_waiters: force setting the FUTEX_WAITERS bit (1) or not (0)
1087 * Try and get the lock on behalf of the top waiter if we can do it atomically.
1088 * Wake the top waiter if we succeed. If the caller specified set_waiters,
1089 * then direct futex_lock_pi_atomic() to force setting the FUTEX_WAITERS bit.
1090 * hb1 and hb2 must be held by the caller.
1093 * 0 - failed to acquire the lock atomicly
1094 * 1 - acquired the lock
1097 static int futex_proxy_trylock_atomic(u32 __user
*pifutex
,
1098 struct futex_hash_bucket
*hb1
,
1099 struct futex_hash_bucket
*hb2
,
1100 union futex_key
*key1
, union futex_key
*key2
,
1101 struct futex_pi_state
**ps
, int set_waiters
)
1103 struct futex_q
*top_waiter
= NULL
;
1107 if (get_futex_value_locked(&curval
, pifutex
))
1111 * Find the top_waiter and determine if there are additional waiters.
1112 * If the caller intends to requeue more than 1 waiter to pifutex,
1113 * force futex_lock_pi_atomic() to set the FUTEX_WAITERS bit now,
1114 * as we have means to handle the possible fault. If not, don't set
1115 * the bit unecessarily as it will force the subsequent unlock to enter
1118 top_waiter
= futex_top_waiter(hb1
, key1
);
1120 /* There are no waiters, nothing for us to do. */
1124 /* Ensure we requeue to the expected futex. */
1125 if (!match_futex(top_waiter
->requeue_pi_key
, key2
))
1129 * Try to take the lock for top_waiter. Set the FUTEX_WAITERS bit in
1130 * the contended case or if set_waiters is 1. The pi_state is returned
1131 * in ps in contended cases.
1133 ret
= futex_lock_pi_atomic(pifutex
, hb2
, key2
, ps
, top_waiter
->task
,
1136 requeue_pi_wake_futex(top_waiter
, key2
, hb2
);
1142 * futex_requeue() - Requeue waiters from uaddr1 to uaddr2
1143 * uaddr1: source futex user address
1144 * uaddr2: target futex user address
1145 * nr_wake: number of waiters to wake (must be 1 for requeue_pi)
1146 * nr_requeue: number of waiters to requeue (0-INT_MAX)
1147 * requeue_pi: if we are attempting to requeue from a non-pi futex to a
1148 * pi futex (pi to pi requeue is not supported)
1150 * Requeue waiters on uaddr1 to uaddr2. In the requeue_pi case, try to acquire
1151 * uaddr2 atomically on behalf of the top waiter.
1154 * >=0 - on success, the number of tasks requeued or woken
1157 static int futex_requeue(u32 __user
*uaddr1
, int fshared
, u32 __user
*uaddr2
,
1158 int nr_wake
, int nr_requeue
, u32
*cmpval
,
1161 union futex_key key1
= FUTEX_KEY_INIT
, key2
= FUTEX_KEY_INIT
;
1162 int drop_count
= 0, task_count
= 0, ret
;
1163 struct futex_pi_state
*pi_state
= NULL
;
1164 struct futex_hash_bucket
*hb1
, *hb2
;
1165 struct plist_head
*head1
;
1166 struct futex_q
*this, *next
;
1171 * requeue_pi requires a pi_state, try to allocate it now
1172 * without any locks in case it fails.
1174 if (refill_pi_state_cache())
1177 * requeue_pi must wake as many tasks as it can, up to nr_wake
1178 * + nr_requeue, since it acquires the rt_mutex prior to
1179 * returning to userspace, so as to not leave the rt_mutex with
1180 * waiters and no owner. However, second and third wake-ups
1181 * cannot be predicted as they involve race conditions with the
1182 * first wake and a fault while looking up the pi_state. Both
1183 * pthread_cond_signal() and pthread_cond_broadcast() should
1191 if (pi_state
!= NULL
) {
1193 * We will have to lookup the pi_state again, so free this one
1194 * to keep the accounting correct.
1196 free_pi_state(pi_state
);
1200 ret
= get_futex_key(uaddr1
, fshared
, &key1
);
1201 if (unlikely(ret
!= 0))
1203 ret
= get_futex_key(uaddr2
, fshared
, &key2
);
1204 if (unlikely(ret
!= 0))
1207 hb1
= hash_futex(&key1
);
1208 hb2
= hash_futex(&key2
);
1211 double_lock_hb(hb1
, hb2
);
1213 if (likely(cmpval
!= NULL
)) {
1216 ret
= get_futex_value_locked(&curval
, uaddr1
);
1218 if (unlikely(ret
)) {
1219 double_unlock_hb(hb1
, hb2
);
1221 ret
= get_user(curval
, uaddr1
);
1228 put_futex_key(fshared
, &key2
);
1229 put_futex_key(fshared
, &key1
);
1232 if (curval
!= *cmpval
) {
1238 if (requeue_pi
&& (task_count
- nr_wake
< nr_requeue
)) {
1240 * Attempt to acquire uaddr2 and wake the top waiter. If we
1241 * intend to requeue waiters, force setting the FUTEX_WAITERS
1242 * bit. We force this here where we are able to easily handle
1243 * faults rather in the requeue loop below.
1245 ret
= futex_proxy_trylock_atomic(uaddr2
, hb1
, hb2
, &key1
,
1246 &key2
, &pi_state
, nr_requeue
);
1249 * At this point the top_waiter has either taken uaddr2 or is
1250 * waiting on it. If the former, then the pi_state will not
1251 * exist yet, look it up one more time to ensure we have a
1258 ret
= get_futex_value_locked(&curval2
, uaddr2
);
1260 ret
= lookup_pi_state(curval2
, hb2
, &key2
,
1268 double_unlock_hb(hb1
, hb2
);
1269 put_futex_key(fshared
, &key2
);
1270 put_futex_key(fshared
, &key1
);
1271 ret
= fault_in_user_writeable(uaddr2
);
1276 /* The owner was exiting, try again. */
1277 double_unlock_hb(hb1
, hb2
);
1278 put_futex_key(fshared
, &key2
);
1279 put_futex_key(fshared
, &key1
);
1287 head1
= &hb1
->chain
;
1288 plist_for_each_entry_safe(this, next
, head1
, list
) {
1289 if (task_count
- nr_wake
>= nr_requeue
)
1292 if (!match_futex(&this->key
, &key1
))
1296 * FUTEX_WAIT_REQEUE_PI and FUTEX_CMP_REQUEUE_PI should always
1297 * be paired with each other and no other futex ops.
1299 if ((requeue_pi
&& !this->rt_waiter
) ||
1300 (!requeue_pi
&& this->rt_waiter
)) {
1306 * Wake nr_wake waiters. For requeue_pi, if we acquired the
1307 * lock, we already woke the top_waiter. If not, it will be
1308 * woken by futex_unlock_pi().
1310 if (++task_count
<= nr_wake
&& !requeue_pi
) {
1315 /* Ensure we requeue to the expected futex for requeue_pi. */
1316 if (requeue_pi
&& !match_futex(this->requeue_pi_key
, &key2
)) {
1322 * Requeue nr_requeue waiters and possibly one more in the case
1323 * of requeue_pi if we couldn't acquire the lock atomically.
1326 /* Prepare the waiter to take the rt_mutex. */
1327 atomic_inc(&pi_state
->refcount
);
1328 this->pi_state
= pi_state
;
1329 ret
= rt_mutex_start_proxy_lock(&pi_state
->pi_mutex
,
1333 /* We got the lock. */
1334 requeue_pi_wake_futex(this, &key2
, hb2
);
1339 this->pi_state
= NULL
;
1340 free_pi_state(pi_state
);
1344 requeue_futex(this, hb1
, hb2
, &key2
);
1349 double_unlock_hb(hb1
, hb2
);
1352 * drop_futex_key_refs() must be called outside the spinlocks. During
1353 * the requeue we moved futex_q's from the hash bucket at key1 to the
1354 * one at key2 and updated their key pointer. We no longer need to
1355 * hold the references to key1.
1357 while (--drop_count
>= 0)
1358 drop_futex_key_refs(&key1
);
1361 put_futex_key(fshared
, &key2
);
1363 put_futex_key(fshared
, &key1
);
1365 if (pi_state
!= NULL
)
1366 free_pi_state(pi_state
);
1367 return ret
? ret
: task_count
;
1370 /* The key must be already stored in q->key. */
1371 static inline struct futex_hash_bucket
*queue_lock(struct futex_q
*q
)
1373 struct futex_hash_bucket
*hb
;
1375 get_futex_key_refs(&q
->key
);
1376 hb
= hash_futex(&q
->key
);
1377 q
->lock_ptr
= &hb
->lock
;
1379 spin_lock(&hb
->lock
);
1384 queue_unlock(struct futex_q
*q
, struct futex_hash_bucket
*hb
)
1386 spin_unlock(&hb
->lock
);
1387 drop_futex_key_refs(&q
->key
);
1391 * queue_me() - Enqueue the futex_q on the futex_hash_bucket
1392 * @q: The futex_q to enqueue
1393 * @hb: The destination hash bucket
1395 * The hb->lock must be held by the caller, and is released here. A call to
1396 * queue_me() is typically paired with exactly one call to unqueue_me(). The
1397 * exceptions involve the PI related operations, which may use unqueue_me_pi()
1398 * or nothing if the unqueue is done as part of the wake process and the unqueue
1399 * state is implicit in the state of woken task (see futex_wait_requeue_pi() for
1402 static inline void queue_me(struct futex_q
*q
, struct futex_hash_bucket
*hb
)
1407 * The priority used to register this element is
1408 * - either the real thread-priority for the real-time threads
1409 * (i.e. threads with a priority lower than MAX_RT_PRIO)
1410 * - or MAX_RT_PRIO for non-RT threads.
1411 * Thus, all RT-threads are woken first in priority order, and
1412 * the others are woken last, in FIFO order.
1414 prio
= min(current
->normal_prio
, MAX_RT_PRIO
);
1416 plist_node_init(&q
->list
, prio
);
1417 #ifdef CONFIG_DEBUG_PI_LIST
1418 q
->list
.plist
.spinlock
= &hb
->lock
;
1420 plist_add(&q
->list
, &hb
->chain
);
1422 spin_unlock(&hb
->lock
);
1426 * unqueue_me() - Remove the futex_q from its futex_hash_bucket
1427 * @q: The futex_q to unqueue
1429 * The q->lock_ptr must not be held by the caller. A call to unqueue_me() must
1430 * be paired with exactly one earlier call to queue_me().
1433 * 1 - if the futex_q was still queued (and we removed unqueued it)
1434 * 0 - if the futex_q was already removed by the waking thread
1436 static int unqueue_me(struct futex_q
*q
)
1438 spinlock_t
*lock_ptr
;
1441 /* In the common case we don't take the spinlock, which is nice. */
1443 lock_ptr
= q
->lock_ptr
;
1445 if (lock_ptr
!= NULL
) {
1446 spin_lock(lock_ptr
);
1448 * q->lock_ptr can change between reading it and
1449 * spin_lock(), causing us to take the wrong lock. This
1450 * corrects the race condition.
1452 * Reasoning goes like this: if we have the wrong lock,
1453 * q->lock_ptr must have changed (maybe several times)
1454 * between reading it and the spin_lock(). It can
1455 * change again after the spin_lock() but only if it was
1456 * already changed before the spin_lock(). It cannot,
1457 * however, change back to the original value. Therefore
1458 * we can detect whether we acquired the correct lock.
1460 if (unlikely(lock_ptr
!= q
->lock_ptr
)) {
1461 spin_unlock(lock_ptr
);
1464 WARN_ON(plist_node_empty(&q
->list
));
1465 plist_del(&q
->list
, &q
->list
.plist
);
1467 BUG_ON(q
->pi_state
);
1469 spin_unlock(lock_ptr
);
1473 drop_futex_key_refs(&q
->key
);
1478 * PI futexes can not be requeued and must remove themself from the
1479 * hash bucket. The hash bucket lock (i.e. lock_ptr) is held on entry
1482 static void unqueue_me_pi(struct futex_q
*q
)
1484 WARN_ON(plist_node_empty(&q
->list
));
1485 plist_del(&q
->list
, &q
->list
.plist
);
1487 BUG_ON(!q
->pi_state
);
1488 free_pi_state(q
->pi_state
);
1491 spin_unlock(q
->lock_ptr
);
1493 drop_futex_key_refs(&q
->key
);
1497 * Fixup the pi_state owner with the new owner.
1499 * Must be called with hash bucket lock held and mm->sem held for non
1502 static int fixup_pi_state_owner(u32 __user
*uaddr
, struct futex_q
*q
,
1503 struct task_struct
*newowner
, int fshared
)
1505 u32 newtid
= task_pid_vnr(newowner
) | FUTEX_WAITERS
;
1506 struct futex_pi_state
*pi_state
= q
->pi_state
;
1507 struct task_struct
*oldowner
= pi_state
->owner
;
1508 u32 uval
, curval
, newval
;
1512 if (!pi_state
->owner
)
1513 newtid
|= FUTEX_OWNER_DIED
;
1516 * We are here either because we stole the rtmutex from the
1517 * pending owner or we are the pending owner which failed to
1518 * get the rtmutex. We have to replace the pending owner TID
1519 * in the user space variable. This must be atomic as we have
1520 * to preserve the owner died bit here.
1522 * Note: We write the user space value _before_ changing the pi_state
1523 * because we can fault here. Imagine swapped out pages or a fork
1524 * that marked all the anonymous memory readonly for cow.
1526 * Modifying pi_state _before_ the user space value would
1527 * leave the pi_state in an inconsistent state when we fault
1528 * here, because we need to drop the hash bucket lock to
1529 * handle the fault. This might be observed in the PID check
1530 * in lookup_pi_state.
1533 if (get_futex_value_locked(&uval
, uaddr
))
1537 newval
= (uval
& FUTEX_OWNER_DIED
) | newtid
;
1539 curval
= cmpxchg_futex_value_locked(uaddr
, uval
, newval
);
1541 if (curval
== -EFAULT
)
1549 * We fixed up user space. Now we need to fix the pi_state
1552 if (pi_state
->owner
!= NULL
) {
1553 raw_spin_lock_irq(&pi_state
->owner
->pi_lock
);
1554 WARN_ON(list_empty(&pi_state
->list
));
1555 list_del_init(&pi_state
->list
);
1556 raw_spin_unlock_irq(&pi_state
->owner
->pi_lock
);
1559 pi_state
->owner
= newowner
;
1561 raw_spin_lock_irq(&newowner
->pi_lock
);
1562 WARN_ON(!list_empty(&pi_state
->list
));
1563 list_add(&pi_state
->list
, &newowner
->pi_state_list
);
1564 raw_spin_unlock_irq(&newowner
->pi_lock
);
1568 * To handle the page fault we need to drop the hash bucket
1569 * lock here. That gives the other task (either the pending
1570 * owner itself or the task which stole the rtmutex) the
1571 * chance to try the fixup of the pi_state. So once we are
1572 * back from handling the fault we need to check the pi_state
1573 * after reacquiring the hash bucket lock and before trying to
1574 * do another fixup. When the fixup has been done already we
1578 spin_unlock(q
->lock_ptr
);
1580 ret
= fault_in_user_writeable(uaddr
);
1582 spin_lock(q
->lock_ptr
);
1585 * Check if someone else fixed it for us:
1587 if (pi_state
->owner
!= oldowner
)
1597 * In case we must use restart_block to restart a futex_wait,
1598 * we encode in the 'flags' shared capability
1600 #define FLAGS_SHARED 0x01
1601 #define FLAGS_CLOCKRT 0x02
1602 #define FLAGS_HAS_TIMEOUT 0x04
1604 static long futex_wait_restart(struct restart_block
*restart
);
1607 * fixup_owner() - Post lock pi_state and corner case management
1608 * @uaddr: user address of the futex
1609 * @fshared: whether the futex is shared (1) or not (0)
1610 * @q: futex_q (contains pi_state and access to the rt_mutex)
1611 * @locked: if the attempt to take the rt_mutex succeeded (1) or not (0)
1613 * After attempting to lock an rt_mutex, this function is called to cleanup
1614 * the pi_state owner as well as handle race conditions that may allow us to
1615 * acquire the lock. Must be called with the hb lock held.
1618 * 1 - success, lock taken
1619 * 0 - success, lock not taken
1620 * <0 - on error (-EFAULT)
1622 static int fixup_owner(u32 __user
*uaddr
, int fshared
, struct futex_q
*q
,
1625 struct task_struct
*owner
;
1630 * Got the lock. We might not be the anticipated owner if we
1631 * did a lock-steal - fix up the PI-state in that case:
1633 if (q
->pi_state
->owner
!= current
)
1634 ret
= fixup_pi_state_owner(uaddr
, q
, current
, fshared
);
1639 * Catch the rare case, where the lock was released when we were on the
1640 * way back before we locked the hash bucket.
1642 if (q
->pi_state
->owner
== current
) {
1644 * Try to get the rt_mutex now. This might fail as some other
1645 * task acquired the rt_mutex after we removed ourself from the
1646 * rt_mutex waiters list.
1648 if (rt_mutex_trylock(&q
->pi_state
->pi_mutex
)) {
1654 * pi_state is incorrect, some other task did a lock steal and
1655 * we returned due to timeout or signal without taking the
1656 * rt_mutex. Too late. We can access the rt_mutex_owner without
1657 * locking, as the other task is now blocked on the hash bucket
1658 * lock. Fix the state up.
1660 owner
= rt_mutex_owner(&q
->pi_state
->pi_mutex
);
1661 ret
= fixup_pi_state_owner(uaddr
, q
, owner
, fshared
);
1666 * Paranoia check. If we did not take the lock, then we should not be
1667 * the owner, nor the pending owner, of the rt_mutex.
1669 if (rt_mutex_owner(&q
->pi_state
->pi_mutex
) == current
)
1670 printk(KERN_ERR
"fixup_owner: ret = %d pi-mutex: %p "
1671 "pi-state %p\n", ret
,
1672 q
->pi_state
->pi_mutex
.owner
,
1673 q
->pi_state
->owner
);
1676 return ret
? ret
: locked
;
1680 * futex_wait_queue_me() - queue_me() and wait for wakeup, timeout, or signal
1681 * @hb: the futex hash bucket, must be locked by the caller
1682 * @q: the futex_q to queue up on
1683 * @timeout: the prepared hrtimer_sleeper, or null for no timeout
1685 static void futex_wait_queue_me(struct futex_hash_bucket
*hb
, struct futex_q
*q
,
1686 struct hrtimer_sleeper
*timeout
)
1689 * The task state is guaranteed to be set before another task can
1690 * wake it. set_current_state() is implemented using set_mb() and
1691 * queue_me() calls spin_unlock() upon completion, both serializing
1692 * access to the hash list and forcing another memory barrier.
1694 set_current_state(TASK_INTERRUPTIBLE
);
1699 hrtimer_start_expires(&timeout
->timer
, HRTIMER_MODE_ABS
);
1700 if (!hrtimer_active(&timeout
->timer
))
1701 timeout
->task
= NULL
;
1705 * If we have been removed from the hash list, then another task
1706 * has tried to wake us, and we can skip the call to schedule().
1708 if (likely(!plist_node_empty(&q
->list
))) {
1710 * If the timer has already expired, current will already be
1711 * flagged for rescheduling. Only call schedule if there
1712 * is no timeout, or if it has yet to expire.
1714 if (!timeout
|| timeout
->task
)
1717 __set_current_state(TASK_RUNNING
);
1721 * futex_wait_setup() - Prepare to wait on a futex
1722 * @uaddr: the futex userspace address
1723 * @val: the expected value
1724 * @fshared: whether the futex is shared (1) or not (0)
1725 * @q: the associated futex_q
1726 * @hb: storage for hash_bucket pointer to be returned to caller
1728 * Setup the futex_q and locate the hash_bucket. Get the futex value and
1729 * compare it with the expected value. Handle atomic faults internally.
1730 * Return with the hb lock held and a q.key reference on success, and unlocked
1731 * with no q.key reference on failure.
1734 * 0 - uaddr contains val and hb has been locked
1735 * <1 - -EFAULT or -EWOULDBLOCK (uaddr does not contain val) and hb is unlcoked
1737 static int futex_wait_setup(u32 __user
*uaddr
, u32 val
, int fshared
,
1738 struct futex_q
*q
, struct futex_hash_bucket
**hb
)
1744 * Access the page AFTER the hash-bucket is locked.
1745 * Order is important:
1747 * Userspace waiter: val = var; if (cond(val)) futex_wait(&var, val);
1748 * Userspace waker: if (cond(var)) { var = new; futex_wake(&var); }
1750 * The basic logical guarantee of a futex is that it blocks ONLY
1751 * if cond(var) is known to be true at the time of blocking, for
1752 * any cond. If we queued after testing *uaddr, that would open
1753 * a race condition where we could block indefinitely with
1754 * cond(var) false, which would violate the guarantee.
1756 * A consequence is that futex_wait() can return zero and absorb
1757 * a wakeup when *uaddr != val on entry to the syscall. This is
1761 q
->key
= FUTEX_KEY_INIT
;
1762 ret
= get_futex_key(uaddr
, fshared
, &q
->key
);
1763 if (unlikely(ret
!= 0))
1767 *hb
= queue_lock(q
);
1769 ret
= get_futex_value_locked(&uval
, uaddr
);
1772 queue_unlock(q
, *hb
);
1774 ret
= get_user(uval
, uaddr
);
1781 put_futex_key(fshared
, &q
->key
);
1786 queue_unlock(q
, *hb
);
1792 put_futex_key(fshared
, &q
->key
);
1796 static int futex_wait(u32 __user
*uaddr
, int fshared
,
1797 u32 val
, ktime_t
*abs_time
, u32 bitset
, int clockrt
)
1799 struct hrtimer_sleeper timeout
, *to
= NULL
;
1800 struct restart_block
*restart
;
1801 struct futex_hash_bucket
*hb
;
1811 q
.requeue_pi_key
= NULL
;
1816 hrtimer_init_on_stack(&to
->timer
, clockrt
? CLOCK_REALTIME
:
1817 CLOCK_MONOTONIC
, HRTIMER_MODE_ABS
);
1818 hrtimer_init_sleeper(to
, current
);
1819 hrtimer_set_expires_range_ns(&to
->timer
, *abs_time
,
1820 current
->timer_slack_ns
);
1824 /* Prepare to wait on uaddr. */
1825 ret
= futex_wait_setup(uaddr
, val
, fshared
, &q
, &hb
);
1829 /* queue_me and wait for wakeup, timeout, or a signal. */
1830 futex_wait_queue_me(hb
, &q
, to
);
1832 /* If we were woken (and unqueued), we succeeded, whatever. */
1834 if (!unqueue_me(&q
))
1837 if (to
&& !to
->task
)
1841 * We expect signal_pending(current), but we might be the
1842 * victim of a spurious wakeup as well.
1844 if (!signal_pending(current
)) {
1845 put_futex_key(fshared
, &q
.key
);
1853 restart
= ¤t_thread_info()->restart_block
;
1854 restart
->fn
= futex_wait_restart
;
1855 restart
->futex
.uaddr
= (u32
*)uaddr
;
1856 restart
->futex
.val
= val
;
1857 restart
->futex
.time
= abs_time
->tv64
;
1858 restart
->futex
.bitset
= bitset
;
1859 restart
->futex
.flags
= FLAGS_HAS_TIMEOUT
;
1862 restart
->futex
.flags
|= FLAGS_SHARED
;
1864 restart
->futex
.flags
|= FLAGS_CLOCKRT
;
1866 ret
= -ERESTART_RESTARTBLOCK
;
1869 put_futex_key(fshared
, &q
.key
);
1872 hrtimer_cancel(&to
->timer
);
1873 destroy_hrtimer_on_stack(&to
->timer
);
1879 static long futex_wait_restart(struct restart_block
*restart
)
1881 u32 __user
*uaddr
= (u32 __user
*)restart
->futex
.uaddr
;
1883 ktime_t t
, *tp
= NULL
;
1885 if (restart
->futex
.flags
& FLAGS_HAS_TIMEOUT
) {
1886 t
.tv64
= restart
->futex
.time
;
1889 restart
->fn
= do_no_restart_syscall
;
1890 if (restart
->futex
.flags
& FLAGS_SHARED
)
1892 return (long)futex_wait(uaddr
, fshared
, restart
->futex
.val
, tp
,
1893 restart
->futex
.bitset
,
1894 restart
->futex
.flags
& FLAGS_CLOCKRT
);
1899 * Userspace tried a 0 -> TID atomic transition of the futex value
1900 * and failed. The kernel side here does the whole locking operation:
1901 * if there are waiters then it will block, it does PI, etc. (Due to
1902 * races the kernel might see a 0 value of the futex too.)
1904 static int futex_lock_pi(u32 __user
*uaddr
, int fshared
,
1905 int detect
, ktime_t
*time
, int trylock
)
1907 struct hrtimer_sleeper timeout
, *to
= NULL
;
1908 struct futex_hash_bucket
*hb
;
1912 if (refill_pi_state_cache())
1917 hrtimer_init_on_stack(&to
->timer
, CLOCK_REALTIME
,
1919 hrtimer_init_sleeper(to
, current
);
1920 hrtimer_set_expires(&to
->timer
, *time
);
1925 q
.requeue_pi_key
= NULL
;
1927 q
.key
= FUTEX_KEY_INIT
;
1928 ret
= get_futex_key(uaddr
, fshared
, &q
.key
);
1929 if (unlikely(ret
!= 0))
1933 hb
= queue_lock(&q
);
1935 ret
= futex_lock_pi_atomic(uaddr
, hb
, &q
.key
, &q
.pi_state
, current
, 0);
1936 if (unlikely(ret
)) {
1939 /* We got the lock. */
1941 goto out_unlock_put_key
;
1946 * Task is exiting and we just wait for the
1949 queue_unlock(&q
, hb
);
1950 put_futex_key(fshared
, &q
.key
);
1954 goto out_unlock_put_key
;
1959 * Only actually queue now that the atomic ops are done:
1963 WARN_ON(!q
.pi_state
);
1965 * Block on the PI mutex:
1968 ret
= rt_mutex_timed_lock(&q
.pi_state
->pi_mutex
, to
, 1);
1970 ret
= rt_mutex_trylock(&q
.pi_state
->pi_mutex
);
1971 /* Fixup the trylock return value: */
1972 ret
= ret
? 0 : -EWOULDBLOCK
;
1975 spin_lock(q
.lock_ptr
);
1977 * Fixup the pi_state owner and possibly acquire the lock if we
1980 res
= fixup_owner(uaddr
, fshared
, &q
, !ret
);
1982 * If fixup_owner() returned an error, proprogate that. If it acquired
1983 * the lock, clear our -ETIMEDOUT or -EINTR.
1986 ret
= (res
< 0) ? res
: 0;
1989 * If fixup_owner() faulted and was unable to handle the fault, unlock
1990 * it and return the fault to userspace.
1992 if (ret
&& (rt_mutex_owner(&q
.pi_state
->pi_mutex
) == current
))
1993 rt_mutex_unlock(&q
.pi_state
->pi_mutex
);
1995 /* Unqueue and drop the lock */
2001 queue_unlock(&q
, hb
);
2004 put_futex_key(fshared
, &q
.key
);
2007 destroy_hrtimer_on_stack(&to
->timer
);
2008 return ret
!= -EINTR
? ret
: -ERESTARTNOINTR
;
2011 queue_unlock(&q
, hb
);
2013 ret
= fault_in_user_writeable(uaddr
);
2020 put_futex_key(fshared
, &q
.key
);
2025 * Userspace attempted a TID -> 0 atomic transition, and failed.
2026 * This is the in-kernel slowpath: we look up the PI state (if any),
2027 * and do the rt-mutex unlock.
2029 static int futex_unlock_pi(u32 __user
*uaddr
, int fshared
)
2031 struct futex_hash_bucket
*hb
;
2032 struct futex_q
*this, *next
;
2034 struct plist_head
*head
;
2035 union futex_key key
= FUTEX_KEY_INIT
;
2039 if (get_user(uval
, uaddr
))
2042 * We release only a lock we actually own:
2044 if ((uval
& FUTEX_TID_MASK
) != task_pid_vnr(current
))
2047 ret
= get_futex_key(uaddr
, fshared
, &key
);
2048 if (unlikely(ret
!= 0))
2051 hb
= hash_futex(&key
);
2052 spin_lock(&hb
->lock
);
2055 * To avoid races, try to do the TID -> 0 atomic transition
2056 * again. If it succeeds then we can return without waking
2059 if (!(uval
& FUTEX_OWNER_DIED
))
2060 uval
= cmpxchg_futex_value_locked(uaddr
, task_pid_vnr(current
), 0);
2063 if (unlikely(uval
== -EFAULT
))
2066 * Rare case: we managed to release the lock atomically,
2067 * no need to wake anyone else up:
2069 if (unlikely(uval
== task_pid_vnr(current
)))
2073 * Ok, other tasks may need to be woken up - check waiters
2074 * and do the wakeup if necessary:
2078 plist_for_each_entry_safe(this, next
, head
, list
) {
2079 if (!match_futex (&this->key
, &key
))
2081 ret
= wake_futex_pi(uaddr
, uval
, this);
2083 * The atomic access to the futex value
2084 * generated a pagefault, so retry the
2085 * user-access and the wakeup:
2092 * No waiters - kernel unlocks the futex:
2094 if (!(uval
& FUTEX_OWNER_DIED
)) {
2095 ret
= unlock_futex_pi(uaddr
, uval
);
2101 spin_unlock(&hb
->lock
);
2102 put_futex_key(fshared
, &key
);
2108 spin_unlock(&hb
->lock
);
2109 put_futex_key(fshared
, &key
);
2111 ret
= fault_in_user_writeable(uaddr
);
2119 * handle_early_requeue_pi_wakeup() - Detect early wakeup on the initial futex
2120 * @hb: the hash_bucket futex_q was original enqueued on
2121 * @q: the futex_q woken while waiting to be requeued
2122 * @key2: the futex_key of the requeue target futex
2123 * @timeout: the timeout associated with the wait (NULL if none)
2125 * Detect if the task was woken on the initial futex as opposed to the requeue
2126 * target futex. If so, determine if it was a timeout or a signal that caused
2127 * the wakeup and return the appropriate error code to the caller. Must be
2128 * called with the hb lock held.
2131 * 0 - no early wakeup detected
2132 * <0 - -ETIMEDOUT or -ERESTARTNOINTR
2135 int handle_early_requeue_pi_wakeup(struct futex_hash_bucket
*hb
,
2136 struct futex_q
*q
, union futex_key
*key2
,
2137 struct hrtimer_sleeper
*timeout
)
2142 * With the hb lock held, we avoid races while we process the wakeup.
2143 * We only need to hold hb (and not hb2) to ensure atomicity as the
2144 * wakeup code can't change q.key from uaddr to uaddr2 if we hold hb.
2145 * It can't be requeued from uaddr2 to something else since we don't
2146 * support a PI aware source futex for requeue.
2148 if (!match_futex(&q
->key
, key2
)) {
2149 WARN_ON(q
->lock_ptr
&& (&hb
->lock
!= q
->lock_ptr
));
2151 * We were woken prior to requeue by a timeout or a signal.
2152 * Unqueue the futex_q and determine which it was.
2154 plist_del(&q
->list
, &q
->list
.plist
);
2156 /* Handle spurious wakeups gracefully */
2158 if (timeout
&& !timeout
->task
)
2160 else if (signal_pending(current
))
2161 ret
= -ERESTARTNOINTR
;
2167 * futex_wait_requeue_pi() - Wait on uaddr and take uaddr2
2168 * @uaddr: the futex we initially wait on (non-pi)
2169 * @fshared: whether the futexes are shared (1) or not (0). They must be
2170 * the same type, no requeueing from private to shared, etc.
2171 * @val: the expected value of uaddr
2172 * @abs_time: absolute timeout
2173 * @bitset: 32 bit wakeup bitset set by userspace, defaults to all
2174 * @clockrt: whether to use CLOCK_REALTIME (1) or CLOCK_MONOTONIC (0)
2175 * @uaddr2: the pi futex we will take prior to returning to user-space
2177 * The caller will wait on uaddr and will be requeued by futex_requeue() to
2178 * uaddr2 which must be PI aware. Normal wakeup will wake on uaddr2 and
2179 * complete the acquisition of the rt_mutex prior to returning to userspace.
2180 * This ensures the rt_mutex maintains an owner when it has waiters; without
2181 * one, the pi logic wouldn't know which task to boost/deboost, if there was a
2184 * We call schedule in futex_wait_queue_me() when we enqueue and return there
2185 * via the following:
2186 * 1) wakeup on uaddr2 after an atomic lock acquisition by futex_requeue()
2187 * 2) wakeup on uaddr2 after a requeue
2191 * If 3, cleanup and return -ERESTARTNOINTR.
2193 * If 2, we may then block on trying to take the rt_mutex and return via:
2194 * 5) successful lock
2197 * 8) other lock acquisition failure
2199 * If 6, return -EWOULDBLOCK (restarting the syscall would do the same).
2201 * If 4 or 7, we cleanup and return with -ETIMEDOUT.
2207 static int futex_wait_requeue_pi(u32 __user
*uaddr
, int fshared
,
2208 u32 val
, ktime_t
*abs_time
, u32 bitset
,
2209 int clockrt
, u32 __user
*uaddr2
)
2211 struct hrtimer_sleeper timeout
, *to
= NULL
;
2212 struct rt_mutex_waiter rt_waiter
;
2213 struct rt_mutex
*pi_mutex
= NULL
;
2214 struct futex_hash_bucket
*hb
;
2215 union futex_key key2
;
2224 hrtimer_init_on_stack(&to
->timer
, clockrt
? CLOCK_REALTIME
:
2225 CLOCK_MONOTONIC
, HRTIMER_MODE_ABS
);
2226 hrtimer_init_sleeper(to
, current
);
2227 hrtimer_set_expires_range_ns(&to
->timer
, *abs_time
,
2228 current
->timer_slack_ns
);
2232 * The waiter is allocated on our stack, manipulated by the requeue
2233 * code while we sleep on uaddr.
2235 debug_rt_mutex_init_waiter(&rt_waiter
);
2236 rt_waiter
.task
= NULL
;
2238 key2
= FUTEX_KEY_INIT
;
2239 ret
= get_futex_key(uaddr2
, fshared
, &key2
);
2240 if (unlikely(ret
!= 0))
2245 q
.rt_waiter
= &rt_waiter
;
2246 q
.requeue_pi_key
= &key2
;
2248 /* Prepare to wait on uaddr. */
2249 ret
= futex_wait_setup(uaddr
, val
, fshared
, &q
, &hb
);
2253 /* Queue the futex_q, drop the hb lock, wait for wakeup. */
2254 futex_wait_queue_me(hb
, &q
, to
);
2256 spin_lock(&hb
->lock
);
2257 ret
= handle_early_requeue_pi_wakeup(hb
, &q
, &key2
, to
);
2258 spin_unlock(&hb
->lock
);
2263 * In order for us to be here, we know our q.key == key2, and since
2264 * we took the hb->lock above, we also know that futex_requeue() has
2265 * completed and we no longer have to concern ourselves with a wakeup
2266 * race with the atomic proxy lock acquition by the requeue code.
2269 /* Check if the requeue code acquired the second futex for us. */
2272 * Got the lock. We might not be the anticipated owner if we
2273 * did a lock-steal - fix up the PI-state in that case.
2275 if (q
.pi_state
&& (q
.pi_state
->owner
!= current
)) {
2276 spin_lock(q
.lock_ptr
);
2277 ret
= fixup_pi_state_owner(uaddr2
, &q
, current
,
2279 spin_unlock(q
.lock_ptr
);
2283 * We have been woken up by futex_unlock_pi(), a timeout, or a
2284 * signal. futex_unlock_pi() will not destroy the lock_ptr nor
2287 WARN_ON(!&q
.pi_state
);
2288 pi_mutex
= &q
.pi_state
->pi_mutex
;
2289 ret
= rt_mutex_finish_proxy_lock(pi_mutex
, to
, &rt_waiter
, 1);
2290 debug_rt_mutex_free_waiter(&rt_waiter
);
2292 spin_lock(q
.lock_ptr
);
2294 * Fixup the pi_state owner and possibly acquire the lock if we
2297 res
= fixup_owner(uaddr2
, fshared
, &q
, !ret
);
2299 * If fixup_owner() returned an error, proprogate that. If it
2300 * acquired the lock, clear -ETIMEDOUT or -EINTR.
2303 ret
= (res
< 0) ? res
: 0;
2305 /* Unqueue and drop the lock. */
2310 * If fixup_pi_state_owner() faulted and was unable to handle the
2311 * fault, unlock the rt_mutex and return the fault to userspace.
2313 if (ret
== -EFAULT
) {
2314 if (rt_mutex_owner(pi_mutex
) == current
)
2315 rt_mutex_unlock(pi_mutex
);
2316 } else if (ret
== -EINTR
) {
2318 * We've already been requeued, but cannot restart by calling
2319 * futex_lock_pi() directly. We could restart this syscall, but
2320 * it would detect that the user space "val" changed and return
2321 * -EWOULDBLOCK. Save the overhead of the restart and return
2322 * -EWOULDBLOCK directly.
2328 put_futex_key(fshared
, &q
.key
);
2330 put_futex_key(fshared
, &key2
);
2334 hrtimer_cancel(&to
->timer
);
2335 destroy_hrtimer_on_stack(&to
->timer
);
2341 * Support for robust futexes: the kernel cleans up held futexes at
2344 * Implementation: user-space maintains a per-thread list of locks it
2345 * is holding. Upon do_exit(), the kernel carefully walks this list,
2346 * and marks all locks that are owned by this thread with the
2347 * FUTEX_OWNER_DIED bit, and wakes up a waiter (if any). The list is
2348 * always manipulated with the lock held, so the list is private and
2349 * per-thread. Userspace also maintains a per-thread 'list_op_pending'
2350 * field, to allow the kernel to clean up if the thread dies after
2351 * acquiring the lock, but just before it could have added itself to
2352 * the list. There can only be one such pending lock.
2356 * sys_set_robust_list() - Set the robust-futex list head of a task
2357 * @head: pointer to the list-head
2358 * @len: length of the list-head, as userspace expects
2360 SYSCALL_DEFINE2(set_robust_list
, struct robust_list_head __user
*, head
,
2363 if (!futex_cmpxchg_enabled
)
2366 * The kernel knows only one size for now:
2368 if (unlikely(len
!= sizeof(*head
)))
2371 current
->robust_list
= head
;
2377 * sys_get_robust_list() - Get the robust-futex list head of a task
2378 * @pid: pid of the process [zero for current task]
2379 * @head_ptr: pointer to a list-head pointer, the kernel fills it in
2380 * @len_ptr: pointer to a length field, the kernel fills in the header size
2382 SYSCALL_DEFINE3(get_robust_list
, int, pid
,
2383 struct robust_list_head __user
* __user
*, head_ptr
,
2384 size_t __user
*, len_ptr
)
2386 struct robust_list_head __user
*head
;
2388 const struct cred
*cred
= current_cred(), *pcred
;
2390 if (!futex_cmpxchg_enabled
)
2394 head
= current
->robust_list
;
2396 struct task_struct
*p
;
2400 p
= find_task_by_vpid(pid
);
2404 pcred
= __task_cred(p
);
2405 if (cred
->euid
!= pcred
->euid
&&
2406 cred
->euid
!= pcred
->uid
&&
2407 !capable(CAP_SYS_PTRACE
))
2409 head
= p
->robust_list
;
2413 if (put_user(sizeof(*head
), len_ptr
))
2415 return put_user(head
, head_ptr
);
2424 * Process a futex-list entry, check whether it's owned by the
2425 * dying task, and do notification if so:
2427 int handle_futex_death(u32 __user
*uaddr
, struct task_struct
*curr
, int pi
)
2429 u32 uval
, nval
, mval
;
2432 if (get_user(uval
, uaddr
))
2435 if ((uval
& FUTEX_TID_MASK
) == task_pid_vnr(curr
)) {
2437 * Ok, this dying thread is truly holding a futex
2438 * of interest. Set the OWNER_DIED bit atomically
2439 * via cmpxchg, and if the value had FUTEX_WAITERS
2440 * set, wake up a waiter (if any). (We have to do a
2441 * futex_wake() even if OWNER_DIED is already set -
2442 * to handle the rare but possible case of recursive
2443 * thread-death.) The rest of the cleanup is done in
2446 mval
= (uval
& FUTEX_WAITERS
) | FUTEX_OWNER_DIED
;
2447 nval
= futex_atomic_cmpxchg_inatomic(uaddr
, uval
, mval
);
2449 if (nval
== -EFAULT
)
2456 * Wake robust non-PI futexes here. The wakeup of
2457 * PI futexes happens in exit_pi_state():
2459 if (!pi
&& (uval
& FUTEX_WAITERS
))
2460 futex_wake(uaddr
, 1, 1, FUTEX_BITSET_MATCH_ANY
);
2466 * Fetch a robust-list pointer. Bit 0 signals PI futexes:
2468 static inline int fetch_robust_entry(struct robust_list __user
**entry
,
2469 struct robust_list __user
* __user
*head
,
2472 unsigned long uentry
;
2474 if (get_user(uentry
, (unsigned long __user
*)head
))
2477 *entry
= (void __user
*)(uentry
& ~1UL);
2484 * Walk curr->robust_list (very carefully, it's a userspace list!)
2485 * and mark any locks found there dead, and notify any waiters.
2487 * We silently return on any sign of list-walking problem.
2489 void exit_robust_list(struct task_struct
*curr
)
2491 struct robust_list_head __user
*head
= curr
->robust_list
;
2492 struct robust_list __user
*entry
, *next_entry
, *pending
;
2493 unsigned int limit
= ROBUST_LIST_LIMIT
, pi
, next_pi
, pip
;
2494 unsigned long futex_offset
;
2497 if (!futex_cmpxchg_enabled
)
2501 * Fetch the list head (which was registered earlier, via
2502 * sys_set_robust_list()):
2504 if (fetch_robust_entry(&entry
, &head
->list
.next
, &pi
))
2507 * Fetch the relative futex offset:
2509 if (get_user(futex_offset
, &head
->futex_offset
))
2512 * Fetch any possibly pending lock-add first, and handle it
2515 if (fetch_robust_entry(&pending
, &head
->list_op_pending
, &pip
))
2518 next_entry
= NULL
; /* avoid warning with gcc */
2519 while (entry
!= &head
->list
) {
2521 * Fetch the next entry in the list before calling
2522 * handle_futex_death:
2524 rc
= fetch_robust_entry(&next_entry
, &entry
->next
, &next_pi
);
2526 * A pending lock might already be on the list, so
2527 * don't process it twice:
2529 if (entry
!= pending
)
2530 if (handle_futex_death((void __user
*)entry
+ futex_offset
,
2538 * Avoid excessively long or circular lists:
2547 handle_futex_death((void __user
*)pending
+ futex_offset
,
2551 long do_futex(u32 __user
*uaddr
, int op
, u32 val
, ktime_t
*timeout
,
2552 u32 __user
*uaddr2
, u32 val2
, u32 val3
)
2554 int clockrt
, ret
= -ENOSYS
;
2555 int cmd
= op
& FUTEX_CMD_MASK
;
2558 if (!(op
& FUTEX_PRIVATE_FLAG
))
2561 clockrt
= op
& FUTEX_CLOCK_REALTIME
;
2562 if (clockrt
&& cmd
!= FUTEX_WAIT_BITSET
&& cmd
!= FUTEX_WAIT_REQUEUE_PI
)
2567 val3
= FUTEX_BITSET_MATCH_ANY
;
2568 case FUTEX_WAIT_BITSET
:
2569 ret
= futex_wait(uaddr
, fshared
, val
, timeout
, val3
, clockrt
);
2572 val3
= FUTEX_BITSET_MATCH_ANY
;
2573 case FUTEX_WAKE_BITSET
:
2574 ret
= futex_wake(uaddr
, fshared
, val
, val3
);
2577 ret
= futex_requeue(uaddr
, fshared
, uaddr2
, val
, val2
, NULL
, 0);
2579 case FUTEX_CMP_REQUEUE
:
2580 ret
= futex_requeue(uaddr
, fshared
, uaddr2
, val
, val2
, &val3
,
2584 ret
= futex_wake_op(uaddr
, fshared
, uaddr2
, val
, val2
, val3
);
2587 if (futex_cmpxchg_enabled
)
2588 ret
= futex_lock_pi(uaddr
, fshared
, val
, timeout
, 0);
2590 case FUTEX_UNLOCK_PI
:
2591 if (futex_cmpxchg_enabled
)
2592 ret
= futex_unlock_pi(uaddr
, fshared
);
2594 case FUTEX_TRYLOCK_PI
:
2595 if (futex_cmpxchg_enabled
)
2596 ret
= futex_lock_pi(uaddr
, fshared
, 0, timeout
, 1);
2598 case FUTEX_WAIT_REQUEUE_PI
:
2599 val3
= FUTEX_BITSET_MATCH_ANY
;
2600 ret
= futex_wait_requeue_pi(uaddr
, fshared
, val
, timeout
, val3
,
2603 case FUTEX_CMP_REQUEUE_PI
:
2604 ret
= futex_requeue(uaddr
, fshared
, uaddr2
, val
, val2
, &val3
,
2614 SYSCALL_DEFINE6(futex
, u32 __user
*, uaddr
, int, op
, u32
, val
,
2615 struct timespec __user
*, utime
, u32 __user
*, uaddr2
,
2619 ktime_t t
, *tp
= NULL
;
2621 int cmd
= op
& FUTEX_CMD_MASK
;
2623 if (utime
&& (cmd
== FUTEX_WAIT
|| cmd
== FUTEX_LOCK_PI
||
2624 cmd
== FUTEX_WAIT_BITSET
||
2625 cmd
== FUTEX_WAIT_REQUEUE_PI
)) {
2626 if (copy_from_user(&ts
, utime
, sizeof(ts
)) != 0)
2628 if (!timespec_valid(&ts
))
2631 t
= timespec_to_ktime(ts
);
2632 if (cmd
== FUTEX_WAIT
)
2633 t
= ktime_add_safe(ktime_get(), t
);
2637 * requeue parameter in 'utime' if cmd == FUTEX_*_REQUEUE_*.
2638 * number of waiters to wake in 'utime' if cmd == FUTEX_WAKE_OP.
2640 if (cmd
== FUTEX_REQUEUE
|| cmd
== FUTEX_CMP_REQUEUE
||
2641 cmd
== FUTEX_CMP_REQUEUE_PI
|| cmd
== FUTEX_WAKE_OP
)
2642 val2
= (u32
) (unsigned long) utime
;
2644 return do_futex(uaddr
, op
, val
, tp
, uaddr2
, val2
, val3
);
2647 static int __init
futex_init(void)
2653 * This will fail and we want it. Some arch implementations do
2654 * runtime detection of the futex_atomic_cmpxchg_inatomic()
2655 * functionality. We want to know that before we call in any
2656 * of the complex code paths. Also we want to prevent
2657 * registration of robust lists in that case. NULL is
2658 * guaranteed to fault and we get -EFAULT on functional
2659 * implementation, the non functional ones will return
2662 curval
= cmpxchg_futex_value_locked(NULL
, 0, 0);
2663 if (curval
== -EFAULT
)
2664 futex_cmpxchg_enabled
= 1;
2666 for (i
= 0; i
< ARRAY_SIZE(futex_queues
); i
++) {
2667 plist_head_init(&futex_queues
[i
].chain
, &futex_queues
[i
].lock
);
2668 spin_lock_init(&futex_queues
[i
].lock
);
2673 __initcall(futex_init
);