[SCSI] advansys: undate version, copyright, etc
[linux-2.6/mini2440.git] / kernel / futex.c
blob3415e9ad1391adc6422c9324b8efdc1bbd6c7ce2
1 /*
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 * Thanks to Ben LaHaise for yelling "hashed waitqueues" loudly
23 * enough at me, Linus for the original (flawed) idea, Matthew
24 * Kirkwood for proof-of-concept implementation.
26 * "The futexes are also cursed."
27 * "But they come in a choice of three flavours!"
29 * This program is free software; you can redistribute it and/or modify
30 * it under the terms of the GNU General Public License as published by
31 * the Free Software Foundation; either version 2 of the License, or
32 * (at your option) any later version.
34 * This program is distributed in the hope that it will be useful,
35 * but WITHOUT ANY WARRANTY; without even the implied warranty of
36 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
37 * GNU General Public License for more details.
39 * You should have received a copy of the GNU General Public License
40 * along with this program; if not, write to the Free Software
41 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
43 #include <linux/slab.h>
44 #include <linux/poll.h>
45 #include <linux/fs.h>
46 #include <linux/file.h>
47 #include <linux/jhash.h>
48 #include <linux/init.h>
49 #include <linux/futex.h>
50 #include <linux/mount.h>
51 #include <linux/pagemap.h>
52 #include <linux/syscalls.h>
53 #include <linux/signal.h>
54 #include <linux/module.h>
55 #include <asm/futex.h>
57 #include "rtmutex_common.h"
59 #define FUTEX_HASHBITS (CONFIG_BASE_SMALL ? 4 : 8)
62 * Priority Inheritance state:
64 struct futex_pi_state {
66 * list of 'owned' pi_state instances - these have to be
67 * cleaned up in do_exit() if the task exits prematurely:
69 struct list_head list;
72 * The PI object:
74 struct rt_mutex pi_mutex;
76 struct task_struct *owner;
77 atomic_t refcount;
79 union futex_key key;
83 * We use this hashed waitqueue instead of a normal wait_queue_t, so
84 * we can wake only the relevant ones (hashed queues may be shared).
86 * A futex_q has a woken state, just like tasks have TASK_RUNNING.
87 * It is considered woken when plist_node_empty(&q->list) || q->lock_ptr == 0.
88 * The order of wakup is always to make the first condition true, then
89 * wake up q->waiters, then make the second condition true.
91 struct futex_q {
92 struct plist_node list;
93 wait_queue_head_t waiters;
95 /* Which hash list lock to use: */
96 spinlock_t *lock_ptr;
98 /* Key which the futex is hashed on: */
99 union futex_key key;
101 /* For fd, sigio sent using these: */
102 int fd;
103 struct file *filp;
105 /* Optional priority inheritance state: */
106 struct futex_pi_state *pi_state;
107 struct task_struct *task;
111 * Split the global futex_lock into every hash list lock.
113 struct futex_hash_bucket {
114 spinlock_t lock;
115 struct plist_head chain;
118 static struct futex_hash_bucket futex_queues[1<<FUTEX_HASHBITS];
120 /* Futex-fs vfsmount entry: */
121 static struct vfsmount *futex_mnt;
124 * Take mm->mmap_sem, when futex is shared
126 static inline void futex_lock_mm(struct rw_semaphore *fshared)
128 if (fshared)
129 down_read(fshared);
133 * Release mm->mmap_sem, when the futex is shared
135 static inline void futex_unlock_mm(struct rw_semaphore *fshared)
137 if (fshared)
138 up_read(fshared);
142 * We hash on the keys returned from get_futex_key (see below).
144 static struct futex_hash_bucket *hash_futex(union futex_key *key)
146 u32 hash = jhash2((u32*)&key->both.word,
147 (sizeof(key->both.word)+sizeof(key->both.ptr))/4,
148 key->both.offset);
149 return &futex_queues[hash & ((1 << FUTEX_HASHBITS)-1)];
153 * Return 1 if two futex_keys are equal, 0 otherwise.
155 static inline int match_futex(union futex_key *key1, union futex_key *key2)
157 return (key1->both.word == key2->both.word
158 && key1->both.ptr == key2->both.ptr
159 && key1->both.offset == key2->both.offset);
163 * get_futex_key - Get parameters which are the keys for a futex.
164 * @uaddr: virtual address of the futex
165 * @shared: NULL for a PROCESS_PRIVATE futex,
166 * &current->mm->mmap_sem for a PROCESS_SHARED futex
167 * @key: address where result is stored.
169 * Returns a negative error code or 0
170 * The key words are stored in *key on success.
172 * For shared mappings, it's (page->index, vma->vm_file->f_path.dentry->d_inode,
173 * offset_within_page). For private mappings, it's (uaddr, current->mm).
174 * We can usually work out the index without swapping in the page.
176 * fshared is NULL for PROCESS_PRIVATE futexes
177 * For other futexes, it points to &current->mm->mmap_sem and
178 * caller must have taken the reader lock. but NOT any spinlocks.
180 int get_futex_key(u32 __user *uaddr, struct rw_semaphore *fshared,
181 union futex_key *key)
183 unsigned long address = (unsigned long)uaddr;
184 struct mm_struct *mm = current->mm;
185 struct vm_area_struct *vma;
186 struct page *page;
187 int err;
190 * The futex address must be "naturally" aligned.
192 key->both.offset = address % PAGE_SIZE;
193 if (unlikely((address % sizeof(u32)) != 0))
194 return -EINVAL;
195 address -= key->both.offset;
198 * PROCESS_PRIVATE futexes are fast.
199 * As the mm cannot disappear under us and the 'key' only needs
200 * virtual address, we dont even have to find the underlying vma.
201 * Note : We do have to check 'uaddr' is a valid user address,
202 * but access_ok() should be faster than find_vma()
204 if (!fshared) {
205 if (unlikely(!access_ok(VERIFY_WRITE, uaddr, sizeof(u32))))
206 return -EFAULT;
207 key->private.mm = mm;
208 key->private.address = address;
209 return 0;
212 * The futex is hashed differently depending on whether
213 * it's in a shared or private mapping. So check vma first.
215 vma = find_extend_vma(mm, address);
216 if (unlikely(!vma))
217 return -EFAULT;
220 * Permissions.
222 if (unlikely((vma->vm_flags & (VM_IO|VM_READ)) != VM_READ))
223 return (vma->vm_flags & VM_IO) ? -EPERM : -EACCES;
226 * Private mappings are handled in a simple way.
228 * NOTE: When userspace waits on a MAP_SHARED mapping, even if
229 * it's a read-only handle, it's expected that futexes attach to
230 * the object not the particular process. Therefore we use
231 * VM_MAYSHARE here, not VM_SHARED which is restricted to shared
232 * mappings of _writable_ handles.
234 if (likely(!(vma->vm_flags & VM_MAYSHARE))) {
235 key->both.offset |= FUT_OFF_MMSHARED; /* reference taken on mm */
236 key->private.mm = mm;
237 key->private.address = address;
238 return 0;
242 * Linear file mappings are also simple.
244 key->shared.inode = vma->vm_file->f_path.dentry->d_inode;
245 key->both.offset |= FUT_OFF_INODE; /* inode-based key. */
246 if (likely(!(vma->vm_flags & VM_NONLINEAR))) {
247 key->shared.pgoff = (((address - vma->vm_start) >> PAGE_SHIFT)
248 + vma->vm_pgoff);
249 return 0;
253 * We could walk the page table to read the non-linear
254 * pte, and get the page index without fetching the page
255 * from swap. But that's a lot of code to duplicate here
256 * for a rare case, so we simply fetch the page.
258 err = get_user_pages(current, mm, address, 1, 0, 0, &page, NULL);
259 if (err >= 0) {
260 key->shared.pgoff =
261 page->index << (PAGE_CACHE_SHIFT - PAGE_SHIFT);
262 put_page(page);
263 return 0;
265 return err;
267 EXPORT_SYMBOL_GPL(get_futex_key);
270 * Take a reference to the resource addressed by a key.
271 * Can be called while holding spinlocks.
274 inline void get_futex_key_refs(union futex_key *key)
276 if (key->both.ptr == 0)
277 return;
278 switch (key->both.offset & (FUT_OFF_INODE|FUT_OFF_MMSHARED)) {
279 case FUT_OFF_INODE:
280 atomic_inc(&key->shared.inode->i_count);
281 break;
282 case FUT_OFF_MMSHARED:
283 atomic_inc(&key->private.mm->mm_count);
284 break;
287 EXPORT_SYMBOL_GPL(get_futex_key_refs);
290 * Drop a reference to the resource addressed by a key.
291 * The hash bucket spinlock must not be held.
293 void drop_futex_key_refs(union futex_key *key)
295 if (key->both.ptr == 0)
296 return;
297 switch (key->both.offset & (FUT_OFF_INODE|FUT_OFF_MMSHARED)) {
298 case FUT_OFF_INODE:
299 iput(key->shared.inode);
300 break;
301 case FUT_OFF_MMSHARED:
302 mmdrop(key->private.mm);
303 break;
306 EXPORT_SYMBOL_GPL(drop_futex_key_refs);
308 static u32 cmpxchg_futex_value_locked(u32 __user *uaddr, u32 uval, u32 newval)
310 u32 curval;
312 pagefault_disable();
313 curval = futex_atomic_cmpxchg_inatomic(uaddr, uval, newval);
314 pagefault_enable();
316 return curval;
319 static int get_futex_value_locked(u32 *dest, u32 __user *from)
321 int ret;
323 pagefault_disable();
324 ret = __copy_from_user_inatomic(dest, from, sizeof(u32));
325 pagefault_enable();
327 return ret ? -EFAULT : 0;
331 * Fault handling.
332 * if fshared is non NULL, current->mm->mmap_sem is already held
334 static int futex_handle_fault(unsigned long address,
335 struct rw_semaphore *fshared, int attempt)
337 struct vm_area_struct * vma;
338 struct mm_struct *mm = current->mm;
339 int ret = -EFAULT;
341 if (attempt > 2)
342 return ret;
344 if (!fshared)
345 down_read(&mm->mmap_sem);
346 vma = find_vma(mm, address);
347 if (vma && address >= vma->vm_start &&
348 (vma->vm_flags & VM_WRITE)) {
349 int fault;
350 fault = handle_mm_fault(mm, vma, address, 1);
351 if (unlikely((fault & VM_FAULT_ERROR))) {
352 #if 0
353 /* XXX: let's do this when we verify it is OK */
354 if (ret & VM_FAULT_OOM)
355 ret = -ENOMEM;
356 #endif
357 } else {
358 ret = 0;
359 if (fault & VM_FAULT_MAJOR)
360 current->maj_flt++;
361 else
362 current->min_flt++;
365 if (!fshared)
366 up_read(&mm->mmap_sem);
367 return ret;
371 * PI code:
373 static int refill_pi_state_cache(void)
375 struct futex_pi_state *pi_state;
377 if (likely(current->pi_state_cache))
378 return 0;
380 pi_state = kzalloc(sizeof(*pi_state), GFP_KERNEL);
382 if (!pi_state)
383 return -ENOMEM;
385 INIT_LIST_HEAD(&pi_state->list);
386 /* pi_mutex gets initialized later */
387 pi_state->owner = NULL;
388 atomic_set(&pi_state->refcount, 1);
390 current->pi_state_cache = pi_state;
392 return 0;
395 static struct futex_pi_state * alloc_pi_state(void)
397 struct futex_pi_state *pi_state = current->pi_state_cache;
399 WARN_ON(!pi_state);
400 current->pi_state_cache = NULL;
402 return pi_state;
405 static void free_pi_state(struct futex_pi_state *pi_state)
407 if (!atomic_dec_and_test(&pi_state->refcount))
408 return;
411 * If pi_state->owner is NULL, the owner is most probably dying
412 * and has cleaned up the pi_state already
414 if (pi_state->owner) {
415 spin_lock_irq(&pi_state->owner->pi_lock);
416 list_del_init(&pi_state->list);
417 spin_unlock_irq(&pi_state->owner->pi_lock);
419 rt_mutex_proxy_unlock(&pi_state->pi_mutex, pi_state->owner);
422 if (current->pi_state_cache)
423 kfree(pi_state);
424 else {
426 * pi_state->list is already empty.
427 * clear pi_state->owner.
428 * refcount is at 0 - put it back to 1.
430 pi_state->owner = NULL;
431 atomic_set(&pi_state->refcount, 1);
432 current->pi_state_cache = pi_state;
437 * Look up the task based on what TID userspace gave us.
438 * We dont trust it.
440 static struct task_struct * futex_find_get_task(pid_t pid)
442 struct task_struct *p;
444 rcu_read_lock();
445 p = find_task_by_pid(pid);
447 if (!p || ((current->euid != p->euid) && (current->euid != p->uid)))
448 p = ERR_PTR(-ESRCH);
449 else
450 get_task_struct(p);
452 rcu_read_unlock();
454 return p;
458 * This task is holding PI mutexes at exit time => bad.
459 * Kernel cleans up PI-state, but userspace is likely hosed.
460 * (Robust-futex cleanup is separate and might save the day for userspace.)
462 void exit_pi_state_list(struct task_struct *curr)
464 struct list_head *next, *head = &curr->pi_state_list;
465 struct futex_pi_state *pi_state;
466 struct futex_hash_bucket *hb;
467 union futex_key key;
470 * We are a ZOMBIE and nobody can enqueue itself on
471 * pi_state_list anymore, but we have to be careful
472 * versus waiters unqueueing themselves:
474 spin_lock_irq(&curr->pi_lock);
475 while (!list_empty(head)) {
477 next = head->next;
478 pi_state = list_entry(next, struct futex_pi_state, list);
479 key = pi_state->key;
480 hb = hash_futex(&key);
481 spin_unlock_irq(&curr->pi_lock);
483 spin_lock(&hb->lock);
485 spin_lock_irq(&curr->pi_lock);
487 * We dropped the pi-lock, so re-check whether this
488 * task still owns the PI-state:
490 if (head->next != next) {
491 spin_unlock(&hb->lock);
492 continue;
495 WARN_ON(pi_state->owner != curr);
496 WARN_ON(list_empty(&pi_state->list));
497 list_del_init(&pi_state->list);
498 pi_state->owner = NULL;
499 spin_unlock_irq(&curr->pi_lock);
501 rt_mutex_unlock(&pi_state->pi_mutex);
503 spin_unlock(&hb->lock);
505 spin_lock_irq(&curr->pi_lock);
507 spin_unlock_irq(&curr->pi_lock);
510 static int
511 lookup_pi_state(u32 uval, struct futex_hash_bucket *hb,
512 union futex_key *key, struct futex_pi_state **ps)
514 struct futex_pi_state *pi_state = NULL;
515 struct futex_q *this, *next;
516 struct plist_head *head;
517 struct task_struct *p;
518 pid_t pid = uval & FUTEX_TID_MASK;
520 head = &hb->chain;
522 plist_for_each_entry_safe(this, next, head, list) {
523 if (match_futex(&this->key, key)) {
525 * Another waiter already exists - bump up
526 * the refcount and return its pi_state:
528 pi_state = this->pi_state;
530 * Userspace might have messed up non PI and PI futexes
532 if (unlikely(!pi_state))
533 return -EINVAL;
535 WARN_ON(!atomic_read(&pi_state->refcount));
536 WARN_ON(pid && pi_state->owner &&
537 pi_state->owner->pid != pid);
539 atomic_inc(&pi_state->refcount);
540 *ps = pi_state;
542 return 0;
547 * We are the first waiter - try to look up the real owner and attach
548 * the new pi_state to it, but bail out when TID = 0
550 if (!pid)
551 return -ESRCH;
552 p = futex_find_get_task(pid);
553 if (IS_ERR(p))
554 return PTR_ERR(p);
557 * We need to look at the task state flags to figure out,
558 * whether the task is exiting. To protect against the do_exit
559 * change of the task flags, we do this protected by
560 * p->pi_lock:
562 spin_lock_irq(&p->pi_lock);
563 if (unlikely(p->flags & PF_EXITING)) {
565 * The task is on the way out. When PF_EXITPIDONE is
566 * set, we know that the task has finished the
567 * cleanup:
569 int ret = (p->flags & PF_EXITPIDONE) ? -ESRCH : -EAGAIN;
571 spin_unlock_irq(&p->pi_lock);
572 put_task_struct(p);
573 return ret;
576 pi_state = alloc_pi_state();
579 * Initialize the pi_mutex in locked state and make 'p'
580 * the owner of it:
582 rt_mutex_init_proxy_locked(&pi_state->pi_mutex, p);
584 /* Store the key for possible exit cleanups: */
585 pi_state->key = *key;
587 WARN_ON(!list_empty(&pi_state->list));
588 list_add(&pi_state->list, &p->pi_state_list);
589 pi_state->owner = p;
590 spin_unlock_irq(&p->pi_lock);
592 put_task_struct(p);
594 *ps = pi_state;
596 return 0;
600 * The hash bucket lock must be held when this is called.
601 * Afterwards, the futex_q must not be accessed.
603 static void wake_futex(struct futex_q *q)
605 plist_del(&q->list, &q->list.plist);
606 if (q->filp)
607 send_sigio(&q->filp->f_owner, q->fd, POLL_IN);
609 * The lock in wake_up_all() is a crucial memory barrier after the
610 * plist_del() and also before assigning to q->lock_ptr.
612 wake_up_all(&q->waiters);
614 * The waiting task can free the futex_q as soon as this is written,
615 * without taking any locks. This must come last.
617 * A memory barrier is required here to prevent the following store
618 * to lock_ptr from getting ahead of the wakeup. Clearing the lock
619 * at the end of wake_up_all() does not prevent this store from
620 * moving.
622 smp_wmb();
623 q->lock_ptr = NULL;
626 static int wake_futex_pi(u32 __user *uaddr, u32 uval, struct futex_q *this)
628 struct task_struct *new_owner;
629 struct futex_pi_state *pi_state = this->pi_state;
630 u32 curval, newval;
632 if (!pi_state)
633 return -EINVAL;
635 spin_lock(&pi_state->pi_mutex.wait_lock);
636 new_owner = rt_mutex_next_owner(&pi_state->pi_mutex);
639 * This happens when we have stolen the lock and the original
640 * pending owner did not enqueue itself back on the rt_mutex.
641 * Thats not a tragedy. We know that way, that a lock waiter
642 * is on the fly. We make the futex_q waiter the pending owner.
644 if (!new_owner)
645 new_owner = this->task;
648 * We pass it to the next owner. (The WAITERS bit is always
649 * kept enabled while there is PI state around. We must also
650 * preserve the owner died bit.)
652 if (!(uval & FUTEX_OWNER_DIED)) {
653 int ret = 0;
655 newval = FUTEX_WAITERS | new_owner->pid;
657 curval = cmpxchg_futex_value_locked(uaddr, uval, newval);
659 if (curval == -EFAULT)
660 ret = -EFAULT;
661 if (curval != uval)
662 ret = -EINVAL;
663 if (ret) {
664 spin_unlock(&pi_state->pi_mutex.wait_lock);
665 return ret;
669 spin_lock_irq(&pi_state->owner->pi_lock);
670 WARN_ON(list_empty(&pi_state->list));
671 list_del_init(&pi_state->list);
672 spin_unlock_irq(&pi_state->owner->pi_lock);
674 spin_lock_irq(&new_owner->pi_lock);
675 WARN_ON(!list_empty(&pi_state->list));
676 list_add(&pi_state->list, &new_owner->pi_state_list);
677 pi_state->owner = new_owner;
678 spin_unlock_irq(&new_owner->pi_lock);
680 spin_unlock(&pi_state->pi_mutex.wait_lock);
681 rt_mutex_unlock(&pi_state->pi_mutex);
683 return 0;
686 static int unlock_futex_pi(u32 __user *uaddr, u32 uval)
688 u32 oldval;
691 * There is no waiter, so we unlock the futex. The owner died
692 * bit has not to be preserved here. We are the owner:
694 oldval = cmpxchg_futex_value_locked(uaddr, uval, 0);
696 if (oldval == -EFAULT)
697 return oldval;
698 if (oldval != uval)
699 return -EAGAIN;
701 return 0;
705 * Express the locking dependencies for lockdep:
707 static inline void
708 double_lock_hb(struct futex_hash_bucket *hb1, struct futex_hash_bucket *hb2)
710 if (hb1 <= hb2) {
711 spin_lock(&hb1->lock);
712 if (hb1 < hb2)
713 spin_lock_nested(&hb2->lock, SINGLE_DEPTH_NESTING);
714 } else { /* hb1 > hb2 */
715 spin_lock(&hb2->lock);
716 spin_lock_nested(&hb1->lock, SINGLE_DEPTH_NESTING);
721 * Wake up all waiters hashed on the physical page that is mapped
722 * to this virtual address:
724 static int futex_wake(u32 __user *uaddr, struct rw_semaphore *fshared,
725 int nr_wake)
727 struct futex_hash_bucket *hb;
728 struct futex_q *this, *next;
729 struct plist_head *head;
730 union futex_key key;
731 int ret;
733 futex_lock_mm(fshared);
735 ret = get_futex_key(uaddr, fshared, &key);
736 if (unlikely(ret != 0))
737 goto out;
739 hb = hash_futex(&key);
740 spin_lock(&hb->lock);
741 head = &hb->chain;
743 plist_for_each_entry_safe(this, next, head, list) {
744 if (match_futex (&this->key, &key)) {
745 if (this->pi_state) {
746 ret = -EINVAL;
747 break;
749 wake_futex(this);
750 if (++ret >= nr_wake)
751 break;
755 spin_unlock(&hb->lock);
756 out:
757 futex_unlock_mm(fshared);
758 return ret;
762 * Wake up all waiters hashed on the physical page that is mapped
763 * to this virtual address:
765 static int
766 futex_wake_op(u32 __user *uaddr1, struct rw_semaphore *fshared,
767 u32 __user *uaddr2,
768 int nr_wake, int nr_wake2, int op)
770 union futex_key key1, key2;
771 struct futex_hash_bucket *hb1, *hb2;
772 struct plist_head *head;
773 struct futex_q *this, *next;
774 int ret, op_ret, attempt = 0;
776 retryfull:
777 futex_lock_mm(fshared);
779 ret = get_futex_key(uaddr1, fshared, &key1);
780 if (unlikely(ret != 0))
781 goto out;
782 ret = get_futex_key(uaddr2, fshared, &key2);
783 if (unlikely(ret != 0))
784 goto out;
786 hb1 = hash_futex(&key1);
787 hb2 = hash_futex(&key2);
789 retry:
790 double_lock_hb(hb1, hb2);
792 op_ret = futex_atomic_op_inuser(op, uaddr2);
793 if (unlikely(op_ret < 0)) {
794 u32 dummy;
796 spin_unlock(&hb1->lock);
797 if (hb1 != hb2)
798 spin_unlock(&hb2->lock);
800 #ifndef CONFIG_MMU
802 * we don't get EFAULT from MMU faults if we don't have an MMU,
803 * but we might get them from range checking
805 ret = op_ret;
806 goto out;
807 #endif
809 if (unlikely(op_ret != -EFAULT)) {
810 ret = op_ret;
811 goto out;
815 * futex_atomic_op_inuser needs to both read and write
816 * *(int __user *)uaddr2, but we can't modify it
817 * non-atomically. Therefore, if get_user below is not
818 * enough, we need to handle the fault ourselves, while
819 * still holding the mmap_sem.
821 if (attempt++) {
822 ret = futex_handle_fault((unsigned long)uaddr2,
823 fshared, attempt);
824 if (ret)
825 goto out;
826 goto retry;
830 * If we would have faulted, release mmap_sem,
831 * fault it in and start all over again.
833 futex_unlock_mm(fshared);
835 ret = get_user(dummy, uaddr2);
836 if (ret)
837 return ret;
839 goto retryfull;
842 head = &hb1->chain;
844 plist_for_each_entry_safe(this, next, head, list) {
845 if (match_futex (&this->key, &key1)) {
846 wake_futex(this);
847 if (++ret >= nr_wake)
848 break;
852 if (op_ret > 0) {
853 head = &hb2->chain;
855 op_ret = 0;
856 plist_for_each_entry_safe(this, next, head, list) {
857 if (match_futex (&this->key, &key2)) {
858 wake_futex(this);
859 if (++op_ret >= nr_wake2)
860 break;
863 ret += op_ret;
866 spin_unlock(&hb1->lock);
867 if (hb1 != hb2)
868 spin_unlock(&hb2->lock);
869 out:
870 futex_unlock_mm(fshared);
872 return ret;
876 * Requeue all waiters hashed on one physical page to another
877 * physical page.
879 static int futex_requeue(u32 __user *uaddr1, struct rw_semaphore *fshared,
880 u32 __user *uaddr2,
881 int nr_wake, int nr_requeue, u32 *cmpval)
883 union futex_key key1, key2;
884 struct futex_hash_bucket *hb1, *hb2;
885 struct plist_head *head1;
886 struct futex_q *this, *next;
887 int ret, drop_count = 0;
889 retry:
890 futex_lock_mm(fshared);
892 ret = get_futex_key(uaddr1, fshared, &key1);
893 if (unlikely(ret != 0))
894 goto out;
895 ret = get_futex_key(uaddr2, fshared, &key2);
896 if (unlikely(ret != 0))
897 goto out;
899 hb1 = hash_futex(&key1);
900 hb2 = hash_futex(&key2);
902 double_lock_hb(hb1, hb2);
904 if (likely(cmpval != NULL)) {
905 u32 curval;
907 ret = get_futex_value_locked(&curval, uaddr1);
909 if (unlikely(ret)) {
910 spin_unlock(&hb1->lock);
911 if (hb1 != hb2)
912 spin_unlock(&hb2->lock);
915 * If we would have faulted, release mmap_sem, fault
916 * it in and start all over again.
918 futex_unlock_mm(fshared);
920 ret = get_user(curval, uaddr1);
922 if (!ret)
923 goto retry;
925 return ret;
927 if (curval != *cmpval) {
928 ret = -EAGAIN;
929 goto out_unlock;
933 head1 = &hb1->chain;
934 plist_for_each_entry_safe(this, next, head1, list) {
935 if (!match_futex (&this->key, &key1))
936 continue;
937 if (++ret <= nr_wake) {
938 wake_futex(this);
939 } else {
941 * If key1 and key2 hash to the same bucket, no need to
942 * requeue.
944 if (likely(head1 != &hb2->chain)) {
945 plist_del(&this->list, &hb1->chain);
946 plist_add(&this->list, &hb2->chain);
947 this->lock_ptr = &hb2->lock;
948 #ifdef CONFIG_DEBUG_PI_LIST
949 this->list.plist.lock = &hb2->lock;
950 #endif
952 this->key = key2;
953 get_futex_key_refs(&key2);
954 drop_count++;
956 if (ret - nr_wake >= nr_requeue)
957 break;
961 out_unlock:
962 spin_unlock(&hb1->lock);
963 if (hb1 != hb2)
964 spin_unlock(&hb2->lock);
966 /* drop_futex_key_refs() must be called outside the spinlocks. */
967 while (--drop_count >= 0)
968 drop_futex_key_refs(&key1);
970 out:
971 futex_unlock_mm(fshared);
972 return ret;
975 /* The key must be already stored in q->key. */
976 static inline struct futex_hash_bucket *
977 queue_lock(struct futex_q *q, int fd, struct file *filp)
979 struct futex_hash_bucket *hb;
981 q->fd = fd;
982 q->filp = filp;
984 init_waitqueue_head(&q->waiters);
986 get_futex_key_refs(&q->key);
987 hb = hash_futex(&q->key);
988 q->lock_ptr = &hb->lock;
990 spin_lock(&hb->lock);
991 return hb;
994 static inline void __queue_me(struct futex_q *q, struct futex_hash_bucket *hb)
996 int prio;
999 * The priority used to register this element is
1000 * - either the real thread-priority for the real-time threads
1001 * (i.e. threads with a priority lower than MAX_RT_PRIO)
1002 * - or MAX_RT_PRIO for non-RT threads.
1003 * Thus, all RT-threads are woken first in priority order, and
1004 * the others are woken last, in FIFO order.
1006 prio = min(current->normal_prio, MAX_RT_PRIO);
1008 plist_node_init(&q->list, prio);
1009 #ifdef CONFIG_DEBUG_PI_LIST
1010 q->list.plist.lock = &hb->lock;
1011 #endif
1012 plist_add(&q->list, &hb->chain);
1013 q->task = current;
1014 spin_unlock(&hb->lock);
1017 static inline void
1018 queue_unlock(struct futex_q *q, struct futex_hash_bucket *hb)
1020 spin_unlock(&hb->lock);
1021 drop_futex_key_refs(&q->key);
1025 * queue_me and unqueue_me must be called as a pair, each
1026 * exactly once. They are called with the hashed spinlock held.
1029 /* The key must be already stored in q->key. */
1030 static void queue_me(struct futex_q *q, int fd, struct file *filp)
1032 struct futex_hash_bucket *hb;
1034 hb = queue_lock(q, fd, filp);
1035 __queue_me(q, hb);
1038 /* Return 1 if we were still queued (ie. 0 means we were woken) */
1039 static int unqueue_me(struct futex_q *q)
1041 spinlock_t *lock_ptr;
1042 int ret = 0;
1044 /* In the common case we don't take the spinlock, which is nice. */
1045 retry:
1046 lock_ptr = q->lock_ptr;
1047 barrier();
1048 if (lock_ptr != 0) {
1049 spin_lock(lock_ptr);
1051 * q->lock_ptr can change between reading it and
1052 * spin_lock(), causing us to take the wrong lock. This
1053 * corrects the race condition.
1055 * Reasoning goes like this: if we have the wrong lock,
1056 * q->lock_ptr must have changed (maybe several times)
1057 * between reading it and the spin_lock(). It can
1058 * change again after the spin_lock() but only if it was
1059 * already changed before the spin_lock(). It cannot,
1060 * however, change back to the original value. Therefore
1061 * we can detect whether we acquired the correct lock.
1063 if (unlikely(lock_ptr != q->lock_ptr)) {
1064 spin_unlock(lock_ptr);
1065 goto retry;
1067 WARN_ON(plist_node_empty(&q->list));
1068 plist_del(&q->list, &q->list.plist);
1070 BUG_ON(q->pi_state);
1072 spin_unlock(lock_ptr);
1073 ret = 1;
1076 drop_futex_key_refs(&q->key);
1077 return ret;
1081 * PI futexes can not be requeued and must remove themself from the
1082 * hash bucket. The hash bucket lock (i.e. lock_ptr) is held on entry
1083 * and dropped here.
1085 static void unqueue_me_pi(struct futex_q *q)
1087 WARN_ON(plist_node_empty(&q->list));
1088 plist_del(&q->list, &q->list.plist);
1090 BUG_ON(!q->pi_state);
1091 free_pi_state(q->pi_state);
1092 q->pi_state = NULL;
1094 spin_unlock(q->lock_ptr);
1096 drop_futex_key_refs(&q->key);
1100 * Fixup the pi_state owner with current.
1102 * Must be called with hash bucket lock held and mm->sem held for non
1103 * private futexes.
1105 static int fixup_pi_state_owner(u32 __user *uaddr, struct futex_q *q,
1106 struct task_struct *curr)
1108 u32 newtid = curr->pid | FUTEX_WAITERS;
1109 struct futex_pi_state *pi_state = q->pi_state;
1110 u32 uval, curval, newval;
1111 int ret;
1113 /* Owner died? */
1114 if (pi_state->owner != NULL) {
1115 spin_lock_irq(&pi_state->owner->pi_lock);
1116 WARN_ON(list_empty(&pi_state->list));
1117 list_del_init(&pi_state->list);
1118 spin_unlock_irq(&pi_state->owner->pi_lock);
1119 } else
1120 newtid |= FUTEX_OWNER_DIED;
1122 pi_state->owner = curr;
1124 spin_lock_irq(&curr->pi_lock);
1125 WARN_ON(!list_empty(&pi_state->list));
1126 list_add(&pi_state->list, &curr->pi_state_list);
1127 spin_unlock_irq(&curr->pi_lock);
1130 * We own it, so we have to replace the pending owner
1131 * TID. This must be atomic as we have preserve the
1132 * owner died bit here.
1134 ret = get_futex_value_locked(&uval, uaddr);
1136 while (!ret) {
1137 newval = (uval & FUTEX_OWNER_DIED) | newtid;
1139 curval = cmpxchg_futex_value_locked(uaddr, uval, newval);
1141 if (curval == -EFAULT)
1142 ret = -EFAULT;
1143 if (curval == uval)
1144 break;
1145 uval = curval;
1147 return ret;
1151 * In case we must use restart_block to restart a futex_wait,
1152 * we encode in the 'arg3' shared capability
1154 #define ARG3_SHARED 1
1156 static long futex_wait_restart(struct restart_block *restart);
1158 static int futex_wait(u32 __user *uaddr, struct rw_semaphore *fshared,
1159 u32 val, ktime_t *abs_time)
1161 struct task_struct *curr = current;
1162 DECLARE_WAITQUEUE(wait, curr);
1163 struct futex_hash_bucket *hb;
1164 struct futex_q q;
1165 u32 uval;
1166 int ret;
1167 struct hrtimer_sleeper t;
1168 int rem = 0;
1170 q.pi_state = NULL;
1171 retry:
1172 futex_lock_mm(fshared);
1174 ret = get_futex_key(uaddr, fshared, &q.key);
1175 if (unlikely(ret != 0))
1176 goto out_release_sem;
1178 hb = queue_lock(&q, -1, NULL);
1181 * Access the page AFTER the futex is queued.
1182 * Order is important:
1184 * Userspace waiter: val = var; if (cond(val)) futex_wait(&var, val);
1185 * Userspace waker: if (cond(var)) { var = new; futex_wake(&var); }
1187 * The basic logical guarantee of a futex is that it blocks ONLY
1188 * if cond(var) is known to be true at the time of blocking, for
1189 * any cond. If we queued after testing *uaddr, that would open
1190 * a race condition where we could block indefinitely with
1191 * cond(var) false, which would violate the guarantee.
1193 * A consequence is that futex_wait() can return zero and absorb
1194 * a wakeup when *uaddr != val on entry to the syscall. This is
1195 * rare, but normal.
1197 * for shared futexes, we hold the mmap semaphore, so the mapping
1198 * cannot have changed since we looked it up in get_futex_key.
1200 ret = get_futex_value_locked(&uval, uaddr);
1202 if (unlikely(ret)) {
1203 queue_unlock(&q, hb);
1206 * If we would have faulted, release mmap_sem, fault it in and
1207 * start all over again.
1209 futex_unlock_mm(fshared);
1211 ret = get_user(uval, uaddr);
1213 if (!ret)
1214 goto retry;
1215 return ret;
1217 ret = -EWOULDBLOCK;
1218 if (uval != val)
1219 goto out_unlock_release_sem;
1221 /* Only actually queue if *uaddr contained val. */
1222 __queue_me(&q, hb);
1225 * Now the futex is queued and we have checked the data, we
1226 * don't want to hold mmap_sem while we sleep.
1228 futex_unlock_mm(fshared);
1231 * There might have been scheduling since the queue_me(), as we
1232 * cannot hold a spinlock across the get_user() in case it
1233 * faults, and we cannot just set TASK_INTERRUPTIBLE state when
1234 * queueing ourselves into the futex hash. This code thus has to
1235 * rely on the futex_wake() code removing us from hash when it
1236 * wakes us up.
1239 /* add_wait_queue is the barrier after __set_current_state. */
1240 __set_current_state(TASK_INTERRUPTIBLE);
1241 add_wait_queue(&q.waiters, &wait);
1243 * !plist_node_empty() is safe here without any lock.
1244 * q.lock_ptr != 0 is not safe, because of ordering against wakeup.
1246 if (likely(!plist_node_empty(&q.list))) {
1247 if (!abs_time)
1248 schedule();
1249 else {
1250 hrtimer_init(&t.timer, CLOCK_MONOTONIC, HRTIMER_MODE_ABS);
1251 hrtimer_init_sleeper(&t, current);
1252 t.timer.expires = *abs_time;
1254 hrtimer_start(&t.timer, t.timer.expires, HRTIMER_MODE_ABS);
1257 * the timer could have already expired, in which
1258 * case current would be flagged for rescheduling.
1259 * Don't bother calling schedule.
1261 if (likely(t.task))
1262 schedule();
1264 hrtimer_cancel(&t.timer);
1266 /* Flag if a timeout occured */
1267 rem = (t.task == NULL);
1270 __set_current_state(TASK_RUNNING);
1273 * NOTE: we don't remove ourselves from the waitqueue because
1274 * we are the only user of it.
1277 /* If we were woken (and unqueued), we succeeded, whatever. */
1278 if (!unqueue_me(&q))
1279 return 0;
1280 if (rem)
1281 return -ETIMEDOUT;
1284 * We expect signal_pending(current), but another thread may
1285 * have handled it for us already.
1287 if (!abs_time)
1288 return -ERESTARTSYS;
1289 else {
1290 struct restart_block *restart;
1291 restart = &current_thread_info()->restart_block;
1292 restart->fn = futex_wait_restart;
1293 restart->arg0 = (unsigned long)uaddr;
1294 restart->arg1 = (unsigned long)val;
1295 restart->arg2 = (unsigned long)abs_time;
1296 restart->arg3 = 0;
1297 if (fshared)
1298 restart->arg3 |= ARG3_SHARED;
1299 return -ERESTART_RESTARTBLOCK;
1302 out_unlock_release_sem:
1303 queue_unlock(&q, hb);
1305 out_release_sem:
1306 futex_unlock_mm(fshared);
1307 return ret;
1311 static long futex_wait_restart(struct restart_block *restart)
1313 u32 __user *uaddr = (u32 __user *)restart->arg0;
1314 u32 val = (u32)restart->arg1;
1315 ktime_t *abs_time = (ktime_t *)restart->arg2;
1316 struct rw_semaphore *fshared = NULL;
1318 restart->fn = do_no_restart_syscall;
1319 if (restart->arg3 & ARG3_SHARED)
1320 fshared = &current->mm->mmap_sem;
1321 return (long)futex_wait(uaddr, fshared, val, abs_time);
1326 * Userspace tried a 0 -> TID atomic transition of the futex value
1327 * and failed. The kernel side here does the whole locking operation:
1328 * if there are waiters then it will block, it does PI, etc. (Due to
1329 * races the kernel might see a 0 value of the futex too.)
1331 static int futex_lock_pi(u32 __user *uaddr, struct rw_semaphore *fshared,
1332 int detect, ktime_t *time, int trylock)
1334 struct hrtimer_sleeper timeout, *to = NULL;
1335 struct task_struct *curr = current;
1336 struct futex_hash_bucket *hb;
1337 u32 uval, newval, curval;
1338 struct futex_q q;
1339 int ret, lock_taken, ownerdied = 0, attempt = 0;
1341 if (refill_pi_state_cache())
1342 return -ENOMEM;
1344 if (time) {
1345 to = &timeout;
1346 hrtimer_init(&to->timer, CLOCK_REALTIME, HRTIMER_MODE_ABS);
1347 hrtimer_init_sleeper(to, current);
1348 to->timer.expires = *time;
1351 q.pi_state = NULL;
1352 retry:
1353 futex_lock_mm(fshared);
1355 ret = get_futex_key(uaddr, fshared, &q.key);
1356 if (unlikely(ret != 0))
1357 goto out_release_sem;
1359 retry_unlocked:
1360 hb = queue_lock(&q, -1, NULL);
1362 retry_locked:
1363 ret = lock_taken = 0;
1366 * To avoid races, we attempt to take the lock here again
1367 * (by doing a 0 -> TID atomic cmpxchg), while holding all
1368 * the locks. It will most likely not succeed.
1370 newval = current->pid;
1372 curval = cmpxchg_futex_value_locked(uaddr, 0, newval);
1374 if (unlikely(curval == -EFAULT))
1375 goto uaddr_faulted;
1378 * Detect deadlocks. In case of REQUEUE_PI this is a valid
1379 * situation and we return success to user space.
1381 if (unlikely((curval & FUTEX_TID_MASK) == current->pid)) {
1382 ret = -EDEADLK;
1383 goto out_unlock_release_sem;
1387 * Surprise - we got the lock. Just return to userspace:
1389 if (unlikely(!curval))
1390 goto out_unlock_release_sem;
1392 uval = curval;
1395 * Set the WAITERS flag, so the owner will know it has someone
1396 * to wake at next unlock
1398 newval = curval | FUTEX_WAITERS;
1401 * There are two cases, where a futex might have no owner (the
1402 * owner TID is 0): OWNER_DIED. We take over the futex in this
1403 * case. We also do an unconditional take over, when the owner
1404 * of the futex died.
1406 * This is safe as we are protected by the hash bucket lock !
1408 if (unlikely(ownerdied || !(curval & FUTEX_TID_MASK))) {
1409 /* Keep the OWNER_DIED bit */
1410 newval = (curval & ~FUTEX_TID_MASK) | current->pid;
1411 ownerdied = 0;
1412 lock_taken = 1;
1415 curval = cmpxchg_futex_value_locked(uaddr, uval, newval);
1417 if (unlikely(curval == -EFAULT))
1418 goto uaddr_faulted;
1419 if (unlikely(curval != uval))
1420 goto retry_locked;
1423 * We took the lock due to owner died take over.
1425 if (unlikely(lock_taken))
1426 goto out_unlock_release_sem;
1429 * We dont have the lock. Look up the PI state (or create it if
1430 * we are the first waiter):
1432 ret = lookup_pi_state(uval, hb, &q.key, &q.pi_state);
1434 if (unlikely(ret)) {
1435 switch (ret) {
1437 case -EAGAIN:
1439 * Task is exiting and we just wait for the
1440 * exit to complete.
1442 queue_unlock(&q, hb);
1443 futex_unlock_mm(fshared);
1444 cond_resched();
1445 goto retry;
1447 case -ESRCH:
1449 * No owner found for this futex. Check if the
1450 * OWNER_DIED bit is set to figure out whether
1451 * this is a robust futex or not.
1453 if (get_futex_value_locked(&curval, uaddr))
1454 goto uaddr_faulted;
1457 * We simply start over in case of a robust
1458 * futex. The code above will take the futex
1459 * and return happy.
1461 if (curval & FUTEX_OWNER_DIED) {
1462 ownerdied = 1;
1463 goto retry_locked;
1465 default:
1466 goto out_unlock_release_sem;
1471 * Only actually queue now that the atomic ops are done:
1473 __queue_me(&q, hb);
1476 * Now the futex is queued and we have checked the data, we
1477 * don't want to hold mmap_sem while we sleep.
1479 futex_unlock_mm(fshared);
1481 WARN_ON(!q.pi_state);
1483 * Block on the PI mutex:
1485 if (!trylock)
1486 ret = rt_mutex_timed_lock(&q.pi_state->pi_mutex, to, 1);
1487 else {
1488 ret = rt_mutex_trylock(&q.pi_state->pi_mutex);
1489 /* Fixup the trylock return value: */
1490 ret = ret ? 0 : -EWOULDBLOCK;
1493 futex_lock_mm(fshared);
1494 spin_lock(q.lock_ptr);
1496 if (!ret) {
1498 * Got the lock. We might not be the anticipated owner
1499 * if we did a lock-steal - fix up the PI-state in
1500 * that case:
1502 if (q.pi_state->owner != curr)
1503 ret = fixup_pi_state_owner(uaddr, &q, curr);
1504 } else {
1506 * Catch the rare case, where the lock was released
1507 * when we were on the way back before we locked the
1508 * hash bucket.
1510 if (q.pi_state->owner == curr &&
1511 rt_mutex_trylock(&q.pi_state->pi_mutex)) {
1512 ret = 0;
1513 } else {
1515 * Paranoia check. If we did not take the lock
1516 * in the trylock above, then we should not be
1517 * the owner of the rtmutex, neither the real
1518 * nor the pending one:
1520 if (rt_mutex_owner(&q.pi_state->pi_mutex) == curr)
1521 printk(KERN_ERR "futex_lock_pi: ret = %d "
1522 "pi-mutex: %p pi-state %p\n", ret,
1523 q.pi_state->pi_mutex.owner,
1524 q.pi_state->owner);
1528 /* Unqueue and drop the lock */
1529 unqueue_me_pi(&q);
1530 futex_unlock_mm(fshared);
1532 return ret != -EINTR ? ret : -ERESTARTNOINTR;
1534 out_unlock_release_sem:
1535 queue_unlock(&q, hb);
1537 out_release_sem:
1538 futex_unlock_mm(fshared);
1539 return ret;
1541 uaddr_faulted:
1543 * We have to r/w *(int __user *)uaddr, but we can't modify it
1544 * non-atomically. Therefore, if get_user below is not
1545 * enough, we need to handle the fault ourselves, while
1546 * still holding the mmap_sem.
1548 * ... and hb->lock. :-) --ANK
1550 queue_unlock(&q, hb);
1552 if (attempt++) {
1553 ret = futex_handle_fault((unsigned long)uaddr, fshared,
1554 attempt);
1555 if (ret)
1556 goto out_release_sem;
1557 goto retry_unlocked;
1560 futex_unlock_mm(fshared);
1562 ret = get_user(uval, uaddr);
1563 if (!ret && (uval != -EFAULT))
1564 goto retry;
1566 return ret;
1570 * Userspace attempted a TID -> 0 atomic transition, and failed.
1571 * This is the in-kernel slowpath: we look up the PI state (if any),
1572 * and do the rt-mutex unlock.
1574 static int futex_unlock_pi(u32 __user *uaddr, struct rw_semaphore *fshared)
1576 struct futex_hash_bucket *hb;
1577 struct futex_q *this, *next;
1578 u32 uval;
1579 struct plist_head *head;
1580 union futex_key key;
1581 int ret, attempt = 0;
1583 retry:
1584 if (get_user(uval, uaddr))
1585 return -EFAULT;
1587 * We release only a lock we actually own:
1589 if ((uval & FUTEX_TID_MASK) != current->pid)
1590 return -EPERM;
1592 * First take all the futex related locks:
1594 futex_lock_mm(fshared);
1596 ret = get_futex_key(uaddr, fshared, &key);
1597 if (unlikely(ret != 0))
1598 goto out;
1600 hb = hash_futex(&key);
1601 retry_unlocked:
1602 spin_lock(&hb->lock);
1605 * To avoid races, try to do the TID -> 0 atomic transition
1606 * again. If it succeeds then we can return without waking
1607 * anyone else up:
1609 if (!(uval & FUTEX_OWNER_DIED))
1610 uval = cmpxchg_futex_value_locked(uaddr, current->pid, 0);
1613 if (unlikely(uval == -EFAULT))
1614 goto pi_faulted;
1616 * Rare case: we managed to release the lock atomically,
1617 * no need to wake anyone else up:
1619 if (unlikely(uval == current->pid))
1620 goto out_unlock;
1623 * Ok, other tasks may need to be woken up - check waiters
1624 * and do the wakeup if necessary:
1626 head = &hb->chain;
1628 plist_for_each_entry_safe(this, next, head, list) {
1629 if (!match_futex (&this->key, &key))
1630 continue;
1631 ret = wake_futex_pi(uaddr, uval, this);
1633 * The atomic access to the futex value
1634 * generated a pagefault, so retry the
1635 * user-access and the wakeup:
1637 if (ret == -EFAULT)
1638 goto pi_faulted;
1639 goto out_unlock;
1642 * No waiters - kernel unlocks the futex:
1644 if (!(uval & FUTEX_OWNER_DIED)) {
1645 ret = unlock_futex_pi(uaddr, uval);
1646 if (ret == -EFAULT)
1647 goto pi_faulted;
1650 out_unlock:
1651 spin_unlock(&hb->lock);
1652 out:
1653 futex_unlock_mm(fshared);
1655 return ret;
1657 pi_faulted:
1659 * We have to r/w *(int __user *)uaddr, but we can't modify it
1660 * non-atomically. Therefore, if get_user below is not
1661 * enough, we need to handle the fault ourselves, while
1662 * still holding the mmap_sem.
1664 * ... and hb->lock. --ANK
1666 spin_unlock(&hb->lock);
1668 if (attempt++) {
1669 ret = futex_handle_fault((unsigned long)uaddr, fshared,
1670 attempt);
1671 if (ret)
1672 goto out;
1673 goto retry_unlocked;
1676 futex_unlock_mm(fshared);
1678 ret = get_user(uval, uaddr);
1679 if (!ret && (uval != -EFAULT))
1680 goto retry;
1682 return ret;
1685 static int futex_close(struct inode *inode, struct file *filp)
1687 struct futex_q *q = filp->private_data;
1689 unqueue_me(q);
1690 kfree(q);
1692 return 0;
1695 /* This is one-shot: once it's gone off you need a new fd */
1696 static unsigned int futex_poll(struct file *filp,
1697 struct poll_table_struct *wait)
1699 struct futex_q *q = filp->private_data;
1700 int ret = 0;
1702 poll_wait(filp, &q->waiters, wait);
1705 * plist_node_empty() is safe here without any lock.
1706 * q->lock_ptr != 0 is not safe, because of ordering against wakeup.
1708 if (plist_node_empty(&q->list))
1709 ret = POLLIN | POLLRDNORM;
1711 return ret;
1714 static const struct file_operations futex_fops = {
1715 .release = futex_close,
1716 .poll = futex_poll,
1720 * Signal allows caller to avoid the race which would occur if they
1721 * set the sigio stuff up afterwards.
1723 static int futex_fd(u32 __user *uaddr, int signal)
1725 struct futex_q *q;
1726 struct file *filp;
1727 int ret, err;
1728 struct rw_semaphore *fshared;
1729 static unsigned long printk_interval;
1731 if (printk_timed_ratelimit(&printk_interval, 60 * 60 * 1000)) {
1732 printk(KERN_WARNING "Process `%s' used FUTEX_FD, which "
1733 "will be removed from the kernel in June 2007\n",
1734 current->comm);
1737 ret = -EINVAL;
1738 if (!valid_signal(signal))
1739 goto out;
1741 ret = get_unused_fd();
1742 if (ret < 0)
1743 goto out;
1744 filp = get_empty_filp();
1745 if (!filp) {
1746 put_unused_fd(ret);
1747 ret = -ENFILE;
1748 goto out;
1750 filp->f_op = &futex_fops;
1751 filp->f_path.mnt = mntget(futex_mnt);
1752 filp->f_path.dentry = dget(futex_mnt->mnt_root);
1753 filp->f_mapping = filp->f_path.dentry->d_inode->i_mapping;
1755 if (signal) {
1756 err = __f_setown(filp, task_pid(current), PIDTYPE_PID, 1);
1757 if (err < 0) {
1758 goto error;
1760 filp->f_owner.signum = signal;
1763 q = kmalloc(sizeof(*q), GFP_KERNEL);
1764 if (!q) {
1765 err = -ENOMEM;
1766 goto error;
1768 q->pi_state = NULL;
1770 fshared = &current->mm->mmap_sem;
1771 down_read(fshared);
1772 err = get_futex_key(uaddr, fshared, &q->key);
1774 if (unlikely(err != 0)) {
1775 up_read(fshared);
1776 kfree(q);
1777 goto error;
1781 * queue_me() must be called before releasing mmap_sem, because
1782 * key->shared.inode needs to be referenced while holding it.
1784 filp->private_data = q;
1786 queue_me(q, ret, filp);
1787 up_read(fshared);
1789 /* Now we map fd to filp, so userspace can access it */
1790 fd_install(ret, filp);
1791 out:
1792 return ret;
1793 error:
1794 put_unused_fd(ret);
1795 put_filp(filp);
1796 ret = err;
1797 goto out;
1801 * Support for robust futexes: the kernel cleans up held futexes at
1802 * thread exit time.
1804 * Implementation: user-space maintains a per-thread list of locks it
1805 * is holding. Upon do_exit(), the kernel carefully walks this list,
1806 * and marks all locks that are owned by this thread with the
1807 * FUTEX_OWNER_DIED bit, and wakes up a waiter (if any). The list is
1808 * always manipulated with the lock held, so the list is private and
1809 * per-thread. Userspace also maintains a per-thread 'list_op_pending'
1810 * field, to allow the kernel to clean up if the thread dies after
1811 * acquiring the lock, but just before it could have added itself to
1812 * the list. There can only be one such pending lock.
1816 * sys_set_robust_list - set the robust-futex list head of a task
1817 * @head: pointer to the list-head
1818 * @len: length of the list-head, as userspace expects
1820 asmlinkage long
1821 sys_set_robust_list(struct robust_list_head __user *head,
1822 size_t len)
1825 * The kernel knows only one size for now:
1827 if (unlikely(len != sizeof(*head)))
1828 return -EINVAL;
1830 current->robust_list = head;
1832 return 0;
1836 * sys_get_robust_list - get the robust-futex list head of a task
1837 * @pid: pid of the process [zero for current task]
1838 * @head_ptr: pointer to a list-head pointer, the kernel fills it in
1839 * @len_ptr: pointer to a length field, the kernel fills in the header size
1841 asmlinkage long
1842 sys_get_robust_list(int pid, struct robust_list_head __user * __user *head_ptr,
1843 size_t __user *len_ptr)
1845 struct robust_list_head __user *head;
1846 unsigned long ret;
1848 if (!pid)
1849 head = current->robust_list;
1850 else {
1851 struct task_struct *p;
1853 ret = -ESRCH;
1854 rcu_read_lock();
1855 p = find_task_by_pid(pid);
1856 if (!p)
1857 goto err_unlock;
1858 ret = -EPERM;
1859 if ((current->euid != p->euid) && (current->euid != p->uid) &&
1860 !capable(CAP_SYS_PTRACE))
1861 goto err_unlock;
1862 head = p->robust_list;
1863 rcu_read_unlock();
1866 if (put_user(sizeof(*head), len_ptr))
1867 return -EFAULT;
1868 return put_user(head, head_ptr);
1870 err_unlock:
1871 rcu_read_unlock();
1873 return ret;
1877 * Process a futex-list entry, check whether it's owned by the
1878 * dying task, and do notification if so:
1880 int handle_futex_death(u32 __user *uaddr, struct task_struct *curr, int pi)
1882 u32 uval, nval, mval;
1884 retry:
1885 if (get_user(uval, uaddr))
1886 return -1;
1888 if ((uval & FUTEX_TID_MASK) == curr->pid) {
1890 * Ok, this dying thread is truly holding a futex
1891 * of interest. Set the OWNER_DIED bit atomically
1892 * via cmpxchg, and if the value had FUTEX_WAITERS
1893 * set, wake up a waiter (if any). (We have to do a
1894 * futex_wake() even if OWNER_DIED is already set -
1895 * to handle the rare but possible case of recursive
1896 * thread-death.) The rest of the cleanup is done in
1897 * userspace.
1899 mval = (uval & FUTEX_WAITERS) | FUTEX_OWNER_DIED;
1900 nval = futex_atomic_cmpxchg_inatomic(uaddr, uval, mval);
1902 if (nval == -EFAULT)
1903 return -1;
1905 if (nval != uval)
1906 goto retry;
1909 * Wake robust non-PI futexes here. The wakeup of
1910 * PI futexes happens in exit_pi_state():
1912 if (!pi && (uval & FUTEX_WAITERS))
1913 futex_wake(uaddr, &curr->mm->mmap_sem, 1);
1915 return 0;
1919 * Fetch a robust-list pointer. Bit 0 signals PI futexes:
1921 static inline int fetch_robust_entry(struct robust_list __user **entry,
1922 struct robust_list __user * __user *head,
1923 int *pi)
1925 unsigned long uentry;
1927 if (get_user(uentry, (unsigned long __user *)head))
1928 return -EFAULT;
1930 *entry = (void __user *)(uentry & ~1UL);
1931 *pi = uentry & 1;
1933 return 0;
1937 * Walk curr->robust_list (very carefully, it's a userspace list!)
1938 * and mark any locks found there dead, and notify any waiters.
1940 * We silently return on any sign of list-walking problem.
1942 void exit_robust_list(struct task_struct *curr)
1944 struct robust_list_head __user *head = curr->robust_list;
1945 struct robust_list __user *entry, *pending;
1946 unsigned int limit = ROBUST_LIST_LIMIT, pi, pip;
1947 unsigned long futex_offset;
1950 * Fetch the list head (which was registered earlier, via
1951 * sys_set_robust_list()):
1953 if (fetch_robust_entry(&entry, &head->list.next, &pi))
1954 return;
1956 * Fetch the relative futex offset:
1958 if (get_user(futex_offset, &head->futex_offset))
1959 return;
1961 * Fetch any possibly pending lock-add first, and handle it
1962 * if it exists:
1964 if (fetch_robust_entry(&pending, &head->list_op_pending, &pip))
1965 return;
1967 if (pending)
1968 handle_futex_death((void __user *)pending + futex_offset,
1969 curr, pip);
1971 while (entry != &head->list) {
1973 * A pending lock might already be on the list, so
1974 * don't process it twice:
1976 if (entry != pending)
1977 if (handle_futex_death((void __user *)entry + futex_offset,
1978 curr, pi))
1979 return;
1981 * Fetch the next entry in the list:
1983 if (fetch_robust_entry(&entry, &entry->next, &pi))
1984 return;
1986 * Avoid excessively long or circular lists:
1988 if (!--limit)
1989 break;
1991 cond_resched();
1995 long do_futex(u32 __user *uaddr, int op, u32 val, ktime_t *timeout,
1996 u32 __user *uaddr2, u32 val2, u32 val3)
1998 int ret;
1999 int cmd = op & FUTEX_CMD_MASK;
2000 struct rw_semaphore *fshared = NULL;
2002 if (!(op & FUTEX_PRIVATE_FLAG))
2003 fshared = &current->mm->mmap_sem;
2005 switch (cmd) {
2006 case FUTEX_WAIT:
2007 ret = futex_wait(uaddr, fshared, val, timeout);
2008 break;
2009 case FUTEX_WAKE:
2010 ret = futex_wake(uaddr, fshared, val);
2011 break;
2012 case FUTEX_FD:
2013 /* non-zero val means F_SETOWN(getpid()) & F_SETSIG(val) */
2014 ret = futex_fd(uaddr, val);
2015 break;
2016 case FUTEX_REQUEUE:
2017 ret = futex_requeue(uaddr, fshared, uaddr2, val, val2, NULL);
2018 break;
2019 case FUTEX_CMP_REQUEUE:
2020 ret = futex_requeue(uaddr, fshared, uaddr2, val, val2, &val3);
2021 break;
2022 case FUTEX_WAKE_OP:
2023 ret = futex_wake_op(uaddr, fshared, uaddr2, val, val2, val3);
2024 break;
2025 case FUTEX_LOCK_PI:
2026 ret = futex_lock_pi(uaddr, fshared, val, timeout, 0);
2027 break;
2028 case FUTEX_UNLOCK_PI:
2029 ret = futex_unlock_pi(uaddr, fshared);
2030 break;
2031 case FUTEX_TRYLOCK_PI:
2032 ret = futex_lock_pi(uaddr, fshared, 0, timeout, 1);
2033 break;
2034 default:
2035 ret = -ENOSYS;
2037 return ret;
2041 asmlinkage long sys_futex(u32 __user *uaddr, int op, u32 val,
2042 struct timespec __user *utime, u32 __user *uaddr2,
2043 u32 val3)
2045 struct timespec ts;
2046 ktime_t t, *tp = NULL;
2047 u32 val2 = 0;
2048 int cmd = op & FUTEX_CMD_MASK;
2050 if (utime && (cmd == FUTEX_WAIT || cmd == FUTEX_LOCK_PI)) {
2051 if (copy_from_user(&ts, utime, sizeof(ts)) != 0)
2052 return -EFAULT;
2053 if (!timespec_valid(&ts))
2054 return -EINVAL;
2056 t = timespec_to_ktime(ts);
2057 if (cmd == FUTEX_WAIT)
2058 t = ktime_add(ktime_get(), t);
2059 tp = &t;
2062 * requeue parameter in 'utime' if cmd == FUTEX_REQUEUE.
2063 * number of waiters to wake in 'utime' if cmd == FUTEX_WAKE_OP.
2065 if (cmd == FUTEX_REQUEUE || cmd == FUTEX_CMP_REQUEUE ||
2066 cmd == FUTEX_WAKE_OP)
2067 val2 = (u32) (unsigned long) utime;
2069 return do_futex(uaddr, op, val, tp, uaddr2, val2, val3);
2072 static int futexfs_get_sb(struct file_system_type *fs_type,
2073 int flags, const char *dev_name, void *data,
2074 struct vfsmount *mnt)
2076 return get_sb_pseudo(fs_type, "futex", NULL, 0xBAD1DEA, mnt);
2079 static struct file_system_type futex_fs_type = {
2080 .name = "futexfs",
2081 .get_sb = futexfs_get_sb,
2082 .kill_sb = kill_anon_super,
2085 static int __init init(void)
2087 int i = register_filesystem(&futex_fs_type);
2089 if (i)
2090 return i;
2092 futex_mnt = kern_mount(&futex_fs_type);
2093 if (IS_ERR(futex_mnt)) {
2094 unregister_filesystem(&futex_fs_type);
2095 return PTR_ERR(futex_mnt);
2098 for (i = 0; i < ARRAY_SIZE(futex_queues); i++) {
2099 plist_head_init(&futex_queues[i].chain, &futex_queues[i].lock);
2100 spin_lock_init(&futex_queues[i].lock);
2102 return 0;
2104 __initcall(init);