futex.c 22 KB

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