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 * Thanks to Ben LaHaise for yelling "hashed waitqueues" loudly
12 * enough at me, Linus for the original (flawed) idea, Matthew
13 * Kirkwood for proof-of-concept implementation.
15 * "The futexes are also cursed."
16 * "But they come in a choice of three flavours!"
18 * This program is free software; you can redistribute it and/or modify
19 * it under the terms of the GNU General Public License as published by
20 * the Free Software Foundation; either version 2 of the License, or
21 * (at your option) any later version.
23 * This program is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU General Public License for more details.
28 * You should have received a copy of the GNU General Public License
29 * along with this program; if not, write to the Free Software
30 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
32 #include <linux/slab.h>
33 #include <linux/poll.h>
35 #include <linux/file.h>
36 #include <linux/jhash.h>
37 #include <linux/init.h>
38 #include <linux/futex.h>
39 #include <linux/mount.h>
40 #include <linux/pagemap.h>
41 #include <linux/syscalls.h>
42 #include <linux/signal.h>
43 #include <asm/futex.h>
45 #define FUTEX_HASHBITS (CONFIG_BASE_SMALL ? 4 : 8)
48 * Futexes are matched on equal values of this key.
49 * The key type depends on whether it's a shared or private mapping.
50 * Don't rearrange members without looking at hash_futex().
52 * offset is aligned to a multiple of sizeof(u32) (== 4) by definition.
53 * We set bit 0 to indicate if it's an inode-based key.
74 * We use this hashed waitqueue instead of a normal wait_queue_t, so
75 * we can wake only the relevant ones (hashed queues may be shared).
77 * A futex_q has a woken state, just like tasks have TASK_RUNNING.
78 * It is considered woken when list_empty(&q->list) || q->lock_ptr == 0.
79 * The order of wakup is always to make the first condition true, then
80 * wake up q->waiters, then make the second condition true.
83 struct list_head list;
84 wait_queue_head_t waiters;
86 /* Which hash list lock to use. */
89 /* Key which the futex is hashed on. */
92 /* For fd, sigio sent using these. */
98 * Split the global futex_lock into every hash list lock.
100 struct futex_hash_bucket {
102 struct list_head chain;
105 static struct futex_hash_bucket futex_queues[1<<FUTEX_HASHBITS];
107 /* Futex-fs vfsmount entry: */
108 static struct vfsmount *futex_mnt;
111 * We hash on the keys returned from get_futex_key (see below).
113 static struct futex_hash_bucket *hash_futex(union futex_key *key)
115 u32 hash = jhash2((u32*)&key->both.word,
116 (sizeof(key->both.word)+sizeof(key->both.ptr))/4,
118 return &futex_queues[hash & ((1 << FUTEX_HASHBITS)-1)];
122 * Return 1 if two futex_keys are equal, 0 otherwise.
124 static inline int match_futex(union futex_key *key1, union futex_key *key2)
126 return (key1->both.word == key2->both.word
127 && key1->both.ptr == key2->both.ptr
128 && key1->both.offset == key2->both.offset);
132 * Get parameters which are the keys for a futex.
134 * For shared mappings, it's (page->index, vma->vm_file->f_dentry->d_inode,
135 * offset_within_page). For private mappings, it's (uaddr, current->mm).
136 * We can usually work out the index without swapping in the page.
138 * Returns: 0, or negative error code.
139 * The key words are stored in *key on success.
141 * Should be called with ¤t->mm->mmap_sem but NOT any spinlocks.
143 static int get_futex_key(unsigned long uaddr, union futex_key *key)
145 struct mm_struct *mm = current->mm;
146 struct vm_area_struct *vma;
151 * The futex address must be "naturally" aligned.
153 key->both.offset = uaddr % PAGE_SIZE;
154 if (unlikely((key->both.offset % sizeof(u32)) != 0))
156 uaddr -= key->both.offset;
159 * The futex is hashed differently depending on whether
160 * it's in a shared or private mapping. So check vma first.
162 vma = find_extend_vma(mm, uaddr);
169 if (unlikely((vma->vm_flags & (VM_IO|VM_READ)) != VM_READ))
170 return (vma->vm_flags & VM_IO) ? -EPERM : -EACCES;
173 * Private mappings are handled in a simple way.
175 * NOTE: When userspace waits on a MAP_SHARED mapping, even if
176 * it's a read-only handle, it's expected that futexes attach to
177 * the object not the particular process. Therefore we use
178 * VM_MAYSHARE here, not VM_SHARED which is restricted to shared
179 * mappings of _writable_ handles.
181 if (likely(!(vma->vm_flags & VM_MAYSHARE))) {
182 key->private.mm = mm;
183 key->private.uaddr = uaddr;
188 * Linear file mappings are also simple.
190 key->shared.inode = vma->vm_file->f_dentry->d_inode;
191 key->both.offset++; /* Bit 0 of offset indicates inode-based key. */
192 if (likely(!(vma->vm_flags & VM_NONLINEAR))) {
193 key->shared.pgoff = (((uaddr - vma->vm_start) >> PAGE_SHIFT)
199 * We could walk the page table to read the non-linear
200 * pte, and get the page index without fetching the page
201 * from swap. But that's a lot of code to duplicate here
202 * for a rare case, so we simply fetch the page.
206 * Do a quick atomic lookup first - this is the fastpath.
208 page = follow_page(mm, uaddr, FOLL_TOUCH|FOLL_GET);
209 if (likely(page != NULL)) {
211 page->index << (PAGE_CACHE_SHIFT - PAGE_SHIFT);
217 * Do it the general way.
219 err = get_user_pages(current, mm, uaddr, 1, 0, 0, &page, NULL);
222 page->index << (PAGE_CACHE_SHIFT - PAGE_SHIFT);
230 * Take a reference to the resource addressed by a key.
231 * Can be called while holding spinlocks.
233 * NOTE: mmap_sem MUST be held between get_futex_key() and calling this
234 * function, if it is called at all. mmap_sem keeps key->shared.inode valid.
236 static inline void get_key_refs(union futex_key *key)
238 if (key->both.ptr != 0) {
239 if (key->both.offset & 1)
240 atomic_inc(&key->shared.inode->i_count);
242 atomic_inc(&key->private.mm->mm_count);
247 * Drop a reference to the resource addressed by a key.
248 * The hash bucket spinlock must not be held.
250 static void drop_key_refs(union futex_key *key)
252 if (key->both.ptr != 0) {
253 if (key->both.offset & 1)
254 iput(key->shared.inode);
256 mmdrop(key->private.mm);
260 static inline int get_futex_value_locked(int *dest, int __user *from)
265 ret = __copy_from_user_inatomic(dest, from, sizeof(int));
268 return ret ? -EFAULT : 0;
272 * The hash bucket lock must be held when this is called.
273 * Afterwards, the futex_q must not be accessed.
275 static void wake_futex(struct futex_q *q)
277 list_del_init(&q->list);
279 send_sigio(&q->filp->f_owner, q->fd, POLL_IN);
281 * The lock in wake_up_all() is a crucial memory barrier after the
282 * list_del_init() and also before assigning to q->lock_ptr.
284 wake_up_all(&q->waiters);
286 * The waiting task can free the futex_q as soon as this is written,
287 * without taking any locks. This must come last.
293 * Wake up all waiters hashed on the physical page that is mapped
294 * to this virtual address:
296 static int futex_wake(unsigned long uaddr, int nr_wake)
299 struct futex_hash_bucket *bh;
300 struct list_head *head;
301 struct futex_q *this, *next;
304 down_read(¤t->mm->mmap_sem);
306 ret = get_futex_key(uaddr, &key);
307 if (unlikely(ret != 0))
310 bh = hash_futex(&key);
311 spin_lock(&bh->lock);
314 list_for_each_entry_safe(this, next, head, list) {
315 if (match_futex (&this->key, &key)) {
317 if (++ret >= nr_wake)
322 spin_unlock(&bh->lock);
324 up_read(¤t->mm->mmap_sem);
329 * Wake up all waiters hashed on the physical page that is mapped
330 * to this virtual address:
332 static int futex_wake_op(unsigned long uaddr1, unsigned long uaddr2, int nr_wake, int nr_wake2, int op)
334 union futex_key key1, key2;
335 struct futex_hash_bucket *bh1, *bh2;
336 struct list_head *head;
337 struct futex_q *this, *next;
338 int ret, op_ret, attempt = 0;
341 down_read(¤t->mm->mmap_sem);
343 ret = get_futex_key(uaddr1, &key1);
344 if (unlikely(ret != 0))
346 ret = get_futex_key(uaddr2, &key2);
347 if (unlikely(ret != 0))
350 bh1 = hash_futex(&key1);
351 bh2 = hash_futex(&key2);
355 spin_lock(&bh1->lock);
356 spin_lock(&bh2->lock);
358 spin_lock(&bh1->lock);
360 op_ret = futex_atomic_op_inuser(op, (int __user *)uaddr2);
361 if (unlikely(op_ret < 0)) {
364 spin_unlock(&bh1->lock);
366 spin_unlock(&bh2->lock);
368 /* futex_atomic_op_inuser needs to both read and write
369 * *(int __user *)uaddr2, but we can't modify it
370 * non-atomically. Therefore, if get_user below is not
371 * enough, we need to handle the fault ourselves, while
372 * still holding the mmap_sem. */
374 struct vm_area_struct * vma;
375 struct mm_struct *mm = current->mm;
379 !(vma = find_vma(mm, uaddr2)) ||
380 vma->vm_start > uaddr2 ||
381 !(vma->vm_flags & VM_WRITE))
384 switch (handle_mm_fault(mm, vma, uaddr2, 1)) {
397 /* If we would have faulted, release mmap_sem,
398 * fault it in and start all over again. */
399 up_read(¤t->mm->mmap_sem);
401 ret = get_user(dummy, (int __user *)uaddr2);
410 list_for_each_entry_safe(this, next, head, list) {
411 if (match_futex (&this->key, &key1)) {
413 if (++ret >= nr_wake)
422 list_for_each_entry_safe(this, next, head, list) {
423 if (match_futex (&this->key, &key2)) {
425 if (++op_ret >= nr_wake2)
432 spin_unlock(&bh1->lock);
434 spin_unlock(&bh2->lock);
436 up_read(¤t->mm->mmap_sem);
441 * Requeue all waiters hashed on one physical page to another
444 static int futex_requeue(unsigned long uaddr1, unsigned long uaddr2,
445 int nr_wake, int nr_requeue, int *valp)
447 union futex_key key1, key2;
448 struct futex_hash_bucket *bh1, *bh2;
449 struct list_head *head1;
450 struct futex_q *this, *next;
451 int ret, drop_count = 0;
454 down_read(¤t->mm->mmap_sem);
456 ret = get_futex_key(uaddr1, &key1);
457 if (unlikely(ret != 0))
459 ret = get_futex_key(uaddr2, &key2);
460 if (unlikely(ret != 0))
463 bh1 = hash_futex(&key1);
464 bh2 = hash_futex(&key2);
467 spin_lock(&bh1->lock);
468 spin_lock(&bh2->lock);
470 spin_lock(&bh1->lock);
472 if (likely(valp != NULL)) {
475 ret = get_futex_value_locked(&curval, (int __user *)uaddr1);
478 spin_unlock(&bh1->lock);
480 spin_unlock(&bh2->lock);
482 /* If we would have faulted, release mmap_sem, fault
483 * it in and start all over again.
485 up_read(¤t->mm->mmap_sem);
487 ret = get_user(curval, (int __user *)uaddr1);
494 if (curval != *valp) {
501 list_for_each_entry_safe(this, next, head1, list) {
502 if (!match_futex (&this->key, &key1))
504 if (++ret <= nr_wake) {
507 list_move_tail(&this->list, &bh2->chain);
508 this->lock_ptr = &bh2->lock;
513 if (ret - nr_wake >= nr_requeue)
515 /* Make sure to stop if key1 == key2 */
516 if (head1 == &bh2->chain && head1 != &next->list)
522 spin_unlock(&bh1->lock);
524 spin_unlock(&bh2->lock);
526 /* drop_key_refs() must be called outside the spinlocks. */
527 while (--drop_count >= 0)
528 drop_key_refs(&key1);
531 up_read(¤t->mm->mmap_sem);
535 /* The key must be already stored in q->key. */
536 static inline struct futex_hash_bucket *
537 queue_lock(struct futex_q *q, int fd, struct file *filp)
539 struct futex_hash_bucket *bh;
544 init_waitqueue_head(&q->waiters);
546 get_key_refs(&q->key);
547 bh = hash_futex(&q->key);
548 q->lock_ptr = &bh->lock;
550 spin_lock(&bh->lock);
554 static inline void __queue_me(struct futex_q *q, struct futex_hash_bucket *bh)
556 list_add_tail(&q->list, &bh->chain);
557 spin_unlock(&bh->lock);
561 queue_unlock(struct futex_q *q, struct futex_hash_bucket *bh)
563 spin_unlock(&bh->lock);
564 drop_key_refs(&q->key);
568 * queue_me and unqueue_me must be called as a pair, each
569 * exactly once. They are called with the hashed spinlock held.
572 /* The key must be already stored in q->key. */
573 static void queue_me(struct futex_q *q, int fd, struct file *filp)
575 struct futex_hash_bucket *bh;
576 bh = queue_lock(q, fd, filp);
580 /* Return 1 if we were still queued (ie. 0 means we were woken) */
581 static int unqueue_me(struct futex_q *q)
584 spinlock_t *lock_ptr;
586 /* In the common case we don't take the spinlock, which is nice. */
588 lock_ptr = q->lock_ptr;
592 * q->lock_ptr can change between reading it and
593 * spin_lock(), causing us to take the wrong lock. This
594 * corrects the race condition.
596 * Reasoning goes like this: if we have the wrong lock,
597 * q->lock_ptr must have changed (maybe several times)
598 * between reading it and the spin_lock(). It can
599 * change again after the spin_lock() but only if it was
600 * already changed before the spin_lock(). It cannot,
601 * however, change back to the original value. Therefore
602 * we can detect whether we acquired the correct lock.
604 if (unlikely(lock_ptr != q->lock_ptr)) {
605 spin_unlock(lock_ptr);
608 WARN_ON(list_empty(&q->list));
610 spin_unlock(lock_ptr);
614 drop_key_refs(&q->key);
618 static int futex_wait(unsigned long uaddr, int val, unsigned long time)
620 DECLARE_WAITQUEUE(wait, current);
623 struct futex_hash_bucket *bh;
626 down_read(¤t->mm->mmap_sem);
628 ret = get_futex_key(uaddr, &q.key);
629 if (unlikely(ret != 0))
630 goto out_release_sem;
632 bh = queue_lock(&q, -1, NULL);
635 * Access the page AFTER the futex is queued.
636 * Order is important:
638 * Userspace waiter: val = var; if (cond(val)) futex_wait(&var, val);
639 * Userspace waker: if (cond(var)) { var = new; futex_wake(&var); }
641 * The basic logical guarantee of a futex is that it blocks ONLY
642 * if cond(var) is known to be true at the time of blocking, for
643 * any cond. If we queued after testing *uaddr, that would open
644 * a race condition where we could block indefinitely with
645 * cond(var) false, which would violate the guarantee.
647 * A consequence is that futex_wait() can return zero and absorb
648 * a wakeup when *uaddr != val on entry to the syscall. This is
651 * We hold the mmap semaphore, so the mapping cannot have changed
652 * since we looked it up in get_futex_key.
655 ret = get_futex_value_locked(&curval, (int __user *)uaddr);
658 queue_unlock(&q, bh);
660 /* If we would have faulted, release mmap_sem, fault it in and
661 * start all over again.
663 up_read(¤t->mm->mmap_sem);
665 ret = get_user(curval, (int __user *)uaddr);
673 queue_unlock(&q, bh);
674 goto out_release_sem;
677 /* Only actually queue if *uaddr contained val. */
681 * Now the futex is queued and we have checked the data, we
682 * don't want to hold mmap_sem while we sleep.
684 up_read(¤t->mm->mmap_sem);
687 * There might have been scheduling since the queue_me(), as we
688 * cannot hold a spinlock across the get_user() in case it
689 * faults, and we cannot just set TASK_INTERRUPTIBLE state when
690 * queueing ourselves into the futex hash. This code thus has to
691 * rely on the futex_wake() code removing us from hash when it
695 /* add_wait_queue is the barrier after __set_current_state. */
696 __set_current_state(TASK_INTERRUPTIBLE);
697 add_wait_queue(&q.waiters, &wait);
699 * !list_empty() is safe here without any lock.
700 * q.lock_ptr != 0 is not safe, because of ordering against wakeup.
702 if (likely(!list_empty(&q.list)))
703 time = schedule_timeout(time);
704 __set_current_state(TASK_RUNNING);
707 * NOTE: we don't remove ourselves from the waitqueue because
708 * we are the only user of it.
711 /* If we were woken (and unqueued), we succeeded, whatever. */
716 /* We expect signal_pending(current), but another thread may
717 * have handled it for us already. */
721 up_read(¤t->mm->mmap_sem);
725 static int futex_close(struct inode *inode, struct file *filp)
727 struct futex_q *q = filp->private_data;
734 /* This is one-shot: once it's gone off you need a new fd */
735 static unsigned int futex_poll(struct file *filp,
736 struct poll_table_struct *wait)
738 struct futex_q *q = filp->private_data;
741 poll_wait(filp, &q->waiters, wait);
744 * list_empty() is safe here without any lock.
745 * q->lock_ptr != 0 is not safe, because of ordering against wakeup.
747 if (list_empty(&q->list))
748 ret = POLLIN | POLLRDNORM;
753 static struct file_operations futex_fops = {
754 .release = futex_close,
759 * Signal allows caller to avoid the race which would occur if they
760 * set the sigio stuff up afterwards.
762 static int futex_fd(unsigned long uaddr, int signal)
769 if (!valid_signal(signal))
772 ret = get_unused_fd();
775 filp = get_empty_filp();
781 filp->f_op = &futex_fops;
782 filp->f_vfsmnt = mntget(futex_mnt);
783 filp->f_dentry = dget(futex_mnt->mnt_root);
784 filp->f_mapping = filp->f_dentry->d_inode->i_mapping;
787 err = f_setown(filp, current->pid, 1);
791 filp->f_owner.signum = signal;
794 q = kmalloc(sizeof(*q), GFP_KERNEL);
800 down_read(¤t->mm->mmap_sem);
801 err = get_futex_key(uaddr, &q->key);
803 if (unlikely(err != 0)) {
804 up_read(¤t->mm->mmap_sem);
810 * queue_me() must be called before releasing mmap_sem, because
811 * key->shared.inode needs to be referenced while holding it.
813 filp->private_data = q;
815 queue_me(q, ret, filp);
816 up_read(¤t->mm->mmap_sem);
818 /* Now we map fd to filp, so userspace can access it */
819 fd_install(ret, filp);
829 long do_futex(unsigned long uaddr, int op, int val, unsigned long timeout,
830 unsigned long uaddr2, int val2, int val3)
836 ret = futex_wait(uaddr, val, timeout);
839 ret = futex_wake(uaddr, val);
842 /* non-zero val means F_SETOWN(getpid()) & F_SETSIG(val) */
843 ret = futex_fd(uaddr, val);
846 ret = futex_requeue(uaddr, uaddr2, val, val2, NULL);
848 case FUTEX_CMP_REQUEUE:
849 ret = futex_requeue(uaddr, uaddr2, val, val2, &val3);
852 ret = futex_wake_op(uaddr, uaddr2, val, val2, val3);
861 asmlinkage long sys_futex(u32 __user *uaddr, int op, int val,
862 struct timespec __user *utime, u32 __user *uaddr2,
866 unsigned long timeout = MAX_SCHEDULE_TIMEOUT;
869 if ((op == FUTEX_WAIT) && utime) {
870 if (copy_from_user(&t, utime, sizeof(t)) != 0)
872 timeout = timespec_to_jiffies(&t) + 1;
875 * requeue parameter in 'utime' if op == FUTEX_REQUEUE.
877 if (op >= FUTEX_REQUEUE)
878 val2 = (int) (unsigned long) utime;
880 return do_futex((unsigned long)uaddr, op, val, timeout,
881 (unsigned long)uaddr2, val2, val3);
884 static struct super_block *
885 futexfs_get_sb(struct file_system_type *fs_type,
886 int flags, const char *dev_name, void *data)
888 return get_sb_pseudo(fs_type, "futex", NULL, 0xBAD1DEA);
891 static struct file_system_type futex_fs_type = {
893 .get_sb = futexfs_get_sb,
894 .kill_sb = kill_anon_super,
897 static int __init init(void)
901 register_filesystem(&futex_fs_type);
902 futex_mnt = kern_mount(&futex_fs_type);
904 for (i = 0; i < ARRAY_SIZE(futex_queues); i++) {
905 INIT_LIST_HEAD(&futex_queues[i].chain);
906 spin_lock_init(&futex_queues[i].lock);