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