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 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>
42 #define FUTEX_HASHBITS 8
45 * Futexes are matched on equal values of this key.
46 * The key type depends on whether it's a shared or private mapping.
47 * Don't rearrange members without looking at hash_futex().
49 * offset is aligned to a multiple of sizeof(u32) (== 4) by definition.
50 * We set bit 0 to indicate if it's an inode-based key.
71 * We use this hashed waitqueue instead of a normal wait_queue_t, so
72 * we can wake only the relevant ones (hashed queues may be shared).
74 * A futex_q has a woken state, just like tasks have TASK_RUNNING.
75 * It is considered woken when list_empty(&q->list) || q->lock_ptr == 0.
76 * The order of wakup is always to make the first condition true, then
77 * wake up q->waiters, then make the second condition true.
80 struct list_head list;
81 wait_queue_head_t waiters;
83 /* Which hash list lock to use. */
86 /* Key which the futex is hashed on. */
89 /* For fd, sigio sent using these. */
95 * Split the global futex_lock into every hash list lock.
97 struct futex_hash_bucket {
99 struct list_head chain;
102 static struct futex_hash_bucket futex_queues[1<<FUTEX_HASHBITS];
104 /* Futex-fs vfsmount entry: */
105 static struct vfsmount *futex_mnt;
108 * We hash on the keys returned from get_futex_key (see below).
110 static struct futex_hash_bucket *hash_futex(union futex_key *key)
112 u32 hash = jhash2((u32*)&key->both.word,
113 (sizeof(key->both.word)+sizeof(key->both.ptr))/4,
115 return &futex_queues[hash & ((1 << FUTEX_HASHBITS)-1)];
119 * Return 1 if two futex_keys are equal, 0 otherwise.
121 static inline int match_futex(union futex_key *key1, union futex_key *key2)
123 return (key1->both.word == key2->both.word
124 && key1->both.ptr == key2->both.ptr
125 && key1->both.offset == key2->both.offset);
129 * Get parameters which are the keys for a futex.
131 * For shared mappings, it's (page->index, vma->vm_file->f_dentry->d_inode,
132 * offset_within_page). For private mappings, it's (uaddr, current->mm).
133 * We can usually work out the index without swapping in the page.
135 * Returns: 0, or negative error code.
136 * The key words are stored in *key on success.
138 * Should be called with ¤t->mm->mmap_sem but NOT any spinlocks.
140 static int get_futex_key(unsigned long uaddr, union futex_key *key)
142 struct mm_struct *mm = current->mm;
143 struct vm_area_struct *vma;
148 * The futex address must be "naturally" aligned.
150 key->both.offset = uaddr % PAGE_SIZE;
151 if (unlikely((key->both.offset % sizeof(u32)) != 0))
153 uaddr -= key->both.offset;
156 * The futex is hashed differently depending on whether
157 * it's in a shared or private mapping. So check vma first.
159 vma = find_extend_vma(mm, uaddr);
166 if (unlikely((vma->vm_flags & (VM_IO|VM_READ)) != VM_READ))
167 return (vma->vm_flags & VM_IO) ? -EPERM : -EACCES;
170 * Private mappings are handled in a simple way.
172 * NOTE: When userspace waits on a MAP_SHARED mapping, even if
173 * it's a read-only handle, it's expected that futexes attach to
174 * the object not the particular process. Therefore we use
175 * VM_MAYSHARE here, not VM_SHARED which is restricted to shared
176 * mappings of _writable_ handles.
178 if (likely(!(vma->vm_flags & VM_MAYSHARE))) {
179 key->private.mm = mm;
180 key->private.uaddr = uaddr;
185 * Linear file mappings are also simple.
187 key->shared.inode = vma->vm_file->f_dentry->d_inode;
188 key->both.offset++; /* Bit 0 of offset indicates inode-based key. */
189 if (likely(!(vma->vm_flags & VM_NONLINEAR))) {
190 key->shared.pgoff = (((uaddr - vma->vm_start) >> PAGE_SHIFT)
196 * We could walk the page table to read the non-linear
197 * pte, and get the page index without fetching the page
198 * from swap. But that's a lot of code to duplicate here
199 * for a rare case, so we simply fetch the page.
203 * Do a quick atomic lookup first - this is the fastpath.
205 spin_lock(¤t->mm->page_table_lock);
206 page = follow_page(mm, uaddr, 0);
207 if (likely(page != NULL)) {
209 page->index << (PAGE_CACHE_SHIFT - PAGE_SHIFT);
210 spin_unlock(¤t->mm->page_table_lock);
213 spin_unlock(¤t->mm->page_table_lock);
216 * Do it the general way.
218 err = get_user_pages(current, mm, uaddr, 1, 0, 0, &page, NULL);
221 page->index << (PAGE_CACHE_SHIFT - PAGE_SHIFT);
229 * Take a reference to the resource addressed by a key.
230 * Can be called while holding spinlocks.
232 * NOTE: mmap_sem MUST be held between get_futex_key() and calling this
233 * function, if it is called at all. mmap_sem keeps key->shared.inode valid.
235 static inline void get_key_refs(union futex_key *key)
237 if (key->both.ptr != 0) {
238 if (key->both.offset & 1)
239 atomic_inc(&key->shared.inode->i_count);
241 atomic_inc(&key->private.mm->mm_count);
246 * Drop a reference to the resource addressed by a key.
247 * The hash bucket spinlock must not be held.
249 static void drop_key_refs(union futex_key *key)
251 if (key->both.ptr != 0) {
252 if (key->both.offset & 1)
253 iput(key->shared.inode);
255 mmdrop(key->private.mm);
260 * The hash bucket lock must be held when this is called.
261 * Afterwards, the futex_q must not be accessed.
263 static void wake_futex(struct futex_q *q)
265 list_del_init(&q->list);
267 send_sigio(&q->filp->f_owner, q->fd, POLL_IN);
269 * The lock in wake_up_all() is a crucial memory barrier after the
270 * list_del_init() and also before assigning to q->lock_ptr.
272 wake_up_all(&q->waiters);
274 * The waiting task can free the futex_q as soon as this is written,
275 * without taking any locks. This must come last.
281 * Wake up all waiters hashed on the physical page that is mapped
282 * to this virtual address:
284 static int futex_wake(unsigned long uaddr, int nr_wake)
287 struct futex_hash_bucket *bh;
288 struct list_head *head;
289 struct futex_q *this, *next;
292 down_read(¤t->mm->mmap_sem);
294 ret = get_futex_key(uaddr, &key);
295 if (unlikely(ret != 0))
298 bh = hash_futex(&key);
299 spin_lock(&bh->lock);
302 list_for_each_entry_safe(this, next, head, list) {
303 if (match_futex (&this->key, &key)) {
305 if (++ret >= nr_wake)
310 spin_unlock(&bh->lock);
312 up_read(¤t->mm->mmap_sem);
317 * Requeue all waiters hashed on one physical page to another
320 static int futex_requeue(unsigned long uaddr1, unsigned long uaddr2,
321 int nr_wake, int nr_requeue)
323 union futex_key key1, key2;
324 struct futex_hash_bucket *bh1, *bh2;
325 struct list_head *head1;
326 struct futex_q *this, *next;
327 int ret, drop_count = 0;
329 down_read(¤t->mm->mmap_sem);
331 ret = get_futex_key(uaddr1, &key1);
332 if (unlikely(ret != 0))
334 ret = get_futex_key(uaddr2, &key2);
335 if (unlikely(ret != 0))
338 bh1 = hash_futex(&key1);
339 bh2 = hash_futex(&key2);
342 spin_lock(&bh1->lock);
343 spin_lock(&bh2->lock);
345 spin_lock(&bh1->lock);
348 list_for_each_entry_safe(this, next, head1, list) {
349 if (!match_futex (&this->key, &key1))
351 if (++ret <= nr_wake) {
354 list_move_tail(&this->list, &bh2->chain);
355 this->lock_ptr = &bh2->lock;
360 if (ret - nr_wake >= nr_requeue)
362 /* Make sure to stop if key1 == key2 */
363 if (head1 == &bh2->chain && head1 != &next->list)
368 spin_unlock(&bh1->lock);
370 spin_unlock(&bh2->lock);
372 /* drop_key_refs() must be called outside the spinlocks. */
373 while (--drop_count >= 0)
374 drop_key_refs(&key1);
377 up_read(¤t->mm->mmap_sem);
382 * queue_me and unqueue_me must be called as a pair, each
383 * exactly once. They are called with the hashed spinlock held.
386 /* The key must be already stored in q->key. */
387 static void queue_me(struct futex_q *q, int fd, struct file *filp)
389 struct futex_hash_bucket *bh;
394 init_waitqueue_head(&q->waiters);
396 get_key_refs(&q->key);
397 bh = hash_futex(&q->key);
398 q->lock_ptr = &bh->lock;
400 spin_lock(&bh->lock);
401 list_add_tail(&q->list, &bh->chain);
402 spin_unlock(&bh->lock);
405 /* Return 1 if we were still queued (ie. 0 means we were woken) */
406 static int unqueue_me(struct futex_q *q)
409 spinlock_t *lock_ptr;
411 /* In the common case we don't take the spinlock, which is nice. */
413 lock_ptr = q->lock_ptr;
417 * q->lock_ptr can change between reading it and
418 * spin_lock(), causing us to take the wrong lock. This
419 * corrects the race condition.
421 * Reasoning goes like this: if we have the wrong lock,
422 * q->lock_ptr must have changed (maybe several times)
423 * between reading it and the spin_lock(). It can
424 * change again after the spin_lock() but only if it was
425 * already changed before the spin_lock(). It cannot,
426 * however, change back to the original value. Therefore
427 * we can detect whether we acquired the correct lock.
429 if (unlikely(lock_ptr != q->lock_ptr)) {
430 spin_unlock(lock_ptr);
433 WARN_ON(list_empty(&q->list));
435 spin_unlock(lock_ptr);
439 drop_key_refs(&q->key);
443 static int futex_wait(unsigned long uaddr, int val, unsigned long time)
445 DECLARE_WAITQUEUE(wait, current);
449 down_read(¤t->mm->mmap_sem);
451 ret = get_futex_key(uaddr, &q.key);
452 if (unlikely(ret != 0))
453 goto out_release_sem;
455 queue_me(&q, -1, NULL);
458 * Access the page after the futex is queued.
459 * We hold the mmap semaphore, so the mapping cannot have changed
460 * since we looked it up.
462 if (get_user(curval, (int __user *)uaddr) != 0) {
472 * Now the futex is queued and we have checked the data, we
473 * don't want to hold mmap_sem while we sleep.
475 up_read(¤t->mm->mmap_sem);
478 * There might have been scheduling since the queue_me(), as we
479 * cannot hold a spinlock across the get_user() in case it
480 * faults, and we cannot just set TASK_INTERRUPTIBLE state when
481 * queueing ourselves into the futex hash. This code thus has to
482 * rely on the futex_wake() code removing us from hash when it
486 /* add_wait_queue is the barrier after __set_current_state. */
487 __set_current_state(TASK_INTERRUPTIBLE);
488 add_wait_queue(&q.waiters, &wait);
490 * !list_empty() is safe here without any lock.
491 * q.lock_ptr != 0 is not safe, because of ordering against wakeup.
493 if (likely(!list_empty(&q.list)))
494 time = schedule_timeout(time);
495 __set_current_state(TASK_RUNNING);
498 * NOTE: we don't remove ourselves from the waitqueue because
499 * we are the only user of it.
502 /* If we were woken (and unqueued), we succeeded, whatever. */
507 /* A spurious wakeup should never happen. */
508 WARN_ON(!signal_pending(current));
512 /* If we were woken (and unqueued), we succeeded, whatever. */
516 up_read(¤t->mm->mmap_sem);
520 static int futex_close(struct inode *inode, struct file *filp)
522 struct futex_q *q = filp->private_data;
529 /* This is one-shot: once it's gone off you need a new fd */
530 static unsigned int futex_poll(struct file *filp,
531 struct poll_table_struct *wait)
533 struct futex_q *q = filp->private_data;
536 poll_wait(filp, &q->waiters, wait);
539 * list_empty() is safe here without any lock.
540 * q->lock_ptr != 0 is not safe, because of ordering against wakeup.
542 if (list_empty(&q->list))
543 ret = POLLIN | POLLRDNORM;
548 static struct file_operations futex_fops = {
549 .release = futex_close,
554 * Signal allows caller to avoid the race which would occur if they
555 * set the sigio stuff up afterwards.
557 static int futex_fd(unsigned long uaddr, int signal)
564 if (signal < 0 || signal > _NSIG)
567 ret = get_unused_fd();
570 filp = get_empty_filp();
576 filp->f_op = &futex_fops;
577 filp->f_vfsmnt = mntget(futex_mnt);
578 filp->f_dentry = dget(futex_mnt->mnt_root);
579 filp->f_mapping = filp->f_dentry->d_inode->i_mapping;
583 err = f_setown(filp, current->pid, 1);
590 filp->f_owner.signum = signal;
593 q = kmalloc(sizeof(*q), GFP_KERNEL);
601 down_read(¤t->mm->mmap_sem);
602 err = get_futex_key(uaddr, &q->key);
604 if (unlikely(err != 0)) {
605 up_read(¤t->mm->mmap_sem);
613 * queue_me() must be called before releasing mmap_sem, because
614 * key->shared.inode needs to be referenced while holding it.
616 filp->private_data = q;
618 queue_me(q, ret, filp);
619 up_read(¤t->mm->mmap_sem);
621 /* Now we map fd to filp, so userspace can access it */
622 fd_install(ret, filp);
627 long do_futex(unsigned long uaddr, int op, int val, unsigned long timeout,
628 unsigned long uaddr2, int val2)
634 ret = futex_wait(uaddr, val, timeout);
637 ret = futex_wake(uaddr, val);
640 /* non-zero val means F_SETOWN(getpid()) & F_SETSIG(val) */
641 ret = futex_fd(uaddr, val);
644 ret = futex_requeue(uaddr, uaddr2, val, val2);
653 asmlinkage long sys_futex(u32 __user *uaddr, int op, int val,
654 struct timespec __user *utime, u32 __user *uaddr2)
657 unsigned long timeout = MAX_SCHEDULE_TIMEOUT;
660 if ((op == FUTEX_WAIT) && utime) {
661 if (copy_from_user(&t, utime, sizeof(t)) != 0)
663 timeout = timespec_to_jiffies(&t) + 1;
666 * requeue parameter in 'utime' if op == FUTEX_REQUEUE.
668 if (op == FUTEX_REQUEUE)
669 val2 = (int) (long) utime;
671 return do_futex((unsigned long)uaddr, op, val, timeout,
672 (unsigned long)uaddr2, val2);
675 static struct super_block *
676 futexfs_get_sb(struct file_system_type *fs_type,
677 int flags, const char *dev_name, void *data)
679 return get_sb_pseudo(fs_type, "futex", NULL, 0xBAD1DEA);
682 static struct file_system_type futex_fs_type = {
684 .get_sb = futexfs_get_sb,
685 .kill_sb = kill_anon_super,
688 static int __init init(void)
692 register_filesystem(&futex_fs_type);
693 futex_mnt = kern_mount(&futex_fs_type);
695 for (i = 0; i < ARRAY_SIZE(futex_queues); i++) {
696 INIT_LIST_HEAD(&futex_queues[i].chain);
697 futex_queues[i].lock = SPIN_LOCK_UNLOCKED;