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