Merge branch 'upstream' of master.kernel.org:/pub/scm/linux/kernel/git/linville/wirel...
[linux-2.6] / kernel / futex.c
1 /*
2  *  Fast Userspace Mutexes (which I call "Futexes!").
3  *  (C) Rusty Russell, IBM 2002
4  *
5  *  Generalized futexes, futex requeueing, misc fixes by Ingo Molnar
6  *  (C) Copyright 2003 Red Hat Inc, All Rights Reserved
7  *
8  *  Removed page pinning, fix privately mapped COW pages and other cleanups
9  *  (C) Copyright 2003, 2004 Jamie Lokier
10  *
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.
14  *
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>
18  *
19  *  Thanks to Ben LaHaise for yelling "hashed waitqueues" loudly
20  *  enough at me, Linus for the original (flawed) idea, Matthew
21  *  Kirkwood for proof-of-concept implementation.
22  *
23  *  "The futexes are also cursed."
24  *  "But they come in a choice of three flavours!"
25  *
26  *  This program is free software; you can redistribute it and/or modify
27  *  it under the terms of the GNU General Public License as published by
28  *  the Free Software Foundation; either version 2 of the License, or
29  *  (at your option) any later version.
30  *
31  *  This program is distributed in the hope that it will be useful,
32  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
33  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
34  *  GNU General Public License for more details.
35  *
36  *  You should have received a copy of the GNU General Public License
37  *  along with this program; if not, write to the Free Software
38  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
39  */
40 #include <linux/slab.h>
41 #include <linux/poll.h>
42 #include <linux/fs.h>
43 #include <linux/file.h>
44 #include <linux/jhash.h>
45 #include <linux/init.h>
46 #include <linux/futex.h>
47 #include <linux/mount.h>
48 #include <linux/pagemap.h>
49 #include <linux/syscalls.h>
50 #include <linux/signal.h>
51 #include <asm/futex.h>
52
53 #include "rtmutex_common.h"
54
55 #define FUTEX_HASHBITS (CONFIG_BASE_SMALL ? 4 : 8)
56
57 /*
58  * Futexes are matched on equal values of this key.
59  * The key type depends on whether it's a shared or private mapping.
60  * Don't rearrange members without looking at hash_futex().
61  *
62  * offset is aligned to a multiple of sizeof(u32) (== 4) by definition.
63  * We set bit 0 to indicate if it's an inode-based key.
64  */
65 union futex_key {
66         struct {
67                 unsigned long pgoff;
68                 struct inode *inode;
69                 int offset;
70         } shared;
71         struct {
72                 unsigned long address;
73                 struct mm_struct *mm;
74                 int offset;
75         } private;
76         struct {
77                 unsigned long word;
78                 void *ptr;
79                 int offset;
80         } both;
81 };
82
83 /*
84  * Priority Inheritance state:
85  */
86 struct futex_pi_state {
87         /*
88          * list of 'owned' pi_state instances - these have to be
89          * cleaned up in do_exit() if the task exits prematurely:
90          */
91         struct list_head list;
92
93         /*
94          * The PI object:
95          */
96         struct rt_mutex pi_mutex;
97
98         struct task_struct *owner;
99         atomic_t refcount;
100
101         union futex_key key;
102 };
103
104 /*
105  * We use this hashed waitqueue instead of a normal wait_queue_t, so
106  * we can wake only the relevant ones (hashed queues may be shared).
107  *
108  * A futex_q has a woken state, just like tasks have TASK_RUNNING.
109  * It is considered woken when list_empty(&q->list) || q->lock_ptr == 0.
110  * The order of wakup is always to make the first condition true, then
111  * wake up q->waiters, then make the second condition true.
112  */
113 struct futex_q {
114         struct list_head list;
115         wait_queue_head_t waiters;
116
117         /* Which hash list lock to use: */
118         spinlock_t *lock_ptr;
119
120         /* Key which the futex is hashed on: */
121         union futex_key key;
122
123         /* For fd, sigio sent using these: */
124         int fd;
125         struct file *filp;
126
127         /* Optional priority inheritance state: */
128         struct futex_pi_state *pi_state;
129         struct task_struct *task;
130 };
131
132 /*
133  * Split the global futex_lock into every hash list lock.
134  */
135 struct futex_hash_bucket {
136        spinlock_t              lock;
137        struct list_head       chain;
138 };
139
140 static struct futex_hash_bucket futex_queues[1<<FUTEX_HASHBITS];
141
142 /* Futex-fs vfsmount entry: */
143 static struct vfsmount *futex_mnt;
144
145 /*
146  * We hash on the keys returned from get_futex_key (see below).
147  */
148 static struct futex_hash_bucket *hash_futex(union futex_key *key)
149 {
150         u32 hash = jhash2((u32*)&key->both.word,
151                           (sizeof(key->both.word)+sizeof(key->both.ptr))/4,
152                           key->both.offset);
153         return &futex_queues[hash & ((1 << FUTEX_HASHBITS)-1)];
154 }
155
156 /*
157  * Return 1 if two futex_keys are equal, 0 otherwise.
158  */
159 static inline int match_futex(union futex_key *key1, union futex_key *key2)
160 {
161         return (key1->both.word == key2->both.word
162                 && key1->both.ptr == key2->both.ptr
163                 && key1->both.offset == key2->both.offset);
164 }
165
166 /*
167  * Get parameters which are the keys for a futex.
168  *
169  * For shared mappings, it's (page->index, vma->vm_file->f_dentry->d_inode,
170  * offset_within_page).  For private mappings, it's (uaddr, current->mm).
171  * We can usually work out the index without swapping in the page.
172  *
173  * Returns: 0, or negative error code.
174  * The key words are stored in *key on success.
175  *
176  * Should be called with &current->mm->mmap_sem but NOT any spinlocks.
177  */
178 static int get_futex_key(u32 __user *uaddr, union futex_key *key)
179 {
180         unsigned long address = (unsigned long)uaddr;
181         struct mm_struct *mm = current->mm;
182         struct vm_area_struct *vma;
183         struct page *page;
184         int err;
185
186         /*
187          * The futex address must be "naturally" aligned.
188          */
189         key->both.offset = address % PAGE_SIZE;
190         if (unlikely((key->both.offset % sizeof(u32)) != 0))
191                 return -EINVAL;
192         address -= key->both.offset;
193
194         /*
195          * The futex is hashed differently depending on whether
196          * it's in a shared or private mapping.  So check vma first.
197          */
198         vma = find_extend_vma(mm, address);
199         if (unlikely(!vma))
200                 return -EFAULT;
201
202         /*
203          * Permissions.
204          */
205         if (unlikely((vma->vm_flags & (VM_IO|VM_READ)) != VM_READ))
206                 return (vma->vm_flags & VM_IO) ? -EPERM : -EACCES;
207
208         /*
209          * Private mappings are handled in a simple way.
210          *
211          * NOTE: When userspace waits on a MAP_SHARED mapping, even if
212          * it's a read-only handle, it's expected that futexes attach to
213          * the object not the particular process.  Therefore we use
214          * VM_MAYSHARE here, not VM_SHARED which is restricted to shared
215          * mappings of _writable_ handles.
216          */
217         if (likely(!(vma->vm_flags & VM_MAYSHARE))) {
218                 key->private.mm = mm;
219                 key->private.address = address;
220                 return 0;
221         }
222
223         /*
224          * Linear file mappings are also simple.
225          */
226         key->shared.inode = vma->vm_file->f_dentry->d_inode;
227         key->both.offset++; /* Bit 0 of offset indicates inode-based key. */
228         if (likely(!(vma->vm_flags & VM_NONLINEAR))) {
229                 key->shared.pgoff = (((address - vma->vm_start) >> PAGE_SHIFT)
230                                      + vma->vm_pgoff);
231                 return 0;
232         }
233
234         /*
235          * We could walk the page table to read the non-linear
236          * pte, and get the page index without fetching the page
237          * from swap.  But that's a lot of code to duplicate here
238          * for a rare case, so we simply fetch the page.
239          */
240         err = get_user_pages(current, mm, address, 1, 0, 0, &page, NULL);
241         if (err >= 0) {
242                 key->shared.pgoff =
243                         page->index << (PAGE_CACHE_SHIFT - PAGE_SHIFT);
244                 put_page(page);
245                 return 0;
246         }
247         return err;
248 }
249
250 /*
251  * Take a reference to the resource addressed by a key.
252  * Can be called while holding spinlocks.
253  *
254  * NOTE: mmap_sem MUST be held between get_futex_key() and calling this
255  * function, if it is called at all.  mmap_sem keeps key->shared.inode valid.
256  */
257 static inline void get_key_refs(union futex_key *key)
258 {
259         if (key->both.ptr != 0) {
260                 if (key->both.offset & 1)
261                         atomic_inc(&key->shared.inode->i_count);
262                 else
263                         atomic_inc(&key->private.mm->mm_count);
264         }
265 }
266
267 /*
268  * Drop a reference to the resource addressed by a key.
269  * The hash bucket spinlock must not be held.
270  */
271 static void drop_key_refs(union futex_key *key)
272 {
273         if (key->both.ptr != 0) {
274                 if (key->both.offset & 1)
275                         iput(key->shared.inode);
276                 else
277                         mmdrop(key->private.mm);
278         }
279 }
280
281 static inline int get_futex_value_locked(u32 *dest, u32 __user *from)
282 {
283         int ret;
284
285         inc_preempt_count();
286         ret = __copy_from_user_inatomic(dest, from, sizeof(u32));
287         dec_preempt_count();
288
289         return ret ? -EFAULT : 0;
290 }
291
292 /*
293  * Fault handling. Called with current->mm->mmap_sem held.
294  */
295 static int futex_handle_fault(unsigned long address, int attempt)
296 {
297         struct vm_area_struct * vma;
298         struct mm_struct *mm = current->mm;
299
300         if (attempt > 2 || !(vma = find_vma(mm, address)) ||
301             vma->vm_start > address || !(vma->vm_flags & VM_WRITE))
302                 return -EFAULT;
303
304         switch (handle_mm_fault(mm, vma, address, 1)) {
305         case VM_FAULT_MINOR:
306                 current->min_flt++;
307                 break;
308         case VM_FAULT_MAJOR:
309                 current->maj_flt++;
310                 break;
311         default:
312                 return -EFAULT;
313         }
314         return 0;
315 }
316
317 /*
318  * PI code:
319  */
320 static int refill_pi_state_cache(void)
321 {
322         struct futex_pi_state *pi_state;
323
324         if (likely(current->pi_state_cache))
325                 return 0;
326
327         pi_state = kmalloc(sizeof(*pi_state), GFP_KERNEL);
328
329         if (!pi_state)
330                 return -ENOMEM;
331
332         memset(pi_state, 0, sizeof(*pi_state));
333         INIT_LIST_HEAD(&pi_state->list);
334         /* pi_mutex gets initialized later */
335         pi_state->owner = NULL;
336         atomic_set(&pi_state->refcount, 1);
337
338         current->pi_state_cache = pi_state;
339
340         return 0;
341 }
342
343 static struct futex_pi_state * alloc_pi_state(void)
344 {
345         struct futex_pi_state *pi_state = current->pi_state_cache;
346
347         WARN_ON(!pi_state);
348         current->pi_state_cache = NULL;
349
350         return pi_state;
351 }
352
353 static void free_pi_state(struct futex_pi_state *pi_state)
354 {
355         if (!atomic_dec_and_test(&pi_state->refcount))
356                 return;
357
358         /*
359          * If pi_state->owner is NULL, the owner is most probably dying
360          * and has cleaned up the pi_state already
361          */
362         if (pi_state->owner) {
363                 spin_lock_irq(&pi_state->owner->pi_lock);
364                 list_del_init(&pi_state->list);
365                 spin_unlock_irq(&pi_state->owner->pi_lock);
366
367                 rt_mutex_proxy_unlock(&pi_state->pi_mutex, pi_state->owner);
368         }
369
370         if (current->pi_state_cache)
371                 kfree(pi_state);
372         else {
373                 /*
374                  * pi_state->list is already empty.
375                  * clear pi_state->owner.
376                  * refcount is at 0 - put it back to 1.
377                  */
378                 pi_state->owner = NULL;
379                 atomic_set(&pi_state->refcount, 1);
380                 current->pi_state_cache = pi_state;
381         }
382 }
383
384 /*
385  * Look up the task based on what TID userspace gave us.
386  * We dont trust it.
387  */
388 static struct task_struct * futex_find_get_task(pid_t pid)
389 {
390         struct task_struct *p;
391
392         read_lock(&tasklist_lock);
393         p = find_task_by_pid(pid);
394         if (!p)
395                 goto out_unlock;
396         if ((current->euid != p->euid) && (current->euid != p->uid)) {
397                 p = NULL;
398                 goto out_unlock;
399         }
400         if (p->exit_state != 0) {
401                 p = NULL;
402                 goto out_unlock;
403         }
404         get_task_struct(p);
405 out_unlock:
406         read_unlock(&tasklist_lock);
407
408         return p;
409 }
410
411 /*
412  * This task is holding PI mutexes at exit time => bad.
413  * Kernel cleans up PI-state, but userspace is likely hosed.
414  * (Robust-futex cleanup is separate and might save the day for userspace.)
415  */
416 void exit_pi_state_list(struct task_struct *curr)
417 {
418         struct list_head *next, *head = &curr->pi_state_list;
419         struct futex_pi_state *pi_state;
420         struct futex_hash_bucket *hb;
421         union futex_key key;
422
423         /*
424          * We are a ZOMBIE and nobody can enqueue itself on
425          * pi_state_list anymore, but we have to be careful
426          * versus waiters unqueueing themselves:
427          */
428         spin_lock_irq(&curr->pi_lock);
429         while (!list_empty(head)) {
430
431                 next = head->next;
432                 pi_state = list_entry(next, struct futex_pi_state, list);
433                 key = pi_state->key;
434                 hb = hash_futex(&key);
435                 spin_unlock_irq(&curr->pi_lock);
436
437                 spin_lock(&hb->lock);
438
439                 spin_lock_irq(&curr->pi_lock);
440                 /*
441                  * We dropped the pi-lock, so re-check whether this
442                  * task still owns the PI-state:
443                  */
444                 if (head->next != next) {
445                         spin_unlock(&hb->lock);
446                         continue;
447                 }
448
449                 WARN_ON(pi_state->owner != curr);
450                 WARN_ON(list_empty(&pi_state->list));
451                 list_del_init(&pi_state->list);
452                 pi_state->owner = NULL;
453                 spin_unlock_irq(&curr->pi_lock);
454
455                 rt_mutex_unlock(&pi_state->pi_mutex);
456
457                 spin_unlock(&hb->lock);
458
459                 spin_lock_irq(&curr->pi_lock);
460         }
461         spin_unlock_irq(&curr->pi_lock);
462 }
463
464 static int
465 lookup_pi_state(u32 uval, struct futex_hash_bucket *hb, struct futex_q *me)
466 {
467         struct futex_pi_state *pi_state = NULL;
468         struct futex_q *this, *next;
469         struct list_head *head;
470         struct task_struct *p;
471         pid_t pid;
472
473         head = &hb->chain;
474
475         list_for_each_entry_safe(this, next, head, list) {
476                 if (match_futex(&this->key, &me->key)) {
477                         /*
478                          * Another waiter already exists - bump up
479                          * the refcount and return its pi_state:
480                          */
481                         pi_state = this->pi_state;
482                         /*
483                          * Userspace might have messed up non PI and PI futexes
484                          */
485                         if (unlikely(!pi_state))
486                                 return -EINVAL;
487
488                         WARN_ON(!atomic_read(&pi_state->refcount));
489
490                         atomic_inc(&pi_state->refcount);
491                         me->pi_state = pi_state;
492
493                         return 0;
494                 }
495         }
496
497         /*
498          * We are the first waiter - try to look up the real owner and attach
499          * the new pi_state to it, but bail out when the owner died bit is set
500          * and TID = 0:
501          */
502         pid = uval & FUTEX_TID_MASK;
503         if (!pid && (uval & FUTEX_OWNER_DIED))
504                 return -ESRCH;
505         p = futex_find_get_task(pid);
506         if (!p)
507                 return -ESRCH;
508
509         pi_state = alloc_pi_state();
510
511         /*
512          * Initialize the pi_mutex in locked state and make 'p'
513          * the owner of it:
514          */
515         rt_mutex_init_proxy_locked(&pi_state->pi_mutex, p);
516
517         /* Store the key for possible exit cleanups: */
518         pi_state->key = me->key;
519
520         spin_lock_irq(&p->pi_lock);
521         WARN_ON(!list_empty(&pi_state->list));
522         list_add(&pi_state->list, &p->pi_state_list);
523         pi_state->owner = p;
524         spin_unlock_irq(&p->pi_lock);
525
526         put_task_struct(p);
527
528         me->pi_state = pi_state;
529
530         return 0;
531 }
532
533 /*
534  * The hash bucket lock must be held when this is called.
535  * Afterwards, the futex_q must not be accessed.
536  */
537 static void wake_futex(struct futex_q *q)
538 {
539         list_del_init(&q->list);
540         if (q->filp)
541                 send_sigio(&q->filp->f_owner, q->fd, POLL_IN);
542         /*
543          * The lock in wake_up_all() is a crucial memory barrier after the
544          * list_del_init() and also before assigning to q->lock_ptr.
545          */
546         wake_up_all(&q->waiters);
547         /*
548          * The waiting task can free the futex_q as soon as this is written,
549          * without taking any locks.  This must come last.
550          *
551          * A memory barrier is required here to prevent the following store
552          * to lock_ptr from getting ahead of the wakeup. Clearing the lock
553          * at the end of wake_up_all() does not prevent this store from
554          * moving.
555          */
556         wmb();
557         q->lock_ptr = NULL;
558 }
559
560 static int wake_futex_pi(u32 __user *uaddr, u32 uval, struct futex_q *this)
561 {
562         struct task_struct *new_owner;
563         struct futex_pi_state *pi_state = this->pi_state;
564         u32 curval, newval;
565
566         if (!pi_state)
567                 return -EINVAL;
568
569         new_owner = rt_mutex_next_owner(&pi_state->pi_mutex);
570
571         /*
572          * This happens when we have stolen the lock and the original
573          * pending owner did not enqueue itself back on the rt_mutex.
574          * Thats not a tragedy. We know that way, that a lock waiter
575          * is on the fly. We make the futex_q waiter the pending owner.
576          */
577         if (!new_owner)
578                 new_owner = this->task;
579
580         /*
581          * We pass it to the next owner. (The WAITERS bit is always
582          * kept enabled while there is PI state around. We must also
583          * preserve the owner died bit.)
584          */
585         if (!(uval & FUTEX_OWNER_DIED)) {
586                 newval = FUTEX_WAITERS | new_owner->pid;
587
588                 inc_preempt_count();
589                 curval = futex_atomic_cmpxchg_inatomic(uaddr, uval, newval);
590                 dec_preempt_count();
591                 if (curval == -EFAULT)
592                         return -EFAULT;
593                 if (curval != uval)
594                         return -EINVAL;
595         }
596
597         spin_lock_irq(&pi_state->owner->pi_lock);
598         WARN_ON(list_empty(&pi_state->list));
599         list_del_init(&pi_state->list);
600         spin_unlock_irq(&pi_state->owner->pi_lock);
601
602         spin_lock_irq(&new_owner->pi_lock);
603         WARN_ON(!list_empty(&pi_state->list));
604         list_add(&pi_state->list, &new_owner->pi_state_list);
605         pi_state->owner = new_owner;
606         spin_unlock_irq(&new_owner->pi_lock);
607
608         rt_mutex_unlock(&pi_state->pi_mutex);
609
610         return 0;
611 }
612
613 static int unlock_futex_pi(u32 __user *uaddr, u32 uval)
614 {
615         u32 oldval;
616
617         /*
618          * There is no waiter, so we unlock the futex. The owner died
619          * bit has not to be preserved here. We are the owner:
620          */
621         inc_preempt_count();
622         oldval = futex_atomic_cmpxchg_inatomic(uaddr, uval, 0);
623         dec_preempt_count();
624
625         if (oldval == -EFAULT)
626                 return oldval;
627         if (oldval != uval)
628                 return -EAGAIN;
629
630         return 0;
631 }
632
633 /*
634  * Express the locking dependencies for lockdep:
635  */
636 static inline void
637 double_lock_hb(struct futex_hash_bucket *hb1, struct futex_hash_bucket *hb2)
638 {
639         if (hb1 <= hb2) {
640                 spin_lock(&hb1->lock);
641                 if (hb1 < hb2)
642                         spin_lock_nested(&hb2->lock, SINGLE_DEPTH_NESTING);
643         } else { /* hb1 > hb2 */
644                 spin_lock(&hb2->lock);
645                 spin_lock_nested(&hb1->lock, SINGLE_DEPTH_NESTING);
646         }
647 }
648
649 /*
650  * Wake up all waiters hashed on the physical page that is mapped
651  * to this virtual address:
652  */
653 static int futex_wake(u32 __user *uaddr, int nr_wake)
654 {
655         struct futex_hash_bucket *hb;
656         struct futex_q *this, *next;
657         struct list_head *head;
658         union futex_key key;
659         int ret;
660
661         down_read(&current->mm->mmap_sem);
662
663         ret = get_futex_key(uaddr, &key);
664         if (unlikely(ret != 0))
665                 goto out;
666
667         hb = hash_futex(&key);
668         spin_lock(&hb->lock);
669         head = &hb->chain;
670
671         list_for_each_entry_safe(this, next, head, list) {
672                 if (match_futex (&this->key, &key)) {
673                         if (this->pi_state) {
674                                 ret = -EINVAL;
675                                 break;
676                         }
677                         wake_futex(this);
678                         if (++ret >= nr_wake)
679                                 break;
680                 }
681         }
682
683         spin_unlock(&hb->lock);
684 out:
685         up_read(&current->mm->mmap_sem);
686         return ret;
687 }
688
689 /*
690  * Wake up all waiters hashed on the physical page that is mapped
691  * to this virtual address:
692  */
693 static int
694 futex_wake_op(u32 __user *uaddr1, u32 __user *uaddr2,
695               int nr_wake, int nr_wake2, int op)
696 {
697         union futex_key key1, key2;
698         struct futex_hash_bucket *hb1, *hb2;
699         struct list_head *head;
700         struct futex_q *this, *next;
701         int ret, op_ret, attempt = 0;
702
703 retryfull:
704         down_read(&current->mm->mmap_sem);
705
706         ret = get_futex_key(uaddr1, &key1);
707         if (unlikely(ret != 0))
708                 goto out;
709         ret = get_futex_key(uaddr2, &key2);
710         if (unlikely(ret != 0))
711                 goto out;
712
713         hb1 = hash_futex(&key1);
714         hb2 = hash_futex(&key2);
715
716 retry:
717         double_lock_hb(hb1, hb2);
718
719         op_ret = futex_atomic_op_inuser(op, uaddr2);
720         if (unlikely(op_ret < 0)) {
721                 u32 dummy;
722
723                 spin_unlock(&hb1->lock);
724                 if (hb1 != hb2)
725                         spin_unlock(&hb2->lock);
726
727 #ifndef CONFIG_MMU
728                 /*
729                  * we don't get EFAULT from MMU faults if we don't have an MMU,
730                  * but we might get them from range checking
731                  */
732                 ret = op_ret;
733                 goto out;
734 #endif
735
736                 if (unlikely(op_ret != -EFAULT)) {
737                         ret = op_ret;
738                         goto out;
739                 }
740
741                 /*
742                  * futex_atomic_op_inuser needs to both read and write
743                  * *(int __user *)uaddr2, but we can't modify it
744                  * non-atomically.  Therefore, if get_user below is not
745                  * enough, we need to handle the fault ourselves, while
746                  * still holding the mmap_sem.
747                  */
748                 if (attempt++) {
749                         if (futex_handle_fault((unsigned long)uaddr2,
750                                                 attempt)) {
751                                 ret = -EFAULT;
752                                 goto out;
753                         }
754                         goto retry;
755                 }
756
757                 /*
758                  * If we would have faulted, release mmap_sem,
759                  * fault it in and start all over again.
760                  */
761                 up_read(&current->mm->mmap_sem);
762
763                 ret = get_user(dummy, uaddr2);
764                 if (ret)
765                         return ret;
766
767                 goto retryfull;
768         }
769
770         head = &hb1->chain;
771
772         list_for_each_entry_safe(this, next, head, list) {
773                 if (match_futex (&this->key, &key1)) {
774                         wake_futex(this);
775                         if (++ret >= nr_wake)
776                                 break;
777                 }
778         }
779
780         if (op_ret > 0) {
781                 head = &hb2->chain;
782
783                 op_ret = 0;
784                 list_for_each_entry_safe(this, next, head, list) {
785                         if (match_futex (&this->key, &key2)) {
786                                 wake_futex(this);
787                                 if (++op_ret >= nr_wake2)
788                                         break;
789                         }
790                 }
791                 ret += op_ret;
792         }
793
794         spin_unlock(&hb1->lock);
795         if (hb1 != hb2)
796                 spin_unlock(&hb2->lock);
797 out:
798         up_read(&current->mm->mmap_sem);
799         return ret;
800 }
801
802 /*
803  * Requeue all waiters hashed on one physical page to another
804  * physical page.
805  */
806 static int futex_requeue(u32 __user *uaddr1, u32 __user *uaddr2,
807                          int nr_wake, int nr_requeue, u32 *cmpval)
808 {
809         union futex_key key1, key2;
810         struct futex_hash_bucket *hb1, *hb2;
811         struct list_head *head1;
812         struct futex_q *this, *next;
813         int ret, drop_count = 0;
814
815  retry:
816         down_read(&current->mm->mmap_sem);
817
818         ret = get_futex_key(uaddr1, &key1);
819         if (unlikely(ret != 0))
820                 goto out;
821         ret = get_futex_key(uaddr2, &key2);
822         if (unlikely(ret != 0))
823                 goto out;
824
825         hb1 = hash_futex(&key1);
826         hb2 = hash_futex(&key2);
827
828         double_lock_hb(hb1, hb2);
829
830         if (likely(cmpval != NULL)) {
831                 u32 curval;
832
833                 ret = get_futex_value_locked(&curval, uaddr1);
834
835                 if (unlikely(ret)) {
836                         spin_unlock(&hb1->lock);
837                         if (hb1 != hb2)
838                                 spin_unlock(&hb2->lock);
839
840                         /*
841                          * If we would have faulted, release mmap_sem, fault
842                          * it in and start all over again.
843                          */
844                         up_read(&current->mm->mmap_sem);
845
846                         ret = get_user(curval, uaddr1);
847
848                         if (!ret)
849                                 goto retry;
850
851                         return ret;
852                 }
853                 if (curval != *cmpval) {
854                         ret = -EAGAIN;
855                         goto out_unlock;
856                 }
857         }
858
859         head1 = &hb1->chain;
860         list_for_each_entry_safe(this, next, head1, list) {
861                 if (!match_futex (&this->key, &key1))
862                         continue;
863                 if (++ret <= nr_wake) {
864                         wake_futex(this);
865                 } else {
866                         /*
867                          * If key1 and key2 hash to the same bucket, no need to
868                          * requeue.
869                          */
870                         if (likely(head1 != &hb2->chain)) {
871                                 list_move_tail(&this->list, &hb2->chain);
872                                 this->lock_ptr = &hb2->lock;
873                         }
874                         this->key = key2;
875                         get_key_refs(&key2);
876                         drop_count++;
877
878                         if (ret - nr_wake >= nr_requeue)
879                                 break;
880                 }
881         }
882
883 out_unlock:
884         spin_unlock(&hb1->lock);
885         if (hb1 != hb2)
886                 spin_unlock(&hb2->lock);
887
888         /* drop_key_refs() must be called outside the spinlocks. */
889         while (--drop_count >= 0)
890                 drop_key_refs(&key1);
891
892 out:
893         up_read(&current->mm->mmap_sem);
894         return ret;
895 }
896
897 /* The key must be already stored in q->key. */
898 static inline struct futex_hash_bucket *
899 queue_lock(struct futex_q *q, int fd, struct file *filp)
900 {
901         struct futex_hash_bucket *hb;
902
903         q->fd = fd;
904         q->filp = filp;
905
906         init_waitqueue_head(&q->waiters);
907
908         get_key_refs(&q->key);
909         hb = hash_futex(&q->key);
910         q->lock_ptr = &hb->lock;
911
912         spin_lock(&hb->lock);
913         return hb;
914 }
915
916 static inline void __queue_me(struct futex_q *q, struct futex_hash_bucket *hb)
917 {
918         list_add_tail(&q->list, &hb->chain);
919         q->task = current;
920         spin_unlock(&hb->lock);
921 }
922
923 static inline void
924 queue_unlock(struct futex_q *q, struct futex_hash_bucket *hb)
925 {
926         spin_unlock(&hb->lock);
927         drop_key_refs(&q->key);
928 }
929
930 /*
931  * queue_me and unqueue_me must be called as a pair, each
932  * exactly once.  They are called with the hashed spinlock held.
933  */
934
935 /* The key must be already stored in q->key. */
936 static void queue_me(struct futex_q *q, int fd, struct file *filp)
937 {
938         struct futex_hash_bucket *hb;
939
940         hb = queue_lock(q, fd, filp);
941         __queue_me(q, hb);
942 }
943
944 /* Return 1 if we were still queued (ie. 0 means we were woken) */
945 static int unqueue_me(struct futex_q *q)
946 {
947         spinlock_t *lock_ptr;
948         int ret = 0;
949
950         /* In the common case we don't take the spinlock, which is nice. */
951  retry:
952         lock_ptr = q->lock_ptr;
953         barrier();
954         if (lock_ptr != 0) {
955                 spin_lock(lock_ptr);
956                 /*
957                  * q->lock_ptr can change between reading it and
958                  * spin_lock(), causing us to take the wrong lock.  This
959                  * corrects the race condition.
960                  *
961                  * Reasoning goes like this: if we have the wrong lock,
962                  * q->lock_ptr must have changed (maybe several times)
963                  * between reading it and the spin_lock().  It can
964                  * change again after the spin_lock() but only if it was
965                  * already changed before the spin_lock().  It cannot,
966                  * however, change back to the original value.  Therefore
967                  * we can detect whether we acquired the correct lock.
968                  */
969                 if (unlikely(lock_ptr != q->lock_ptr)) {
970                         spin_unlock(lock_ptr);
971                         goto retry;
972                 }
973                 WARN_ON(list_empty(&q->list));
974                 list_del(&q->list);
975
976                 BUG_ON(q->pi_state);
977
978                 spin_unlock(lock_ptr);
979                 ret = 1;
980         }
981
982         drop_key_refs(&q->key);
983         return ret;
984 }
985
986 /*
987  * PI futexes can not be requeued and must remove themself from the
988  * hash bucket. The hash bucket lock is held on entry and dropped here.
989  */
990 static void unqueue_me_pi(struct futex_q *q, struct futex_hash_bucket *hb)
991 {
992         WARN_ON(list_empty(&q->list));
993         list_del(&q->list);
994
995         BUG_ON(!q->pi_state);
996         free_pi_state(q->pi_state);
997         q->pi_state = NULL;
998
999         spin_unlock(&hb->lock);
1000
1001         drop_key_refs(&q->key);
1002 }
1003
1004 static int futex_wait(u32 __user *uaddr, u32 val, unsigned long time)
1005 {
1006         struct task_struct *curr = current;
1007         DECLARE_WAITQUEUE(wait, curr);
1008         struct futex_hash_bucket *hb;
1009         struct futex_q q;
1010         u32 uval;
1011         int ret;
1012
1013         q.pi_state = NULL;
1014  retry:
1015         down_read(&curr->mm->mmap_sem);
1016
1017         ret = get_futex_key(uaddr, &q.key);
1018         if (unlikely(ret != 0))
1019                 goto out_release_sem;
1020
1021         hb = queue_lock(&q, -1, NULL);
1022
1023         /*
1024          * Access the page AFTER the futex is queued.
1025          * Order is important:
1026          *
1027          *   Userspace waiter: val = var; if (cond(val)) futex_wait(&var, val);
1028          *   Userspace waker:  if (cond(var)) { var = new; futex_wake(&var); }
1029          *
1030          * The basic logical guarantee of a futex is that it blocks ONLY
1031          * if cond(var) is known to be true at the time of blocking, for
1032          * any cond.  If we queued after testing *uaddr, that would open
1033          * a race condition where we could block indefinitely with
1034          * cond(var) false, which would violate the guarantee.
1035          *
1036          * A consequence is that futex_wait() can return zero and absorb
1037          * a wakeup when *uaddr != val on entry to the syscall.  This is
1038          * rare, but normal.
1039          *
1040          * We hold the mmap semaphore, so the mapping cannot have changed
1041          * since we looked it up in get_futex_key.
1042          */
1043         ret = get_futex_value_locked(&uval, uaddr);
1044
1045         if (unlikely(ret)) {
1046                 queue_unlock(&q, hb);
1047
1048                 /*
1049                  * If we would have faulted, release mmap_sem, fault it in and
1050                  * start all over again.
1051                  */
1052                 up_read(&curr->mm->mmap_sem);
1053
1054                 ret = get_user(uval, uaddr);
1055
1056                 if (!ret)
1057                         goto retry;
1058                 return ret;
1059         }
1060         ret = -EWOULDBLOCK;
1061         if (uval != val)
1062                 goto out_unlock_release_sem;
1063
1064         /* Only actually queue if *uaddr contained val.  */
1065         __queue_me(&q, hb);
1066
1067         /*
1068          * Now the futex is queued and we have checked the data, we
1069          * don't want to hold mmap_sem while we sleep.
1070          */
1071         up_read(&curr->mm->mmap_sem);
1072
1073         /*
1074          * There might have been scheduling since the queue_me(), as we
1075          * cannot hold a spinlock across the get_user() in case it
1076          * faults, and we cannot just set TASK_INTERRUPTIBLE state when
1077          * queueing ourselves into the futex hash.  This code thus has to
1078          * rely on the futex_wake() code removing us from hash when it
1079          * wakes us up.
1080          */
1081
1082         /* add_wait_queue is the barrier after __set_current_state. */
1083         __set_current_state(TASK_INTERRUPTIBLE);
1084         add_wait_queue(&q.waiters, &wait);
1085         /*
1086          * !list_empty() is safe here without any lock.
1087          * q.lock_ptr != 0 is not safe, because of ordering against wakeup.
1088          */
1089         if (likely(!list_empty(&q.list)))
1090                 time = schedule_timeout(time);
1091         __set_current_state(TASK_RUNNING);
1092
1093         /*
1094          * NOTE: we don't remove ourselves from the waitqueue because
1095          * we are the only user of it.
1096          */
1097
1098         /* If we were woken (and unqueued), we succeeded, whatever. */
1099         if (!unqueue_me(&q))
1100                 return 0;
1101         if (time == 0)
1102                 return -ETIMEDOUT;
1103         /*
1104          * We expect signal_pending(current), but another thread may
1105          * have handled it for us already.
1106          */
1107         return -EINTR;
1108
1109  out_unlock_release_sem:
1110         queue_unlock(&q, hb);
1111
1112  out_release_sem:
1113         up_read(&curr->mm->mmap_sem);
1114         return ret;
1115 }
1116
1117 /*
1118  * Userspace tried a 0 -> TID atomic transition of the futex value
1119  * and failed. The kernel side here does the whole locking operation:
1120  * if there are waiters then it will block, it does PI, etc. (Due to
1121  * races the kernel might see a 0 value of the futex too.)
1122  */
1123 static int do_futex_lock_pi(u32 __user *uaddr, int detect, int trylock,
1124                             struct hrtimer_sleeper *to)
1125 {
1126         struct task_struct *curr = current;
1127         struct futex_hash_bucket *hb;
1128         u32 uval, newval, curval;
1129         struct futex_q q;
1130         int ret, attempt = 0;
1131
1132         if (refill_pi_state_cache())
1133                 return -ENOMEM;
1134
1135         q.pi_state = NULL;
1136  retry:
1137         down_read(&curr->mm->mmap_sem);
1138
1139         ret = get_futex_key(uaddr, &q.key);
1140         if (unlikely(ret != 0))
1141                 goto out_release_sem;
1142
1143         hb = queue_lock(&q, -1, NULL);
1144
1145  retry_locked:
1146         /*
1147          * To avoid races, we attempt to take the lock here again
1148          * (by doing a 0 -> TID atomic cmpxchg), while holding all
1149          * the locks. It will most likely not succeed.
1150          */
1151         newval = current->pid;
1152
1153         inc_preempt_count();
1154         curval = futex_atomic_cmpxchg_inatomic(uaddr, 0, newval);
1155         dec_preempt_count();
1156
1157         if (unlikely(curval == -EFAULT))
1158                 goto uaddr_faulted;
1159
1160         /* We own the lock already */
1161         if (unlikely((curval & FUTEX_TID_MASK) == current->pid)) {
1162                 if (!detect && 0)
1163                         force_sig(SIGKILL, current);
1164                 ret = -EDEADLK;
1165                 goto out_unlock_release_sem;
1166         }
1167
1168         /*
1169          * Surprise - we got the lock. Just return
1170          * to userspace:
1171          */
1172         if (unlikely(!curval))
1173                 goto out_unlock_release_sem;
1174
1175         uval = curval;
1176         newval = uval | FUTEX_WAITERS;
1177
1178         inc_preempt_count();
1179         curval = futex_atomic_cmpxchg_inatomic(uaddr, uval, newval);
1180         dec_preempt_count();
1181
1182         if (unlikely(curval == -EFAULT))
1183                 goto uaddr_faulted;
1184         if (unlikely(curval != uval))
1185                 goto retry_locked;
1186
1187         /*
1188          * We dont have the lock. Look up the PI state (or create it if
1189          * we are the first waiter):
1190          */
1191         ret = lookup_pi_state(uval, hb, &q);
1192
1193         if (unlikely(ret)) {
1194                 /*
1195                  * There were no waiters and the owner task lookup
1196                  * failed. When the OWNER_DIED bit is set, then we
1197                  * know that this is a robust futex and we actually
1198                  * take the lock. This is safe as we are protected by
1199                  * the hash bucket lock. We also set the waiters bit
1200                  * unconditionally here, to simplify glibc handling of
1201                  * multiple tasks racing to acquire the lock and
1202                  * cleanup the problems which were left by the dead
1203                  * owner.
1204                  */
1205                 if (curval & FUTEX_OWNER_DIED) {
1206                         uval = newval;
1207                         newval = current->pid |
1208                                 FUTEX_OWNER_DIED | FUTEX_WAITERS;
1209
1210                         inc_preempt_count();
1211                         curval = futex_atomic_cmpxchg_inatomic(uaddr,
1212                                                                uval, newval);
1213                         dec_preempt_count();
1214
1215                         if (unlikely(curval == -EFAULT))
1216                                 goto uaddr_faulted;
1217                         if (unlikely(curval != uval))
1218                                 goto retry_locked;
1219                         ret = 0;
1220                 }
1221                 goto out_unlock_release_sem;
1222         }
1223
1224         /*
1225          * Only actually queue now that the atomic ops are done:
1226          */
1227         __queue_me(&q, hb);
1228
1229         /*
1230          * Now the futex is queued and we have checked the data, we
1231          * don't want to hold mmap_sem while we sleep.
1232          */
1233         up_read(&curr->mm->mmap_sem);
1234
1235         WARN_ON(!q.pi_state);
1236         /*
1237          * Block on the PI mutex:
1238          */
1239         if (!trylock)
1240                 ret = rt_mutex_timed_lock(&q.pi_state->pi_mutex, to, 1);
1241         else {
1242                 ret = rt_mutex_trylock(&q.pi_state->pi_mutex);
1243                 /* Fixup the trylock return value: */
1244                 ret = ret ? 0 : -EWOULDBLOCK;
1245         }
1246
1247         down_read(&curr->mm->mmap_sem);
1248         spin_lock(q.lock_ptr);
1249
1250         /*
1251          * Got the lock. We might not be the anticipated owner if we
1252          * did a lock-steal - fix up the PI-state in that case.
1253          */
1254         if (!ret && q.pi_state->owner != curr) {
1255                 u32 newtid = current->pid | FUTEX_WAITERS;
1256
1257                 /* Owner died? */
1258                 if (q.pi_state->owner != NULL) {
1259                         spin_lock_irq(&q.pi_state->owner->pi_lock);
1260                         WARN_ON(list_empty(&q.pi_state->list));
1261                         list_del_init(&q.pi_state->list);
1262                         spin_unlock_irq(&q.pi_state->owner->pi_lock);
1263                 } else
1264                         newtid |= FUTEX_OWNER_DIED;
1265
1266                 q.pi_state->owner = current;
1267
1268                 spin_lock_irq(&current->pi_lock);
1269                 WARN_ON(!list_empty(&q.pi_state->list));
1270                 list_add(&q.pi_state->list, &current->pi_state_list);
1271                 spin_unlock_irq(&current->pi_lock);
1272
1273                 /* Unqueue and drop the lock */
1274                 unqueue_me_pi(&q, hb);
1275                 up_read(&curr->mm->mmap_sem);
1276                 /*
1277                  * We own it, so we have to replace the pending owner
1278                  * TID. This must be atomic as we have preserve the
1279                  * owner died bit here.
1280                  */
1281                 ret = get_user(uval, uaddr);
1282                 while (!ret) {
1283                         newval = (uval & FUTEX_OWNER_DIED) | newtid;
1284                         curval = futex_atomic_cmpxchg_inatomic(uaddr,
1285                                                                uval, newval);
1286                         if (curval == -EFAULT)
1287                                 ret = -EFAULT;
1288                         if (curval == uval)
1289                                 break;
1290                         uval = curval;
1291                 }
1292         } else {
1293                 /*
1294                  * Catch the rare case, where the lock was released
1295                  * when we were on the way back before we locked
1296                  * the hash bucket.
1297                  */
1298                 if (ret && q.pi_state->owner == curr) {
1299                         if (rt_mutex_trylock(&q.pi_state->pi_mutex))
1300                                 ret = 0;
1301                 }
1302                 /* Unqueue and drop the lock */
1303                 unqueue_me_pi(&q, hb);
1304                 up_read(&curr->mm->mmap_sem);
1305         }
1306
1307         if (!detect && ret == -EDEADLK && 0)
1308                 force_sig(SIGKILL, current);
1309
1310         return ret;
1311
1312  out_unlock_release_sem:
1313         queue_unlock(&q, hb);
1314
1315  out_release_sem:
1316         up_read(&curr->mm->mmap_sem);
1317         return ret;
1318
1319  uaddr_faulted:
1320         /*
1321          * We have to r/w  *(int __user *)uaddr, but we can't modify it
1322          * non-atomically.  Therefore, if get_user below is not
1323          * enough, we need to handle the fault ourselves, while
1324          * still holding the mmap_sem.
1325          */
1326         if (attempt++) {
1327                 if (futex_handle_fault((unsigned long)uaddr, attempt)) {
1328                         ret = -EFAULT;
1329                         goto out_unlock_release_sem;
1330                 }
1331                 goto retry_locked;
1332         }
1333
1334         queue_unlock(&q, hb);
1335         up_read(&curr->mm->mmap_sem);
1336
1337         ret = get_user(uval, uaddr);
1338         if (!ret && (uval != -EFAULT))
1339                 goto retry;
1340
1341         return ret;
1342 }
1343
1344 /*
1345  * Restart handler
1346  */
1347 static long futex_lock_pi_restart(struct restart_block *restart)
1348 {
1349         struct hrtimer_sleeper timeout, *to = NULL;
1350         int ret;
1351
1352         restart->fn = do_no_restart_syscall;
1353
1354         if (restart->arg2 || restart->arg3) {
1355                 to = &timeout;
1356                 hrtimer_init(&to->timer, CLOCK_REALTIME, HRTIMER_ABS);
1357                 hrtimer_init_sleeper(to, current);
1358                 to->timer.expires.tv64 = ((u64)restart->arg1 << 32) |
1359                         (u64) restart->arg0;
1360         }
1361
1362         pr_debug("lock_pi restart: %p, %d (%d)\n",
1363                  (u32 __user *)restart->arg0, current->pid);
1364
1365         ret = do_futex_lock_pi((u32 __user *)restart->arg0, restart->arg1,
1366                                0, to);
1367
1368         if (ret != -EINTR)
1369                 return ret;
1370
1371         restart->fn = futex_lock_pi_restart;
1372
1373         /* The other values are filled in */
1374         return -ERESTART_RESTARTBLOCK;
1375 }
1376
1377 /*
1378  * Called from the syscall entry below.
1379  */
1380 static int futex_lock_pi(u32 __user *uaddr, int detect, unsigned long sec,
1381                          long nsec, int trylock)
1382 {
1383         struct hrtimer_sleeper timeout, *to = NULL;
1384         struct restart_block *restart;
1385         int ret;
1386
1387         if (sec != MAX_SCHEDULE_TIMEOUT) {
1388                 to = &timeout;
1389                 hrtimer_init(&to->timer, CLOCK_REALTIME, HRTIMER_ABS);
1390                 hrtimer_init_sleeper(to, current);
1391                 to->timer.expires = ktime_set(sec, nsec);
1392         }
1393
1394         ret = do_futex_lock_pi(uaddr, detect, trylock, to);
1395
1396         if (ret != -EINTR)
1397                 return ret;
1398
1399         pr_debug("lock_pi interrupted: %p, %d (%d)\n", uaddr, current->pid);
1400
1401         restart = &current_thread_info()->restart_block;
1402         restart->fn = futex_lock_pi_restart;
1403         restart->arg0 = (unsigned long) uaddr;
1404         restart->arg1 = detect;
1405         if (to) {
1406                 restart->arg2 = to->timer.expires.tv64 & 0xFFFFFFFF;
1407                 restart->arg3 = to->timer.expires.tv64 >> 32;
1408         } else
1409                 restart->arg2 = restart->arg3 = 0;
1410
1411         return -ERESTART_RESTARTBLOCK;
1412 }
1413
1414 /*
1415  * Userspace attempted a TID -> 0 atomic transition, and failed.
1416  * This is the in-kernel slowpath: we look up the PI state (if any),
1417  * and do the rt-mutex unlock.
1418  */
1419 static int futex_unlock_pi(u32 __user *uaddr)
1420 {
1421         struct futex_hash_bucket *hb;
1422         struct futex_q *this, *next;
1423         u32 uval;
1424         struct list_head *head;
1425         union futex_key key;
1426         int ret, attempt = 0;
1427
1428 retry:
1429         if (get_user(uval, uaddr))
1430                 return -EFAULT;
1431         /*
1432          * We release only a lock we actually own:
1433          */
1434         if ((uval & FUTEX_TID_MASK) != current->pid)
1435                 return -EPERM;
1436         /*
1437          * First take all the futex related locks:
1438          */
1439         down_read(&current->mm->mmap_sem);
1440
1441         ret = get_futex_key(uaddr, &key);
1442         if (unlikely(ret != 0))
1443                 goto out;
1444
1445         hb = hash_futex(&key);
1446         spin_lock(&hb->lock);
1447
1448 retry_locked:
1449         /*
1450          * To avoid races, try to do the TID -> 0 atomic transition
1451          * again. If it succeeds then we can return without waking
1452          * anyone else up:
1453          */
1454         if (!(uval & FUTEX_OWNER_DIED)) {
1455                 inc_preempt_count();
1456                 uval = futex_atomic_cmpxchg_inatomic(uaddr, current->pid, 0);
1457                 dec_preempt_count();
1458         }
1459
1460         if (unlikely(uval == -EFAULT))
1461                 goto pi_faulted;
1462         /*
1463          * Rare case: we managed to release the lock atomically,
1464          * no need to wake anyone else up:
1465          */
1466         if (unlikely(uval == current->pid))
1467                 goto out_unlock;
1468
1469         /*
1470          * Ok, other tasks may need to be woken up - check waiters
1471          * and do the wakeup if necessary:
1472          */
1473         head = &hb->chain;
1474
1475         list_for_each_entry_safe(this, next, head, list) {
1476                 if (!match_futex (&this->key, &key))
1477                         continue;
1478                 ret = wake_futex_pi(uaddr, uval, this);
1479                 /*
1480                  * The atomic access to the futex value
1481                  * generated a pagefault, so retry the
1482                  * user-access and the wakeup:
1483                  */
1484                 if (ret == -EFAULT)
1485                         goto pi_faulted;
1486                 goto out_unlock;
1487         }
1488         /*
1489          * No waiters - kernel unlocks the futex:
1490          */
1491         if (!(uval & FUTEX_OWNER_DIED)) {
1492                 ret = unlock_futex_pi(uaddr, uval);
1493                 if (ret == -EFAULT)
1494                         goto pi_faulted;
1495         }
1496
1497 out_unlock:
1498         spin_unlock(&hb->lock);
1499 out:
1500         up_read(&current->mm->mmap_sem);
1501
1502         return ret;
1503
1504 pi_faulted:
1505         /*
1506          * We have to r/w  *(int __user *)uaddr, but we can't modify it
1507          * non-atomically.  Therefore, if get_user below is not
1508          * enough, we need to handle the fault ourselves, while
1509          * still holding the mmap_sem.
1510          */
1511         if (attempt++) {
1512                 if (futex_handle_fault((unsigned long)uaddr, attempt)) {
1513                         ret = -EFAULT;
1514                         goto out_unlock;
1515                 }
1516                 goto retry_locked;
1517         }
1518
1519         spin_unlock(&hb->lock);
1520         up_read(&current->mm->mmap_sem);
1521
1522         ret = get_user(uval, uaddr);
1523         if (!ret && (uval != -EFAULT))
1524                 goto retry;
1525
1526         return ret;
1527 }
1528
1529 static int futex_close(struct inode *inode, struct file *filp)
1530 {
1531         struct futex_q *q = filp->private_data;
1532
1533         unqueue_me(q);
1534         kfree(q);
1535
1536         return 0;
1537 }
1538
1539 /* This is one-shot: once it's gone off you need a new fd */
1540 static unsigned int futex_poll(struct file *filp,
1541                                struct poll_table_struct *wait)
1542 {
1543         struct futex_q *q = filp->private_data;
1544         int ret = 0;
1545
1546         poll_wait(filp, &q->waiters, wait);
1547
1548         /*
1549          * list_empty() is safe here without any lock.
1550          * q->lock_ptr != 0 is not safe, because of ordering against wakeup.
1551          */
1552         if (list_empty(&q->list))
1553                 ret = POLLIN | POLLRDNORM;
1554
1555         return ret;
1556 }
1557
1558 static struct file_operations futex_fops = {
1559         .release        = futex_close,
1560         .poll           = futex_poll,
1561 };
1562
1563 /*
1564  * Signal allows caller to avoid the race which would occur if they
1565  * set the sigio stuff up afterwards.
1566  */
1567 static int futex_fd(u32 __user *uaddr, int signal)
1568 {
1569         struct futex_q *q;
1570         struct file *filp;
1571         int ret, err;
1572
1573         ret = -EINVAL;
1574         if (!valid_signal(signal))
1575                 goto out;
1576
1577         ret = get_unused_fd();
1578         if (ret < 0)
1579                 goto out;
1580         filp = get_empty_filp();
1581         if (!filp) {
1582                 put_unused_fd(ret);
1583                 ret = -ENFILE;
1584                 goto out;
1585         }
1586         filp->f_op = &futex_fops;
1587         filp->f_vfsmnt = mntget(futex_mnt);
1588         filp->f_dentry = dget(futex_mnt->mnt_root);
1589         filp->f_mapping = filp->f_dentry->d_inode->i_mapping;
1590
1591         if (signal) {
1592                 err = f_setown(filp, current->pid, 1);
1593                 if (err < 0) {
1594                         goto error;
1595                 }
1596                 filp->f_owner.signum = signal;
1597         }
1598
1599         q = kmalloc(sizeof(*q), GFP_KERNEL);
1600         if (!q) {
1601                 err = -ENOMEM;
1602                 goto error;
1603         }
1604         q->pi_state = NULL;
1605
1606         down_read(&current->mm->mmap_sem);
1607         err = get_futex_key(uaddr, &q->key);
1608
1609         if (unlikely(err != 0)) {
1610                 up_read(&current->mm->mmap_sem);
1611                 kfree(q);
1612                 goto error;
1613         }
1614
1615         /*
1616          * queue_me() must be called before releasing mmap_sem, because
1617          * key->shared.inode needs to be referenced while holding it.
1618          */
1619         filp->private_data = q;
1620
1621         queue_me(q, ret, filp);
1622         up_read(&current->mm->mmap_sem);
1623
1624         /* Now we map fd to filp, so userspace can access it */
1625         fd_install(ret, filp);
1626 out:
1627         return ret;
1628 error:
1629         put_unused_fd(ret);
1630         put_filp(filp);
1631         ret = err;
1632         goto out;
1633 }
1634
1635 /*
1636  * Support for robust futexes: the kernel cleans up held futexes at
1637  * thread exit time.
1638  *
1639  * Implementation: user-space maintains a per-thread list of locks it
1640  * is holding. Upon do_exit(), the kernel carefully walks this list,
1641  * and marks all locks that are owned by this thread with the
1642  * FUTEX_OWNER_DIED bit, and wakes up a waiter (if any). The list is
1643  * always manipulated with the lock held, so the list is private and
1644  * per-thread. Userspace also maintains a per-thread 'list_op_pending'
1645  * field, to allow the kernel to clean up if the thread dies after
1646  * acquiring the lock, but just before it could have added itself to
1647  * the list. There can only be one such pending lock.
1648  */
1649
1650 /**
1651  * sys_set_robust_list - set the robust-futex list head of a task
1652  * @head: pointer to the list-head
1653  * @len: length of the list-head, as userspace expects
1654  */
1655 asmlinkage long
1656 sys_set_robust_list(struct robust_list_head __user *head,
1657                     size_t len)
1658 {
1659         /*
1660          * The kernel knows only one size for now:
1661          */
1662         if (unlikely(len != sizeof(*head)))
1663                 return -EINVAL;
1664
1665         current->robust_list = head;
1666
1667         return 0;
1668 }
1669
1670 /**
1671  * sys_get_robust_list - get the robust-futex list head of a task
1672  * @pid: pid of the process [zero for current task]
1673  * @head_ptr: pointer to a list-head pointer, the kernel fills it in
1674  * @len_ptr: pointer to a length field, the kernel fills in the header size
1675  */
1676 asmlinkage long
1677 sys_get_robust_list(int pid, struct robust_list_head __user **head_ptr,
1678                     size_t __user *len_ptr)
1679 {
1680         struct robust_list_head *head;
1681         unsigned long ret;
1682
1683         if (!pid)
1684                 head = current->robust_list;
1685         else {
1686                 struct task_struct *p;
1687
1688                 ret = -ESRCH;
1689                 read_lock(&tasklist_lock);
1690                 p = find_task_by_pid(pid);
1691                 if (!p)
1692                         goto err_unlock;
1693                 ret = -EPERM;
1694                 if ((current->euid != p->euid) && (current->euid != p->uid) &&
1695                                 !capable(CAP_SYS_PTRACE))
1696                         goto err_unlock;
1697                 head = p->robust_list;
1698                 read_unlock(&tasklist_lock);
1699         }
1700
1701         if (put_user(sizeof(*head), len_ptr))
1702                 return -EFAULT;
1703         return put_user(head, head_ptr);
1704
1705 err_unlock:
1706         read_unlock(&tasklist_lock);
1707
1708         return ret;
1709 }
1710
1711 /*
1712  * Process a futex-list entry, check whether it's owned by the
1713  * dying task, and do notification if so:
1714  */
1715 int handle_futex_death(u32 __user *uaddr, struct task_struct *curr, int pi)
1716 {
1717         u32 uval, nval, mval;
1718
1719 retry:
1720         if (get_user(uval, uaddr))
1721                 return -1;
1722
1723         if ((uval & FUTEX_TID_MASK) == curr->pid) {
1724                 /*
1725                  * Ok, this dying thread is truly holding a futex
1726                  * of interest. Set the OWNER_DIED bit atomically
1727                  * via cmpxchg, and if the value had FUTEX_WAITERS
1728                  * set, wake up a waiter (if any). (We have to do a
1729                  * futex_wake() even if OWNER_DIED is already set -
1730                  * to handle the rare but possible case of recursive
1731                  * thread-death.) The rest of the cleanup is done in
1732                  * userspace.
1733                  */
1734                 mval = (uval & FUTEX_WAITERS) | FUTEX_OWNER_DIED;
1735                 nval = futex_atomic_cmpxchg_inatomic(uaddr, uval, mval);
1736
1737                 if (nval == -EFAULT)
1738                         return -1;
1739
1740                 if (nval != uval)
1741                         goto retry;
1742
1743                 /*
1744                  * Wake robust non-PI futexes here. The wakeup of
1745                  * PI futexes happens in exit_pi_state():
1746                  */
1747                 if (!pi) {
1748                         if (uval & FUTEX_WAITERS)
1749                                 futex_wake(uaddr, 1);
1750                 }
1751         }
1752         return 0;
1753 }
1754
1755 /*
1756  * Fetch a robust-list pointer. Bit 0 signals PI futexes:
1757  */
1758 static inline int fetch_robust_entry(struct robust_list __user **entry,
1759                                      struct robust_list __user **head, int *pi)
1760 {
1761         unsigned long uentry;
1762
1763         if (get_user(uentry, (unsigned long *)head))
1764                 return -EFAULT;
1765
1766         *entry = (void *)(uentry & ~1UL);
1767         *pi = uentry & 1;
1768
1769         return 0;
1770 }
1771
1772 /*
1773  * Walk curr->robust_list (very carefully, it's a userspace list!)
1774  * and mark any locks found there dead, and notify any waiters.
1775  *
1776  * We silently return on any sign of list-walking problem.
1777  */
1778 void exit_robust_list(struct task_struct *curr)
1779 {
1780         struct robust_list_head __user *head = curr->robust_list;
1781         struct robust_list __user *entry, *pending;
1782         unsigned int limit = ROBUST_LIST_LIMIT, pi, pip;
1783         unsigned long futex_offset;
1784
1785         /*
1786          * Fetch the list head (which was registered earlier, via
1787          * sys_set_robust_list()):
1788          */
1789         if (fetch_robust_entry(&entry, &head->list.next, &pi))
1790                 return;
1791         /*
1792          * Fetch the relative futex offset:
1793          */
1794         if (get_user(futex_offset, &head->futex_offset))
1795                 return;
1796         /*
1797          * Fetch any possibly pending lock-add first, and handle it
1798          * if it exists:
1799          */
1800         if (fetch_robust_entry(&pending, &head->list_op_pending, &pip))
1801                 return;
1802
1803         if (pending)
1804                 handle_futex_death((void *)pending + futex_offset, curr, pip);
1805
1806         while (entry != &head->list) {
1807                 /*
1808                  * A pending lock might already be on the list, so
1809                  * don't process it twice:
1810                  */
1811                 if (entry != pending)
1812                         if (handle_futex_death((void *)entry + futex_offset,
1813                                                 curr, pi))
1814                                 return;
1815                 /*
1816                  * Fetch the next entry in the list:
1817                  */
1818                 if (fetch_robust_entry(&entry, &entry->next, &pi))
1819                         return;
1820                 /*
1821                  * Avoid excessively long or circular lists:
1822                  */
1823                 if (!--limit)
1824                         break;
1825
1826                 cond_resched();
1827         }
1828 }
1829
1830 long do_futex(u32 __user *uaddr, int op, u32 val, unsigned long timeout,
1831                 u32 __user *uaddr2, u32 val2, u32 val3)
1832 {
1833         int ret;
1834
1835         switch (op) {
1836         case FUTEX_WAIT:
1837                 ret = futex_wait(uaddr, val, timeout);
1838                 break;
1839         case FUTEX_WAKE:
1840                 ret = futex_wake(uaddr, val);
1841                 break;
1842         case FUTEX_FD:
1843                 /* non-zero val means F_SETOWN(getpid()) & F_SETSIG(val) */
1844                 ret = futex_fd(uaddr, val);
1845                 break;
1846         case FUTEX_REQUEUE:
1847                 ret = futex_requeue(uaddr, uaddr2, val, val2, NULL);
1848                 break;
1849         case FUTEX_CMP_REQUEUE:
1850                 ret = futex_requeue(uaddr, uaddr2, val, val2, &val3);
1851                 break;
1852         case FUTEX_WAKE_OP:
1853                 ret = futex_wake_op(uaddr, uaddr2, val, val2, val3);
1854                 break;
1855         case FUTEX_LOCK_PI:
1856                 ret = futex_lock_pi(uaddr, val, timeout, val2, 0);
1857                 break;
1858         case FUTEX_UNLOCK_PI:
1859                 ret = futex_unlock_pi(uaddr);
1860                 break;
1861         case FUTEX_TRYLOCK_PI:
1862                 ret = futex_lock_pi(uaddr, 0, timeout, val2, 1);
1863                 break;
1864         default:
1865                 ret = -ENOSYS;
1866         }
1867         return ret;
1868 }
1869
1870
1871 asmlinkage long sys_futex(u32 __user *uaddr, int op, u32 val,
1872                           struct timespec __user *utime, u32 __user *uaddr2,
1873                           u32 val3)
1874 {
1875         struct timespec t;
1876         unsigned long timeout = MAX_SCHEDULE_TIMEOUT;
1877         u32 val2 = 0;
1878
1879         if (utime && (op == FUTEX_WAIT || op == FUTEX_LOCK_PI)) {
1880                 if (copy_from_user(&t, utime, sizeof(t)) != 0)
1881                         return -EFAULT;
1882                 if (!timespec_valid(&t))
1883                         return -EINVAL;
1884                 if (op == FUTEX_WAIT)
1885                         timeout = timespec_to_jiffies(&t) + 1;
1886                 else {
1887                         timeout = t.tv_sec;
1888                         val2 = t.tv_nsec;
1889                 }
1890         }
1891         /*
1892          * requeue parameter in 'utime' if op == FUTEX_REQUEUE.
1893          */
1894         if (op == FUTEX_REQUEUE || op == FUTEX_CMP_REQUEUE)
1895                 val2 = (u32) (unsigned long) utime;
1896
1897         return do_futex(uaddr, op, val, timeout, uaddr2, val2, val3);
1898 }
1899
1900 static int futexfs_get_sb(struct file_system_type *fs_type,
1901                           int flags, const char *dev_name, void *data,
1902                           struct vfsmount *mnt)
1903 {
1904         return get_sb_pseudo(fs_type, "futex", NULL, 0xBAD1DEA, mnt);
1905 }
1906
1907 static struct file_system_type futex_fs_type = {
1908         .name           = "futexfs",
1909         .get_sb         = futexfs_get_sb,
1910         .kill_sb        = kill_anon_super,
1911 };
1912
1913 static int __init init(void)
1914 {
1915         unsigned int i;
1916
1917         register_filesystem(&futex_fs_type);
1918         futex_mnt = kern_mount(&futex_fs_type);
1919
1920         for (i = 0; i < ARRAY_SIZE(futex_queues); i++) {
1921                 INIT_LIST_HEAD(&futex_queues[i].chain);
1922                 spin_lock_init(&futex_queues[i].lock);
1923         }
1924         return 0;
1925 }
1926 __initcall(init);