futex.c 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912
  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. * 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.
  14. *
  15. * "The futexes are also cursed."
  16. * "But they come in a choice of three flavours!"
  17. *
  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.
  22. *
  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.
  27. *
  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
  31. */
  32. #include <linux/slab.h>
  33. #include <linux/poll.h>
  34. #include <linux/fs.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>
  44. #define FUTEX_HASHBITS (CONFIG_BASE_SMALL ? 4 : 8)
  45. /*
  46. * Futexes are matched on equal values of this key.
  47. * The key type depends on whether it's a shared or private mapping.
  48. * Don't rearrange members without looking at hash_futex().
  49. *
  50. * offset is aligned to a multiple of sizeof(u32) (== 4) by definition.
  51. * We set bit 0 to indicate if it's an inode-based key.
  52. */
  53. union futex_key {
  54. struct {
  55. unsigned long pgoff;
  56. struct inode *inode;
  57. int offset;
  58. } shared;
  59. struct {
  60. unsigned long uaddr;
  61. struct mm_struct *mm;
  62. int offset;
  63. } private;
  64. struct {
  65. unsigned long word;
  66. void *ptr;
  67. int offset;
  68. } both;
  69. };
  70. /*
  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).
  73. *
  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.
  78. */
  79. struct futex_q {
  80. struct list_head list;
  81. wait_queue_head_t waiters;
  82. /* Which hash list lock to use. */
  83. spinlock_t *lock_ptr;
  84. /* Key which the futex is hashed on. */
  85. union futex_key key;
  86. /* For fd, sigio sent using these. */
  87. int fd;
  88. struct file *filp;
  89. };
  90. /*
  91. * Split the global futex_lock into every hash list lock.
  92. */
  93. struct futex_hash_bucket {
  94. spinlock_t lock;
  95. struct list_head chain;
  96. };
  97. static struct futex_hash_bucket futex_queues[1<<FUTEX_HASHBITS];
  98. /* Futex-fs vfsmount entry: */
  99. static struct vfsmount *futex_mnt;
  100. /*
  101. * We hash on the keys returned from get_futex_key (see below).
  102. */
  103. static struct futex_hash_bucket *hash_futex(union futex_key *key)
  104. {
  105. u32 hash = jhash2((u32*)&key->both.word,
  106. (sizeof(key->both.word)+sizeof(key->both.ptr))/4,
  107. key->both.offset);
  108. return &futex_queues[hash & ((1 << FUTEX_HASHBITS)-1)];
  109. }
  110. /*
  111. * Return 1 if two futex_keys are equal, 0 otherwise.
  112. */
  113. static inline int match_futex(union futex_key *key1, union futex_key *key2)
  114. {
  115. return (key1->both.word == key2->both.word
  116. && key1->both.ptr == key2->both.ptr
  117. && key1->both.offset == key2->both.offset);
  118. }
  119. /*
  120. * Get parameters which are the keys for a futex.
  121. *
  122. * For shared mappings, it's (page->index, vma->vm_file->f_dentry->d_inode,
  123. * offset_within_page). For private mappings, it's (uaddr, current->mm).
  124. * We can usually work out the index without swapping in the page.
  125. *
  126. * Returns: 0, or negative error code.
  127. * The key words are stored in *key on success.
  128. *
  129. * Should be called with &current->mm->mmap_sem but NOT any spinlocks.
  130. */
  131. static int get_futex_key(unsigned long uaddr, union futex_key *key)
  132. {
  133. struct mm_struct *mm = current->mm;
  134. struct vm_area_struct *vma;
  135. struct page *page;
  136. int err;
  137. /*
  138. * The futex address must be "naturally" aligned.
  139. */
  140. key->both.offset = uaddr % PAGE_SIZE;
  141. if (unlikely((key->both.offset % sizeof(u32)) != 0))
  142. return -EINVAL;
  143. uaddr -= key->both.offset;
  144. /*
  145. * The futex is hashed differently depending on whether
  146. * it's in a shared or private mapping. So check vma first.
  147. */
  148. vma = find_extend_vma(mm, uaddr);
  149. if (unlikely(!vma))
  150. return -EFAULT;
  151. /*
  152. * Permissions.
  153. */
  154. if (unlikely((vma->vm_flags & (VM_IO|VM_READ)) != VM_READ))
  155. return (vma->vm_flags & VM_IO) ? -EPERM : -EACCES;
  156. /*
  157. * Private mappings are handled in a simple way.
  158. *
  159. * NOTE: When userspace waits on a MAP_SHARED mapping, even if
  160. * it's a read-only handle, it's expected that futexes attach to
  161. * the object not the particular process. Therefore we use
  162. * VM_MAYSHARE here, not VM_SHARED which is restricted to shared
  163. * mappings of _writable_ handles.
  164. */
  165. if (likely(!(vma->vm_flags & VM_MAYSHARE))) {
  166. key->private.mm = mm;
  167. key->private.uaddr = uaddr;
  168. return 0;
  169. }
  170. /*
  171. * Linear file mappings are also simple.
  172. */
  173. key->shared.inode = vma->vm_file->f_dentry->d_inode;
  174. key->both.offset++; /* Bit 0 of offset indicates inode-based key. */
  175. if (likely(!(vma->vm_flags & VM_NONLINEAR))) {
  176. key->shared.pgoff = (((uaddr - vma->vm_start) >> PAGE_SHIFT)
  177. + vma->vm_pgoff);
  178. return 0;
  179. }
  180. /*
  181. * We could walk the page table to read the non-linear
  182. * pte, and get the page index without fetching the page
  183. * from swap. But that's a lot of code to duplicate here
  184. * for a rare case, so we simply fetch the page.
  185. */
  186. /*
  187. * Do a quick atomic lookup first - this is the fastpath.
  188. */
  189. spin_lock(&current->mm->page_table_lock);
  190. page = follow_page(mm, uaddr, 0);
  191. if (likely(page != NULL)) {
  192. key->shared.pgoff =
  193. page->index << (PAGE_CACHE_SHIFT - PAGE_SHIFT);
  194. spin_unlock(&current->mm->page_table_lock);
  195. return 0;
  196. }
  197. spin_unlock(&current->mm->page_table_lock);
  198. /*
  199. * Do it the general way.
  200. */
  201. err = get_user_pages(current, mm, uaddr, 1, 0, 0, &page, NULL);
  202. if (err >= 0) {
  203. key->shared.pgoff =
  204. page->index << (PAGE_CACHE_SHIFT - PAGE_SHIFT);
  205. put_page(page);
  206. return 0;
  207. }
  208. return err;
  209. }
  210. /*
  211. * Take a reference to the resource addressed by a key.
  212. * Can be called while holding spinlocks.
  213. *
  214. * NOTE: mmap_sem MUST be held between get_futex_key() and calling this
  215. * function, if it is called at all. mmap_sem keeps key->shared.inode valid.
  216. */
  217. static inline void get_key_refs(union futex_key *key)
  218. {
  219. if (key->both.ptr != 0) {
  220. if (key->both.offset & 1)
  221. atomic_inc(&key->shared.inode->i_count);
  222. else
  223. atomic_inc(&key->private.mm->mm_count);
  224. }
  225. }
  226. /*
  227. * Drop a reference to the resource addressed by a key.
  228. * The hash bucket spinlock must not be held.
  229. */
  230. static void drop_key_refs(union futex_key *key)
  231. {
  232. if (key->both.ptr != 0) {
  233. if (key->both.offset & 1)
  234. iput(key->shared.inode);
  235. else
  236. mmdrop(key->private.mm);
  237. }
  238. }
  239. static inline int get_futex_value_locked(int *dest, int __user *from)
  240. {
  241. int ret;
  242. inc_preempt_count();
  243. ret = __copy_from_user_inatomic(dest, from, sizeof(int));
  244. dec_preempt_count();
  245. return ret ? -EFAULT : 0;
  246. }
  247. /*
  248. * The hash bucket lock must be held when this is called.
  249. * Afterwards, the futex_q must not be accessed.
  250. */
  251. static void wake_futex(struct futex_q *q)
  252. {
  253. list_del_init(&q->list);
  254. if (q->filp)
  255. send_sigio(&q->filp->f_owner, q->fd, POLL_IN);
  256. /*
  257. * The lock in wake_up_all() is a crucial memory barrier after the
  258. * list_del_init() and also before assigning to q->lock_ptr.
  259. */
  260. wake_up_all(&q->waiters);
  261. /*
  262. * The waiting task can free the futex_q as soon as this is written,
  263. * without taking any locks. This must come last.
  264. */
  265. q->lock_ptr = NULL;
  266. }
  267. /*
  268. * Wake up all waiters hashed on the physical page that is mapped
  269. * to this virtual address:
  270. */
  271. static int futex_wake(unsigned long uaddr, int nr_wake)
  272. {
  273. union futex_key key;
  274. struct futex_hash_bucket *bh;
  275. struct list_head *head;
  276. struct futex_q *this, *next;
  277. int ret;
  278. down_read(&current->mm->mmap_sem);
  279. ret = get_futex_key(uaddr, &key);
  280. if (unlikely(ret != 0))
  281. goto out;
  282. bh = hash_futex(&key);
  283. spin_lock(&bh->lock);
  284. head = &bh->chain;
  285. list_for_each_entry_safe(this, next, head, list) {
  286. if (match_futex (&this->key, &key)) {
  287. wake_futex(this);
  288. if (++ret >= nr_wake)
  289. break;
  290. }
  291. }
  292. spin_unlock(&bh->lock);
  293. out:
  294. up_read(&current->mm->mmap_sem);
  295. return ret;
  296. }
  297. /*
  298. * Wake up all waiters hashed on the physical page that is mapped
  299. * to this virtual address:
  300. */
  301. static int futex_wake_op(unsigned long uaddr1, unsigned long uaddr2, int nr_wake, int nr_wake2, int op)
  302. {
  303. union futex_key key1, key2;
  304. struct futex_hash_bucket *bh1, *bh2;
  305. struct list_head *head;
  306. struct futex_q *this, *next;
  307. int ret, op_ret, attempt = 0;
  308. retryfull:
  309. down_read(&current->mm->mmap_sem);
  310. ret = get_futex_key(uaddr1, &key1);
  311. if (unlikely(ret != 0))
  312. goto out;
  313. ret = get_futex_key(uaddr2, &key2);
  314. if (unlikely(ret != 0))
  315. goto out;
  316. bh1 = hash_futex(&key1);
  317. bh2 = hash_futex(&key2);
  318. retry:
  319. if (bh1 < bh2)
  320. spin_lock(&bh1->lock);
  321. spin_lock(&bh2->lock);
  322. if (bh1 > bh2)
  323. spin_lock(&bh1->lock);
  324. op_ret = futex_atomic_op_inuser(op, (int __user *)uaddr2);
  325. if (unlikely(op_ret < 0)) {
  326. int dummy;
  327. spin_unlock(&bh1->lock);
  328. if (bh1 != bh2)
  329. spin_unlock(&bh2->lock);
  330. /* futex_atomic_op_inuser needs to both read and write
  331. * *(int __user *)uaddr2, but we can't modify it
  332. * non-atomically. Therefore, if get_user below is not
  333. * enough, we need to handle the fault ourselves, while
  334. * still holding the mmap_sem. */
  335. if (attempt++) {
  336. struct vm_area_struct * vma;
  337. struct mm_struct *mm = current->mm;
  338. ret = -EFAULT;
  339. if (attempt >= 2 ||
  340. !(vma = find_vma(mm, uaddr2)) ||
  341. vma->vm_start > uaddr2 ||
  342. !(vma->vm_flags & VM_WRITE))
  343. goto out;
  344. switch (handle_mm_fault(mm, vma, uaddr2, 1)) {
  345. case VM_FAULT_MINOR:
  346. current->min_flt++;
  347. break;
  348. case VM_FAULT_MAJOR:
  349. current->maj_flt++;
  350. break;
  351. default:
  352. goto out;
  353. }
  354. goto retry;
  355. }
  356. /* If we would have faulted, release mmap_sem,
  357. * fault it in and start all over again. */
  358. up_read(&current->mm->mmap_sem);
  359. ret = get_user(dummy, (int __user *)uaddr2);
  360. if (ret)
  361. return ret;
  362. goto retryfull;
  363. }
  364. head = &bh1->chain;
  365. list_for_each_entry_safe(this, next, head, list) {
  366. if (match_futex (&this->key, &key1)) {
  367. wake_futex(this);
  368. if (++ret >= nr_wake)
  369. break;
  370. }
  371. }
  372. if (op_ret > 0) {
  373. head = &bh2->chain;
  374. op_ret = 0;
  375. list_for_each_entry_safe(this, next, head, list) {
  376. if (match_futex (&this->key, &key2)) {
  377. wake_futex(this);
  378. if (++op_ret >= nr_wake2)
  379. break;
  380. }
  381. }
  382. ret += op_ret;
  383. }
  384. spin_unlock(&bh1->lock);
  385. if (bh1 != bh2)
  386. spin_unlock(&bh2->lock);
  387. out:
  388. up_read(&current->mm->mmap_sem);
  389. return ret;
  390. }
  391. /*
  392. * Requeue all waiters hashed on one physical page to another
  393. * physical page.
  394. */
  395. static int futex_requeue(unsigned long uaddr1, unsigned long uaddr2,
  396. int nr_wake, int nr_requeue, int *valp)
  397. {
  398. union futex_key key1, key2;
  399. struct futex_hash_bucket *bh1, *bh2;
  400. struct list_head *head1;
  401. struct futex_q *this, *next;
  402. int ret, drop_count = 0;
  403. retry:
  404. down_read(&current->mm->mmap_sem);
  405. ret = get_futex_key(uaddr1, &key1);
  406. if (unlikely(ret != 0))
  407. goto out;
  408. ret = get_futex_key(uaddr2, &key2);
  409. if (unlikely(ret != 0))
  410. goto out;
  411. bh1 = hash_futex(&key1);
  412. bh2 = hash_futex(&key2);
  413. if (bh1 < bh2)
  414. spin_lock(&bh1->lock);
  415. spin_lock(&bh2->lock);
  416. if (bh1 > bh2)
  417. spin_lock(&bh1->lock);
  418. if (likely(valp != NULL)) {
  419. int curval;
  420. ret = get_futex_value_locked(&curval, (int __user *)uaddr1);
  421. if (unlikely(ret)) {
  422. spin_unlock(&bh1->lock);
  423. if (bh1 != bh2)
  424. spin_unlock(&bh2->lock);
  425. /* If we would have faulted, release mmap_sem, fault
  426. * it in and start all over again.
  427. */
  428. up_read(&current->mm->mmap_sem);
  429. ret = get_user(curval, (int __user *)uaddr1);
  430. if (!ret)
  431. goto retry;
  432. return ret;
  433. }
  434. if (curval != *valp) {
  435. ret = -EAGAIN;
  436. goto out_unlock;
  437. }
  438. }
  439. head1 = &bh1->chain;
  440. list_for_each_entry_safe(this, next, head1, list) {
  441. if (!match_futex (&this->key, &key1))
  442. continue;
  443. if (++ret <= nr_wake) {
  444. wake_futex(this);
  445. } else {
  446. list_move_tail(&this->list, &bh2->chain);
  447. this->lock_ptr = &bh2->lock;
  448. this->key = key2;
  449. get_key_refs(&key2);
  450. drop_count++;
  451. if (ret - nr_wake >= nr_requeue)
  452. break;
  453. /* Make sure to stop if key1 == key2 */
  454. if (head1 == &bh2->chain && head1 != &next->list)
  455. head1 = &this->list;
  456. }
  457. }
  458. out_unlock:
  459. spin_unlock(&bh1->lock);
  460. if (bh1 != bh2)
  461. spin_unlock(&bh2->lock);
  462. /* drop_key_refs() must be called outside the spinlocks. */
  463. while (--drop_count >= 0)
  464. drop_key_refs(&key1);
  465. out:
  466. up_read(&current->mm->mmap_sem);
  467. return ret;
  468. }
  469. /* The key must be already stored in q->key. */
  470. static inline struct futex_hash_bucket *
  471. queue_lock(struct futex_q *q, int fd, struct file *filp)
  472. {
  473. struct futex_hash_bucket *bh;
  474. q->fd = fd;
  475. q->filp = filp;
  476. init_waitqueue_head(&q->waiters);
  477. get_key_refs(&q->key);
  478. bh = hash_futex(&q->key);
  479. q->lock_ptr = &bh->lock;
  480. spin_lock(&bh->lock);
  481. return bh;
  482. }
  483. static inline void __queue_me(struct futex_q *q, struct futex_hash_bucket *bh)
  484. {
  485. list_add_tail(&q->list, &bh->chain);
  486. spin_unlock(&bh->lock);
  487. }
  488. static inline void
  489. queue_unlock(struct futex_q *q, struct futex_hash_bucket *bh)
  490. {
  491. spin_unlock(&bh->lock);
  492. drop_key_refs(&q->key);
  493. }
  494. /*
  495. * queue_me and unqueue_me must be called as a pair, each
  496. * exactly once. They are called with the hashed spinlock held.
  497. */
  498. /* The key must be already stored in q->key. */
  499. static void queue_me(struct futex_q *q, int fd, struct file *filp)
  500. {
  501. struct futex_hash_bucket *bh;
  502. bh = queue_lock(q, fd, filp);
  503. __queue_me(q, bh);
  504. }
  505. /* Return 1 if we were still queued (ie. 0 means we were woken) */
  506. static int unqueue_me(struct futex_q *q)
  507. {
  508. int ret = 0;
  509. spinlock_t *lock_ptr;
  510. /* In the common case we don't take the spinlock, which is nice. */
  511. retry:
  512. lock_ptr = q->lock_ptr;
  513. if (lock_ptr != 0) {
  514. spin_lock(lock_ptr);
  515. /*
  516. * q->lock_ptr can change between reading it and
  517. * spin_lock(), causing us to take the wrong lock. This
  518. * corrects the race condition.
  519. *
  520. * Reasoning goes like this: if we have the wrong lock,
  521. * q->lock_ptr must have changed (maybe several times)
  522. * between reading it and the spin_lock(). It can
  523. * change again after the spin_lock() but only if it was
  524. * already changed before the spin_lock(). It cannot,
  525. * however, change back to the original value. Therefore
  526. * we can detect whether we acquired the correct lock.
  527. */
  528. if (unlikely(lock_ptr != q->lock_ptr)) {
  529. spin_unlock(lock_ptr);
  530. goto retry;
  531. }
  532. WARN_ON(list_empty(&q->list));
  533. list_del(&q->list);
  534. spin_unlock(lock_ptr);
  535. ret = 1;
  536. }
  537. drop_key_refs(&q->key);
  538. return ret;
  539. }
  540. static int futex_wait(unsigned long uaddr, int val, unsigned long time)
  541. {
  542. DECLARE_WAITQUEUE(wait, current);
  543. int ret, curval;
  544. struct futex_q q;
  545. struct futex_hash_bucket *bh;
  546. retry:
  547. down_read(&current->mm->mmap_sem);
  548. ret = get_futex_key(uaddr, &q.key);
  549. if (unlikely(ret != 0))
  550. goto out_release_sem;
  551. bh = queue_lock(&q, -1, NULL);
  552. /*
  553. * Access the page AFTER the futex is queued.
  554. * Order is important:
  555. *
  556. * Userspace waiter: val = var; if (cond(val)) futex_wait(&var, val);
  557. * Userspace waker: if (cond(var)) { var = new; futex_wake(&var); }
  558. *
  559. * The basic logical guarantee of a futex is that it blocks ONLY
  560. * if cond(var) is known to be true at the time of blocking, for
  561. * any cond. If we queued after testing *uaddr, that would open
  562. * a race condition where we could block indefinitely with
  563. * cond(var) false, which would violate the guarantee.
  564. *
  565. * A consequence is that futex_wait() can return zero and absorb
  566. * a wakeup when *uaddr != val on entry to the syscall. This is
  567. * rare, but normal.
  568. *
  569. * We hold the mmap semaphore, so the mapping cannot have changed
  570. * since we looked it up in get_futex_key.
  571. */
  572. ret = get_futex_value_locked(&curval, (int __user *)uaddr);
  573. if (unlikely(ret)) {
  574. queue_unlock(&q, bh);
  575. /* If we would have faulted, release mmap_sem, fault it in and
  576. * start all over again.
  577. */
  578. up_read(&current->mm->mmap_sem);
  579. ret = get_user(curval, (int __user *)uaddr);
  580. if (!ret)
  581. goto retry;
  582. return ret;
  583. }
  584. if (curval != val) {
  585. ret = -EWOULDBLOCK;
  586. queue_unlock(&q, bh);
  587. goto out_release_sem;
  588. }
  589. /* Only actually queue if *uaddr contained val. */
  590. __queue_me(&q, bh);
  591. /*
  592. * Now the futex is queued and we have checked the data, we
  593. * don't want to hold mmap_sem while we sleep.
  594. */
  595. up_read(&current->mm->mmap_sem);
  596. /*
  597. * There might have been scheduling since the queue_me(), as we
  598. * cannot hold a spinlock across the get_user() in case it
  599. * faults, and we cannot just set TASK_INTERRUPTIBLE state when
  600. * queueing ourselves into the futex hash. This code thus has to
  601. * rely on the futex_wake() code removing us from hash when it
  602. * wakes us up.
  603. */
  604. /* add_wait_queue is the barrier after __set_current_state. */
  605. __set_current_state(TASK_INTERRUPTIBLE);
  606. add_wait_queue(&q.waiters, &wait);
  607. /*
  608. * !list_empty() is safe here without any lock.
  609. * q.lock_ptr != 0 is not safe, because of ordering against wakeup.
  610. */
  611. if (likely(!list_empty(&q.list)))
  612. time = schedule_timeout(time);
  613. __set_current_state(TASK_RUNNING);
  614. /*
  615. * NOTE: we don't remove ourselves from the waitqueue because
  616. * we are the only user of it.
  617. */
  618. /* If we were woken (and unqueued), we succeeded, whatever. */
  619. if (!unqueue_me(&q))
  620. return 0;
  621. if (time == 0)
  622. return -ETIMEDOUT;
  623. /* We expect signal_pending(current), but another thread may
  624. * have handled it for us already. */
  625. return -EINTR;
  626. out_release_sem:
  627. up_read(&current->mm->mmap_sem);
  628. return ret;
  629. }
  630. static int futex_close(struct inode *inode, struct file *filp)
  631. {
  632. struct futex_q *q = filp->private_data;
  633. unqueue_me(q);
  634. kfree(q);
  635. return 0;
  636. }
  637. /* This is one-shot: once it's gone off you need a new fd */
  638. static unsigned int futex_poll(struct file *filp,
  639. struct poll_table_struct *wait)
  640. {
  641. struct futex_q *q = filp->private_data;
  642. int ret = 0;
  643. poll_wait(filp, &q->waiters, wait);
  644. /*
  645. * list_empty() is safe here without any lock.
  646. * q->lock_ptr != 0 is not safe, because of ordering against wakeup.
  647. */
  648. if (list_empty(&q->list))
  649. ret = POLLIN | POLLRDNORM;
  650. return ret;
  651. }
  652. static struct file_operations futex_fops = {
  653. .release = futex_close,
  654. .poll = futex_poll,
  655. };
  656. /*
  657. * Signal allows caller to avoid the race which would occur if they
  658. * set the sigio stuff up afterwards.
  659. */
  660. static int futex_fd(unsigned long uaddr, int signal)
  661. {
  662. struct futex_q *q;
  663. struct file *filp;
  664. int ret, err;
  665. ret = -EINVAL;
  666. if (!valid_signal(signal))
  667. goto out;
  668. ret = get_unused_fd();
  669. if (ret < 0)
  670. goto out;
  671. filp = get_empty_filp();
  672. if (!filp) {
  673. put_unused_fd(ret);
  674. ret = -ENFILE;
  675. goto out;
  676. }
  677. filp->f_op = &futex_fops;
  678. filp->f_vfsmnt = mntget(futex_mnt);
  679. filp->f_dentry = dget(futex_mnt->mnt_root);
  680. filp->f_mapping = filp->f_dentry->d_inode->i_mapping;
  681. if (signal) {
  682. err = f_setown(filp, current->pid, 1);
  683. if (err < 0) {
  684. goto error;
  685. }
  686. filp->f_owner.signum = signal;
  687. }
  688. q = kmalloc(sizeof(*q), GFP_KERNEL);
  689. if (!q) {
  690. err = -ENOMEM;
  691. goto error;
  692. }
  693. down_read(&current->mm->mmap_sem);
  694. err = get_futex_key(uaddr, &q->key);
  695. if (unlikely(err != 0)) {
  696. up_read(&current->mm->mmap_sem);
  697. kfree(q);
  698. goto error;
  699. }
  700. /*
  701. * queue_me() must be called before releasing mmap_sem, because
  702. * key->shared.inode needs to be referenced while holding it.
  703. */
  704. filp->private_data = q;
  705. queue_me(q, ret, filp);
  706. up_read(&current->mm->mmap_sem);
  707. /* Now we map fd to filp, so userspace can access it */
  708. fd_install(ret, filp);
  709. out:
  710. return ret;
  711. error:
  712. put_unused_fd(ret);
  713. put_filp(filp);
  714. ret = err;
  715. goto out;
  716. }
  717. long do_futex(unsigned long uaddr, int op, int val, unsigned long timeout,
  718. unsigned long uaddr2, int val2, int val3)
  719. {
  720. int ret;
  721. switch (op) {
  722. case FUTEX_WAIT:
  723. ret = futex_wait(uaddr, val, timeout);
  724. break;
  725. case FUTEX_WAKE:
  726. ret = futex_wake(uaddr, val);
  727. break;
  728. case FUTEX_FD:
  729. /* non-zero val means F_SETOWN(getpid()) & F_SETSIG(val) */
  730. ret = futex_fd(uaddr, val);
  731. break;
  732. case FUTEX_REQUEUE:
  733. ret = futex_requeue(uaddr, uaddr2, val, val2, NULL);
  734. break;
  735. case FUTEX_CMP_REQUEUE:
  736. ret = futex_requeue(uaddr, uaddr2, val, val2, &val3);
  737. break;
  738. case FUTEX_WAKE_OP:
  739. ret = futex_wake_op(uaddr, uaddr2, val, val2, val3);
  740. break;
  741. default:
  742. ret = -ENOSYS;
  743. }
  744. return ret;
  745. }
  746. asmlinkage long sys_futex(u32 __user *uaddr, int op, int val,
  747. struct timespec __user *utime, u32 __user *uaddr2,
  748. int val3)
  749. {
  750. struct timespec t;
  751. unsigned long timeout = MAX_SCHEDULE_TIMEOUT;
  752. int val2 = 0;
  753. if ((op == FUTEX_WAIT) && utime) {
  754. if (copy_from_user(&t, utime, sizeof(t)) != 0)
  755. return -EFAULT;
  756. timeout = timespec_to_jiffies(&t) + 1;
  757. }
  758. /*
  759. * requeue parameter in 'utime' if op == FUTEX_REQUEUE.
  760. */
  761. if (op >= FUTEX_REQUEUE)
  762. val2 = (int) (unsigned long) utime;
  763. return do_futex((unsigned long)uaddr, op, val, timeout,
  764. (unsigned long)uaddr2, val2, val3);
  765. }
  766. static struct super_block *
  767. futexfs_get_sb(struct file_system_type *fs_type,
  768. int flags, const char *dev_name, void *data)
  769. {
  770. return get_sb_pseudo(fs_type, "futex", NULL, 0xBAD1DEA);
  771. }
  772. static struct file_system_type futex_fs_type = {
  773. .name = "futexfs",
  774. .get_sb = futexfs_get_sb,
  775. .kill_sb = kill_anon_super,
  776. };
  777. static int __init init(void)
  778. {
  779. unsigned int i;
  780. register_filesystem(&futex_fs_type);
  781. futex_mnt = kern_mount(&futex_fs_type);
  782. for (i = 0; i < ARRAY_SIZE(futex_queues); i++) {
  783. INIT_LIST_HEAD(&futex_queues[i].chain);
  784. spin_lock_init(&futex_queues[i].lock);
  785. }
  786. return 0;
  787. }
  788. __initcall(init);