aio.c 45 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777
  1. /*
  2. * An async IO implementation for Linux
  3. * Written by Benjamin LaHaise <bcrl@kvack.org>
  4. *
  5. * Implements an efficient asynchronous io interface.
  6. *
  7. * Copyright 2000, 2001, 2002 Red Hat, Inc. All Rights Reserved.
  8. *
  9. * See ../COPYING for licensing terms.
  10. */
  11. #include <linux/kernel.h>
  12. #include <linux/init.h>
  13. #include <linux/errno.h>
  14. #include <linux/time.h>
  15. #include <linux/aio_abi.h>
  16. #include <linux/module.h>
  17. #include <linux/syscalls.h>
  18. #include <linux/uio.h>
  19. #define DEBUG 0
  20. #include <linux/sched.h>
  21. #include <linux/fs.h>
  22. #include <linux/file.h>
  23. #include <linux/mm.h>
  24. #include <linux/mman.h>
  25. #include <linux/slab.h>
  26. #include <linux/timer.h>
  27. #include <linux/aio.h>
  28. #include <linux/highmem.h>
  29. #include <linux/workqueue.h>
  30. #include <linux/security.h>
  31. #include <linux/eventfd.h>
  32. #include <asm/kmap_types.h>
  33. #include <asm/uaccess.h>
  34. #include <asm/mmu_context.h>
  35. #if DEBUG > 1
  36. #define dprintk printk
  37. #else
  38. #define dprintk(x...) do { ; } while (0)
  39. #endif
  40. /*------ sysctl variables----*/
  41. static DEFINE_SPINLOCK(aio_nr_lock);
  42. unsigned long aio_nr; /* current system wide number of aio requests */
  43. unsigned long aio_max_nr = 0x10000; /* system wide maximum number of aio requests */
  44. /*----end sysctl variables---*/
  45. static struct kmem_cache *kiocb_cachep;
  46. static struct kmem_cache *kioctx_cachep;
  47. static struct workqueue_struct *aio_wq;
  48. /* Used for rare fput completion. */
  49. static void aio_fput_routine(struct work_struct *);
  50. static DECLARE_WORK(fput_work, aio_fput_routine);
  51. static DEFINE_SPINLOCK(fput_lock);
  52. static LIST_HEAD(fput_head);
  53. static void aio_kick_handler(struct work_struct *);
  54. static void aio_queue_work(struct kioctx *);
  55. /* aio_setup
  56. * Creates the slab caches used by the aio routines, panic on
  57. * failure as this is done early during the boot sequence.
  58. */
  59. static int __init aio_setup(void)
  60. {
  61. kiocb_cachep = KMEM_CACHE(kiocb, SLAB_HWCACHE_ALIGN|SLAB_PANIC);
  62. kioctx_cachep = KMEM_CACHE(kioctx,SLAB_HWCACHE_ALIGN|SLAB_PANIC);
  63. aio_wq = create_workqueue("aio");
  64. pr_debug("aio_setup: sizeof(struct page) = %d\n", (int)sizeof(struct page));
  65. return 0;
  66. }
  67. static void aio_free_ring(struct kioctx *ctx)
  68. {
  69. struct aio_ring_info *info = &ctx->ring_info;
  70. long i;
  71. for (i=0; i<info->nr_pages; i++)
  72. put_page(info->ring_pages[i]);
  73. if (info->mmap_size) {
  74. down_write(&ctx->mm->mmap_sem);
  75. do_munmap(ctx->mm, info->mmap_base, info->mmap_size);
  76. up_write(&ctx->mm->mmap_sem);
  77. }
  78. if (info->ring_pages && info->ring_pages != info->internal_pages)
  79. kfree(info->ring_pages);
  80. info->ring_pages = NULL;
  81. info->nr = 0;
  82. }
  83. static int aio_setup_ring(struct kioctx *ctx)
  84. {
  85. struct aio_ring *ring;
  86. struct aio_ring_info *info = &ctx->ring_info;
  87. unsigned nr_events = ctx->max_reqs;
  88. unsigned long size;
  89. int nr_pages;
  90. /* Compensate for the ring buffer's head/tail overlap entry */
  91. nr_events += 2; /* 1 is required, 2 for good luck */
  92. size = sizeof(struct aio_ring);
  93. size += sizeof(struct io_event) * nr_events;
  94. nr_pages = (size + PAGE_SIZE-1) >> PAGE_SHIFT;
  95. if (nr_pages < 0)
  96. return -EINVAL;
  97. nr_events = (PAGE_SIZE * nr_pages - sizeof(struct aio_ring)) / sizeof(struct io_event);
  98. info->nr = 0;
  99. info->ring_pages = info->internal_pages;
  100. if (nr_pages > AIO_RING_PAGES) {
  101. info->ring_pages = kcalloc(nr_pages, sizeof(struct page *), GFP_KERNEL);
  102. if (!info->ring_pages)
  103. return -ENOMEM;
  104. }
  105. info->mmap_size = nr_pages * PAGE_SIZE;
  106. dprintk("attempting mmap of %lu bytes\n", info->mmap_size);
  107. down_write(&ctx->mm->mmap_sem);
  108. info->mmap_base = do_mmap(NULL, 0, info->mmap_size,
  109. PROT_READ|PROT_WRITE, MAP_ANONYMOUS|MAP_PRIVATE,
  110. 0);
  111. if (IS_ERR((void *)info->mmap_base)) {
  112. up_write(&ctx->mm->mmap_sem);
  113. info->mmap_size = 0;
  114. aio_free_ring(ctx);
  115. return -EAGAIN;
  116. }
  117. dprintk("mmap address: 0x%08lx\n", info->mmap_base);
  118. info->nr_pages = get_user_pages(current, ctx->mm,
  119. info->mmap_base, nr_pages,
  120. 1, 0, info->ring_pages, NULL);
  121. up_write(&ctx->mm->mmap_sem);
  122. if (unlikely(info->nr_pages != nr_pages)) {
  123. aio_free_ring(ctx);
  124. return -EAGAIN;
  125. }
  126. ctx->user_id = info->mmap_base;
  127. info->nr = nr_events; /* trusted copy */
  128. ring = kmap_atomic(info->ring_pages[0], KM_USER0);
  129. ring->nr = nr_events; /* user copy */
  130. ring->id = ctx->user_id;
  131. ring->head = ring->tail = 0;
  132. ring->magic = AIO_RING_MAGIC;
  133. ring->compat_features = AIO_RING_COMPAT_FEATURES;
  134. ring->incompat_features = AIO_RING_INCOMPAT_FEATURES;
  135. ring->header_length = sizeof(struct aio_ring);
  136. kunmap_atomic(ring, KM_USER0);
  137. return 0;
  138. }
  139. /* aio_ring_event: returns a pointer to the event at the given index from
  140. * kmap_atomic(, km). Release the pointer with put_aio_ring_event();
  141. */
  142. #define AIO_EVENTS_PER_PAGE (PAGE_SIZE / sizeof(struct io_event))
  143. #define AIO_EVENTS_FIRST_PAGE ((PAGE_SIZE - sizeof(struct aio_ring)) / sizeof(struct io_event))
  144. #define AIO_EVENTS_OFFSET (AIO_EVENTS_PER_PAGE - AIO_EVENTS_FIRST_PAGE)
  145. #define aio_ring_event(info, nr, km) ({ \
  146. unsigned pos = (nr) + AIO_EVENTS_OFFSET; \
  147. struct io_event *__event; \
  148. __event = kmap_atomic( \
  149. (info)->ring_pages[pos / AIO_EVENTS_PER_PAGE], km); \
  150. __event += pos % AIO_EVENTS_PER_PAGE; \
  151. __event; \
  152. })
  153. #define put_aio_ring_event(event, km) do { \
  154. struct io_event *__event = (event); \
  155. (void)__event; \
  156. kunmap_atomic((void *)((unsigned long)__event & PAGE_MASK), km); \
  157. } while(0)
  158. /* ioctx_alloc
  159. * Allocates and initializes an ioctx. Returns an ERR_PTR if it failed.
  160. */
  161. static struct kioctx *ioctx_alloc(unsigned nr_events)
  162. {
  163. struct mm_struct *mm;
  164. struct kioctx *ctx;
  165. /* Prevent overflows */
  166. if ((nr_events > (0x10000000U / sizeof(struct io_event))) ||
  167. (nr_events > (0x10000000U / sizeof(struct kiocb)))) {
  168. pr_debug("ENOMEM: nr_events too high\n");
  169. return ERR_PTR(-EINVAL);
  170. }
  171. if ((unsigned long)nr_events > aio_max_nr)
  172. return ERR_PTR(-EAGAIN);
  173. ctx = kmem_cache_zalloc(kioctx_cachep, GFP_KERNEL);
  174. if (!ctx)
  175. return ERR_PTR(-ENOMEM);
  176. ctx->max_reqs = nr_events;
  177. mm = ctx->mm = current->mm;
  178. atomic_inc(&mm->mm_count);
  179. atomic_set(&ctx->users, 1);
  180. spin_lock_init(&ctx->ctx_lock);
  181. spin_lock_init(&ctx->ring_info.ring_lock);
  182. init_waitqueue_head(&ctx->wait);
  183. INIT_LIST_HEAD(&ctx->active_reqs);
  184. INIT_LIST_HEAD(&ctx->run_list);
  185. INIT_DELAYED_WORK(&ctx->wq, aio_kick_handler);
  186. if (aio_setup_ring(ctx) < 0)
  187. goto out_freectx;
  188. /* limit the number of system wide aios */
  189. spin_lock(&aio_nr_lock);
  190. if (aio_nr + ctx->max_reqs > aio_max_nr ||
  191. aio_nr + ctx->max_reqs < aio_nr)
  192. ctx->max_reqs = 0;
  193. else
  194. aio_nr += ctx->max_reqs;
  195. spin_unlock(&aio_nr_lock);
  196. if (ctx->max_reqs == 0)
  197. goto out_cleanup;
  198. /* now link into global list. kludge. FIXME */
  199. write_lock(&mm->ioctx_list_lock);
  200. ctx->next = mm->ioctx_list;
  201. mm->ioctx_list = ctx;
  202. write_unlock(&mm->ioctx_list_lock);
  203. dprintk("aio: allocated ioctx %p[%ld]: mm=%p mask=0x%x\n",
  204. ctx, ctx->user_id, current->mm, ctx->ring_info.nr);
  205. return ctx;
  206. out_cleanup:
  207. __put_ioctx(ctx);
  208. return ERR_PTR(-EAGAIN);
  209. out_freectx:
  210. mmdrop(mm);
  211. kmem_cache_free(kioctx_cachep, ctx);
  212. ctx = ERR_PTR(-ENOMEM);
  213. dprintk("aio: error allocating ioctx %p\n", ctx);
  214. return ctx;
  215. }
  216. /* aio_cancel_all
  217. * Cancels all outstanding aio requests on an aio context. Used
  218. * when the processes owning a context have all exited to encourage
  219. * the rapid destruction of the kioctx.
  220. */
  221. static void aio_cancel_all(struct kioctx *ctx)
  222. {
  223. int (*cancel)(struct kiocb *, struct io_event *);
  224. struct io_event res;
  225. spin_lock_irq(&ctx->ctx_lock);
  226. ctx->dead = 1;
  227. while (!list_empty(&ctx->active_reqs)) {
  228. struct list_head *pos = ctx->active_reqs.next;
  229. struct kiocb *iocb = list_kiocb(pos);
  230. list_del_init(&iocb->ki_list);
  231. cancel = iocb->ki_cancel;
  232. kiocbSetCancelled(iocb);
  233. if (cancel) {
  234. iocb->ki_users++;
  235. spin_unlock_irq(&ctx->ctx_lock);
  236. cancel(iocb, &res);
  237. spin_lock_irq(&ctx->ctx_lock);
  238. }
  239. }
  240. spin_unlock_irq(&ctx->ctx_lock);
  241. }
  242. static void wait_for_all_aios(struct kioctx *ctx)
  243. {
  244. struct task_struct *tsk = current;
  245. DECLARE_WAITQUEUE(wait, tsk);
  246. spin_lock_irq(&ctx->ctx_lock);
  247. if (!ctx->reqs_active)
  248. goto out;
  249. add_wait_queue(&ctx->wait, &wait);
  250. set_task_state(tsk, TASK_UNINTERRUPTIBLE);
  251. while (ctx->reqs_active) {
  252. spin_unlock_irq(&ctx->ctx_lock);
  253. io_schedule();
  254. set_task_state(tsk, TASK_UNINTERRUPTIBLE);
  255. spin_lock_irq(&ctx->ctx_lock);
  256. }
  257. __set_task_state(tsk, TASK_RUNNING);
  258. remove_wait_queue(&ctx->wait, &wait);
  259. out:
  260. spin_unlock_irq(&ctx->ctx_lock);
  261. }
  262. /* wait_on_sync_kiocb:
  263. * Waits on the given sync kiocb to complete.
  264. */
  265. ssize_t fastcall wait_on_sync_kiocb(struct kiocb *iocb)
  266. {
  267. while (iocb->ki_users) {
  268. set_current_state(TASK_UNINTERRUPTIBLE);
  269. if (!iocb->ki_users)
  270. break;
  271. io_schedule();
  272. }
  273. __set_current_state(TASK_RUNNING);
  274. return iocb->ki_user_data;
  275. }
  276. /* exit_aio: called when the last user of mm goes away. At this point,
  277. * there is no way for any new requests to be submited or any of the
  278. * io_* syscalls to be called on the context. However, there may be
  279. * outstanding requests which hold references to the context; as they
  280. * go away, they will call put_ioctx and release any pinned memory
  281. * associated with the request (held via struct page * references).
  282. */
  283. void fastcall exit_aio(struct mm_struct *mm)
  284. {
  285. struct kioctx *ctx = mm->ioctx_list;
  286. mm->ioctx_list = NULL;
  287. while (ctx) {
  288. struct kioctx *next = ctx->next;
  289. ctx->next = NULL;
  290. aio_cancel_all(ctx);
  291. wait_for_all_aios(ctx);
  292. /*
  293. * Ensure we don't leave the ctx on the aio_wq
  294. */
  295. cancel_work_sync(&ctx->wq.work);
  296. if (1 != atomic_read(&ctx->users))
  297. printk(KERN_DEBUG
  298. "exit_aio:ioctx still alive: %d %d %d\n",
  299. atomic_read(&ctx->users), ctx->dead,
  300. ctx->reqs_active);
  301. put_ioctx(ctx);
  302. ctx = next;
  303. }
  304. }
  305. /* __put_ioctx
  306. * Called when the last user of an aio context has gone away,
  307. * and the struct needs to be freed.
  308. */
  309. void fastcall __put_ioctx(struct kioctx *ctx)
  310. {
  311. unsigned nr_events = ctx->max_reqs;
  312. BUG_ON(ctx->reqs_active);
  313. cancel_delayed_work(&ctx->wq);
  314. cancel_work_sync(&ctx->wq.work);
  315. aio_free_ring(ctx);
  316. mmdrop(ctx->mm);
  317. ctx->mm = NULL;
  318. pr_debug("__put_ioctx: freeing %p\n", ctx);
  319. kmem_cache_free(kioctx_cachep, ctx);
  320. if (nr_events) {
  321. spin_lock(&aio_nr_lock);
  322. BUG_ON(aio_nr - nr_events > aio_nr);
  323. aio_nr -= nr_events;
  324. spin_unlock(&aio_nr_lock);
  325. }
  326. }
  327. /* aio_get_req
  328. * Allocate a slot for an aio request. Increments the users count
  329. * of the kioctx so that the kioctx stays around until all requests are
  330. * complete. Returns NULL if no requests are free.
  331. *
  332. * Returns with kiocb->users set to 2. The io submit code path holds
  333. * an extra reference while submitting the i/o.
  334. * This prevents races between the aio code path referencing the
  335. * req (after submitting it) and aio_complete() freeing the req.
  336. */
  337. static struct kiocb *FASTCALL(__aio_get_req(struct kioctx *ctx));
  338. static struct kiocb fastcall *__aio_get_req(struct kioctx *ctx)
  339. {
  340. struct kiocb *req = NULL;
  341. struct aio_ring *ring;
  342. int okay = 0;
  343. req = kmem_cache_alloc(kiocb_cachep, GFP_KERNEL);
  344. if (unlikely(!req))
  345. return NULL;
  346. req->ki_flags = 0;
  347. req->ki_users = 2;
  348. req->ki_key = 0;
  349. req->ki_ctx = ctx;
  350. req->ki_cancel = NULL;
  351. req->ki_retry = NULL;
  352. req->ki_dtor = NULL;
  353. req->private = NULL;
  354. req->ki_iovec = NULL;
  355. INIT_LIST_HEAD(&req->ki_run_list);
  356. req->ki_eventfd = ERR_PTR(-EINVAL);
  357. /* Check if the completion queue has enough free space to
  358. * accept an event from this io.
  359. */
  360. spin_lock_irq(&ctx->ctx_lock);
  361. ring = kmap_atomic(ctx->ring_info.ring_pages[0], KM_USER0);
  362. if (ctx->reqs_active < aio_ring_avail(&ctx->ring_info, ring)) {
  363. list_add(&req->ki_list, &ctx->active_reqs);
  364. ctx->reqs_active++;
  365. okay = 1;
  366. }
  367. kunmap_atomic(ring, KM_USER0);
  368. spin_unlock_irq(&ctx->ctx_lock);
  369. if (!okay) {
  370. kmem_cache_free(kiocb_cachep, req);
  371. req = NULL;
  372. }
  373. return req;
  374. }
  375. static inline struct kiocb *aio_get_req(struct kioctx *ctx)
  376. {
  377. struct kiocb *req;
  378. /* Handle a potential starvation case -- should be exceedingly rare as
  379. * requests will be stuck on fput_head only if the aio_fput_routine is
  380. * delayed and the requests were the last user of the struct file.
  381. */
  382. req = __aio_get_req(ctx);
  383. if (unlikely(NULL == req)) {
  384. aio_fput_routine(NULL);
  385. req = __aio_get_req(ctx);
  386. }
  387. return req;
  388. }
  389. static inline void really_put_req(struct kioctx *ctx, struct kiocb *req)
  390. {
  391. assert_spin_locked(&ctx->ctx_lock);
  392. if (!IS_ERR(req->ki_eventfd))
  393. fput(req->ki_eventfd);
  394. if (req->ki_dtor)
  395. req->ki_dtor(req);
  396. if (req->ki_iovec != &req->ki_inline_vec)
  397. kfree(req->ki_iovec);
  398. kmem_cache_free(kiocb_cachep, req);
  399. ctx->reqs_active--;
  400. if (unlikely(!ctx->reqs_active && ctx->dead))
  401. wake_up(&ctx->wait);
  402. }
  403. static void aio_fput_routine(struct work_struct *data)
  404. {
  405. spin_lock_irq(&fput_lock);
  406. while (likely(!list_empty(&fput_head))) {
  407. struct kiocb *req = list_kiocb(fput_head.next);
  408. struct kioctx *ctx = req->ki_ctx;
  409. list_del(&req->ki_list);
  410. spin_unlock_irq(&fput_lock);
  411. /* Complete the fput */
  412. __fput(req->ki_filp);
  413. /* Link the iocb into the context's free list */
  414. spin_lock_irq(&ctx->ctx_lock);
  415. really_put_req(ctx, req);
  416. spin_unlock_irq(&ctx->ctx_lock);
  417. put_ioctx(ctx);
  418. spin_lock_irq(&fput_lock);
  419. }
  420. spin_unlock_irq(&fput_lock);
  421. }
  422. /* __aio_put_req
  423. * Returns true if this put was the last user of the request.
  424. */
  425. static int __aio_put_req(struct kioctx *ctx, struct kiocb *req)
  426. {
  427. dprintk(KERN_DEBUG "aio_put(%p): f_count=%d\n",
  428. req, atomic_read(&req->ki_filp->f_count));
  429. assert_spin_locked(&ctx->ctx_lock);
  430. req->ki_users --;
  431. BUG_ON(req->ki_users < 0);
  432. if (likely(req->ki_users))
  433. return 0;
  434. list_del(&req->ki_list); /* remove from active_reqs */
  435. req->ki_cancel = NULL;
  436. req->ki_retry = NULL;
  437. /* Must be done under the lock to serialise against cancellation.
  438. * Call this aio_fput as it duplicates fput via the fput_work.
  439. */
  440. if (unlikely(atomic_dec_and_test(&req->ki_filp->f_count))) {
  441. get_ioctx(ctx);
  442. spin_lock(&fput_lock);
  443. list_add(&req->ki_list, &fput_head);
  444. spin_unlock(&fput_lock);
  445. queue_work(aio_wq, &fput_work);
  446. } else
  447. really_put_req(ctx, req);
  448. return 1;
  449. }
  450. /* aio_put_req
  451. * Returns true if this put was the last user of the kiocb,
  452. * false if the request is still in use.
  453. */
  454. int fastcall aio_put_req(struct kiocb *req)
  455. {
  456. struct kioctx *ctx = req->ki_ctx;
  457. int ret;
  458. spin_lock_irq(&ctx->ctx_lock);
  459. ret = __aio_put_req(ctx, req);
  460. spin_unlock_irq(&ctx->ctx_lock);
  461. return ret;
  462. }
  463. /* Lookup an ioctx id. ioctx_list is lockless for reads.
  464. * FIXME: this is O(n) and is only suitable for development.
  465. */
  466. struct kioctx *lookup_ioctx(unsigned long ctx_id)
  467. {
  468. struct kioctx *ioctx;
  469. struct mm_struct *mm;
  470. mm = current->mm;
  471. read_lock(&mm->ioctx_list_lock);
  472. for (ioctx = mm->ioctx_list; ioctx; ioctx = ioctx->next)
  473. if (likely(ioctx->user_id == ctx_id && !ioctx->dead)) {
  474. get_ioctx(ioctx);
  475. break;
  476. }
  477. read_unlock(&mm->ioctx_list_lock);
  478. return ioctx;
  479. }
  480. /*
  481. * use_mm
  482. * Makes the calling kernel thread take on the specified
  483. * mm context.
  484. * Called by the retry thread execute retries within the
  485. * iocb issuer's mm context, so that copy_from/to_user
  486. * operations work seamlessly for aio.
  487. * (Note: this routine is intended to be called only
  488. * from a kernel thread context)
  489. */
  490. static void use_mm(struct mm_struct *mm)
  491. {
  492. struct mm_struct *active_mm;
  493. struct task_struct *tsk = current;
  494. task_lock(tsk);
  495. tsk->flags |= PF_BORROWED_MM;
  496. active_mm = tsk->active_mm;
  497. atomic_inc(&mm->mm_count);
  498. tsk->mm = mm;
  499. tsk->active_mm = mm;
  500. /*
  501. * Note that on UML this *requires* PF_BORROWED_MM to be set, otherwise
  502. * it won't work. Update it accordingly if you change it here
  503. */
  504. switch_mm(active_mm, mm, tsk);
  505. task_unlock(tsk);
  506. mmdrop(active_mm);
  507. }
  508. /*
  509. * unuse_mm
  510. * Reverses the effect of use_mm, i.e. releases the
  511. * specified mm context which was earlier taken on
  512. * by the calling kernel thread
  513. * (Note: this routine is intended to be called only
  514. * from a kernel thread context)
  515. */
  516. static void unuse_mm(struct mm_struct *mm)
  517. {
  518. struct task_struct *tsk = current;
  519. task_lock(tsk);
  520. tsk->flags &= ~PF_BORROWED_MM;
  521. tsk->mm = NULL;
  522. /* active_mm is still 'mm' */
  523. enter_lazy_tlb(mm, tsk);
  524. task_unlock(tsk);
  525. }
  526. /*
  527. * Queue up a kiocb to be retried. Assumes that the kiocb
  528. * has already been marked as kicked, and places it on
  529. * the retry run list for the corresponding ioctx, if it
  530. * isn't already queued. Returns 1 if it actually queued
  531. * the kiocb (to tell the caller to activate the work
  532. * queue to process it), or 0, if it found that it was
  533. * already queued.
  534. */
  535. static inline int __queue_kicked_iocb(struct kiocb *iocb)
  536. {
  537. struct kioctx *ctx = iocb->ki_ctx;
  538. assert_spin_locked(&ctx->ctx_lock);
  539. if (list_empty(&iocb->ki_run_list)) {
  540. list_add_tail(&iocb->ki_run_list,
  541. &ctx->run_list);
  542. return 1;
  543. }
  544. return 0;
  545. }
  546. /* aio_run_iocb
  547. * This is the core aio execution routine. It is
  548. * invoked both for initial i/o submission and
  549. * subsequent retries via the aio_kick_handler.
  550. * Expects to be invoked with iocb->ki_ctx->lock
  551. * already held. The lock is released and reacquired
  552. * as needed during processing.
  553. *
  554. * Calls the iocb retry method (already setup for the
  555. * iocb on initial submission) for operation specific
  556. * handling, but takes care of most of common retry
  557. * execution details for a given iocb. The retry method
  558. * needs to be non-blocking as far as possible, to avoid
  559. * holding up other iocbs waiting to be serviced by the
  560. * retry kernel thread.
  561. *
  562. * The trickier parts in this code have to do with
  563. * ensuring that only one retry instance is in progress
  564. * for a given iocb at any time. Providing that guarantee
  565. * simplifies the coding of individual aio operations as
  566. * it avoids various potential races.
  567. */
  568. static ssize_t aio_run_iocb(struct kiocb *iocb)
  569. {
  570. struct kioctx *ctx = iocb->ki_ctx;
  571. ssize_t (*retry)(struct kiocb *);
  572. ssize_t ret;
  573. if (!(retry = iocb->ki_retry)) {
  574. printk("aio_run_iocb: iocb->ki_retry = NULL\n");
  575. return 0;
  576. }
  577. /*
  578. * We don't want the next retry iteration for this
  579. * operation to start until this one has returned and
  580. * updated the iocb state. However, wait_queue functions
  581. * can trigger a kick_iocb from interrupt context in the
  582. * meantime, indicating that data is available for the next
  583. * iteration. We want to remember that and enable the
  584. * next retry iteration _after_ we are through with
  585. * this one.
  586. *
  587. * So, in order to be able to register a "kick", but
  588. * prevent it from being queued now, we clear the kick
  589. * flag, but make the kick code *think* that the iocb is
  590. * still on the run list until we are actually done.
  591. * When we are done with this iteration, we check if
  592. * the iocb was kicked in the meantime and if so, queue
  593. * it up afresh.
  594. */
  595. kiocbClearKicked(iocb);
  596. /*
  597. * This is so that aio_complete knows it doesn't need to
  598. * pull the iocb off the run list (We can't just call
  599. * INIT_LIST_HEAD because we don't want a kick_iocb to
  600. * queue this on the run list yet)
  601. */
  602. iocb->ki_run_list.next = iocb->ki_run_list.prev = NULL;
  603. spin_unlock_irq(&ctx->ctx_lock);
  604. /* Quit retrying if the i/o has been cancelled */
  605. if (kiocbIsCancelled(iocb)) {
  606. ret = -EINTR;
  607. aio_complete(iocb, ret, 0);
  608. /* must not access the iocb after this */
  609. goto out;
  610. }
  611. /*
  612. * Now we are all set to call the retry method in async
  613. * context.
  614. */
  615. ret = retry(iocb);
  616. if (ret != -EIOCBRETRY && ret != -EIOCBQUEUED) {
  617. BUG_ON(!list_empty(&iocb->ki_wait.task_list));
  618. aio_complete(iocb, ret, 0);
  619. }
  620. out:
  621. spin_lock_irq(&ctx->ctx_lock);
  622. if (-EIOCBRETRY == ret) {
  623. /*
  624. * OK, now that we are done with this iteration
  625. * and know that there is more left to go,
  626. * this is where we let go so that a subsequent
  627. * "kick" can start the next iteration
  628. */
  629. /* will make __queue_kicked_iocb succeed from here on */
  630. INIT_LIST_HEAD(&iocb->ki_run_list);
  631. /* we must queue the next iteration ourselves, if it
  632. * has already been kicked */
  633. if (kiocbIsKicked(iocb)) {
  634. __queue_kicked_iocb(iocb);
  635. /*
  636. * __queue_kicked_iocb will always return 1 here, because
  637. * iocb->ki_run_list is empty at this point so it should
  638. * be safe to unconditionally queue the context into the
  639. * work queue.
  640. */
  641. aio_queue_work(ctx);
  642. }
  643. }
  644. return ret;
  645. }
  646. /*
  647. * __aio_run_iocbs:
  648. * Process all pending retries queued on the ioctx
  649. * run list.
  650. * Assumes it is operating within the aio issuer's mm
  651. * context.
  652. */
  653. static int __aio_run_iocbs(struct kioctx *ctx)
  654. {
  655. struct kiocb *iocb;
  656. struct list_head run_list;
  657. assert_spin_locked(&ctx->ctx_lock);
  658. list_replace_init(&ctx->run_list, &run_list);
  659. while (!list_empty(&run_list)) {
  660. iocb = list_entry(run_list.next, struct kiocb,
  661. ki_run_list);
  662. list_del(&iocb->ki_run_list);
  663. /*
  664. * Hold an extra reference while retrying i/o.
  665. */
  666. iocb->ki_users++; /* grab extra reference */
  667. aio_run_iocb(iocb);
  668. __aio_put_req(ctx, iocb);
  669. }
  670. if (!list_empty(&ctx->run_list))
  671. return 1;
  672. return 0;
  673. }
  674. static void aio_queue_work(struct kioctx * ctx)
  675. {
  676. unsigned long timeout;
  677. /*
  678. * if someone is waiting, get the work started right
  679. * away, otherwise, use a longer delay
  680. */
  681. smp_mb();
  682. if (waitqueue_active(&ctx->wait))
  683. timeout = 1;
  684. else
  685. timeout = HZ/10;
  686. queue_delayed_work(aio_wq, &ctx->wq, timeout);
  687. }
  688. /*
  689. * aio_run_iocbs:
  690. * Process all pending retries queued on the ioctx
  691. * run list.
  692. * Assumes it is operating within the aio issuer's mm
  693. * context.
  694. */
  695. static inline void aio_run_iocbs(struct kioctx *ctx)
  696. {
  697. int requeue;
  698. spin_lock_irq(&ctx->ctx_lock);
  699. requeue = __aio_run_iocbs(ctx);
  700. spin_unlock_irq(&ctx->ctx_lock);
  701. if (requeue)
  702. aio_queue_work(ctx);
  703. }
  704. /*
  705. * just like aio_run_iocbs, but keeps running them until
  706. * the list stays empty
  707. */
  708. static inline void aio_run_all_iocbs(struct kioctx *ctx)
  709. {
  710. spin_lock_irq(&ctx->ctx_lock);
  711. while (__aio_run_iocbs(ctx))
  712. ;
  713. spin_unlock_irq(&ctx->ctx_lock);
  714. }
  715. /*
  716. * aio_kick_handler:
  717. * Work queue handler triggered to process pending
  718. * retries on an ioctx. Takes on the aio issuer's
  719. * mm context before running the iocbs, so that
  720. * copy_xxx_user operates on the issuer's address
  721. * space.
  722. * Run on aiod's context.
  723. */
  724. static void aio_kick_handler(struct work_struct *work)
  725. {
  726. struct kioctx *ctx = container_of(work, struct kioctx, wq.work);
  727. mm_segment_t oldfs = get_fs();
  728. struct mm_struct *mm;
  729. int requeue;
  730. set_fs(USER_DS);
  731. use_mm(ctx->mm);
  732. spin_lock_irq(&ctx->ctx_lock);
  733. requeue =__aio_run_iocbs(ctx);
  734. mm = ctx->mm;
  735. spin_unlock_irq(&ctx->ctx_lock);
  736. unuse_mm(mm);
  737. set_fs(oldfs);
  738. /*
  739. * we're in a worker thread already, don't use queue_delayed_work,
  740. */
  741. if (requeue)
  742. queue_delayed_work(aio_wq, &ctx->wq, 0);
  743. }
  744. /*
  745. * Called by kick_iocb to queue the kiocb for retry
  746. * and if required activate the aio work queue to process
  747. * it
  748. */
  749. static void try_queue_kicked_iocb(struct kiocb *iocb)
  750. {
  751. struct kioctx *ctx = iocb->ki_ctx;
  752. unsigned long flags;
  753. int run = 0;
  754. /* We're supposed to be the only path putting the iocb back on the run
  755. * list. If we find that the iocb is *back* on a wait queue already
  756. * than retry has happened before we could queue the iocb. This also
  757. * means that the retry could have completed and freed our iocb, no
  758. * good. */
  759. BUG_ON((!list_empty(&iocb->ki_wait.task_list)));
  760. spin_lock_irqsave(&ctx->ctx_lock, flags);
  761. /* set this inside the lock so that we can't race with aio_run_iocb()
  762. * testing it and putting the iocb on the run list under the lock */
  763. if (!kiocbTryKick(iocb))
  764. run = __queue_kicked_iocb(iocb);
  765. spin_unlock_irqrestore(&ctx->ctx_lock, flags);
  766. if (run)
  767. aio_queue_work(ctx);
  768. }
  769. /*
  770. * kick_iocb:
  771. * Called typically from a wait queue callback context
  772. * (aio_wake_function) to trigger a retry of the iocb.
  773. * The retry is usually executed by aio workqueue
  774. * threads (See aio_kick_handler).
  775. */
  776. void fastcall kick_iocb(struct kiocb *iocb)
  777. {
  778. /* sync iocbs are easy: they can only ever be executing from a
  779. * single context. */
  780. if (is_sync_kiocb(iocb)) {
  781. kiocbSetKicked(iocb);
  782. wake_up_process(iocb->ki_obj.tsk);
  783. return;
  784. }
  785. try_queue_kicked_iocb(iocb);
  786. }
  787. EXPORT_SYMBOL(kick_iocb);
  788. /* aio_complete
  789. * Called when the io request on the given iocb is complete.
  790. * Returns true if this is the last user of the request. The
  791. * only other user of the request can be the cancellation code.
  792. */
  793. int fastcall aio_complete(struct kiocb *iocb, long res, long res2)
  794. {
  795. struct kioctx *ctx = iocb->ki_ctx;
  796. struct aio_ring_info *info;
  797. struct aio_ring *ring;
  798. struct io_event *event;
  799. unsigned long flags;
  800. unsigned long tail;
  801. int ret;
  802. /*
  803. * Special case handling for sync iocbs:
  804. * - events go directly into the iocb for fast handling
  805. * - the sync task with the iocb in its stack holds the single iocb
  806. * ref, no other paths have a way to get another ref
  807. * - the sync task helpfully left a reference to itself in the iocb
  808. */
  809. if (is_sync_kiocb(iocb)) {
  810. BUG_ON(iocb->ki_users != 1);
  811. iocb->ki_user_data = res;
  812. iocb->ki_users = 0;
  813. wake_up_process(iocb->ki_obj.tsk);
  814. return 1;
  815. }
  816. /*
  817. * Check if the user asked us to deliver the result through an
  818. * eventfd. The eventfd_signal() function is safe to be called
  819. * from IRQ context.
  820. */
  821. if (!IS_ERR(iocb->ki_eventfd))
  822. eventfd_signal(iocb->ki_eventfd, 1);
  823. info = &ctx->ring_info;
  824. /* add a completion event to the ring buffer.
  825. * must be done holding ctx->ctx_lock to prevent
  826. * other code from messing with the tail
  827. * pointer since we might be called from irq
  828. * context.
  829. */
  830. spin_lock_irqsave(&ctx->ctx_lock, flags);
  831. if (iocb->ki_run_list.prev && !list_empty(&iocb->ki_run_list))
  832. list_del_init(&iocb->ki_run_list);
  833. /*
  834. * cancelled requests don't get events, userland was given one
  835. * when the event got cancelled.
  836. */
  837. if (kiocbIsCancelled(iocb))
  838. goto put_rq;
  839. ring = kmap_atomic(info->ring_pages[0], KM_IRQ1);
  840. tail = info->tail;
  841. event = aio_ring_event(info, tail, KM_IRQ0);
  842. if (++tail >= info->nr)
  843. tail = 0;
  844. event->obj = (u64)(unsigned long)iocb->ki_obj.user;
  845. event->data = iocb->ki_user_data;
  846. event->res = res;
  847. event->res2 = res2;
  848. dprintk("aio_complete: %p[%lu]: %p: %p %Lx %lx %lx\n",
  849. ctx, tail, iocb, iocb->ki_obj.user, iocb->ki_user_data,
  850. res, res2);
  851. /* after flagging the request as done, we
  852. * must never even look at it again
  853. */
  854. smp_wmb(); /* make event visible before updating tail */
  855. info->tail = tail;
  856. ring->tail = tail;
  857. put_aio_ring_event(event, KM_IRQ0);
  858. kunmap_atomic(ring, KM_IRQ1);
  859. pr_debug("added to ring %p at [%lu]\n", iocb, tail);
  860. put_rq:
  861. /* everything turned out well, dispose of the aiocb. */
  862. ret = __aio_put_req(ctx, iocb);
  863. if (waitqueue_active(&ctx->wait))
  864. wake_up(&ctx->wait);
  865. spin_unlock_irqrestore(&ctx->ctx_lock, flags);
  866. return ret;
  867. }
  868. /* aio_read_evt
  869. * Pull an event off of the ioctx's event ring. Returns the number of
  870. * events fetched (0 or 1 ;-)
  871. * FIXME: make this use cmpxchg.
  872. * TODO: make the ringbuffer user mmap()able (requires FIXME).
  873. */
  874. static int aio_read_evt(struct kioctx *ioctx, struct io_event *ent)
  875. {
  876. struct aio_ring_info *info = &ioctx->ring_info;
  877. struct aio_ring *ring;
  878. unsigned long head;
  879. int ret = 0;
  880. ring = kmap_atomic(info->ring_pages[0], KM_USER0);
  881. dprintk("in aio_read_evt h%lu t%lu m%lu\n",
  882. (unsigned long)ring->head, (unsigned long)ring->tail,
  883. (unsigned long)ring->nr);
  884. if (ring->head == ring->tail)
  885. goto out;
  886. spin_lock(&info->ring_lock);
  887. head = ring->head % info->nr;
  888. if (head != ring->tail) {
  889. struct io_event *evp = aio_ring_event(info, head, KM_USER1);
  890. *ent = *evp;
  891. head = (head + 1) % info->nr;
  892. smp_mb(); /* finish reading the event before updatng the head */
  893. ring->head = head;
  894. ret = 1;
  895. put_aio_ring_event(evp, KM_USER1);
  896. }
  897. spin_unlock(&info->ring_lock);
  898. out:
  899. kunmap_atomic(ring, KM_USER0);
  900. dprintk("leaving aio_read_evt: %d h%lu t%lu\n", ret,
  901. (unsigned long)ring->head, (unsigned long)ring->tail);
  902. return ret;
  903. }
  904. struct aio_timeout {
  905. struct timer_list timer;
  906. int timed_out;
  907. struct task_struct *p;
  908. };
  909. static void timeout_func(unsigned long data)
  910. {
  911. struct aio_timeout *to = (struct aio_timeout *)data;
  912. to->timed_out = 1;
  913. wake_up_process(to->p);
  914. }
  915. static inline void init_timeout(struct aio_timeout *to)
  916. {
  917. init_timer(&to->timer);
  918. to->timer.data = (unsigned long)to;
  919. to->timer.function = timeout_func;
  920. to->timed_out = 0;
  921. to->p = current;
  922. }
  923. static inline void set_timeout(long start_jiffies, struct aio_timeout *to,
  924. const struct timespec *ts)
  925. {
  926. to->timer.expires = start_jiffies + timespec_to_jiffies(ts);
  927. if (time_after(to->timer.expires, jiffies))
  928. add_timer(&to->timer);
  929. else
  930. to->timed_out = 1;
  931. }
  932. static inline void clear_timeout(struct aio_timeout *to)
  933. {
  934. del_singleshot_timer_sync(&to->timer);
  935. }
  936. static int read_events(struct kioctx *ctx,
  937. long min_nr, long nr,
  938. struct io_event __user *event,
  939. struct timespec __user *timeout)
  940. {
  941. long start_jiffies = jiffies;
  942. struct task_struct *tsk = current;
  943. DECLARE_WAITQUEUE(wait, tsk);
  944. int ret;
  945. int i = 0;
  946. struct io_event ent;
  947. struct aio_timeout to;
  948. int retry = 0;
  949. /* needed to zero any padding within an entry (there shouldn't be
  950. * any, but C is fun!
  951. */
  952. memset(&ent, 0, sizeof(ent));
  953. retry:
  954. ret = 0;
  955. while (likely(i < nr)) {
  956. ret = aio_read_evt(ctx, &ent);
  957. if (unlikely(ret <= 0))
  958. break;
  959. dprintk("read event: %Lx %Lx %Lx %Lx\n",
  960. ent.data, ent.obj, ent.res, ent.res2);
  961. /* Could we split the check in two? */
  962. ret = -EFAULT;
  963. if (unlikely(copy_to_user(event, &ent, sizeof(ent)))) {
  964. dprintk("aio: lost an event due to EFAULT.\n");
  965. break;
  966. }
  967. ret = 0;
  968. /* Good, event copied to userland, update counts. */
  969. event ++;
  970. i ++;
  971. }
  972. if (min_nr <= i)
  973. return i;
  974. if (ret)
  975. return ret;
  976. /* End fast path */
  977. /* racey check, but it gets redone */
  978. if (!retry && unlikely(!list_empty(&ctx->run_list))) {
  979. retry = 1;
  980. aio_run_all_iocbs(ctx);
  981. goto retry;
  982. }
  983. init_timeout(&to);
  984. if (timeout) {
  985. struct timespec ts;
  986. ret = -EFAULT;
  987. if (unlikely(copy_from_user(&ts, timeout, sizeof(ts))))
  988. goto out;
  989. set_timeout(start_jiffies, &to, &ts);
  990. }
  991. while (likely(i < nr)) {
  992. add_wait_queue_exclusive(&ctx->wait, &wait);
  993. do {
  994. set_task_state(tsk, TASK_INTERRUPTIBLE);
  995. ret = aio_read_evt(ctx, &ent);
  996. if (ret)
  997. break;
  998. if (min_nr <= i)
  999. break;
  1000. ret = 0;
  1001. if (to.timed_out) /* Only check after read evt */
  1002. break;
  1003. io_schedule();
  1004. if (signal_pending(tsk)) {
  1005. ret = -EINTR;
  1006. break;
  1007. }
  1008. /*ret = aio_read_evt(ctx, &ent);*/
  1009. } while (1) ;
  1010. set_task_state(tsk, TASK_RUNNING);
  1011. remove_wait_queue(&ctx->wait, &wait);
  1012. if (unlikely(ret <= 0))
  1013. break;
  1014. ret = -EFAULT;
  1015. if (unlikely(copy_to_user(event, &ent, sizeof(ent)))) {
  1016. dprintk("aio: lost an event due to EFAULT.\n");
  1017. break;
  1018. }
  1019. /* Good, event copied to userland, update counts. */
  1020. event ++;
  1021. i ++;
  1022. }
  1023. if (timeout)
  1024. clear_timeout(&to);
  1025. out:
  1026. return i ? i : ret;
  1027. }
  1028. /* Take an ioctx and remove it from the list of ioctx's. Protects
  1029. * against races with itself via ->dead.
  1030. */
  1031. static void io_destroy(struct kioctx *ioctx)
  1032. {
  1033. struct mm_struct *mm = current->mm;
  1034. struct kioctx **tmp;
  1035. int was_dead;
  1036. /* delete the entry from the list is someone else hasn't already */
  1037. write_lock(&mm->ioctx_list_lock);
  1038. was_dead = ioctx->dead;
  1039. ioctx->dead = 1;
  1040. for (tmp = &mm->ioctx_list; *tmp && *tmp != ioctx;
  1041. tmp = &(*tmp)->next)
  1042. ;
  1043. if (*tmp)
  1044. *tmp = ioctx->next;
  1045. write_unlock(&mm->ioctx_list_lock);
  1046. dprintk("aio_release(%p)\n", ioctx);
  1047. if (likely(!was_dead))
  1048. put_ioctx(ioctx); /* twice for the list */
  1049. aio_cancel_all(ioctx);
  1050. wait_for_all_aios(ioctx);
  1051. put_ioctx(ioctx); /* once for the lookup */
  1052. }
  1053. /* sys_io_setup:
  1054. * Create an aio_context capable of receiving at least nr_events.
  1055. * ctxp must not point to an aio_context that already exists, and
  1056. * must be initialized to 0 prior to the call. On successful
  1057. * creation of the aio_context, *ctxp is filled in with the resulting
  1058. * handle. May fail with -EINVAL if *ctxp is not initialized,
  1059. * if the specified nr_events exceeds internal limits. May fail
  1060. * with -EAGAIN if the specified nr_events exceeds the user's limit
  1061. * of available events. May fail with -ENOMEM if insufficient kernel
  1062. * resources are available. May fail with -EFAULT if an invalid
  1063. * pointer is passed for ctxp. Will fail with -ENOSYS if not
  1064. * implemented.
  1065. */
  1066. asmlinkage long sys_io_setup(unsigned nr_events, aio_context_t __user *ctxp)
  1067. {
  1068. struct kioctx *ioctx = NULL;
  1069. unsigned long ctx;
  1070. long ret;
  1071. ret = get_user(ctx, ctxp);
  1072. if (unlikely(ret))
  1073. goto out;
  1074. ret = -EINVAL;
  1075. if (unlikely(ctx || nr_events == 0)) {
  1076. pr_debug("EINVAL: io_setup: ctx %lu nr_events %u\n",
  1077. ctx, nr_events);
  1078. goto out;
  1079. }
  1080. ioctx = ioctx_alloc(nr_events);
  1081. ret = PTR_ERR(ioctx);
  1082. if (!IS_ERR(ioctx)) {
  1083. ret = put_user(ioctx->user_id, ctxp);
  1084. if (!ret)
  1085. return 0;
  1086. get_ioctx(ioctx); /* io_destroy() expects us to hold a ref */
  1087. io_destroy(ioctx);
  1088. }
  1089. out:
  1090. return ret;
  1091. }
  1092. /* sys_io_destroy:
  1093. * Destroy the aio_context specified. May cancel any outstanding
  1094. * AIOs and block on completion. Will fail with -ENOSYS if not
  1095. * implemented. May fail with -EFAULT if the context pointed to
  1096. * is invalid.
  1097. */
  1098. asmlinkage long sys_io_destroy(aio_context_t ctx)
  1099. {
  1100. struct kioctx *ioctx = lookup_ioctx(ctx);
  1101. if (likely(NULL != ioctx)) {
  1102. io_destroy(ioctx);
  1103. return 0;
  1104. }
  1105. pr_debug("EINVAL: io_destroy: invalid context id\n");
  1106. return -EINVAL;
  1107. }
  1108. static void aio_advance_iovec(struct kiocb *iocb, ssize_t ret)
  1109. {
  1110. struct iovec *iov = &iocb->ki_iovec[iocb->ki_cur_seg];
  1111. BUG_ON(ret <= 0);
  1112. while (iocb->ki_cur_seg < iocb->ki_nr_segs && ret > 0) {
  1113. ssize_t this = min((ssize_t)iov->iov_len, ret);
  1114. iov->iov_base += this;
  1115. iov->iov_len -= this;
  1116. iocb->ki_left -= this;
  1117. ret -= this;
  1118. if (iov->iov_len == 0) {
  1119. iocb->ki_cur_seg++;
  1120. iov++;
  1121. }
  1122. }
  1123. /* the caller should not have done more io than what fit in
  1124. * the remaining iovecs */
  1125. BUG_ON(ret > 0 && iocb->ki_left == 0);
  1126. }
  1127. static ssize_t aio_rw_vect_retry(struct kiocb *iocb)
  1128. {
  1129. struct file *file = iocb->ki_filp;
  1130. struct address_space *mapping = file->f_mapping;
  1131. struct inode *inode = mapping->host;
  1132. ssize_t (*rw_op)(struct kiocb *, const struct iovec *,
  1133. unsigned long, loff_t);
  1134. ssize_t ret = 0;
  1135. unsigned short opcode;
  1136. if ((iocb->ki_opcode == IOCB_CMD_PREADV) ||
  1137. (iocb->ki_opcode == IOCB_CMD_PREAD)) {
  1138. rw_op = file->f_op->aio_read;
  1139. opcode = IOCB_CMD_PREADV;
  1140. } else {
  1141. rw_op = file->f_op->aio_write;
  1142. opcode = IOCB_CMD_PWRITEV;
  1143. }
  1144. do {
  1145. ret = rw_op(iocb, &iocb->ki_iovec[iocb->ki_cur_seg],
  1146. iocb->ki_nr_segs - iocb->ki_cur_seg,
  1147. iocb->ki_pos);
  1148. if (ret > 0)
  1149. aio_advance_iovec(iocb, ret);
  1150. /* retry all partial writes. retry partial reads as long as its a
  1151. * regular file. */
  1152. } while (ret > 0 && iocb->ki_left > 0 &&
  1153. (opcode == IOCB_CMD_PWRITEV ||
  1154. (!S_ISFIFO(inode->i_mode) && !S_ISSOCK(inode->i_mode))));
  1155. /* This means we must have transferred all that we could */
  1156. /* No need to retry anymore */
  1157. if ((ret == 0) || (iocb->ki_left == 0))
  1158. ret = iocb->ki_nbytes - iocb->ki_left;
  1159. return ret;
  1160. }
  1161. static ssize_t aio_fdsync(struct kiocb *iocb)
  1162. {
  1163. struct file *file = iocb->ki_filp;
  1164. ssize_t ret = -EINVAL;
  1165. if (file->f_op->aio_fsync)
  1166. ret = file->f_op->aio_fsync(iocb, 1);
  1167. return ret;
  1168. }
  1169. static ssize_t aio_fsync(struct kiocb *iocb)
  1170. {
  1171. struct file *file = iocb->ki_filp;
  1172. ssize_t ret = -EINVAL;
  1173. if (file->f_op->aio_fsync)
  1174. ret = file->f_op->aio_fsync(iocb, 0);
  1175. return ret;
  1176. }
  1177. static ssize_t aio_setup_vectored_rw(int type, struct kiocb *kiocb)
  1178. {
  1179. ssize_t ret;
  1180. ret = rw_copy_check_uvector(type, (struct iovec __user *)kiocb->ki_buf,
  1181. kiocb->ki_nbytes, 1,
  1182. &kiocb->ki_inline_vec, &kiocb->ki_iovec);
  1183. if (ret < 0)
  1184. goto out;
  1185. kiocb->ki_nr_segs = kiocb->ki_nbytes;
  1186. kiocb->ki_cur_seg = 0;
  1187. /* ki_nbytes/left now reflect bytes instead of segs */
  1188. kiocb->ki_nbytes = ret;
  1189. kiocb->ki_left = ret;
  1190. ret = 0;
  1191. out:
  1192. return ret;
  1193. }
  1194. static ssize_t aio_setup_single_vector(struct kiocb *kiocb)
  1195. {
  1196. kiocb->ki_iovec = &kiocb->ki_inline_vec;
  1197. kiocb->ki_iovec->iov_base = kiocb->ki_buf;
  1198. kiocb->ki_iovec->iov_len = kiocb->ki_left;
  1199. kiocb->ki_nr_segs = 1;
  1200. kiocb->ki_cur_seg = 0;
  1201. return 0;
  1202. }
  1203. /*
  1204. * aio_setup_iocb:
  1205. * Performs the initial checks and aio retry method
  1206. * setup for the kiocb at the time of io submission.
  1207. */
  1208. static ssize_t aio_setup_iocb(struct kiocb *kiocb)
  1209. {
  1210. struct file *file = kiocb->ki_filp;
  1211. ssize_t ret = 0;
  1212. switch (kiocb->ki_opcode) {
  1213. case IOCB_CMD_PREAD:
  1214. ret = -EBADF;
  1215. if (unlikely(!(file->f_mode & FMODE_READ)))
  1216. break;
  1217. ret = -EFAULT;
  1218. if (unlikely(!access_ok(VERIFY_WRITE, kiocb->ki_buf,
  1219. kiocb->ki_left)))
  1220. break;
  1221. ret = security_file_permission(file, MAY_READ);
  1222. if (unlikely(ret))
  1223. break;
  1224. ret = aio_setup_single_vector(kiocb);
  1225. if (ret)
  1226. break;
  1227. ret = -EINVAL;
  1228. if (file->f_op->aio_read)
  1229. kiocb->ki_retry = aio_rw_vect_retry;
  1230. break;
  1231. case IOCB_CMD_PWRITE:
  1232. ret = -EBADF;
  1233. if (unlikely(!(file->f_mode & FMODE_WRITE)))
  1234. break;
  1235. ret = -EFAULT;
  1236. if (unlikely(!access_ok(VERIFY_READ, kiocb->ki_buf,
  1237. kiocb->ki_left)))
  1238. break;
  1239. ret = security_file_permission(file, MAY_WRITE);
  1240. if (unlikely(ret))
  1241. break;
  1242. ret = aio_setup_single_vector(kiocb);
  1243. if (ret)
  1244. break;
  1245. ret = -EINVAL;
  1246. if (file->f_op->aio_write)
  1247. kiocb->ki_retry = aio_rw_vect_retry;
  1248. break;
  1249. case IOCB_CMD_PREADV:
  1250. ret = -EBADF;
  1251. if (unlikely(!(file->f_mode & FMODE_READ)))
  1252. break;
  1253. ret = security_file_permission(file, MAY_READ);
  1254. if (unlikely(ret))
  1255. break;
  1256. ret = aio_setup_vectored_rw(READ, kiocb);
  1257. if (ret)
  1258. break;
  1259. ret = -EINVAL;
  1260. if (file->f_op->aio_read)
  1261. kiocb->ki_retry = aio_rw_vect_retry;
  1262. break;
  1263. case IOCB_CMD_PWRITEV:
  1264. ret = -EBADF;
  1265. if (unlikely(!(file->f_mode & FMODE_WRITE)))
  1266. break;
  1267. ret = security_file_permission(file, MAY_WRITE);
  1268. if (unlikely(ret))
  1269. break;
  1270. ret = aio_setup_vectored_rw(WRITE, kiocb);
  1271. if (ret)
  1272. break;
  1273. ret = -EINVAL;
  1274. if (file->f_op->aio_write)
  1275. kiocb->ki_retry = aio_rw_vect_retry;
  1276. break;
  1277. case IOCB_CMD_FDSYNC:
  1278. ret = -EINVAL;
  1279. if (file->f_op->aio_fsync)
  1280. kiocb->ki_retry = aio_fdsync;
  1281. break;
  1282. case IOCB_CMD_FSYNC:
  1283. ret = -EINVAL;
  1284. if (file->f_op->aio_fsync)
  1285. kiocb->ki_retry = aio_fsync;
  1286. break;
  1287. default:
  1288. dprintk("EINVAL: io_submit: no operation provided\n");
  1289. ret = -EINVAL;
  1290. }
  1291. if (!kiocb->ki_retry)
  1292. return ret;
  1293. return 0;
  1294. }
  1295. /*
  1296. * aio_wake_function:
  1297. * wait queue callback function for aio notification,
  1298. * Simply triggers a retry of the operation via kick_iocb.
  1299. *
  1300. * This callback is specified in the wait queue entry in
  1301. * a kiocb.
  1302. *
  1303. * Note:
  1304. * This routine is executed with the wait queue lock held.
  1305. * Since kick_iocb acquires iocb->ctx->ctx_lock, it nests
  1306. * the ioctx lock inside the wait queue lock. This is safe
  1307. * because this callback isn't used for wait queues which
  1308. * are nested inside ioctx lock (i.e. ctx->wait)
  1309. */
  1310. static int aio_wake_function(wait_queue_t *wait, unsigned mode,
  1311. int sync, void *key)
  1312. {
  1313. struct kiocb *iocb = container_of(wait, struct kiocb, ki_wait);
  1314. list_del_init(&wait->task_list);
  1315. kick_iocb(iocb);
  1316. return 1;
  1317. }
  1318. int fastcall io_submit_one(struct kioctx *ctx, struct iocb __user *user_iocb,
  1319. struct iocb *iocb)
  1320. {
  1321. struct kiocb *req;
  1322. struct file *file;
  1323. ssize_t ret;
  1324. /* enforce forwards compatibility on users */
  1325. if (unlikely(iocb->aio_reserved1 || iocb->aio_reserved2)) {
  1326. pr_debug("EINVAL: io_submit: reserve field set\n");
  1327. return -EINVAL;
  1328. }
  1329. /* prevent overflows */
  1330. if (unlikely(
  1331. (iocb->aio_buf != (unsigned long)iocb->aio_buf) ||
  1332. (iocb->aio_nbytes != (size_t)iocb->aio_nbytes) ||
  1333. ((ssize_t)iocb->aio_nbytes < 0)
  1334. )) {
  1335. pr_debug("EINVAL: io_submit: overflow check\n");
  1336. return -EINVAL;
  1337. }
  1338. file = fget(iocb->aio_fildes);
  1339. if (unlikely(!file))
  1340. return -EBADF;
  1341. req = aio_get_req(ctx); /* returns with 2 references to req */
  1342. if (unlikely(!req)) {
  1343. fput(file);
  1344. return -EAGAIN;
  1345. }
  1346. req->ki_filp = file;
  1347. if (iocb->aio_flags & IOCB_FLAG_RESFD) {
  1348. /*
  1349. * If the IOCB_FLAG_RESFD flag of aio_flags is set, get an
  1350. * instance of the file* now. The file descriptor must be
  1351. * an eventfd() fd, and will be signaled for each completed
  1352. * event using the eventfd_signal() function.
  1353. */
  1354. req->ki_eventfd = eventfd_fget((int) iocb->aio_resfd);
  1355. if (unlikely(IS_ERR(req->ki_eventfd))) {
  1356. ret = PTR_ERR(req->ki_eventfd);
  1357. goto out_put_req;
  1358. }
  1359. }
  1360. ret = put_user(req->ki_key, &user_iocb->aio_key);
  1361. if (unlikely(ret)) {
  1362. dprintk("EFAULT: aio_key\n");
  1363. goto out_put_req;
  1364. }
  1365. req->ki_obj.user = user_iocb;
  1366. req->ki_user_data = iocb->aio_data;
  1367. req->ki_pos = iocb->aio_offset;
  1368. req->ki_buf = (char __user *)(unsigned long)iocb->aio_buf;
  1369. req->ki_left = req->ki_nbytes = iocb->aio_nbytes;
  1370. req->ki_opcode = iocb->aio_lio_opcode;
  1371. init_waitqueue_func_entry(&req->ki_wait, aio_wake_function);
  1372. INIT_LIST_HEAD(&req->ki_wait.task_list);
  1373. ret = aio_setup_iocb(req);
  1374. if (ret)
  1375. goto out_put_req;
  1376. spin_lock_irq(&ctx->ctx_lock);
  1377. aio_run_iocb(req);
  1378. if (!list_empty(&ctx->run_list)) {
  1379. /* drain the run list */
  1380. while (__aio_run_iocbs(ctx))
  1381. ;
  1382. }
  1383. spin_unlock_irq(&ctx->ctx_lock);
  1384. aio_put_req(req); /* drop extra ref to req */
  1385. return 0;
  1386. out_put_req:
  1387. aio_put_req(req); /* drop extra ref to req */
  1388. aio_put_req(req); /* drop i/o ref to req */
  1389. return ret;
  1390. }
  1391. /* sys_io_submit:
  1392. * Queue the nr iocbs pointed to by iocbpp for processing. Returns
  1393. * the number of iocbs queued. May return -EINVAL if the aio_context
  1394. * specified by ctx_id is invalid, if nr is < 0, if the iocb at
  1395. * *iocbpp[0] is not properly initialized, if the operation specified
  1396. * is invalid for the file descriptor in the iocb. May fail with
  1397. * -EFAULT if any of the data structures point to invalid data. May
  1398. * fail with -EBADF if the file descriptor specified in the first
  1399. * iocb is invalid. May fail with -EAGAIN if insufficient resources
  1400. * are available to queue any iocbs. Will return 0 if nr is 0. Will
  1401. * fail with -ENOSYS if not implemented.
  1402. */
  1403. asmlinkage long sys_io_submit(aio_context_t ctx_id, long nr,
  1404. struct iocb __user * __user *iocbpp)
  1405. {
  1406. struct kioctx *ctx;
  1407. long ret = 0;
  1408. int i;
  1409. if (unlikely(nr < 0))
  1410. return -EINVAL;
  1411. if (unlikely(!access_ok(VERIFY_READ, iocbpp, (nr*sizeof(*iocbpp)))))
  1412. return -EFAULT;
  1413. ctx = lookup_ioctx(ctx_id);
  1414. if (unlikely(!ctx)) {
  1415. pr_debug("EINVAL: io_submit: invalid context id\n");
  1416. return -EINVAL;
  1417. }
  1418. /*
  1419. * AKPM: should this return a partial result if some of the IOs were
  1420. * successfully submitted?
  1421. */
  1422. for (i=0; i<nr; i++) {
  1423. struct iocb __user *user_iocb;
  1424. struct iocb tmp;
  1425. if (unlikely(__get_user(user_iocb, iocbpp + i))) {
  1426. ret = -EFAULT;
  1427. break;
  1428. }
  1429. if (unlikely(copy_from_user(&tmp, user_iocb, sizeof(tmp)))) {
  1430. ret = -EFAULT;
  1431. break;
  1432. }
  1433. ret = io_submit_one(ctx, user_iocb, &tmp);
  1434. if (ret)
  1435. break;
  1436. }
  1437. put_ioctx(ctx);
  1438. return i ? i : ret;
  1439. }
  1440. /* lookup_kiocb
  1441. * Finds a given iocb for cancellation.
  1442. */
  1443. static struct kiocb *lookup_kiocb(struct kioctx *ctx, struct iocb __user *iocb,
  1444. u32 key)
  1445. {
  1446. struct list_head *pos;
  1447. assert_spin_locked(&ctx->ctx_lock);
  1448. /* TODO: use a hash or array, this sucks. */
  1449. list_for_each(pos, &ctx->active_reqs) {
  1450. struct kiocb *kiocb = list_kiocb(pos);
  1451. if (kiocb->ki_obj.user == iocb && kiocb->ki_key == key)
  1452. return kiocb;
  1453. }
  1454. return NULL;
  1455. }
  1456. /* sys_io_cancel:
  1457. * Attempts to cancel an iocb previously passed to io_submit. If
  1458. * the operation is successfully cancelled, the resulting event is
  1459. * copied into the memory pointed to by result without being placed
  1460. * into the completion queue and 0 is returned. May fail with
  1461. * -EFAULT if any of the data structures pointed to are invalid.
  1462. * May fail with -EINVAL if aio_context specified by ctx_id is
  1463. * invalid. May fail with -EAGAIN if the iocb specified was not
  1464. * cancelled. Will fail with -ENOSYS if not implemented.
  1465. */
  1466. asmlinkage long sys_io_cancel(aio_context_t ctx_id, struct iocb __user *iocb,
  1467. struct io_event __user *result)
  1468. {
  1469. int (*cancel)(struct kiocb *iocb, struct io_event *res);
  1470. struct kioctx *ctx;
  1471. struct kiocb *kiocb;
  1472. u32 key;
  1473. int ret;
  1474. ret = get_user(key, &iocb->aio_key);
  1475. if (unlikely(ret))
  1476. return -EFAULT;
  1477. ctx = lookup_ioctx(ctx_id);
  1478. if (unlikely(!ctx))
  1479. return -EINVAL;
  1480. spin_lock_irq(&ctx->ctx_lock);
  1481. ret = -EAGAIN;
  1482. kiocb = lookup_kiocb(ctx, iocb, key);
  1483. if (kiocb && kiocb->ki_cancel) {
  1484. cancel = kiocb->ki_cancel;
  1485. kiocb->ki_users ++;
  1486. kiocbSetCancelled(kiocb);
  1487. } else
  1488. cancel = NULL;
  1489. spin_unlock_irq(&ctx->ctx_lock);
  1490. if (NULL != cancel) {
  1491. struct io_event tmp;
  1492. pr_debug("calling cancel\n");
  1493. memset(&tmp, 0, sizeof(tmp));
  1494. tmp.obj = (u64)(unsigned long)kiocb->ki_obj.user;
  1495. tmp.data = kiocb->ki_user_data;
  1496. ret = cancel(kiocb, &tmp);
  1497. if (!ret) {
  1498. /* Cancellation succeeded -- copy the result
  1499. * into the user's buffer.
  1500. */
  1501. if (copy_to_user(result, &tmp, sizeof(tmp)))
  1502. ret = -EFAULT;
  1503. }
  1504. } else
  1505. ret = -EINVAL;
  1506. put_ioctx(ctx);
  1507. return ret;
  1508. }
  1509. /* io_getevents:
  1510. * Attempts to read at least min_nr events and up to nr events from
  1511. * the completion queue for the aio_context specified by ctx_id. May
  1512. * fail with -EINVAL if ctx_id is invalid, if min_nr is out of range,
  1513. * if nr is out of range, if when is out of range. May fail with
  1514. * -EFAULT if any of the memory specified to is invalid. May return
  1515. * 0 or < min_nr if no events are available and the timeout specified
  1516. * by when has elapsed, where when == NULL specifies an infinite
  1517. * timeout. Note that the timeout pointed to by when is relative and
  1518. * will be updated if not NULL and the operation blocks. Will fail
  1519. * with -ENOSYS if not implemented.
  1520. */
  1521. asmlinkage long sys_io_getevents(aio_context_t ctx_id,
  1522. long min_nr,
  1523. long nr,
  1524. struct io_event __user *events,
  1525. struct timespec __user *timeout)
  1526. {
  1527. struct kioctx *ioctx = lookup_ioctx(ctx_id);
  1528. long ret = -EINVAL;
  1529. if (likely(ioctx)) {
  1530. if (likely(min_nr <= nr && min_nr >= 0 && nr >= 0))
  1531. ret = read_events(ioctx, min_nr, nr, events, timeout);
  1532. put_ioctx(ioctx);
  1533. }
  1534. return ret;
  1535. }
  1536. __initcall(aio_setup);
  1537. EXPORT_SYMBOL(aio_complete);
  1538. EXPORT_SYMBOL(aio_put_req);
  1539. EXPORT_SYMBOL(wait_on_sync_kiocb);