futex.c 44 KB

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