block: add a helper to free bio bounce buffer pages
[firefly-linux-kernel-4.4.55.git] / block / bio.c
1 /*
2  * Copyright (C) 2001 Jens Axboe <axboe@kernel.dk>
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License version 2 as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11  * GNU General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public Licens
14  * along with this program; if not, write to the Free Software
15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-
16  *
17  */
18 #include <linux/mm.h>
19 #include <linux/swap.h>
20 #include <linux/bio.h>
21 #include <linux/blkdev.h>
22 #include <linux/uio.h>
23 #include <linux/iocontext.h>
24 #include <linux/slab.h>
25 #include <linux/init.h>
26 #include <linux/kernel.h>
27 #include <linux/export.h>
28 #include <linux/mempool.h>
29 #include <linux/workqueue.h>
30 #include <linux/cgroup.h>
31 #include <scsi/sg.h>            /* for struct sg_iovec */
32
33 #include <trace/events/block.h>
34
35 /*
36  * Test patch to inline a certain number of bi_io_vec's inside the bio
37  * itself, to shrink a bio data allocation from two mempool calls to one
38  */
39 #define BIO_INLINE_VECS         4
40
41 /*
42  * if you change this list, also change bvec_alloc or things will
43  * break badly! cannot be bigger than what you can fit into an
44  * unsigned short
45  */
46 #define BV(x) { .nr_vecs = x, .name = "biovec-"__stringify(x) }
47 static struct biovec_slab bvec_slabs[BIOVEC_NR_POOLS] __read_mostly = {
48         BV(1), BV(4), BV(16), BV(64), BV(128), BV(BIO_MAX_PAGES),
49 };
50 #undef BV
51
52 /*
53  * fs_bio_set is the bio_set containing bio and iovec memory pools used by
54  * IO code that does not need private memory pools.
55  */
56 struct bio_set *fs_bio_set;
57 EXPORT_SYMBOL(fs_bio_set);
58
59 /*
60  * Our slab pool management
61  */
62 struct bio_slab {
63         struct kmem_cache *slab;
64         unsigned int slab_ref;
65         unsigned int slab_size;
66         char name[8];
67 };
68 static DEFINE_MUTEX(bio_slab_lock);
69 static struct bio_slab *bio_slabs;
70 static unsigned int bio_slab_nr, bio_slab_max;
71
72 static struct kmem_cache *bio_find_or_create_slab(unsigned int extra_size)
73 {
74         unsigned int sz = sizeof(struct bio) + extra_size;
75         struct kmem_cache *slab = NULL;
76         struct bio_slab *bslab, *new_bio_slabs;
77         unsigned int new_bio_slab_max;
78         unsigned int i, entry = -1;
79
80         mutex_lock(&bio_slab_lock);
81
82         i = 0;
83         while (i < bio_slab_nr) {
84                 bslab = &bio_slabs[i];
85
86                 if (!bslab->slab && entry == -1)
87                         entry = i;
88                 else if (bslab->slab_size == sz) {
89                         slab = bslab->slab;
90                         bslab->slab_ref++;
91                         break;
92                 }
93                 i++;
94         }
95
96         if (slab)
97                 goto out_unlock;
98
99         if (bio_slab_nr == bio_slab_max && entry == -1) {
100                 new_bio_slab_max = bio_slab_max << 1;
101                 new_bio_slabs = krealloc(bio_slabs,
102                                          new_bio_slab_max * sizeof(struct bio_slab),
103                                          GFP_KERNEL);
104                 if (!new_bio_slabs)
105                         goto out_unlock;
106                 bio_slab_max = new_bio_slab_max;
107                 bio_slabs = new_bio_slabs;
108         }
109         if (entry == -1)
110                 entry = bio_slab_nr++;
111
112         bslab = &bio_slabs[entry];
113
114         snprintf(bslab->name, sizeof(bslab->name), "bio-%d", entry);
115         slab = kmem_cache_create(bslab->name, sz, ARCH_KMALLOC_MINALIGN,
116                                  SLAB_HWCACHE_ALIGN, NULL);
117         if (!slab)
118                 goto out_unlock;
119
120         bslab->slab = slab;
121         bslab->slab_ref = 1;
122         bslab->slab_size = sz;
123 out_unlock:
124         mutex_unlock(&bio_slab_lock);
125         return slab;
126 }
127
128 static void bio_put_slab(struct bio_set *bs)
129 {
130         struct bio_slab *bslab = NULL;
131         unsigned int i;
132
133         mutex_lock(&bio_slab_lock);
134
135         for (i = 0; i < bio_slab_nr; i++) {
136                 if (bs->bio_slab == bio_slabs[i].slab) {
137                         bslab = &bio_slabs[i];
138                         break;
139                 }
140         }
141
142         if (WARN(!bslab, KERN_ERR "bio: unable to find slab!\n"))
143                 goto out;
144
145         WARN_ON(!bslab->slab_ref);
146
147         if (--bslab->slab_ref)
148                 goto out;
149
150         kmem_cache_destroy(bslab->slab);
151         bslab->slab = NULL;
152
153 out:
154         mutex_unlock(&bio_slab_lock);
155 }
156
157 unsigned int bvec_nr_vecs(unsigned short idx)
158 {
159         return bvec_slabs[idx].nr_vecs;
160 }
161
162 void bvec_free(mempool_t *pool, struct bio_vec *bv, unsigned int idx)
163 {
164         BIO_BUG_ON(idx >= BIOVEC_NR_POOLS);
165
166         if (idx == BIOVEC_MAX_IDX)
167                 mempool_free(bv, pool);
168         else {
169                 struct biovec_slab *bvs = bvec_slabs + idx;
170
171                 kmem_cache_free(bvs->slab, bv);
172         }
173 }
174
175 struct bio_vec *bvec_alloc(gfp_t gfp_mask, int nr, unsigned long *idx,
176                            mempool_t *pool)
177 {
178         struct bio_vec *bvl;
179
180         /*
181          * see comment near bvec_array define!
182          */
183         switch (nr) {
184         case 1:
185                 *idx = 0;
186                 break;
187         case 2 ... 4:
188                 *idx = 1;
189                 break;
190         case 5 ... 16:
191                 *idx = 2;
192                 break;
193         case 17 ... 64:
194                 *idx = 3;
195                 break;
196         case 65 ... 128:
197                 *idx = 4;
198                 break;
199         case 129 ... BIO_MAX_PAGES:
200                 *idx = 5;
201                 break;
202         default:
203                 return NULL;
204         }
205
206         /*
207          * idx now points to the pool we want to allocate from. only the
208          * 1-vec entry pool is mempool backed.
209          */
210         if (*idx == BIOVEC_MAX_IDX) {
211 fallback:
212                 bvl = mempool_alloc(pool, gfp_mask);
213         } else {
214                 struct biovec_slab *bvs = bvec_slabs + *idx;
215                 gfp_t __gfp_mask = gfp_mask & ~(__GFP_WAIT | __GFP_IO);
216
217                 /*
218                  * Make this allocation restricted and don't dump info on
219                  * allocation failures, since we'll fallback to the mempool
220                  * in case of failure.
221                  */
222                 __gfp_mask |= __GFP_NOMEMALLOC | __GFP_NORETRY | __GFP_NOWARN;
223
224                 /*
225                  * Try a slab allocation. If this fails and __GFP_WAIT
226                  * is set, retry with the 1-entry mempool
227                  */
228                 bvl = kmem_cache_alloc(bvs->slab, __gfp_mask);
229                 if (unlikely(!bvl && (gfp_mask & __GFP_WAIT))) {
230                         *idx = BIOVEC_MAX_IDX;
231                         goto fallback;
232                 }
233         }
234
235         return bvl;
236 }
237
238 static void __bio_free(struct bio *bio)
239 {
240         bio_disassociate_task(bio);
241
242         if (bio_integrity(bio))
243                 bio_integrity_free(bio);
244 }
245
246 static void bio_free(struct bio *bio)
247 {
248         struct bio_set *bs = bio->bi_pool;
249         void *p;
250
251         __bio_free(bio);
252
253         if (bs) {
254                 if (bio_flagged(bio, BIO_OWNS_VEC))
255                         bvec_free(bs->bvec_pool, bio->bi_io_vec, BIO_POOL_IDX(bio));
256
257                 /*
258                  * If we have front padding, adjust the bio pointer before freeing
259                  */
260                 p = bio;
261                 p -= bs->front_pad;
262
263                 mempool_free(p, bs->bio_pool);
264         } else {
265                 /* Bio was allocated by bio_kmalloc() */
266                 kfree(bio);
267         }
268 }
269
270 void bio_init(struct bio *bio)
271 {
272         memset(bio, 0, sizeof(*bio));
273         bio->bi_flags = 1 << BIO_UPTODATE;
274         atomic_set(&bio->bi_remaining, 1);
275         atomic_set(&bio->bi_cnt, 1);
276 }
277 EXPORT_SYMBOL(bio_init);
278
279 /**
280  * bio_reset - reinitialize a bio
281  * @bio:        bio to reset
282  *
283  * Description:
284  *   After calling bio_reset(), @bio will be in the same state as a freshly
285  *   allocated bio returned bio bio_alloc_bioset() - the only fields that are
286  *   preserved are the ones that are initialized by bio_alloc_bioset(). See
287  *   comment in struct bio.
288  */
289 void bio_reset(struct bio *bio)
290 {
291         unsigned long flags = bio->bi_flags & (~0UL << BIO_RESET_BITS);
292
293         __bio_free(bio);
294
295         memset(bio, 0, BIO_RESET_BYTES);
296         bio->bi_flags = flags|(1 << BIO_UPTODATE);
297         atomic_set(&bio->bi_remaining, 1);
298 }
299 EXPORT_SYMBOL(bio_reset);
300
301 static void bio_chain_endio(struct bio *bio, int error)
302 {
303         bio_endio(bio->bi_private, error);
304         bio_put(bio);
305 }
306
307 /**
308  * bio_chain - chain bio completions
309  * @bio: the target bio
310  * @parent: the @bio's parent bio
311  *
312  * The caller won't have a bi_end_io called when @bio completes - instead,
313  * @parent's bi_end_io won't be called until both @parent and @bio have
314  * completed; the chained bio will also be freed when it completes.
315  *
316  * The caller must not set bi_private or bi_end_io in @bio.
317  */
318 void bio_chain(struct bio *bio, struct bio *parent)
319 {
320         BUG_ON(bio->bi_private || bio->bi_end_io);
321
322         bio->bi_private = parent;
323         bio->bi_end_io  = bio_chain_endio;
324         atomic_inc(&parent->bi_remaining);
325 }
326 EXPORT_SYMBOL(bio_chain);
327
328 static void bio_alloc_rescue(struct work_struct *work)
329 {
330         struct bio_set *bs = container_of(work, struct bio_set, rescue_work);
331         struct bio *bio;
332
333         while (1) {
334                 spin_lock(&bs->rescue_lock);
335                 bio = bio_list_pop(&bs->rescue_list);
336                 spin_unlock(&bs->rescue_lock);
337
338                 if (!bio)
339                         break;
340
341                 generic_make_request(bio);
342         }
343 }
344
345 static void punt_bios_to_rescuer(struct bio_set *bs)
346 {
347         struct bio_list punt, nopunt;
348         struct bio *bio;
349
350         /*
351          * In order to guarantee forward progress we must punt only bios that
352          * were allocated from this bio_set; otherwise, if there was a bio on
353          * there for a stacking driver higher up in the stack, processing it
354          * could require allocating bios from this bio_set, and doing that from
355          * our own rescuer would be bad.
356          *
357          * Since bio lists are singly linked, pop them all instead of trying to
358          * remove from the middle of the list:
359          */
360
361         bio_list_init(&punt);
362         bio_list_init(&nopunt);
363
364         while ((bio = bio_list_pop(current->bio_list)))
365                 bio_list_add(bio->bi_pool == bs ? &punt : &nopunt, bio);
366
367         *current->bio_list = nopunt;
368
369         spin_lock(&bs->rescue_lock);
370         bio_list_merge(&bs->rescue_list, &punt);
371         spin_unlock(&bs->rescue_lock);
372
373         queue_work(bs->rescue_workqueue, &bs->rescue_work);
374 }
375
376 /**
377  * bio_alloc_bioset - allocate a bio for I/O
378  * @gfp_mask:   the GFP_ mask given to the slab allocator
379  * @nr_iovecs:  number of iovecs to pre-allocate
380  * @bs:         the bio_set to allocate from.
381  *
382  * Description:
383  *   If @bs is NULL, uses kmalloc() to allocate the bio; else the allocation is
384  *   backed by the @bs's mempool.
385  *
386  *   When @bs is not NULL, if %__GFP_WAIT is set then bio_alloc will always be
387  *   able to allocate a bio. This is due to the mempool guarantees. To make this
388  *   work, callers must never allocate more than 1 bio at a time from this pool.
389  *   Callers that need to allocate more than 1 bio must always submit the
390  *   previously allocated bio for IO before attempting to allocate a new one.
391  *   Failure to do so can cause deadlocks under memory pressure.
392  *
393  *   Note that when running under generic_make_request() (i.e. any block
394  *   driver), bios are not submitted until after you return - see the code in
395  *   generic_make_request() that converts recursion into iteration, to prevent
396  *   stack overflows.
397  *
398  *   This would normally mean allocating multiple bios under
399  *   generic_make_request() would be susceptible to deadlocks, but we have
400  *   deadlock avoidance code that resubmits any blocked bios from a rescuer
401  *   thread.
402  *
403  *   However, we do not guarantee forward progress for allocations from other
404  *   mempools. Doing multiple allocations from the same mempool under
405  *   generic_make_request() should be avoided - instead, use bio_set's front_pad
406  *   for per bio allocations.
407  *
408  *   RETURNS:
409  *   Pointer to new bio on success, NULL on failure.
410  */
411 struct bio *bio_alloc_bioset(gfp_t gfp_mask, int nr_iovecs, struct bio_set *bs)
412 {
413         gfp_t saved_gfp = gfp_mask;
414         unsigned front_pad;
415         unsigned inline_vecs;
416         unsigned long idx = BIO_POOL_NONE;
417         struct bio_vec *bvl = NULL;
418         struct bio *bio;
419         void *p;
420
421         if (!bs) {
422                 if (nr_iovecs > UIO_MAXIOV)
423                         return NULL;
424
425                 p = kmalloc(sizeof(struct bio) +
426                             nr_iovecs * sizeof(struct bio_vec),
427                             gfp_mask);
428                 front_pad = 0;
429                 inline_vecs = nr_iovecs;
430         } else {
431                 /* should not use nobvec bioset for nr_iovecs > 0 */
432                 if (WARN_ON_ONCE(!bs->bvec_pool && nr_iovecs > 0))
433                         return NULL;
434                 /*
435                  * generic_make_request() converts recursion to iteration; this
436                  * means if we're running beneath it, any bios we allocate and
437                  * submit will not be submitted (and thus freed) until after we
438                  * return.
439                  *
440                  * This exposes us to a potential deadlock if we allocate
441                  * multiple bios from the same bio_set() while running
442                  * underneath generic_make_request(). If we were to allocate
443                  * multiple bios (say a stacking block driver that was splitting
444                  * bios), we would deadlock if we exhausted the mempool's
445                  * reserve.
446                  *
447                  * We solve this, and guarantee forward progress, with a rescuer
448                  * workqueue per bio_set. If we go to allocate and there are
449                  * bios on current->bio_list, we first try the allocation
450                  * without __GFP_WAIT; if that fails, we punt those bios we
451                  * would be blocking to the rescuer workqueue before we retry
452                  * with the original gfp_flags.
453                  */
454
455                 if (current->bio_list && !bio_list_empty(current->bio_list))
456                         gfp_mask &= ~__GFP_WAIT;
457
458                 p = mempool_alloc(bs->bio_pool, gfp_mask);
459                 if (!p && gfp_mask != saved_gfp) {
460                         punt_bios_to_rescuer(bs);
461                         gfp_mask = saved_gfp;
462                         p = mempool_alloc(bs->bio_pool, gfp_mask);
463                 }
464
465                 front_pad = bs->front_pad;
466                 inline_vecs = BIO_INLINE_VECS;
467         }
468
469         if (unlikely(!p))
470                 return NULL;
471
472         bio = p + front_pad;
473         bio_init(bio);
474
475         if (nr_iovecs > inline_vecs) {
476                 bvl = bvec_alloc(gfp_mask, nr_iovecs, &idx, bs->bvec_pool);
477                 if (!bvl && gfp_mask != saved_gfp) {
478                         punt_bios_to_rescuer(bs);
479                         gfp_mask = saved_gfp;
480                         bvl = bvec_alloc(gfp_mask, nr_iovecs, &idx, bs->bvec_pool);
481                 }
482
483                 if (unlikely(!bvl))
484                         goto err_free;
485
486                 bio->bi_flags |= 1 << BIO_OWNS_VEC;
487         } else if (nr_iovecs) {
488                 bvl = bio->bi_inline_vecs;
489         }
490
491         bio->bi_pool = bs;
492         bio->bi_flags |= idx << BIO_POOL_OFFSET;
493         bio->bi_max_vecs = nr_iovecs;
494         bio->bi_io_vec = bvl;
495         return bio;
496
497 err_free:
498         mempool_free(p, bs->bio_pool);
499         return NULL;
500 }
501 EXPORT_SYMBOL(bio_alloc_bioset);
502
503 void zero_fill_bio(struct bio *bio)
504 {
505         unsigned long flags;
506         struct bio_vec bv;
507         struct bvec_iter iter;
508
509         bio_for_each_segment(bv, bio, iter) {
510                 char *data = bvec_kmap_irq(&bv, &flags);
511                 memset(data, 0, bv.bv_len);
512                 flush_dcache_page(bv.bv_page);
513                 bvec_kunmap_irq(data, &flags);
514         }
515 }
516 EXPORT_SYMBOL(zero_fill_bio);
517
518 /**
519  * bio_put - release a reference to a bio
520  * @bio:   bio to release reference to
521  *
522  * Description:
523  *   Put a reference to a &struct bio, either one you have gotten with
524  *   bio_alloc, bio_get or bio_clone. The last put of a bio will free it.
525  **/
526 void bio_put(struct bio *bio)
527 {
528         BIO_BUG_ON(!atomic_read(&bio->bi_cnt));
529
530         /*
531          * last put frees it
532          */
533         if (atomic_dec_and_test(&bio->bi_cnt))
534                 bio_free(bio);
535 }
536 EXPORT_SYMBOL(bio_put);
537
538 inline int bio_phys_segments(struct request_queue *q, struct bio *bio)
539 {
540         if (unlikely(!bio_flagged(bio, BIO_SEG_VALID)))
541                 blk_recount_segments(q, bio);
542
543         return bio->bi_phys_segments;
544 }
545 EXPORT_SYMBOL(bio_phys_segments);
546
547 /**
548  *      __bio_clone_fast - clone a bio that shares the original bio's biovec
549  *      @bio: destination bio
550  *      @bio_src: bio to clone
551  *
552  *      Clone a &bio. Caller will own the returned bio, but not
553  *      the actual data it points to. Reference count of returned
554  *      bio will be one.
555  *
556  *      Caller must ensure that @bio_src is not freed before @bio.
557  */
558 void __bio_clone_fast(struct bio *bio, struct bio *bio_src)
559 {
560         BUG_ON(bio->bi_pool && BIO_POOL_IDX(bio) != BIO_POOL_NONE);
561
562         /*
563          * most users will be overriding ->bi_bdev with a new target,
564          * so we don't set nor calculate new physical/hw segment counts here
565          */
566         bio->bi_bdev = bio_src->bi_bdev;
567         bio->bi_flags |= 1 << BIO_CLONED;
568         bio->bi_rw = bio_src->bi_rw;
569         bio->bi_iter = bio_src->bi_iter;
570         bio->bi_io_vec = bio_src->bi_io_vec;
571 }
572 EXPORT_SYMBOL(__bio_clone_fast);
573
574 /**
575  *      bio_clone_fast - clone a bio that shares the original bio's biovec
576  *      @bio: bio to clone
577  *      @gfp_mask: allocation priority
578  *      @bs: bio_set to allocate from
579  *
580  *      Like __bio_clone_fast, only also allocates the returned bio
581  */
582 struct bio *bio_clone_fast(struct bio *bio, gfp_t gfp_mask, struct bio_set *bs)
583 {
584         struct bio *b;
585
586         b = bio_alloc_bioset(gfp_mask, 0, bs);
587         if (!b)
588                 return NULL;
589
590         __bio_clone_fast(b, bio);
591
592         if (bio_integrity(bio)) {
593                 int ret;
594
595                 ret = bio_integrity_clone(b, bio, gfp_mask);
596
597                 if (ret < 0) {
598                         bio_put(b);
599                         return NULL;
600                 }
601         }
602
603         return b;
604 }
605 EXPORT_SYMBOL(bio_clone_fast);
606
607 /**
608  *      bio_clone_bioset - clone a bio
609  *      @bio_src: bio to clone
610  *      @gfp_mask: allocation priority
611  *      @bs: bio_set to allocate from
612  *
613  *      Clone bio. Caller will own the returned bio, but not the actual data it
614  *      points to. Reference count of returned bio will be one.
615  */
616 struct bio *bio_clone_bioset(struct bio *bio_src, gfp_t gfp_mask,
617                              struct bio_set *bs)
618 {
619         struct bvec_iter iter;
620         struct bio_vec bv;
621         struct bio *bio;
622
623         /*
624          * Pre immutable biovecs, __bio_clone() used to just do a memcpy from
625          * bio_src->bi_io_vec to bio->bi_io_vec.
626          *
627          * We can't do that anymore, because:
628          *
629          *  - The point of cloning the biovec is to produce a bio with a biovec
630          *    the caller can modify: bi_idx and bi_bvec_done should be 0.
631          *
632          *  - The original bio could've had more than BIO_MAX_PAGES biovecs; if
633          *    we tried to clone the whole thing bio_alloc_bioset() would fail.
634          *    But the clone should succeed as long as the number of biovecs we
635          *    actually need to allocate is fewer than BIO_MAX_PAGES.
636          *
637          *  - Lastly, bi_vcnt should not be looked at or relied upon by code
638          *    that does not own the bio - reason being drivers don't use it for
639          *    iterating over the biovec anymore, so expecting it to be kept up
640          *    to date (i.e. for clones that share the parent biovec) is just
641          *    asking for trouble and would force extra work on
642          *    __bio_clone_fast() anyways.
643          */
644
645         bio = bio_alloc_bioset(gfp_mask, bio_segments(bio_src), bs);
646         if (!bio)
647                 return NULL;
648
649         bio->bi_bdev            = bio_src->bi_bdev;
650         bio->bi_rw              = bio_src->bi_rw;
651         bio->bi_iter.bi_sector  = bio_src->bi_iter.bi_sector;
652         bio->bi_iter.bi_size    = bio_src->bi_iter.bi_size;
653
654         if (bio->bi_rw & REQ_DISCARD)
655                 goto integrity_clone;
656
657         if (bio->bi_rw & REQ_WRITE_SAME) {
658                 bio->bi_io_vec[bio->bi_vcnt++] = bio_src->bi_io_vec[0];
659                 goto integrity_clone;
660         }
661
662         bio_for_each_segment(bv, bio_src, iter)
663                 bio->bi_io_vec[bio->bi_vcnt++] = bv;
664
665 integrity_clone:
666         if (bio_integrity(bio_src)) {
667                 int ret;
668
669                 ret = bio_integrity_clone(bio, bio_src, gfp_mask);
670                 if (ret < 0) {
671                         bio_put(bio);
672                         return NULL;
673                 }
674         }
675
676         return bio;
677 }
678 EXPORT_SYMBOL(bio_clone_bioset);
679
680 /**
681  *      bio_get_nr_vecs         - return approx number of vecs
682  *      @bdev:  I/O target
683  *
684  *      Return the approximate number of pages we can send to this target.
685  *      There's no guarantee that you will be able to fit this number of pages
686  *      into a bio, it does not account for dynamic restrictions that vary
687  *      on offset.
688  */
689 int bio_get_nr_vecs(struct block_device *bdev)
690 {
691         struct request_queue *q = bdev_get_queue(bdev);
692         int nr_pages;
693
694         nr_pages = min_t(unsigned,
695                      queue_max_segments(q),
696                      queue_max_sectors(q) / (PAGE_SIZE >> 9) + 1);
697
698         return min_t(unsigned, nr_pages, BIO_MAX_PAGES);
699
700 }
701 EXPORT_SYMBOL(bio_get_nr_vecs);
702
703 static int __bio_add_page(struct request_queue *q, struct bio *bio, struct page
704                           *page, unsigned int len, unsigned int offset,
705                           unsigned int max_sectors)
706 {
707         int retried_segments = 0;
708         struct bio_vec *bvec;
709
710         /*
711          * cloned bio must not modify vec list
712          */
713         if (unlikely(bio_flagged(bio, BIO_CLONED)))
714                 return 0;
715
716         if (((bio->bi_iter.bi_size + len) >> 9) > max_sectors)
717                 return 0;
718
719         /*
720          * For filesystems with a blocksize smaller than the pagesize
721          * we will often be called with the same page as last time and
722          * a consecutive offset.  Optimize this special case.
723          */
724         if (bio->bi_vcnt > 0) {
725                 struct bio_vec *prev = &bio->bi_io_vec[bio->bi_vcnt - 1];
726
727                 if (page == prev->bv_page &&
728                     offset == prev->bv_offset + prev->bv_len) {
729                         unsigned int prev_bv_len = prev->bv_len;
730                         prev->bv_len += len;
731
732                         if (q->merge_bvec_fn) {
733                                 struct bvec_merge_data bvm = {
734                                         /* prev_bvec is already charged in
735                                            bi_size, discharge it in order to
736                                            simulate merging updated prev_bvec
737                                            as new bvec. */
738                                         .bi_bdev = bio->bi_bdev,
739                                         .bi_sector = bio->bi_iter.bi_sector,
740                                         .bi_size = bio->bi_iter.bi_size -
741                                                 prev_bv_len,
742                                         .bi_rw = bio->bi_rw,
743                                 };
744
745                                 if (q->merge_bvec_fn(q, &bvm, prev) < prev->bv_len) {
746                                         prev->bv_len -= len;
747                                         return 0;
748                                 }
749                         }
750
751                         bio->bi_iter.bi_size += len;
752                         goto done;
753                 }
754
755                 /*
756                  * If the queue doesn't support SG gaps and adding this
757                  * offset would create a gap, disallow it.
758                  */
759                 if (q->queue_flags & (1 << QUEUE_FLAG_SG_GAPS) &&
760                     bvec_gap_to_prev(prev, offset))
761                         return 0;
762         }
763
764         if (bio->bi_vcnt >= bio->bi_max_vecs)
765                 return 0;
766
767         /*
768          * setup the new entry, we might clear it again later if we
769          * cannot add the page
770          */
771         bvec = &bio->bi_io_vec[bio->bi_vcnt];
772         bvec->bv_page = page;
773         bvec->bv_len = len;
774         bvec->bv_offset = offset;
775         bio->bi_vcnt++;
776         bio->bi_phys_segments++;
777         bio->bi_iter.bi_size += len;
778
779         /*
780          * Perform a recount if the number of segments is greater
781          * than queue_max_segments(q).
782          */
783
784         while (bio->bi_phys_segments > queue_max_segments(q)) {
785
786                 if (retried_segments)
787                         goto failed;
788
789                 retried_segments = 1;
790                 blk_recount_segments(q, bio);
791         }
792
793         /*
794          * if queue has other restrictions (eg varying max sector size
795          * depending on offset), it can specify a merge_bvec_fn in the
796          * queue to get further control
797          */
798         if (q->merge_bvec_fn) {
799                 struct bvec_merge_data bvm = {
800                         .bi_bdev = bio->bi_bdev,
801                         .bi_sector = bio->bi_iter.bi_sector,
802                         .bi_size = bio->bi_iter.bi_size - len,
803                         .bi_rw = bio->bi_rw,
804                 };
805
806                 /*
807                  * merge_bvec_fn() returns number of bytes it can accept
808                  * at this offset
809                  */
810                 if (q->merge_bvec_fn(q, &bvm, bvec) < bvec->bv_len)
811                         goto failed;
812         }
813
814         /* If we may be able to merge these biovecs, force a recount */
815         if (bio->bi_vcnt > 1 && (BIOVEC_PHYS_MERGEABLE(bvec-1, bvec)))
816                 bio->bi_flags &= ~(1 << BIO_SEG_VALID);
817
818  done:
819         return len;
820
821  failed:
822         bvec->bv_page = NULL;
823         bvec->bv_len = 0;
824         bvec->bv_offset = 0;
825         bio->bi_vcnt--;
826         bio->bi_iter.bi_size -= len;
827         blk_recount_segments(q, bio);
828         return 0;
829 }
830
831 /**
832  *      bio_add_pc_page -       attempt to add page to bio
833  *      @q: the target queue
834  *      @bio: destination bio
835  *      @page: page to add
836  *      @len: vec entry length
837  *      @offset: vec entry offset
838  *
839  *      Attempt to add a page to the bio_vec maplist. This can fail for a
840  *      number of reasons, such as the bio being full or target block device
841  *      limitations. The target block device must allow bio's up to PAGE_SIZE,
842  *      so it is always possible to add a single page to an empty bio.
843  *
844  *      This should only be used by REQ_PC bios.
845  */
846 int bio_add_pc_page(struct request_queue *q, struct bio *bio, struct page *page,
847                     unsigned int len, unsigned int offset)
848 {
849         return __bio_add_page(q, bio, page, len, offset,
850                               queue_max_hw_sectors(q));
851 }
852 EXPORT_SYMBOL(bio_add_pc_page);
853
854 /**
855  *      bio_add_page    -       attempt to add page to bio
856  *      @bio: destination bio
857  *      @page: page to add
858  *      @len: vec entry length
859  *      @offset: vec entry offset
860  *
861  *      Attempt to add a page to the bio_vec maplist. This can fail for a
862  *      number of reasons, such as the bio being full or target block device
863  *      limitations. The target block device must allow bio's up to PAGE_SIZE,
864  *      so it is always possible to add a single page to an empty bio.
865  */
866 int bio_add_page(struct bio *bio, struct page *page, unsigned int len,
867                  unsigned int offset)
868 {
869         struct request_queue *q = bdev_get_queue(bio->bi_bdev);
870         unsigned int max_sectors;
871
872         max_sectors = blk_max_size_offset(q, bio->bi_iter.bi_sector);
873         if ((max_sectors < (len >> 9)) && !bio->bi_iter.bi_size)
874                 max_sectors = len >> 9;
875
876         return __bio_add_page(q, bio, page, len, offset, max_sectors);
877 }
878 EXPORT_SYMBOL(bio_add_page);
879
880 struct submit_bio_ret {
881         struct completion event;
882         int error;
883 };
884
885 static void submit_bio_wait_endio(struct bio *bio, int error)
886 {
887         struct submit_bio_ret *ret = bio->bi_private;
888
889         ret->error = error;
890         complete(&ret->event);
891 }
892
893 /**
894  * submit_bio_wait - submit a bio, and wait until it completes
895  * @rw: whether to %READ or %WRITE, or maybe to %READA (read ahead)
896  * @bio: The &struct bio which describes the I/O
897  *
898  * Simple wrapper around submit_bio(). Returns 0 on success, or the error from
899  * bio_endio() on failure.
900  */
901 int submit_bio_wait(int rw, struct bio *bio)
902 {
903         struct submit_bio_ret ret;
904
905         rw |= REQ_SYNC;
906         init_completion(&ret.event);
907         bio->bi_private = &ret;
908         bio->bi_end_io = submit_bio_wait_endio;
909         submit_bio(rw, bio);
910         wait_for_completion(&ret.event);
911
912         return ret.error;
913 }
914 EXPORT_SYMBOL(submit_bio_wait);
915
916 /**
917  * bio_advance - increment/complete a bio by some number of bytes
918  * @bio:        bio to advance
919  * @bytes:      number of bytes to complete
920  *
921  * This updates bi_sector, bi_size and bi_idx; if the number of bytes to
922  * complete doesn't align with a bvec boundary, then bv_len and bv_offset will
923  * be updated on the last bvec as well.
924  *
925  * @bio will then represent the remaining, uncompleted portion of the io.
926  */
927 void bio_advance(struct bio *bio, unsigned bytes)
928 {
929         if (bio_integrity(bio))
930                 bio_integrity_advance(bio, bytes);
931
932         bio_advance_iter(bio, &bio->bi_iter, bytes);
933 }
934 EXPORT_SYMBOL(bio_advance);
935
936 /**
937  * bio_alloc_pages - allocates a single page for each bvec in a bio
938  * @bio: bio to allocate pages for
939  * @gfp_mask: flags for allocation
940  *
941  * Allocates pages up to @bio->bi_vcnt.
942  *
943  * Returns 0 on success, -ENOMEM on failure. On failure, any allocated pages are
944  * freed.
945  */
946 int bio_alloc_pages(struct bio *bio, gfp_t gfp_mask)
947 {
948         int i;
949         struct bio_vec *bv;
950
951         bio_for_each_segment_all(bv, bio, i) {
952                 bv->bv_page = alloc_page(gfp_mask);
953                 if (!bv->bv_page) {
954                         while (--bv >= bio->bi_io_vec)
955                                 __free_page(bv->bv_page);
956                         return -ENOMEM;
957                 }
958         }
959
960         return 0;
961 }
962 EXPORT_SYMBOL(bio_alloc_pages);
963
964 /**
965  * bio_copy_data - copy contents of data buffers from one chain of bios to
966  * another
967  * @src: source bio list
968  * @dst: destination bio list
969  *
970  * If @src and @dst are single bios, bi_next must be NULL - otherwise, treats
971  * @src and @dst as linked lists of bios.
972  *
973  * Stops when it reaches the end of either @src or @dst - that is, copies
974  * min(src->bi_size, dst->bi_size) bytes (or the equivalent for lists of bios).
975  */
976 void bio_copy_data(struct bio *dst, struct bio *src)
977 {
978         struct bvec_iter src_iter, dst_iter;
979         struct bio_vec src_bv, dst_bv;
980         void *src_p, *dst_p;
981         unsigned bytes;
982
983         src_iter = src->bi_iter;
984         dst_iter = dst->bi_iter;
985
986         while (1) {
987                 if (!src_iter.bi_size) {
988                         src = src->bi_next;
989                         if (!src)
990                                 break;
991
992                         src_iter = src->bi_iter;
993                 }
994
995                 if (!dst_iter.bi_size) {
996                         dst = dst->bi_next;
997                         if (!dst)
998                                 break;
999
1000                         dst_iter = dst->bi_iter;
1001                 }
1002
1003                 src_bv = bio_iter_iovec(src, src_iter);
1004                 dst_bv = bio_iter_iovec(dst, dst_iter);
1005
1006                 bytes = min(src_bv.bv_len, dst_bv.bv_len);
1007
1008                 src_p = kmap_atomic(src_bv.bv_page);
1009                 dst_p = kmap_atomic(dst_bv.bv_page);
1010
1011                 memcpy(dst_p + dst_bv.bv_offset,
1012                        src_p + src_bv.bv_offset,
1013                        bytes);
1014
1015                 kunmap_atomic(dst_p);
1016                 kunmap_atomic(src_p);
1017
1018                 bio_advance_iter(src, &src_iter, bytes);
1019                 bio_advance_iter(dst, &dst_iter, bytes);
1020         }
1021 }
1022 EXPORT_SYMBOL(bio_copy_data);
1023
1024 struct bio_map_data {
1025         int nr_sgvecs;
1026         int is_our_pages;
1027         struct sg_iovec sgvecs[];
1028 };
1029
1030 static void bio_set_map_data(struct bio_map_data *bmd, struct bio *bio,
1031                              const struct sg_iovec *iov, int iov_count,
1032                              int is_our_pages)
1033 {
1034         memcpy(bmd->sgvecs, iov, sizeof(struct sg_iovec) * iov_count);
1035         bmd->nr_sgvecs = iov_count;
1036         bmd->is_our_pages = is_our_pages;
1037         bio->bi_private = bmd;
1038 }
1039
1040 static struct bio_map_data *bio_alloc_map_data(unsigned int iov_count,
1041                                                gfp_t gfp_mask)
1042 {
1043         if (iov_count > UIO_MAXIOV)
1044                 return NULL;
1045
1046         return kmalloc(sizeof(struct bio_map_data) +
1047                        sizeof(struct sg_iovec) * iov_count, gfp_mask);
1048 }
1049
1050 static int __bio_copy_iov(struct bio *bio, const struct sg_iovec *iov, int iov_count,
1051                           int to_user, int from_user)
1052 {
1053         int ret = 0, i;
1054         struct bio_vec *bvec;
1055         int iov_idx = 0;
1056         unsigned int iov_off = 0;
1057
1058         bio_for_each_segment_all(bvec, bio, i) {
1059                 char *bv_addr = page_address(bvec->bv_page);
1060                 unsigned int bv_len = bvec->bv_len;
1061
1062                 while (bv_len && iov_idx < iov_count) {
1063                         unsigned int bytes;
1064                         char __user *iov_addr;
1065
1066                         bytes = min_t(unsigned int,
1067                                       iov[iov_idx].iov_len - iov_off, bv_len);
1068                         iov_addr = iov[iov_idx].iov_base + iov_off;
1069
1070                         if (!ret) {
1071                                 if (to_user)
1072                                         ret = copy_to_user(iov_addr, bv_addr,
1073                                                            bytes);
1074
1075                                 if (from_user)
1076                                         ret = copy_from_user(bv_addr, iov_addr,
1077                                                              bytes);
1078
1079                                 if (ret)
1080                                         ret = -EFAULT;
1081                         }
1082
1083                         bv_len -= bytes;
1084                         bv_addr += bytes;
1085                         iov_addr += bytes;
1086                         iov_off += bytes;
1087
1088                         if (iov[iov_idx].iov_len == iov_off) {
1089                                 iov_idx++;
1090                                 iov_off = 0;
1091                         }
1092                 }
1093         }
1094
1095         return ret;
1096 }
1097
1098 static void bio_free_pages(struct bio *bio)
1099 {
1100         struct bio_vec *bvec;
1101         int i;
1102
1103         bio_for_each_segment_all(bvec, bio, i)
1104                 __free_page(bvec->bv_page);
1105 }
1106
1107 /**
1108  *      bio_uncopy_user -       finish previously mapped bio
1109  *      @bio: bio being terminated
1110  *
1111  *      Free pages allocated from bio_copy_user_iov() and write back data
1112  *      to user space in case of a read.
1113  */
1114 int bio_uncopy_user(struct bio *bio)
1115 {
1116         struct bio_map_data *bmd = bio->bi_private;
1117         int ret = 0;
1118
1119         if (!bio_flagged(bio, BIO_NULL_MAPPED)) {
1120                 /*
1121                  * if we're in a workqueue, the request is orphaned, so
1122                  * don't copy into a random user address space, just free.
1123                  */
1124                 if (current->mm)
1125                         ret = __bio_copy_iov(bio, bmd->sgvecs, bmd->nr_sgvecs,
1126                                              bio_data_dir(bio) == READ, 0);
1127                 if (bmd->is_our_pages)
1128                         bio_free_pages(bio);
1129         }
1130         kfree(bmd);
1131         bio_put(bio);
1132         return ret;
1133 }
1134 EXPORT_SYMBOL(bio_uncopy_user);
1135
1136 /**
1137  *      bio_copy_user_iov       -       copy user data to bio
1138  *      @q: destination block queue
1139  *      @map_data: pointer to the rq_map_data holding pages (if necessary)
1140  *      @iov:   the iovec.
1141  *      @iov_count: number of elements in the iovec
1142  *      @write_to_vm: bool indicating writing to pages or not
1143  *      @gfp_mask: memory allocation flags
1144  *
1145  *      Prepares and returns a bio for indirect user io, bouncing data
1146  *      to/from kernel pages as necessary. Must be paired with
1147  *      call bio_uncopy_user() on io completion.
1148  */
1149 struct bio *bio_copy_user_iov(struct request_queue *q,
1150                               struct rq_map_data *map_data,
1151                               const struct sg_iovec *iov, int iov_count,
1152                               int write_to_vm, gfp_t gfp_mask)
1153 {
1154         struct bio_map_data *bmd;
1155         struct page *page;
1156         struct bio *bio;
1157         int i, ret;
1158         int nr_pages = 0;
1159         unsigned int len = 0;
1160         unsigned int offset = map_data ? map_data->offset & ~PAGE_MASK : 0;
1161
1162         for (i = 0; i < iov_count; i++) {
1163                 unsigned long uaddr;
1164                 unsigned long end;
1165                 unsigned long start;
1166
1167                 uaddr = (unsigned long)iov[i].iov_base;
1168                 end = (uaddr + iov[i].iov_len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1169                 start = uaddr >> PAGE_SHIFT;
1170
1171                 /*
1172                  * Overflow, abort
1173                  */
1174                 if (end < start)
1175                         return ERR_PTR(-EINVAL);
1176
1177                 nr_pages += end - start;
1178                 len += iov[i].iov_len;
1179         }
1180
1181         if (offset)
1182                 nr_pages++;
1183
1184         bmd = bio_alloc_map_data(iov_count, gfp_mask);
1185         if (!bmd)
1186                 return ERR_PTR(-ENOMEM);
1187
1188         ret = -ENOMEM;
1189         bio = bio_kmalloc(gfp_mask, nr_pages);
1190         if (!bio)
1191                 goto out_bmd;
1192
1193         if (!write_to_vm)
1194                 bio->bi_rw |= REQ_WRITE;
1195
1196         ret = 0;
1197
1198         if (map_data) {
1199                 nr_pages = 1 << map_data->page_order;
1200                 i = map_data->offset / PAGE_SIZE;
1201         }
1202         while (len) {
1203                 unsigned int bytes = PAGE_SIZE;
1204
1205                 bytes -= offset;
1206
1207                 if (bytes > len)
1208                         bytes = len;
1209
1210                 if (map_data) {
1211                         if (i == map_data->nr_entries * nr_pages) {
1212                                 ret = -ENOMEM;
1213                                 break;
1214                         }
1215
1216                         page = map_data->pages[i / nr_pages];
1217                         page += (i % nr_pages);
1218
1219                         i++;
1220                 } else {
1221                         page = alloc_page(q->bounce_gfp | gfp_mask);
1222                         if (!page) {
1223                                 ret = -ENOMEM;
1224                                 break;
1225                         }
1226                 }
1227
1228                 if (bio_add_pc_page(q, bio, page, bytes, offset) < bytes)
1229                         break;
1230
1231                 len -= bytes;
1232                 offset = 0;
1233         }
1234
1235         if (ret)
1236                 goto cleanup;
1237
1238         /*
1239          * success
1240          */
1241         if ((!write_to_vm && (!map_data || !map_data->null_mapped)) ||
1242             (map_data && map_data->from_user)) {
1243                 ret = __bio_copy_iov(bio, iov, iov_count, 0, 1);
1244                 if (ret)
1245                         goto cleanup;
1246         }
1247
1248         bio_set_map_data(bmd, bio, iov, iov_count, map_data ? 0 : 1);
1249         return bio;
1250 cleanup:
1251         if (!map_data)
1252                 bio_free_pages(bio);
1253         bio_put(bio);
1254 out_bmd:
1255         kfree(bmd);
1256         return ERR_PTR(ret);
1257 }
1258
1259 static struct bio *__bio_map_user_iov(struct request_queue *q,
1260                                       struct block_device *bdev,
1261                                       const struct sg_iovec *iov, int iov_count,
1262                                       int write_to_vm, gfp_t gfp_mask)
1263 {
1264         int i, j;
1265         int nr_pages = 0;
1266         struct page **pages;
1267         struct bio *bio;
1268         int cur_page = 0;
1269         int ret, offset;
1270
1271         for (i = 0; i < iov_count; i++) {
1272                 unsigned long uaddr = (unsigned long)iov[i].iov_base;
1273                 unsigned long len = iov[i].iov_len;
1274                 unsigned long end = (uaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1275                 unsigned long start = uaddr >> PAGE_SHIFT;
1276
1277                 /*
1278                  * Overflow, abort
1279                  */
1280                 if (end < start)
1281                         return ERR_PTR(-EINVAL);
1282
1283                 nr_pages += end - start;
1284                 /*
1285                  * buffer must be aligned to at least hardsector size for now
1286                  */
1287                 if (uaddr & queue_dma_alignment(q))
1288                         return ERR_PTR(-EINVAL);
1289         }
1290
1291         if (!nr_pages)
1292                 return ERR_PTR(-EINVAL);
1293
1294         bio = bio_kmalloc(gfp_mask, nr_pages);
1295         if (!bio)
1296                 return ERR_PTR(-ENOMEM);
1297
1298         ret = -ENOMEM;
1299         pages = kcalloc(nr_pages, sizeof(struct page *), gfp_mask);
1300         if (!pages)
1301                 goto out;
1302
1303         for (i = 0; i < iov_count; i++) {
1304                 unsigned long uaddr = (unsigned long)iov[i].iov_base;
1305                 unsigned long len = iov[i].iov_len;
1306                 unsigned long end = (uaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1307                 unsigned long start = uaddr >> PAGE_SHIFT;
1308                 const int local_nr_pages = end - start;
1309                 const int page_limit = cur_page + local_nr_pages;
1310
1311                 ret = get_user_pages_fast(uaddr, local_nr_pages,
1312                                 write_to_vm, &pages[cur_page]);
1313                 if (ret < local_nr_pages) {
1314                         ret = -EFAULT;
1315                         goto out_unmap;
1316                 }
1317
1318                 offset = uaddr & ~PAGE_MASK;
1319                 for (j = cur_page; j < page_limit; j++) {
1320                         unsigned int bytes = PAGE_SIZE - offset;
1321
1322                         if (len <= 0)
1323                                 break;
1324                         
1325                         if (bytes > len)
1326                                 bytes = len;
1327
1328                         /*
1329                          * sorry...
1330                          */
1331                         if (bio_add_pc_page(q, bio, pages[j], bytes, offset) <
1332                                             bytes)
1333                                 break;
1334
1335                         len -= bytes;
1336                         offset = 0;
1337                 }
1338
1339                 cur_page = j;
1340                 /*
1341                  * release the pages we didn't map into the bio, if any
1342                  */
1343                 while (j < page_limit)
1344                         page_cache_release(pages[j++]);
1345         }
1346
1347         kfree(pages);
1348
1349         /*
1350          * set data direction, and check if mapped pages need bouncing
1351          */
1352         if (!write_to_vm)
1353                 bio->bi_rw |= REQ_WRITE;
1354
1355         bio->bi_bdev = bdev;
1356         bio->bi_flags |= (1 << BIO_USER_MAPPED);
1357         return bio;
1358
1359  out_unmap:
1360         for (i = 0; i < nr_pages; i++) {
1361                 if(!pages[i])
1362                         break;
1363                 page_cache_release(pages[i]);
1364         }
1365  out:
1366         kfree(pages);
1367         bio_put(bio);
1368         return ERR_PTR(ret);
1369 }
1370
1371 /**
1372  *      bio_map_user_iov - map user sg_iovec table into bio
1373  *      @q: the struct request_queue for the bio
1374  *      @bdev: destination block device
1375  *      @iov:   the iovec.
1376  *      @iov_count: number of elements in the iovec
1377  *      @write_to_vm: bool indicating writing to pages or not
1378  *      @gfp_mask: memory allocation flags
1379  *
1380  *      Map the user space address into a bio suitable for io to a block
1381  *      device. Returns an error pointer in case of error.
1382  */
1383 struct bio *bio_map_user_iov(struct request_queue *q, struct block_device *bdev,
1384                              const struct sg_iovec *iov, int iov_count,
1385                              int write_to_vm, gfp_t gfp_mask)
1386 {
1387         struct bio *bio;
1388
1389         bio = __bio_map_user_iov(q, bdev, iov, iov_count, write_to_vm,
1390                                  gfp_mask);
1391         if (IS_ERR(bio))
1392                 return bio;
1393
1394         /*
1395          * subtle -- if __bio_map_user() ended up bouncing a bio,
1396          * it would normally disappear when its bi_end_io is run.
1397          * however, we need it for the unmap, so grab an extra
1398          * reference to it
1399          */
1400         bio_get(bio);
1401
1402         return bio;
1403 }
1404
1405 static void __bio_unmap_user(struct bio *bio)
1406 {
1407         struct bio_vec *bvec;
1408         int i;
1409
1410         /*
1411          * make sure we dirty pages we wrote to
1412          */
1413         bio_for_each_segment_all(bvec, bio, i) {
1414                 if (bio_data_dir(bio) == READ)
1415                         set_page_dirty_lock(bvec->bv_page);
1416
1417                 page_cache_release(bvec->bv_page);
1418         }
1419
1420         bio_put(bio);
1421 }
1422
1423 /**
1424  *      bio_unmap_user  -       unmap a bio
1425  *      @bio:           the bio being unmapped
1426  *
1427  *      Unmap a bio previously mapped by bio_map_user(). Must be called with
1428  *      a process context.
1429  *
1430  *      bio_unmap_user() may sleep.
1431  */
1432 void bio_unmap_user(struct bio *bio)
1433 {
1434         __bio_unmap_user(bio);
1435         bio_put(bio);
1436 }
1437 EXPORT_SYMBOL(bio_unmap_user);
1438
1439 static void bio_map_kern_endio(struct bio *bio, int err)
1440 {
1441         bio_put(bio);
1442 }
1443
1444 static struct bio *__bio_map_kern(struct request_queue *q, void *data,
1445                                   unsigned int len, gfp_t gfp_mask)
1446 {
1447         unsigned long kaddr = (unsigned long)data;
1448         unsigned long end = (kaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1449         unsigned long start = kaddr >> PAGE_SHIFT;
1450         const int nr_pages = end - start;
1451         int offset, i;
1452         struct bio *bio;
1453
1454         bio = bio_kmalloc(gfp_mask, nr_pages);
1455         if (!bio)
1456                 return ERR_PTR(-ENOMEM);
1457
1458         offset = offset_in_page(kaddr);
1459         for (i = 0; i < nr_pages; i++) {
1460                 unsigned int bytes = PAGE_SIZE - offset;
1461
1462                 if (len <= 0)
1463                         break;
1464
1465                 if (bytes > len)
1466                         bytes = len;
1467
1468                 if (bio_add_pc_page(q, bio, virt_to_page(data), bytes,
1469                                     offset) < bytes)
1470                         break;
1471
1472                 data += bytes;
1473                 len -= bytes;
1474                 offset = 0;
1475         }
1476
1477         bio->bi_end_io = bio_map_kern_endio;
1478         return bio;
1479 }
1480
1481 /**
1482  *      bio_map_kern    -       map kernel address into bio
1483  *      @q: the struct request_queue for the bio
1484  *      @data: pointer to buffer to map
1485  *      @len: length in bytes
1486  *      @gfp_mask: allocation flags for bio allocation
1487  *
1488  *      Map the kernel address into a bio suitable for io to a block
1489  *      device. Returns an error pointer in case of error.
1490  */
1491 struct bio *bio_map_kern(struct request_queue *q, void *data, unsigned int len,
1492                          gfp_t gfp_mask)
1493 {
1494         struct bio *bio;
1495
1496         bio = __bio_map_kern(q, data, len, gfp_mask);
1497         if (IS_ERR(bio))
1498                 return bio;
1499
1500         if (bio->bi_iter.bi_size == len)
1501                 return bio;
1502
1503         /*
1504          * Don't support partial mappings.
1505          */
1506         bio_put(bio);
1507         return ERR_PTR(-EINVAL);
1508 }
1509 EXPORT_SYMBOL(bio_map_kern);
1510
1511 static void bio_copy_kern_endio(struct bio *bio, int err)
1512 {
1513         bio_free_pages(bio);
1514         bio_put(bio);
1515 }
1516
1517 static void bio_copy_kern_endio_read(struct bio *bio, int err)
1518 {
1519         char *p = bio->bi_private;
1520         struct bio_vec *bvec;
1521         int i;
1522
1523         bio_for_each_segment_all(bvec, bio, i) {
1524                 memcpy(p, page_address(bvec->bv_page), bvec->bv_len);
1525                 p += bvec->bv_len;
1526         }
1527
1528         bio_copy_kern_endio(bio, err);
1529 }
1530
1531 /**
1532  *      bio_copy_kern   -       copy kernel address into bio
1533  *      @q: the struct request_queue for the bio
1534  *      @data: pointer to buffer to copy
1535  *      @len: length in bytes
1536  *      @gfp_mask: allocation flags for bio and page allocation
1537  *      @reading: data direction is READ
1538  *
1539  *      copy the kernel address into a bio suitable for io to a block
1540  *      device. Returns an error pointer in case of error.
1541  */
1542 struct bio *bio_copy_kern(struct request_queue *q, void *data, unsigned int len,
1543                           gfp_t gfp_mask, int reading)
1544 {
1545         unsigned long kaddr = (unsigned long)data;
1546         unsigned long end = (kaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1547         unsigned long start = kaddr >> PAGE_SHIFT;
1548         struct bio *bio;
1549         void *p = data;
1550         int nr_pages = 0;
1551
1552         /*
1553          * Overflow, abort
1554          */
1555         if (end < start)
1556                 return ERR_PTR(-EINVAL);
1557
1558         nr_pages = end - start;
1559         bio = bio_kmalloc(gfp_mask, nr_pages);
1560         if (!bio)
1561                 return ERR_PTR(-ENOMEM);
1562
1563         while (len) {
1564                 struct page *page;
1565                 unsigned int bytes = PAGE_SIZE;
1566
1567                 if (bytes > len)
1568                         bytes = len;
1569
1570                 page = alloc_page(q->bounce_gfp | gfp_mask);
1571                 if (!page)
1572                         goto cleanup;
1573
1574                 if (!reading)
1575                         memcpy(page_address(page), p, bytes);
1576
1577                 if (bio_add_pc_page(q, bio, page, bytes, 0) < bytes)
1578                         break;
1579
1580                 len -= bytes;
1581                 p += bytes;
1582         }
1583
1584         if (reading) {
1585                 bio->bi_end_io = bio_copy_kern_endio_read;
1586                 bio->bi_private = data;
1587         } else {
1588                 bio->bi_end_io = bio_copy_kern_endio;
1589                 bio->bi_rw |= REQ_WRITE;
1590         }
1591
1592         return bio;
1593
1594 cleanup:
1595         bio_free_pages(bio);
1596         bio_put(bio);
1597         return ERR_PTR(-ENOMEM);
1598 }
1599 EXPORT_SYMBOL(bio_copy_kern);
1600
1601 /*
1602  * bio_set_pages_dirty() and bio_check_pages_dirty() are support functions
1603  * for performing direct-IO in BIOs.
1604  *
1605  * The problem is that we cannot run set_page_dirty() from interrupt context
1606  * because the required locks are not interrupt-safe.  So what we can do is to
1607  * mark the pages dirty _before_ performing IO.  And in interrupt context,
1608  * check that the pages are still dirty.   If so, fine.  If not, redirty them
1609  * in process context.
1610  *
1611  * We special-case compound pages here: normally this means reads into hugetlb
1612  * pages.  The logic in here doesn't really work right for compound pages
1613  * because the VM does not uniformly chase down the head page in all cases.
1614  * But dirtiness of compound pages is pretty meaningless anyway: the VM doesn't
1615  * handle them at all.  So we skip compound pages here at an early stage.
1616  *
1617  * Note that this code is very hard to test under normal circumstances because
1618  * direct-io pins the pages with get_user_pages().  This makes
1619  * is_page_cache_freeable return false, and the VM will not clean the pages.
1620  * But other code (eg, flusher threads) could clean the pages if they are mapped
1621  * pagecache.
1622  *
1623  * Simply disabling the call to bio_set_pages_dirty() is a good way to test the
1624  * deferred bio dirtying paths.
1625  */
1626
1627 /*
1628  * bio_set_pages_dirty() will mark all the bio's pages as dirty.
1629  */
1630 void bio_set_pages_dirty(struct bio *bio)
1631 {
1632         struct bio_vec *bvec;
1633         int i;
1634
1635         bio_for_each_segment_all(bvec, bio, i) {
1636                 struct page *page = bvec->bv_page;
1637
1638                 if (page && !PageCompound(page))
1639                         set_page_dirty_lock(page);
1640         }
1641 }
1642
1643 static void bio_release_pages(struct bio *bio)
1644 {
1645         struct bio_vec *bvec;
1646         int i;
1647
1648         bio_for_each_segment_all(bvec, bio, i) {
1649                 struct page *page = bvec->bv_page;
1650
1651                 if (page)
1652                         put_page(page);
1653         }
1654 }
1655
1656 /*
1657  * bio_check_pages_dirty() will check that all the BIO's pages are still dirty.
1658  * If they are, then fine.  If, however, some pages are clean then they must
1659  * have been written out during the direct-IO read.  So we take another ref on
1660  * the BIO and the offending pages and re-dirty the pages in process context.
1661  *
1662  * It is expected that bio_check_pages_dirty() will wholly own the BIO from
1663  * here on.  It will run one page_cache_release() against each page and will
1664  * run one bio_put() against the BIO.
1665  */
1666
1667 static void bio_dirty_fn(struct work_struct *work);
1668
1669 static DECLARE_WORK(bio_dirty_work, bio_dirty_fn);
1670 static DEFINE_SPINLOCK(bio_dirty_lock);
1671 static struct bio *bio_dirty_list;
1672
1673 /*
1674  * This runs in process context
1675  */
1676 static void bio_dirty_fn(struct work_struct *work)
1677 {
1678         unsigned long flags;
1679         struct bio *bio;
1680
1681         spin_lock_irqsave(&bio_dirty_lock, flags);
1682         bio = bio_dirty_list;
1683         bio_dirty_list = NULL;
1684         spin_unlock_irqrestore(&bio_dirty_lock, flags);
1685
1686         while (bio) {
1687                 struct bio *next = bio->bi_private;
1688
1689                 bio_set_pages_dirty(bio);
1690                 bio_release_pages(bio);
1691                 bio_put(bio);
1692                 bio = next;
1693         }
1694 }
1695
1696 void bio_check_pages_dirty(struct bio *bio)
1697 {
1698         struct bio_vec *bvec;
1699         int nr_clean_pages = 0;
1700         int i;
1701
1702         bio_for_each_segment_all(bvec, bio, i) {
1703                 struct page *page = bvec->bv_page;
1704
1705                 if (PageDirty(page) || PageCompound(page)) {
1706                         page_cache_release(page);
1707                         bvec->bv_page = NULL;
1708                 } else {
1709                         nr_clean_pages++;
1710                 }
1711         }
1712
1713         if (nr_clean_pages) {
1714                 unsigned long flags;
1715
1716                 spin_lock_irqsave(&bio_dirty_lock, flags);
1717                 bio->bi_private = bio_dirty_list;
1718                 bio_dirty_list = bio;
1719                 spin_unlock_irqrestore(&bio_dirty_lock, flags);
1720                 schedule_work(&bio_dirty_work);
1721         } else {
1722                 bio_put(bio);
1723         }
1724 }
1725
1726 void generic_start_io_acct(int rw, unsigned long sectors,
1727                            struct hd_struct *part)
1728 {
1729         int cpu = part_stat_lock();
1730
1731         part_round_stats(cpu, part);
1732         part_stat_inc(cpu, part, ios[rw]);
1733         part_stat_add(cpu, part, sectors[rw], sectors);
1734         part_inc_in_flight(part, rw);
1735
1736         part_stat_unlock();
1737 }
1738 EXPORT_SYMBOL(generic_start_io_acct);
1739
1740 void generic_end_io_acct(int rw, struct hd_struct *part,
1741                          unsigned long start_time)
1742 {
1743         unsigned long duration = jiffies - start_time;
1744         int cpu = part_stat_lock();
1745
1746         part_stat_add(cpu, part, ticks[rw], duration);
1747         part_round_stats(cpu, part);
1748         part_dec_in_flight(part, rw);
1749
1750         part_stat_unlock();
1751 }
1752 EXPORT_SYMBOL(generic_end_io_acct);
1753
1754 #if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
1755 void bio_flush_dcache_pages(struct bio *bi)
1756 {
1757         struct bio_vec bvec;
1758         struct bvec_iter iter;
1759
1760         bio_for_each_segment(bvec, bi, iter)
1761                 flush_dcache_page(bvec.bv_page);
1762 }
1763 EXPORT_SYMBOL(bio_flush_dcache_pages);
1764 #endif
1765
1766 /**
1767  * bio_endio - end I/O on a bio
1768  * @bio:        bio
1769  * @error:      error, if any
1770  *
1771  * Description:
1772  *   bio_endio() will end I/O on the whole bio. bio_endio() is the
1773  *   preferred way to end I/O on a bio, it takes care of clearing
1774  *   BIO_UPTODATE on error. @error is 0 on success, and and one of the
1775  *   established -Exxxx (-EIO, for instance) error values in case
1776  *   something went wrong. No one should call bi_end_io() directly on a
1777  *   bio unless they own it and thus know that it has an end_io
1778  *   function.
1779  **/
1780 void bio_endio(struct bio *bio, int error)
1781 {
1782         while (bio) {
1783                 BUG_ON(atomic_read(&bio->bi_remaining) <= 0);
1784
1785                 if (error)
1786                         clear_bit(BIO_UPTODATE, &bio->bi_flags);
1787                 else if (!test_bit(BIO_UPTODATE, &bio->bi_flags))
1788                         error = -EIO;
1789
1790                 if (!atomic_dec_and_test(&bio->bi_remaining))
1791                         return;
1792
1793                 /*
1794                  * Need to have a real endio function for chained bios,
1795                  * otherwise various corner cases will break (like stacking
1796                  * block devices that save/restore bi_end_io) - however, we want
1797                  * to avoid unbounded recursion and blowing the stack. Tail call
1798                  * optimization would handle this, but compiling with frame
1799                  * pointers also disables gcc's sibling call optimization.
1800                  */
1801                 if (bio->bi_end_io == bio_chain_endio) {
1802                         struct bio *parent = bio->bi_private;
1803                         bio_put(bio);
1804                         bio = parent;
1805                 } else {
1806                         if (bio->bi_end_io)
1807                                 bio->bi_end_io(bio, error);
1808                         bio = NULL;
1809                 }
1810         }
1811 }
1812 EXPORT_SYMBOL(bio_endio);
1813
1814 /**
1815  * bio_endio_nodec - end I/O on a bio, without decrementing bi_remaining
1816  * @bio:        bio
1817  * @error:      error, if any
1818  *
1819  * For code that has saved and restored bi_end_io; thing hard before using this
1820  * function, probably you should've cloned the entire bio.
1821  **/
1822 void bio_endio_nodec(struct bio *bio, int error)
1823 {
1824         atomic_inc(&bio->bi_remaining);
1825         bio_endio(bio, error);
1826 }
1827 EXPORT_SYMBOL(bio_endio_nodec);
1828
1829 /**
1830  * bio_split - split a bio
1831  * @bio:        bio to split
1832  * @sectors:    number of sectors to split from the front of @bio
1833  * @gfp:        gfp mask
1834  * @bs:         bio set to allocate from
1835  *
1836  * Allocates and returns a new bio which represents @sectors from the start of
1837  * @bio, and updates @bio to represent the remaining sectors.
1838  *
1839  * The newly allocated bio will point to @bio's bi_io_vec; it is the caller's
1840  * responsibility to ensure that @bio is not freed before the split.
1841  */
1842 struct bio *bio_split(struct bio *bio, int sectors,
1843                       gfp_t gfp, struct bio_set *bs)
1844 {
1845         struct bio *split = NULL;
1846
1847         BUG_ON(sectors <= 0);
1848         BUG_ON(sectors >= bio_sectors(bio));
1849
1850         split = bio_clone_fast(bio, gfp, bs);
1851         if (!split)
1852                 return NULL;
1853
1854         split->bi_iter.bi_size = sectors << 9;
1855
1856         if (bio_integrity(split))
1857                 bio_integrity_trim(split, 0, sectors);
1858
1859         bio_advance(bio, split->bi_iter.bi_size);
1860
1861         return split;
1862 }
1863 EXPORT_SYMBOL(bio_split);
1864
1865 /**
1866  * bio_trim - trim a bio
1867  * @bio:        bio to trim
1868  * @offset:     number of sectors to trim from the front of @bio
1869  * @size:       size we want to trim @bio to, in sectors
1870  */
1871 void bio_trim(struct bio *bio, int offset, int size)
1872 {
1873         /* 'bio' is a cloned bio which we need to trim to match
1874          * the given offset and size.
1875          */
1876
1877         size <<= 9;
1878         if (offset == 0 && size == bio->bi_iter.bi_size)
1879                 return;
1880
1881         clear_bit(BIO_SEG_VALID, &bio->bi_flags);
1882
1883         bio_advance(bio, offset << 9);
1884
1885         bio->bi_iter.bi_size = size;
1886 }
1887 EXPORT_SYMBOL_GPL(bio_trim);
1888
1889 /*
1890  * create memory pools for biovec's in a bio_set.
1891  * use the global biovec slabs created for general use.
1892  */
1893 mempool_t *biovec_create_pool(int pool_entries)
1894 {
1895         struct biovec_slab *bp = bvec_slabs + BIOVEC_MAX_IDX;
1896
1897         return mempool_create_slab_pool(pool_entries, bp->slab);
1898 }
1899
1900 void bioset_free(struct bio_set *bs)
1901 {
1902         if (bs->rescue_workqueue)
1903                 destroy_workqueue(bs->rescue_workqueue);
1904
1905         if (bs->bio_pool)
1906                 mempool_destroy(bs->bio_pool);
1907
1908         if (bs->bvec_pool)
1909                 mempool_destroy(bs->bvec_pool);
1910
1911         bioset_integrity_free(bs);
1912         bio_put_slab(bs);
1913
1914         kfree(bs);
1915 }
1916 EXPORT_SYMBOL(bioset_free);
1917
1918 static struct bio_set *__bioset_create(unsigned int pool_size,
1919                                        unsigned int front_pad,
1920                                        bool create_bvec_pool)
1921 {
1922         unsigned int back_pad = BIO_INLINE_VECS * sizeof(struct bio_vec);
1923         struct bio_set *bs;
1924
1925         bs = kzalloc(sizeof(*bs), GFP_KERNEL);
1926         if (!bs)
1927                 return NULL;
1928
1929         bs->front_pad = front_pad;
1930
1931         spin_lock_init(&bs->rescue_lock);
1932         bio_list_init(&bs->rescue_list);
1933         INIT_WORK(&bs->rescue_work, bio_alloc_rescue);
1934
1935         bs->bio_slab = bio_find_or_create_slab(front_pad + back_pad);
1936         if (!bs->bio_slab) {
1937                 kfree(bs);
1938                 return NULL;
1939         }
1940
1941         bs->bio_pool = mempool_create_slab_pool(pool_size, bs->bio_slab);
1942         if (!bs->bio_pool)
1943                 goto bad;
1944
1945         if (create_bvec_pool) {
1946                 bs->bvec_pool = biovec_create_pool(pool_size);
1947                 if (!bs->bvec_pool)
1948                         goto bad;
1949         }
1950
1951         bs->rescue_workqueue = alloc_workqueue("bioset", WQ_MEM_RECLAIM, 0);
1952         if (!bs->rescue_workqueue)
1953                 goto bad;
1954
1955         return bs;
1956 bad:
1957         bioset_free(bs);
1958         return NULL;
1959 }
1960
1961 /**
1962  * bioset_create  - Create a bio_set
1963  * @pool_size:  Number of bio and bio_vecs to cache in the mempool
1964  * @front_pad:  Number of bytes to allocate in front of the returned bio
1965  *
1966  * Description:
1967  *    Set up a bio_set to be used with @bio_alloc_bioset. Allows the caller
1968  *    to ask for a number of bytes to be allocated in front of the bio.
1969  *    Front pad allocation is useful for embedding the bio inside
1970  *    another structure, to avoid allocating extra data to go with the bio.
1971  *    Note that the bio must be embedded at the END of that structure always,
1972  *    or things will break badly.
1973  */
1974 struct bio_set *bioset_create(unsigned int pool_size, unsigned int front_pad)
1975 {
1976         return __bioset_create(pool_size, front_pad, true);
1977 }
1978 EXPORT_SYMBOL(bioset_create);
1979
1980 /**
1981  * bioset_create_nobvec  - Create a bio_set without bio_vec mempool
1982  * @pool_size:  Number of bio to cache in the mempool
1983  * @front_pad:  Number of bytes to allocate in front of the returned bio
1984  *
1985  * Description:
1986  *    Same functionality as bioset_create() except that mempool is not
1987  *    created for bio_vecs. Saving some memory for bio_clone_fast() users.
1988  */
1989 struct bio_set *bioset_create_nobvec(unsigned int pool_size, unsigned int front_pad)
1990 {
1991         return __bioset_create(pool_size, front_pad, false);
1992 }
1993 EXPORT_SYMBOL(bioset_create_nobvec);
1994
1995 #ifdef CONFIG_BLK_CGROUP
1996 /**
1997  * bio_associate_current - associate a bio with %current
1998  * @bio: target bio
1999  *
2000  * Associate @bio with %current if it hasn't been associated yet.  Block
2001  * layer will treat @bio as if it were issued by %current no matter which
2002  * task actually issues it.
2003  *
2004  * This function takes an extra reference of @task's io_context and blkcg
2005  * which will be put when @bio is released.  The caller must own @bio,
2006  * ensure %current->io_context exists, and is responsible for synchronizing
2007  * calls to this function.
2008  */
2009 int bio_associate_current(struct bio *bio)
2010 {
2011         struct io_context *ioc;
2012         struct cgroup_subsys_state *css;
2013
2014         if (bio->bi_ioc)
2015                 return -EBUSY;
2016
2017         ioc = current->io_context;
2018         if (!ioc)
2019                 return -ENOENT;
2020
2021         /* acquire active ref on @ioc and associate */
2022         get_io_context_active(ioc);
2023         bio->bi_ioc = ioc;
2024
2025         /* associate blkcg if exists */
2026         rcu_read_lock();
2027         css = task_css(current, blkio_cgrp_id);
2028         if (css && css_tryget_online(css))
2029                 bio->bi_css = css;
2030         rcu_read_unlock();
2031
2032         return 0;
2033 }
2034
2035 /**
2036  * bio_disassociate_task - undo bio_associate_current()
2037  * @bio: target bio
2038  */
2039 void bio_disassociate_task(struct bio *bio)
2040 {
2041         if (bio->bi_ioc) {
2042                 put_io_context(bio->bi_ioc);
2043                 bio->bi_ioc = NULL;
2044         }
2045         if (bio->bi_css) {
2046                 css_put(bio->bi_css);
2047                 bio->bi_css = NULL;
2048         }
2049 }
2050
2051 #endif /* CONFIG_BLK_CGROUP */
2052
2053 static void __init biovec_init_slabs(void)
2054 {
2055         int i;
2056
2057         for (i = 0; i < BIOVEC_NR_POOLS; i++) {
2058                 int size;
2059                 struct biovec_slab *bvs = bvec_slabs + i;
2060
2061                 if (bvs->nr_vecs <= BIO_INLINE_VECS) {
2062                         bvs->slab = NULL;
2063                         continue;
2064                 }
2065
2066                 size = bvs->nr_vecs * sizeof(struct bio_vec);
2067                 bvs->slab = kmem_cache_create(bvs->name, size, 0,
2068                                 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
2069         }
2070 }
2071
2072 static int __init init_bio(void)
2073 {
2074         bio_slab_max = 2;
2075         bio_slab_nr = 0;
2076         bio_slabs = kzalloc(bio_slab_max * sizeof(struct bio_slab), GFP_KERNEL);
2077         if (!bio_slabs)
2078                 panic("bio: can't allocate bios\n");
2079
2080         bio_integrity_init();
2081         biovec_init_slabs();
2082
2083         fs_bio_set = bioset_create(BIO_POOL_SIZE, 0);
2084         if (!fs_bio_set)
2085                 panic("bio: can't allocate bios\n");
2086
2087         if (bioset_integrity_create(fs_bio_set, BIO_POOL_SIZE))
2088                 panic("bio: can't create integrity pool\n");
2089
2090         return 0;
2091 }
2092 subsys_initcall(init_bio);