direct-io.c 34 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228
  1. /*
  2. * fs/direct-io.c
  3. *
  4. * Copyright (C) 2002, Linus Torvalds.
  5. *
  6. * O_DIRECT
  7. *
  8. * 04Jul2002 akpm@zip.com.au
  9. * Initial version
  10. * 11Sep2002 janetinc@us.ibm.com
  11. * added readv/writev support.
  12. * 29Oct2002 akpm@zip.com.au
  13. * rewrote bio_add_page() support.
  14. * 30Oct2002 pbadari@us.ibm.com
  15. * added support for non-aligned IO.
  16. * 06Nov2002 pbadari@us.ibm.com
  17. * added asynchronous IO support.
  18. * 21Jul2003 nathans@sgi.com
  19. * added IO completion notifier.
  20. */
  21. #include <linux/kernel.h>
  22. #include <linux/module.h>
  23. #include <linux/types.h>
  24. #include <linux/fs.h>
  25. #include <linux/mm.h>
  26. #include <linux/slab.h>
  27. #include <linux/highmem.h>
  28. #include <linux/pagemap.h>
  29. #include <linux/task_io_accounting_ops.h>
  30. #include <linux/bio.h>
  31. #include <linux/wait.h>
  32. #include <linux/err.h>
  33. #include <linux/blkdev.h>
  34. #include <linux/buffer_head.h>
  35. #include <linux/rwsem.h>
  36. #include <linux/uio.h>
  37. #include <asm/atomic.h>
  38. /*
  39. * How many user pages to map in one call to get_user_pages(). This determines
  40. * the size of a structure on the stack.
  41. */
  42. #define DIO_PAGES 64
  43. /*
  44. * This code generally works in units of "dio_blocks". A dio_block is
  45. * somewhere between the hard sector size and the filesystem block size. it
  46. * is determined on a per-invocation basis. When talking to the filesystem
  47. * we need to convert dio_blocks to fs_blocks by scaling the dio_block quantity
  48. * down by dio->blkfactor. Similarly, fs-blocksize quantities are converted
  49. * to bio_block quantities by shifting left by blkfactor.
  50. *
  51. * If blkfactor is zero then the user's request was aligned to the filesystem's
  52. * blocksize.
  53. *
  54. * lock_type is DIO_LOCKING for regular files on direct-IO-naive filesystems.
  55. * This determines whether we need to do the fancy locking which prevents
  56. * direct-IO from being able to read uninitialised disk blocks. If its zero
  57. * (blockdev) this locking is not done, and if it is DIO_OWN_LOCKING i_mutex is
  58. * not held for the entire direct write (taken briefly, initially, during a
  59. * direct read though, but its never held for the duration of a direct-IO).
  60. */
  61. struct dio {
  62. /* BIO submission state */
  63. struct bio *bio; /* bio under assembly */
  64. struct inode *inode;
  65. int rw;
  66. loff_t i_size; /* i_size when submitted */
  67. int lock_type; /* doesn't change */
  68. unsigned blkbits; /* doesn't change */
  69. unsigned blkfactor; /* When we're using an alignment which
  70. is finer than the filesystem's soft
  71. blocksize, this specifies how much
  72. finer. blkfactor=2 means 1/4-block
  73. alignment. Does not change */
  74. unsigned start_zero_done; /* flag: sub-blocksize zeroing has
  75. been performed at the start of a
  76. write */
  77. int pages_in_io; /* approximate total IO pages */
  78. size_t size; /* total request size (doesn't change)*/
  79. sector_t block_in_file; /* Current offset into the underlying
  80. file in dio_block units. */
  81. unsigned blocks_available; /* At block_in_file. changes */
  82. sector_t final_block_in_request;/* doesn't change */
  83. unsigned first_block_in_page; /* doesn't change, Used only once */
  84. int boundary; /* prev block is at a boundary */
  85. int reap_counter; /* rate limit reaping */
  86. get_block_t *get_block; /* block mapping function */
  87. dio_iodone_t *end_io; /* IO completion function */
  88. sector_t final_block_in_bio; /* current final block in bio + 1 */
  89. sector_t next_block_for_io; /* next block to be put under IO,
  90. in dio_blocks units */
  91. struct buffer_head map_bh; /* last get_block() result */
  92. /*
  93. * Deferred addition of a page to the dio. These variables are
  94. * private to dio_send_cur_page(), submit_page_section() and
  95. * dio_bio_add_page().
  96. */
  97. struct page *cur_page; /* The page */
  98. unsigned cur_page_offset; /* Offset into it, in bytes */
  99. unsigned cur_page_len; /* Nr of bytes at cur_page_offset */
  100. sector_t cur_page_block; /* Where it starts */
  101. /*
  102. * Page fetching state. These variables belong to dio_refill_pages().
  103. */
  104. int curr_page; /* changes */
  105. int total_pages; /* doesn't change */
  106. unsigned long curr_user_address;/* changes */
  107. /*
  108. * Page queue. These variables belong to dio_refill_pages() and
  109. * dio_get_page().
  110. */
  111. struct page *pages[DIO_PAGES]; /* page buffer */
  112. unsigned head; /* next page to process */
  113. unsigned tail; /* last valid page + 1 */
  114. int page_errors; /* errno from get_user_pages() */
  115. /* BIO completion state */
  116. spinlock_t bio_lock; /* protects BIO fields below */
  117. unsigned long refcount; /* direct_io_worker() and bios */
  118. struct bio *bio_list; /* singly linked via bi_private */
  119. struct task_struct *waiter; /* waiting task (NULL if none) */
  120. /* AIO related stuff */
  121. struct kiocb *iocb; /* kiocb */
  122. int is_async; /* is IO async ? */
  123. int io_error; /* IO error in completion path */
  124. ssize_t result; /* IO result */
  125. };
  126. /*
  127. * How many pages are in the queue?
  128. */
  129. static inline unsigned dio_pages_present(struct dio *dio)
  130. {
  131. return dio->tail - dio->head;
  132. }
  133. /*
  134. * Go grab and pin some userspace pages. Typically we'll get 64 at a time.
  135. */
  136. static int dio_refill_pages(struct dio *dio)
  137. {
  138. int ret;
  139. int nr_pages;
  140. nr_pages = min(dio->total_pages - dio->curr_page, DIO_PAGES);
  141. down_read(&current->mm->mmap_sem);
  142. ret = get_user_pages(
  143. current, /* Task for fault acounting */
  144. current->mm, /* whose pages? */
  145. dio->curr_user_address, /* Where from? */
  146. nr_pages, /* How many pages? */
  147. dio->rw == READ, /* Write to memory? */
  148. 0, /* force (?) */
  149. &dio->pages[0],
  150. NULL); /* vmas */
  151. up_read(&current->mm->mmap_sem);
  152. if (ret < 0 && dio->blocks_available && (dio->rw & WRITE)) {
  153. struct page *page = ZERO_PAGE(0);
  154. /*
  155. * A memory fault, but the filesystem has some outstanding
  156. * mapped blocks. We need to use those blocks up to avoid
  157. * leaking stale data in the file.
  158. */
  159. if (dio->page_errors == 0)
  160. dio->page_errors = ret;
  161. page_cache_get(page);
  162. dio->pages[0] = page;
  163. dio->head = 0;
  164. dio->tail = 1;
  165. ret = 0;
  166. goto out;
  167. }
  168. if (ret >= 0) {
  169. dio->curr_user_address += ret * PAGE_SIZE;
  170. dio->curr_page += ret;
  171. dio->head = 0;
  172. dio->tail = ret;
  173. ret = 0;
  174. }
  175. out:
  176. return ret;
  177. }
  178. /*
  179. * Get another userspace page. Returns an ERR_PTR on error. Pages are
  180. * buffered inside the dio so that we can call get_user_pages() against a
  181. * decent number of pages, less frequently. To provide nicer use of the
  182. * L1 cache.
  183. */
  184. static struct page *dio_get_page(struct dio *dio)
  185. {
  186. if (dio_pages_present(dio) == 0) {
  187. int ret;
  188. ret = dio_refill_pages(dio);
  189. if (ret)
  190. return ERR_PTR(ret);
  191. BUG_ON(dio_pages_present(dio) == 0);
  192. }
  193. return dio->pages[dio->head++];
  194. }
  195. /**
  196. * dio_complete() - called when all DIO BIO I/O has been completed
  197. * @offset: the byte offset in the file of the completed operation
  198. *
  199. * This releases locks as dictated by the locking type, lets interested parties
  200. * know that a DIO operation has completed, and calculates the resulting return
  201. * code for the operation.
  202. *
  203. * It lets the filesystem know if it registered an interest earlier via
  204. * get_block. Pass the private field of the map buffer_head so that
  205. * filesystems can use it to hold additional state between get_block calls and
  206. * dio_complete.
  207. */
  208. static int dio_complete(struct dio *dio, loff_t offset, int ret)
  209. {
  210. ssize_t transferred = 0;
  211. /*
  212. * AIO submission can race with bio completion to get here while
  213. * expecting to have the last io completed by bio completion.
  214. * In that case -EIOCBQUEUED is in fact not an error we want
  215. * to preserve through this call.
  216. */
  217. if (ret == -EIOCBQUEUED)
  218. ret = 0;
  219. if (dio->result) {
  220. transferred = dio->result;
  221. /* Check for short read case */
  222. if ((dio->rw == READ) && ((offset + transferred) > dio->i_size))
  223. transferred = dio->i_size - offset;
  224. }
  225. if (dio->end_io && dio->result)
  226. dio->end_io(dio->iocb, offset, transferred,
  227. dio->map_bh.b_private);
  228. if (dio->lock_type == DIO_LOCKING)
  229. /* lockdep: non-owner release */
  230. up_read_non_owner(&dio->inode->i_alloc_sem);
  231. if (ret == 0)
  232. ret = dio->page_errors;
  233. if (ret == 0)
  234. ret = dio->io_error;
  235. if (ret == 0)
  236. ret = transferred;
  237. return ret;
  238. }
  239. static int dio_bio_complete(struct dio *dio, struct bio *bio);
  240. /*
  241. * Asynchronous IO callback.
  242. */
  243. static void dio_bio_end_aio(struct bio *bio, int error)
  244. {
  245. struct dio *dio = bio->bi_private;
  246. unsigned long remaining;
  247. unsigned long flags;
  248. /* cleanup the bio */
  249. dio_bio_complete(dio, bio);
  250. spin_lock_irqsave(&dio->bio_lock, flags);
  251. remaining = --dio->refcount;
  252. if (remaining == 1 && dio->waiter)
  253. wake_up_process(dio->waiter);
  254. spin_unlock_irqrestore(&dio->bio_lock, flags);
  255. if (remaining == 0) {
  256. int ret = dio_complete(dio, dio->iocb->ki_pos, 0);
  257. aio_complete(dio->iocb, ret, 0);
  258. kfree(dio);
  259. }
  260. }
  261. /*
  262. * The BIO completion handler simply queues the BIO up for the process-context
  263. * handler.
  264. *
  265. * During I/O bi_private points at the dio. After I/O, bi_private is used to
  266. * implement a singly-linked list of completed BIOs, at dio->bio_list.
  267. */
  268. static void dio_bio_end_io(struct bio *bio, int error)
  269. {
  270. struct dio *dio = bio->bi_private;
  271. unsigned long flags;
  272. spin_lock_irqsave(&dio->bio_lock, flags);
  273. bio->bi_private = dio->bio_list;
  274. dio->bio_list = bio;
  275. if (--dio->refcount == 1 && dio->waiter)
  276. wake_up_process(dio->waiter);
  277. spin_unlock_irqrestore(&dio->bio_lock, flags);
  278. }
  279. static int
  280. dio_bio_alloc(struct dio *dio, struct block_device *bdev,
  281. sector_t first_sector, int nr_vecs)
  282. {
  283. struct bio *bio;
  284. bio = bio_alloc(GFP_KERNEL, nr_vecs);
  285. if (bio == NULL)
  286. return -ENOMEM;
  287. bio->bi_bdev = bdev;
  288. bio->bi_sector = first_sector;
  289. if (dio->is_async)
  290. bio->bi_end_io = dio_bio_end_aio;
  291. else
  292. bio->bi_end_io = dio_bio_end_io;
  293. dio->bio = bio;
  294. return 0;
  295. }
  296. /*
  297. * In the AIO read case we speculatively dirty the pages before starting IO.
  298. * During IO completion, any of these pages which happen to have been written
  299. * back will be redirtied by bio_check_pages_dirty().
  300. *
  301. * bios hold a dio reference between submit_bio and ->end_io.
  302. */
  303. static void dio_bio_submit(struct dio *dio)
  304. {
  305. struct bio *bio = dio->bio;
  306. unsigned long flags;
  307. bio->bi_private = dio;
  308. spin_lock_irqsave(&dio->bio_lock, flags);
  309. dio->refcount++;
  310. spin_unlock_irqrestore(&dio->bio_lock, flags);
  311. if (dio->is_async && dio->rw == READ)
  312. bio_set_pages_dirty(bio);
  313. submit_bio(dio->rw, bio);
  314. dio->bio = NULL;
  315. dio->boundary = 0;
  316. }
  317. /*
  318. * Release any resources in case of a failure
  319. */
  320. static void dio_cleanup(struct dio *dio)
  321. {
  322. while (dio_pages_present(dio))
  323. page_cache_release(dio_get_page(dio));
  324. }
  325. /*
  326. * Wait for the next BIO to complete. Remove it and return it. NULL is
  327. * returned once all BIOs have been completed. This must only be called once
  328. * all bios have been issued so that dio->refcount can only decrease. This
  329. * requires that that the caller hold a reference on the dio.
  330. */
  331. static struct bio *dio_await_one(struct dio *dio)
  332. {
  333. unsigned long flags;
  334. struct bio *bio = NULL;
  335. spin_lock_irqsave(&dio->bio_lock, flags);
  336. /*
  337. * Wait as long as the list is empty and there are bios in flight. bio
  338. * completion drops the count, maybe adds to the list, and wakes while
  339. * holding the bio_lock so we don't need set_current_state()'s barrier
  340. * and can call it after testing our condition.
  341. */
  342. while (dio->refcount > 1 && dio->bio_list == NULL) {
  343. __set_current_state(TASK_UNINTERRUPTIBLE);
  344. dio->waiter = current;
  345. spin_unlock_irqrestore(&dio->bio_lock, flags);
  346. io_schedule();
  347. /* wake up sets us TASK_RUNNING */
  348. spin_lock_irqsave(&dio->bio_lock, flags);
  349. dio->waiter = NULL;
  350. }
  351. if (dio->bio_list) {
  352. bio = dio->bio_list;
  353. dio->bio_list = bio->bi_private;
  354. }
  355. spin_unlock_irqrestore(&dio->bio_lock, flags);
  356. return bio;
  357. }
  358. /*
  359. * Process one completed BIO. No locks are held.
  360. */
  361. static int dio_bio_complete(struct dio *dio, struct bio *bio)
  362. {
  363. const int uptodate = test_bit(BIO_UPTODATE, &bio->bi_flags);
  364. struct bio_vec *bvec = bio->bi_io_vec;
  365. int page_no;
  366. if (!uptodate)
  367. dio->io_error = -EIO;
  368. if (dio->is_async && dio->rw == READ) {
  369. bio_check_pages_dirty(bio); /* transfers ownership */
  370. } else {
  371. for (page_no = 0; page_no < bio->bi_vcnt; page_no++) {
  372. struct page *page = bvec[page_no].bv_page;
  373. if (dio->rw == READ && !PageCompound(page))
  374. set_page_dirty_lock(page);
  375. page_cache_release(page);
  376. }
  377. bio_put(bio);
  378. }
  379. return uptodate ? 0 : -EIO;
  380. }
  381. /*
  382. * Wait on and process all in-flight BIOs. This must only be called once
  383. * all bios have been issued so that the refcount can only decrease.
  384. * This just waits for all bios to make it through dio_bio_complete. IO
  385. * errors are propagated through dio->io_error and should be propagated via
  386. * dio_complete().
  387. */
  388. static void dio_await_completion(struct dio *dio)
  389. {
  390. struct bio *bio;
  391. do {
  392. bio = dio_await_one(dio);
  393. if (bio)
  394. dio_bio_complete(dio, bio);
  395. } while (bio);
  396. }
  397. /*
  398. * A really large O_DIRECT read or write can generate a lot of BIOs. So
  399. * to keep the memory consumption sane we periodically reap any completed BIOs
  400. * during the BIO generation phase.
  401. *
  402. * This also helps to limit the peak amount of pinned userspace memory.
  403. */
  404. static int dio_bio_reap(struct dio *dio)
  405. {
  406. int ret = 0;
  407. if (dio->reap_counter++ >= 64) {
  408. while (dio->bio_list) {
  409. unsigned long flags;
  410. struct bio *bio;
  411. int ret2;
  412. spin_lock_irqsave(&dio->bio_lock, flags);
  413. bio = dio->bio_list;
  414. dio->bio_list = bio->bi_private;
  415. spin_unlock_irqrestore(&dio->bio_lock, flags);
  416. ret2 = dio_bio_complete(dio, bio);
  417. if (ret == 0)
  418. ret = ret2;
  419. }
  420. dio->reap_counter = 0;
  421. }
  422. return ret;
  423. }
  424. /*
  425. * Call into the fs to map some more disk blocks. We record the current number
  426. * of available blocks at dio->blocks_available. These are in units of the
  427. * fs blocksize, (1 << inode->i_blkbits).
  428. *
  429. * The fs is allowed to map lots of blocks at once. If it wants to do that,
  430. * it uses the passed inode-relative block number as the file offset, as usual.
  431. *
  432. * get_block() is passed the number of i_blkbits-sized blocks which direct_io
  433. * has remaining to do. The fs should not map more than this number of blocks.
  434. *
  435. * If the fs has mapped a lot of blocks, it should populate bh->b_size to
  436. * indicate how much contiguous disk space has been made available at
  437. * bh->b_blocknr.
  438. *
  439. * If *any* of the mapped blocks are new, then the fs must set buffer_new().
  440. * This isn't very efficient...
  441. *
  442. * In the case of filesystem holes: the fs may return an arbitrarily-large
  443. * hole by returning an appropriate value in b_size and by clearing
  444. * buffer_mapped(). However the direct-io code will only process holes one
  445. * block at a time - it will repeatedly call get_block() as it walks the hole.
  446. */
  447. static int get_more_blocks(struct dio *dio)
  448. {
  449. int ret;
  450. struct buffer_head *map_bh = &dio->map_bh;
  451. sector_t fs_startblk; /* Into file, in filesystem-sized blocks */
  452. unsigned long fs_count; /* Number of filesystem-sized blocks */
  453. unsigned long dio_count;/* Number of dio_block-sized blocks */
  454. unsigned long blkmask;
  455. int create;
  456. /*
  457. * If there was a memory error and we've overwritten all the
  458. * mapped blocks then we can now return that memory error
  459. */
  460. ret = dio->page_errors;
  461. if (ret == 0) {
  462. BUG_ON(dio->block_in_file >= dio->final_block_in_request);
  463. fs_startblk = dio->block_in_file >> dio->blkfactor;
  464. dio_count = dio->final_block_in_request - dio->block_in_file;
  465. fs_count = dio_count >> dio->blkfactor;
  466. blkmask = (1 << dio->blkfactor) - 1;
  467. if (dio_count & blkmask)
  468. fs_count++;
  469. map_bh->b_state = 0;
  470. map_bh->b_size = fs_count << dio->inode->i_blkbits;
  471. create = dio->rw & WRITE;
  472. if (dio->lock_type == DIO_LOCKING) {
  473. if (dio->block_in_file < (i_size_read(dio->inode) >>
  474. dio->blkbits))
  475. create = 0;
  476. } else if (dio->lock_type == DIO_NO_LOCKING) {
  477. create = 0;
  478. }
  479. /*
  480. * For writes inside i_size we forbid block creations: only
  481. * overwrites are permitted. We fall back to buffered writes
  482. * at a higher level for inside-i_size block-instantiating
  483. * writes.
  484. */
  485. ret = (*dio->get_block)(dio->inode, fs_startblk,
  486. map_bh, create);
  487. }
  488. return ret;
  489. }
  490. /*
  491. * There is no bio. Make one now.
  492. */
  493. static int dio_new_bio(struct dio *dio, sector_t start_sector)
  494. {
  495. sector_t sector;
  496. int ret, nr_pages;
  497. ret = dio_bio_reap(dio);
  498. if (ret)
  499. goto out;
  500. sector = start_sector << (dio->blkbits - 9);
  501. nr_pages = min(dio->pages_in_io, bio_get_nr_vecs(dio->map_bh.b_bdev));
  502. BUG_ON(nr_pages <= 0);
  503. ret = dio_bio_alloc(dio, dio->map_bh.b_bdev, sector, nr_pages);
  504. dio->boundary = 0;
  505. out:
  506. return ret;
  507. }
  508. /*
  509. * Attempt to put the current chunk of 'cur_page' into the current BIO. If
  510. * that was successful then update final_block_in_bio and take a ref against
  511. * the just-added page.
  512. *
  513. * Return zero on success. Non-zero means the caller needs to start a new BIO.
  514. */
  515. static int dio_bio_add_page(struct dio *dio)
  516. {
  517. int ret;
  518. ret = bio_add_page(dio->bio, dio->cur_page,
  519. dio->cur_page_len, dio->cur_page_offset);
  520. if (ret == dio->cur_page_len) {
  521. /*
  522. * Decrement count only, if we are done with this page
  523. */
  524. if ((dio->cur_page_len + dio->cur_page_offset) == PAGE_SIZE)
  525. dio->pages_in_io--;
  526. page_cache_get(dio->cur_page);
  527. dio->final_block_in_bio = dio->cur_page_block +
  528. (dio->cur_page_len >> dio->blkbits);
  529. ret = 0;
  530. } else {
  531. ret = 1;
  532. }
  533. return ret;
  534. }
  535. /*
  536. * Put cur_page under IO. The section of cur_page which is described by
  537. * cur_page_offset,cur_page_len is put into a BIO. The section of cur_page
  538. * starts on-disk at cur_page_block.
  539. *
  540. * We take a ref against the page here (on behalf of its presence in the bio).
  541. *
  542. * The caller of this function is responsible for removing cur_page from the
  543. * dio, and for dropping the refcount which came from that presence.
  544. */
  545. static int dio_send_cur_page(struct dio *dio)
  546. {
  547. int ret = 0;
  548. if (dio->bio) {
  549. /*
  550. * See whether this new request is contiguous with the old
  551. */
  552. if (dio->final_block_in_bio != dio->cur_page_block)
  553. dio_bio_submit(dio);
  554. /*
  555. * Submit now if the underlying fs is about to perform a
  556. * metadata read
  557. */
  558. if (dio->boundary)
  559. dio_bio_submit(dio);
  560. }
  561. if (dio->bio == NULL) {
  562. ret = dio_new_bio(dio, dio->cur_page_block);
  563. if (ret)
  564. goto out;
  565. }
  566. if (dio_bio_add_page(dio) != 0) {
  567. dio_bio_submit(dio);
  568. ret = dio_new_bio(dio, dio->cur_page_block);
  569. if (ret == 0) {
  570. ret = dio_bio_add_page(dio);
  571. BUG_ON(ret != 0);
  572. }
  573. }
  574. out:
  575. return ret;
  576. }
  577. /*
  578. * An autonomous function to put a chunk of a page under deferred IO.
  579. *
  580. * The caller doesn't actually know (or care) whether this piece of page is in
  581. * a BIO, or is under IO or whatever. We just take care of all possible
  582. * situations here. The separation between the logic of do_direct_IO() and
  583. * that of submit_page_section() is important for clarity. Please don't break.
  584. *
  585. * The chunk of page starts on-disk at blocknr.
  586. *
  587. * We perform deferred IO, by recording the last-submitted page inside our
  588. * private part of the dio structure. If possible, we just expand the IO
  589. * across that page here.
  590. *
  591. * If that doesn't work out then we put the old page into the bio and add this
  592. * page to the dio instead.
  593. */
  594. static int
  595. submit_page_section(struct dio *dio, struct page *page,
  596. unsigned offset, unsigned len, sector_t blocknr)
  597. {
  598. int ret = 0;
  599. if (dio->rw & WRITE) {
  600. /*
  601. * Read accounting is performed in submit_bio()
  602. */
  603. task_io_account_write(len);
  604. }
  605. /*
  606. * Can we just grow the current page's presence in the dio?
  607. */
  608. if ( (dio->cur_page == page) &&
  609. (dio->cur_page_offset + dio->cur_page_len == offset) &&
  610. (dio->cur_page_block +
  611. (dio->cur_page_len >> dio->blkbits) == blocknr)) {
  612. dio->cur_page_len += len;
  613. /*
  614. * If dio->boundary then we want to schedule the IO now to
  615. * avoid metadata seeks.
  616. */
  617. if (dio->boundary) {
  618. ret = dio_send_cur_page(dio);
  619. page_cache_release(dio->cur_page);
  620. dio->cur_page = NULL;
  621. }
  622. goto out;
  623. }
  624. /*
  625. * If there's a deferred page already there then send it.
  626. */
  627. if (dio->cur_page) {
  628. ret = dio_send_cur_page(dio);
  629. page_cache_release(dio->cur_page);
  630. dio->cur_page = NULL;
  631. if (ret)
  632. goto out;
  633. }
  634. page_cache_get(page); /* It is in dio */
  635. dio->cur_page = page;
  636. dio->cur_page_offset = offset;
  637. dio->cur_page_len = len;
  638. dio->cur_page_block = blocknr;
  639. out:
  640. return ret;
  641. }
  642. /*
  643. * Clean any dirty buffers in the blockdev mapping which alias newly-created
  644. * file blocks. Only called for S_ISREG files - blockdevs do not set
  645. * buffer_new
  646. */
  647. static void clean_blockdev_aliases(struct dio *dio)
  648. {
  649. unsigned i;
  650. unsigned nblocks;
  651. nblocks = dio->map_bh.b_size >> dio->inode->i_blkbits;
  652. for (i = 0; i < nblocks; i++) {
  653. unmap_underlying_metadata(dio->map_bh.b_bdev,
  654. dio->map_bh.b_blocknr + i);
  655. }
  656. }
  657. /*
  658. * If we are not writing the entire block and get_block() allocated
  659. * the block for us, we need to fill-in the unused portion of the
  660. * block with zeros. This happens only if user-buffer, fileoffset or
  661. * io length is not filesystem block-size multiple.
  662. *
  663. * `end' is zero if we're doing the start of the IO, 1 at the end of the
  664. * IO.
  665. */
  666. static void dio_zero_block(struct dio *dio, int end)
  667. {
  668. unsigned dio_blocks_per_fs_block;
  669. unsigned this_chunk_blocks; /* In dio_blocks */
  670. unsigned this_chunk_bytes;
  671. struct page *page;
  672. dio->start_zero_done = 1;
  673. if (!dio->blkfactor || !buffer_new(&dio->map_bh))
  674. return;
  675. dio_blocks_per_fs_block = 1 << dio->blkfactor;
  676. this_chunk_blocks = dio->block_in_file & (dio_blocks_per_fs_block - 1);
  677. if (!this_chunk_blocks)
  678. return;
  679. /*
  680. * We need to zero out part of an fs block. It is either at the
  681. * beginning or the end of the fs block.
  682. */
  683. if (end)
  684. this_chunk_blocks = dio_blocks_per_fs_block - this_chunk_blocks;
  685. this_chunk_bytes = this_chunk_blocks << dio->blkbits;
  686. page = ZERO_PAGE(0);
  687. if (submit_page_section(dio, page, 0, this_chunk_bytes,
  688. dio->next_block_for_io))
  689. return;
  690. dio->next_block_for_io += this_chunk_blocks;
  691. }
  692. /*
  693. * Walk the user pages, and the file, mapping blocks to disk and generating
  694. * a sequence of (page,offset,len,block) mappings. These mappings are injected
  695. * into submit_page_section(), which takes care of the next stage of submission
  696. *
  697. * Direct IO against a blockdev is different from a file. Because we can
  698. * happily perform page-sized but 512-byte aligned IOs. It is important that
  699. * blockdev IO be able to have fine alignment and large sizes.
  700. *
  701. * So what we do is to permit the ->get_block function to populate bh.b_size
  702. * with the size of IO which is permitted at this offset and this i_blkbits.
  703. *
  704. * For best results, the blockdev should be set up with 512-byte i_blkbits and
  705. * it should set b_size to PAGE_SIZE or more inside get_block(). This gives
  706. * fine alignment but still allows this function to work in PAGE_SIZE units.
  707. */
  708. static int do_direct_IO(struct dio *dio)
  709. {
  710. const unsigned blkbits = dio->blkbits;
  711. const unsigned blocks_per_page = PAGE_SIZE >> blkbits;
  712. struct page *page;
  713. unsigned block_in_page;
  714. struct buffer_head *map_bh = &dio->map_bh;
  715. int ret = 0;
  716. /* The I/O can start at any block offset within the first page */
  717. block_in_page = dio->first_block_in_page;
  718. while (dio->block_in_file < dio->final_block_in_request) {
  719. page = dio_get_page(dio);
  720. if (IS_ERR(page)) {
  721. ret = PTR_ERR(page);
  722. goto out;
  723. }
  724. while (block_in_page < blocks_per_page) {
  725. unsigned offset_in_page = block_in_page << blkbits;
  726. unsigned this_chunk_bytes; /* # of bytes mapped */
  727. unsigned this_chunk_blocks; /* # of blocks */
  728. unsigned u;
  729. if (dio->blocks_available == 0) {
  730. /*
  731. * Need to go and map some more disk
  732. */
  733. unsigned long blkmask;
  734. unsigned long dio_remainder;
  735. ret = get_more_blocks(dio);
  736. if (ret) {
  737. page_cache_release(page);
  738. goto out;
  739. }
  740. if (!buffer_mapped(map_bh))
  741. goto do_holes;
  742. dio->blocks_available =
  743. map_bh->b_size >> dio->blkbits;
  744. dio->next_block_for_io =
  745. map_bh->b_blocknr << dio->blkfactor;
  746. if (buffer_new(map_bh))
  747. clean_blockdev_aliases(dio);
  748. if (!dio->blkfactor)
  749. goto do_holes;
  750. blkmask = (1 << dio->blkfactor) - 1;
  751. dio_remainder = (dio->block_in_file & blkmask);
  752. /*
  753. * If we are at the start of IO and that IO
  754. * starts partway into a fs-block,
  755. * dio_remainder will be non-zero. If the IO
  756. * is a read then we can simply advance the IO
  757. * cursor to the first block which is to be
  758. * read. But if the IO is a write and the
  759. * block was newly allocated we cannot do that;
  760. * the start of the fs block must be zeroed out
  761. * on-disk
  762. */
  763. if (!buffer_new(map_bh))
  764. dio->next_block_for_io += dio_remainder;
  765. dio->blocks_available -= dio_remainder;
  766. }
  767. do_holes:
  768. /* Handle holes */
  769. if (!buffer_mapped(map_bh)) {
  770. loff_t i_size_aligned;
  771. /* AKPM: eargh, -ENOTBLK is a hack */
  772. if (dio->rw & WRITE) {
  773. page_cache_release(page);
  774. return -ENOTBLK;
  775. }
  776. /*
  777. * Be sure to account for a partial block as the
  778. * last block in the file
  779. */
  780. i_size_aligned = ALIGN(i_size_read(dio->inode),
  781. 1 << blkbits);
  782. if (dio->block_in_file >=
  783. i_size_aligned >> blkbits) {
  784. /* We hit eof */
  785. page_cache_release(page);
  786. goto out;
  787. }
  788. zero_user_page(page, block_in_page << blkbits,
  789. 1 << blkbits, KM_USER0);
  790. dio->block_in_file++;
  791. block_in_page++;
  792. goto next_block;
  793. }
  794. /*
  795. * If we're performing IO which has an alignment which
  796. * is finer than the underlying fs, go check to see if
  797. * we must zero out the start of this block.
  798. */
  799. if (unlikely(dio->blkfactor && !dio->start_zero_done))
  800. dio_zero_block(dio, 0);
  801. /*
  802. * Work out, in this_chunk_blocks, how much disk we
  803. * can add to this page
  804. */
  805. this_chunk_blocks = dio->blocks_available;
  806. u = (PAGE_SIZE - offset_in_page) >> blkbits;
  807. if (this_chunk_blocks > u)
  808. this_chunk_blocks = u;
  809. u = dio->final_block_in_request - dio->block_in_file;
  810. if (this_chunk_blocks > u)
  811. this_chunk_blocks = u;
  812. this_chunk_bytes = this_chunk_blocks << blkbits;
  813. BUG_ON(this_chunk_bytes == 0);
  814. dio->boundary = buffer_boundary(map_bh);
  815. ret = submit_page_section(dio, page, offset_in_page,
  816. this_chunk_bytes, dio->next_block_for_io);
  817. if (ret) {
  818. page_cache_release(page);
  819. goto out;
  820. }
  821. dio->next_block_for_io += this_chunk_blocks;
  822. dio->block_in_file += this_chunk_blocks;
  823. block_in_page += this_chunk_blocks;
  824. dio->blocks_available -= this_chunk_blocks;
  825. next_block:
  826. BUG_ON(dio->block_in_file > dio->final_block_in_request);
  827. if (dio->block_in_file == dio->final_block_in_request)
  828. break;
  829. }
  830. /* Drop the ref which was taken in get_user_pages() */
  831. page_cache_release(page);
  832. block_in_page = 0;
  833. }
  834. out:
  835. return ret;
  836. }
  837. /*
  838. * Releases both i_mutex and i_alloc_sem
  839. */
  840. static ssize_t
  841. direct_io_worker(int rw, struct kiocb *iocb, struct inode *inode,
  842. const struct iovec *iov, loff_t offset, unsigned long nr_segs,
  843. unsigned blkbits, get_block_t get_block, dio_iodone_t end_io,
  844. struct dio *dio)
  845. {
  846. unsigned long user_addr;
  847. unsigned long flags;
  848. int seg;
  849. ssize_t ret = 0;
  850. ssize_t ret2;
  851. size_t bytes;
  852. dio->inode = inode;
  853. dio->rw = rw;
  854. dio->blkbits = blkbits;
  855. dio->blkfactor = inode->i_blkbits - blkbits;
  856. dio->block_in_file = offset >> blkbits;
  857. dio->get_block = get_block;
  858. dio->end_io = end_io;
  859. dio->final_block_in_bio = -1;
  860. dio->next_block_for_io = -1;
  861. dio->iocb = iocb;
  862. dio->i_size = i_size_read(inode);
  863. spin_lock_init(&dio->bio_lock);
  864. dio->refcount = 1;
  865. /*
  866. * In case of non-aligned buffers, we may need 2 more
  867. * pages since we need to zero out first and last block.
  868. */
  869. if (unlikely(dio->blkfactor))
  870. dio->pages_in_io = 2;
  871. for (seg = 0; seg < nr_segs; seg++) {
  872. user_addr = (unsigned long)iov[seg].iov_base;
  873. dio->pages_in_io +=
  874. ((user_addr+iov[seg].iov_len +PAGE_SIZE-1)/PAGE_SIZE
  875. - user_addr/PAGE_SIZE);
  876. }
  877. for (seg = 0; seg < nr_segs; seg++) {
  878. user_addr = (unsigned long)iov[seg].iov_base;
  879. dio->size += bytes = iov[seg].iov_len;
  880. /* Index into the first page of the first block */
  881. dio->first_block_in_page = (user_addr & ~PAGE_MASK) >> blkbits;
  882. dio->final_block_in_request = dio->block_in_file +
  883. (bytes >> blkbits);
  884. /* Page fetching state */
  885. dio->head = 0;
  886. dio->tail = 0;
  887. dio->curr_page = 0;
  888. dio->total_pages = 0;
  889. if (user_addr & (PAGE_SIZE-1)) {
  890. dio->total_pages++;
  891. bytes -= PAGE_SIZE - (user_addr & (PAGE_SIZE - 1));
  892. }
  893. dio->total_pages += (bytes + PAGE_SIZE - 1) / PAGE_SIZE;
  894. dio->curr_user_address = user_addr;
  895. ret = do_direct_IO(dio);
  896. dio->result += iov[seg].iov_len -
  897. ((dio->final_block_in_request - dio->block_in_file) <<
  898. blkbits);
  899. if (ret) {
  900. dio_cleanup(dio);
  901. break;
  902. }
  903. } /* end iovec loop */
  904. if (ret == -ENOTBLK && (rw & WRITE)) {
  905. /*
  906. * The remaining part of the request will be
  907. * be handled by buffered I/O when we return
  908. */
  909. ret = 0;
  910. }
  911. /*
  912. * There may be some unwritten disk at the end of a part-written
  913. * fs-block-sized block. Go zero that now.
  914. */
  915. dio_zero_block(dio, 1);
  916. if (dio->cur_page) {
  917. ret2 = dio_send_cur_page(dio);
  918. if (ret == 0)
  919. ret = ret2;
  920. page_cache_release(dio->cur_page);
  921. dio->cur_page = NULL;
  922. }
  923. if (dio->bio)
  924. dio_bio_submit(dio);
  925. /* All IO is now issued, send it on its way */
  926. blk_run_address_space(inode->i_mapping);
  927. /*
  928. * It is possible that, we return short IO due to end of file.
  929. * In that case, we need to release all the pages we got hold on.
  930. */
  931. dio_cleanup(dio);
  932. /*
  933. * All block lookups have been performed. For READ requests
  934. * we can let i_mutex go now that its achieved its purpose
  935. * of protecting us from looking up uninitialized blocks.
  936. */
  937. if ((rw == READ) && (dio->lock_type == DIO_LOCKING))
  938. mutex_unlock(&dio->inode->i_mutex);
  939. /*
  940. * The only time we want to leave bios in flight is when a successful
  941. * partial aio read or full aio write have been setup. In that case
  942. * bio completion will call aio_complete. The only time it's safe to
  943. * call aio_complete is when we return -EIOCBQUEUED, so we key on that.
  944. * This had *better* be the only place that raises -EIOCBQUEUED.
  945. */
  946. BUG_ON(ret == -EIOCBQUEUED);
  947. if (dio->is_async && ret == 0 && dio->result &&
  948. ((rw & READ) || (dio->result == dio->size)))
  949. ret = -EIOCBQUEUED;
  950. if (ret != -EIOCBQUEUED)
  951. dio_await_completion(dio);
  952. /*
  953. * Sync will always be dropping the final ref and completing the
  954. * operation. AIO can if it was a broken operation described above or
  955. * in fact if all the bios race to complete before we get here. In
  956. * that case dio_complete() translates the EIOCBQUEUED into the proper
  957. * return code that the caller will hand to aio_complete().
  958. *
  959. * This is managed by the bio_lock instead of being an atomic_t so that
  960. * completion paths can drop their ref and use the remaining count to
  961. * decide to wake the submission path atomically.
  962. */
  963. spin_lock_irqsave(&dio->bio_lock, flags);
  964. ret2 = --dio->refcount;
  965. spin_unlock_irqrestore(&dio->bio_lock, flags);
  966. if (ret2 == 0) {
  967. ret = dio_complete(dio, offset, ret);
  968. kfree(dio);
  969. } else
  970. BUG_ON(ret != -EIOCBQUEUED);
  971. return ret;
  972. }
  973. /*
  974. * This is a library function for use by filesystem drivers.
  975. * The locking rules are governed by the dio_lock_type parameter.
  976. *
  977. * DIO_NO_LOCKING (no locking, for raw block device access)
  978. * For writes, i_mutex is not held on entry; it is never taken.
  979. *
  980. * DIO_LOCKING (simple locking for regular files)
  981. * For writes we are called under i_mutex and return with i_mutex held, even
  982. * though it is internally dropped.
  983. * For reads, i_mutex is not held on entry, but it is taken and dropped before
  984. * returning.
  985. *
  986. * DIO_OWN_LOCKING (filesystem provides synchronisation and handling of
  987. * uninitialised data, allowing parallel direct readers and writers)
  988. * For writes we are called without i_mutex, return without it, never touch it.
  989. * For reads we are called under i_mutex and return with i_mutex held, even
  990. * though it may be internally dropped.
  991. *
  992. * Additional i_alloc_sem locking requirements described inline below.
  993. */
  994. ssize_t
  995. __blockdev_direct_IO(int rw, struct kiocb *iocb, struct inode *inode,
  996. struct block_device *bdev, const struct iovec *iov, loff_t offset,
  997. unsigned long nr_segs, get_block_t get_block, dio_iodone_t end_io,
  998. int dio_lock_type)
  999. {
  1000. int seg;
  1001. size_t size;
  1002. unsigned long addr;
  1003. unsigned blkbits = inode->i_blkbits;
  1004. unsigned bdev_blkbits = 0;
  1005. unsigned blocksize_mask = (1 << blkbits) - 1;
  1006. ssize_t retval = -EINVAL;
  1007. loff_t end = offset;
  1008. struct dio *dio;
  1009. int release_i_mutex = 0;
  1010. int acquire_i_mutex = 0;
  1011. if (rw & WRITE)
  1012. rw = WRITE_SYNC;
  1013. if (bdev)
  1014. bdev_blkbits = blksize_bits(bdev_hardsect_size(bdev));
  1015. if (offset & blocksize_mask) {
  1016. if (bdev)
  1017. blkbits = bdev_blkbits;
  1018. blocksize_mask = (1 << blkbits) - 1;
  1019. if (offset & blocksize_mask)
  1020. goto out;
  1021. }
  1022. /* Check the memory alignment. Blocks cannot straddle pages */
  1023. for (seg = 0; seg < nr_segs; seg++) {
  1024. addr = (unsigned long)iov[seg].iov_base;
  1025. size = iov[seg].iov_len;
  1026. end += size;
  1027. if ((addr & blocksize_mask) || (size & blocksize_mask)) {
  1028. if (bdev)
  1029. blkbits = bdev_blkbits;
  1030. blocksize_mask = (1 << blkbits) - 1;
  1031. if ((addr & blocksize_mask) || (size & blocksize_mask))
  1032. goto out;
  1033. }
  1034. }
  1035. dio = kzalloc(sizeof(*dio), GFP_KERNEL);
  1036. retval = -ENOMEM;
  1037. if (!dio)
  1038. goto out;
  1039. /*
  1040. * For block device access DIO_NO_LOCKING is used,
  1041. * neither readers nor writers do any locking at all
  1042. * For regular files using DIO_LOCKING,
  1043. * readers need to grab i_mutex and i_alloc_sem
  1044. * writers need to grab i_alloc_sem only (i_mutex is already held)
  1045. * For regular files using DIO_OWN_LOCKING,
  1046. * neither readers nor writers take any locks here
  1047. */
  1048. dio->lock_type = dio_lock_type;
  1049. if (dio_lock_type != DIO_NO_LOCKING) {
  1050. /* watch out for a 0 len io from a tricksy fs */
  1051. if (rw == READ && end > offset) {
  1052. struct address_space *mapping;
  1053. mapping = iocb->ki_filp->f_mapping;
  1054. if (dio_lock_type != DIO_OWN_LOCKING) {
  1055. mutex_lock(&inode->i_mutex);
  1056. release_i_mutex = 1;
  1057. }
  1058. retval = filemap_write_and_wait_range(mapping, offset,
  1059. end - 1);
  1060. if (retval) {
  1061. kfree(dio);
  1062. goto out;
  1063. }
  1064. if (dio_lock_type == DIO_OWN_LOCKING) {
  1065. mutex_unlock(&inode->i_mutex);
  1066. acquire_i_mutex = 1;
  1067. }
  1068. }
  1069. if (dio_lock_type == DIO_LOCKING)
  1070. /* lockdep: not the owner will release it */
  1071. down_read_non_owner(&inode->i_alloc_sem);
  1072. }
  1073. /*
  1074. * For file extending writes updating i_size before data
  1075. * writeouts complete can expose uninitialized blocks. So
  1076. * even for AIO, we need to wait for i/o to complete before
  1077. * returning in this case.
  1078. */
  1079. dio->is_async = !is_sync_kiocb(iocb) && !((rw & WRITE) &&
  1080. (end > i_size_read(inode)));
  1081. retval = direct_io_worker(rw, iocb, inode, iov, offset,
  1082. nr_segs, blkbits, get_block, end_io, dio);
  1083. if (rw == READ && dio_lock_type == DIO_LOCKING)
  1084. release_i_mutex = 0;
  1085. out:
  1086. if (release_i_mutex)
  1087. mutex_unlock(&inode->i_mutex);
  1088. else if (acquire_i_mutex)
  1089. mutex_lock(&inode->i_mutex);
  1090. return retval;
  1091. }
  1092. EXPORT_SYMBOL(__blockdev_direct_IO);