block: set BIO_NO_PAGE_REF in bio_iov_bvec_set
[linux-2.6-microblaze.git] / block / bio.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (C) 2001 Jens Axboe <axboe@kernel.dk>
4  */
5 #include <linux/mm.h>
6 #include <linux/swap.h>
7 #include <linux/bio.h>
8 #include <linux/blkdev.h>
9 #include <linux/uio.h>
10 #include <linux/iocontext.h>
11 #include <linux/slab.h>
12 #include <linux/init.h>
13 #include <linux/kernel.h>
14 #include <linux/export.h>
15 #include <linux/mempool.h>
16 #include <linux/workqueue.h>
17 #include <linux/cgroup.h>
18 #include <linux/blk-cgroup.h>
19 #include <linux/highmem.h>
20 #include <linux/sched/sysctl.h>
21 #include <linux/blk-crypto.h>
22 #include <linux/xarray.h>
23
24 #include <trace/events/block.h>
25 #include "blk.h"
26 #include "blk-rq-qos.h"
27
28 static struct biovec_slab {
29         int nr_vecs;
30         char *name;
31         struct kmem_cache *slab;
32 } bvec_slabs[] __read_mostly = {
33         { .nr_vecs = 16, .name = "biovec-16" },
34         { .nr_vecs = 64, .name = "biovec-64" },
35         { .nr_vecs = 128, .name = "biovec-128" },
36         { .nr_vecs = BIO_MAX_PAGES, .name = "biovec-max" },
37 };
38
39 /*
40  * fs_bio_set is the bio_set containing bio and iovec memory pools used by
41  * IO code that does not need private memory pools.
42  */
43 struct bio_set fs_bio_set;
44 EXPORT_SYMBOL(fs_bio_set);
45
46 /*
47  * Our slab pool management
48  */
49 struct bio_slab {
50         struct kmem_cache *slab;
51         unsigned int slab_ref;
52         unsigned int slab_size;
53         char name[8];
54 };
55 static DEFINE_MUTEX(bio_slab_lock);
56 static DEFINE_XARRAY(bio_slabs);
57
58 static struct bio_slab *create_bio_slab(unsigned int size)
59 {
60         struct bio_slab *bslab = kzalloc(sizeof(*bslab), GFP_KERNEL);
61
62         if (!bslab)
63                 return NULL;
64
65         snprintf(bslab->name, sizeof(bslab->name), "bio-%d", size);
66         bslab->slab = kmem_cache_create(bslab->name, size,
67                         ARCH_KMALLOC_MINALIGN, SLAB_HWCACHE_ALIGN, NULL);
68         if (!bslab->slab)
69                 goto fail_alloc_slab;
70
71         bslab->slab_ref = 1;
72         bslab->slab_size = size;
73
74         if (!xa_err(xa_store(&bio_slabs, size, bslab, GFP_KERNEL)))
75                 return bslab;
76
77         kmem_cache_destroy(bslab->slab);
78
79 fail_alloc_slab:
80         kfree(bslab);
81         return NULL;
82 }
83
84 static inline unsigned int bs_bio_slab_size(struct bio_set *bs)
85 {
86         return bs->front_pad + sizeof(struct bio) + bs->back_pad;
87 }
88
89 static struct kmem_cache *bio_find_or_create_slab(struct bio_set *bs)
90 {
91         unsigned int size = bs_bio_slab_size(bs);
92         struct bio_slab *bslab;
93
94         mutex_lock(&bio_slab_lock);
95         bslab = xa_load(&bio_slabs, size);
96         if (bslab)
97                 bslab->slab_ref++;
98         else
99                 bslab = create_bio_slab(size);
100         mutex_unlock(&bio_slab_lock);
101
102         if (bslab)
103                 return bslab->slab;
104         return NULL;
105 }
106
107 static void bio_put_slab(struct bio_set *bs)
108 {
109         struct bio_slab *bslab = NULL;
110         unsigned int slab_size = bs_bio_slab_size(bs);
111
112         mutex_lock(&bio_slab_lock);
113
114         bslab = xa_load(&bio_slabs, slab_size);
115         if (WARN(!bslab, KERN_ERR "bio: unable to find slab!\n"))
116                 goto out;
117
118         WARN_ON_ONCE(bslab->slab != bs->bio_slab);
119
120         WARN_ON(!bslab->slab_ref);
121
122         if (--bslab->slab_ref)
123                 goto out;
124
125         xa_erase(&bio_slabs, slab_size);
126
127         kmem_cache_destroy(bslab->slab);
128         kfree(bslab);
129
130 out:
131         mutex_unlock(&bio_slab_lock);
132 }
133
134 unsigned int bvec_nr_vecs(unsigned short idx)
135 {
136         return bvec_slabs[--idx].nr_vecs;
137 }
138
139 void bvec_free(mempool_t *pool, struct bio_vec *bv, unsigned int idx)
140 {
141         if (!idx)
142                 return;
143         idx--;
144
145         BIO_BUG_ON(idx >= BVEC_POOL_NR);
146
147         if (idx == BVEC_POOL_MAX) {
148                 mempool_free(bv, pool);
149         } else {
150                 struct biovec_slab *bvs = bvec_slabs + idx;
151
152                 kmem_cache_free(bvs->slab, bv);
153         }
154 }
155
156 /*
157  * Make the first allocation restricted and don't dump info on allocation
158  * failures, since we'll fall back to the mempool in case of failure.
159  */
160 static inline gfp_t bvec_alloc_gfp(gfp_t gfp)
161 {
162         return (gfp & ~(__GFP_DIRECT_RECLAIM | __GFP_IO)) |
163                 __GFP_NOMEMALLOC | __GFP_NORETRY | __GFP_NOWARN;
164 }
165
166 struct bio_vec *bvec_alloc(gfp_t gfp_mask, int nr, unsigned long *idx,
167                            mempool_t *pool)
168 {
169         /*
170          * see comment near bvec_array define!
171          */
172         switch (nr) {
173         /* smaller bios use inline vecs */
174         case 5 ... 16:
175                 *idx = 2;
176                 break;
177         case 17 ... 64:
178                 *idx = 3;
179                 break;
180         case 65 ... 128:
181                 *idx = 4;
182                 break;
183         case 129 ... BIO_MAX_PAGES:
184                 *idx = 5;
185                 break;
186         default:
187                 return NULL;
188         }
189
190         /*
191          * Try a slab allocation first for all smaller allocations.  If that
192          * fails and __GFP_DIRECT_RECLAIM is set retry with the mempool.
193          * The mempool is sized to handle up to BIO_MAX_PAGES entries.
194          */
195         if (*idx < BVEC_POOL_MAX) {
196                 struct biovec_slab *bvs = bvec_slabs + *idx;
197                 struct bio_vec *bvl;
198
199                 bvl = kmem_cache_alloc(bvs->slab, bvec_alloc_gfp(gfp_mask));
200                 if (likely(bvl) || !(gfp_mask & __GFP_DIRECT_RECLAIM)) {
201                         (*idx)++;
202                         return bvl;
203                 }
204                 *idx = BVEC_POOL_MAX;
205         }
206
207         (*idx)++;
208         return mempool_alloc(pool, gfp_mask);
209 }
210
211 void bio_uninit(struct bio *bio)
212 {
213 #ifdef CONFIG_BLK_CGROUP
214         if (bio->bi_blkg) {
215                 blkg_put(bio->bi_blkg);
216                 bio->bi_blkg = NULL;
217         }
218 #endif
219         if (bio_integrity(bio))
220                 bio_integrity_free(bio);
221
222         bio_crypt_free_ctx(bio);
223 }
224 EXPORT_SYMBOL(bio_uninit);
225
226 static void bio_free(struct bio *bio)
227 {
228         struct bio_set *bs = bio->bi_pool;
229         void *p;
230
231         bio_uninit(bio);
232
233         if (bs) {
234                 bvec_free(&bs->bvec_pool, bio->bi_io_vec, BVEC_POOL_IDX(bio));
235
236                 /*
237                  * If we have front padding, adjust the bio pointer before freeing
238                  */
239                 p = bio;
240                 p -= bs->front_pad;
241
242                 mempool_free(p, &bs->bio_pool);
243         } else {
244                 /* Bio was allocated by bio_kmalloc() */
245                 kfree(bio);
246         }
247 }
248
249 /*
250  * Users of this function have their own bio allocation. Subsequently,
251  * they must remember to pair any call to bio_init() with bio_uninit()
252  * when IO has completed, or when the bio is released.
253  */
254 void bio_init(struct bio *bio, struct bio_vec *table,
255               unsigned short max_vecs)
256 {
257         memset(bio, 0, sizeof(*bio));
258         atomic_set(&bio->__bi_remaining, 1);
259         atomic_set(&bio->__bi_cnt, 1);
260
261         bio->bi_io_vec = table;
262         bio->bi_max_vecs = max_vecs;
263 }
264 EXPORT_SYMBOL(bio_init);
265
266 /**
267  * bio_reset - reinitialize a bio
268  * @bio:        bio to reset
269  *
270  * Description:
271  *   After calling bio_reset(), @bio will be in the same state as a freshly
272  *   allocated bio returned bio bio_alloc_bioset() - the only fields that are
273  *   preserved are the ones that are initialized by bio_alloc_bioset(). See
274  *   comment in struct bio.
275  */
276 void bio_reset(struct bio *bio)
277 {
278         unsigned long flags = bio->bi_flags & (~0UL << BIO_RESET_BITS);
279
280         bio_uninit(bio);
281
282         memset(bio, 0, BIO_RESET_BYTES);
283         bio->bi_flags = flags;
284         atomic_set(&bio->__bi_remaining, 1);
285 }
286 EXPORT_SYMBOL(bio_reset);
287
288 static struct bio *__bio_chain_endio(struct bio *bio)
289 {
290         struct bio *parent = bio->bi_private;
291
292         if (!parent->bi_status)
293                 parent->bi_status = bio->bi_status;
294         bio_put(bio);
295         return parent;
296 }
297
298 static void bio_chain_endio(struct bio *bio)
299 {
300         bio_endio(__bio_chain_endio(bio));
301 }
302
303 /**
304  * bio_chain - chain bio completions
305  * @bio: the target bio
306  * @parent: the parent bio of @bio
307  *
308  * The caller won't have a bi_end_io called when @bio completes - instead,
309  * @parent's bi_end_io won't be called until both @parent and @bio have
310  * completed; the chained bio will also be freed when it completes.
311  *
312  * The caller must not set bi_private or bi_end_io in @bio.
313  */
314 void bio_chain(struct bio *bio, struct bio *parent)
315 {
316         BUG_ON(bio->bi_private || bio->bi_end_io);
317
318         bio->bi_private = parent;
319         bio->bi_end_io  = bio_chain_endio;
320         bio_inc_remaining(parent);
321 }
322 EXPORT_SYMBOL(bio_chain);
323
324 static void bio_alloc_rescue(struct work_struct *work)
325 {
326         struct bio_set *bs = container_of(work, struct bio_set, rescue_work);
327         struct bio *bio;
328
329         while (1) {
330                 spin_lock(&bs->rescue_lock);
331                 bio = bio_list_pop(&bs->rescue_list);
332                 spin_unlock(&bs->rescue_lock);
333
334                 if (!bio)
335                         break;
336
337                 submit_bio_noacct(bio);
338         }
339 }
340
341 static void punt_bios_to_rescuer(struct bio_set *bs)
342 {
343         struct bio_list punt, nopunt;
344         struct bio *bio;
345
346         if (WARN_ON_ONCE(!bs->rescue_workqueue))
347                 return;
348         /*
349          * In order to guarantee forward progress we must punt only bios that
350          * were allocated from this bio_set; otherwise, if there was a bio on
351          * there for a stacking driver higher up in the stack, processing it
352          * could require allocating bios from this bio_set, and doing that from
353          * our own rescuer would be bad.
354          *
355          * Since bio lists are singly linked, pop them all instead of trying to
356          * remove from the middle of the list:
357          */
358
359         bio_list_init(&punt);
360         bio_list_init(&nopunt);
361
362         while ((bio = bio_list_pop(&current->bio_list[0])))
363                 bio_list_add(bio->bi_pool == bs ? &punt : &nopunt, bio);
364         current->bio_list[0] = nopunt;
365
366         bio_list_init(&nopunt);
367         while ((bio = bio_list_pop(&current->bio_list[1])))
368                 bio_list_add(bio->bi_pool == bs ? &punt : &nopunt, bio);
369         current->bio_list[1] = nopunt;
370
371         spin_lock(&bs->rescue_lock);
372         bio_list_merge(&bs->rescue_list, &punt);
373         spin_unlock(&bs->rescue_lock);
374
375         queue_work(bs->rescue_workqueue, &bs->rescue_work);
376 }
377
378 /**
379  * bio_alloc_bioset - allocate a bio for I/O
380  * @gfp_mask:   the GFP_* mask given to the slab allocator
381  * @nr_iovecs:  number of iovecs to pre-allocate
382  * @bs:         the bio_set to allocate from.
383  *
384  * Allocate a bio from the mempools in @bs.
385  *
386  * If %__GFP_DIRECT_RECLAIM is set then bio_alloc will always be able to
387  * allocate a bio.  This is due to the mempool guarantees.  To make this work,
388  * callers must never allocate more than 1 bio at a time from the general 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 submit_bio_noacct() (i.e. any block driver),
394  * bios are not submitted until after you return - see the code in
395  * submit_bio_noacct() that converts recursion into iteration, to prevent
396  * stack overflows.
397  *
398  * This would normally mean allocating multiple bios under submit_bio_noacct()
399  * 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  * submit_bio_noacct() should be avoided - instead, use bio_set's front_pad
406  * for per bio allocations.
407  *
408  * Returns: Pointer to new bio on success, NULL on failure.
409  */
410 struct bio *bio_alloc_bioset(gfp_t gfp_mask, unsigned short nr_iovecs,
411                              struct bio_set *bs)
412 {
413         gfp_t saved_gfp = gfp_mask;
414         struct bio *bio;
415         void *p;
416
417         /* should not use nobvec bioset for nr_iovecs > 0 */
418         if (WARN_ON_ONCE(!mempool_initialized(&bs->bvec_pool) && nr_iovecs > 0))
419                 return NULL;
420
421         /*
422          * submit_bio_noacct() converts recursion to iteration; this means if
423          * we're running beneath it, any bios we allocate and submit will not be
424          * submitted (and thus freed) until after we return.
425          *
426          * This exposes us to a potential deadlock if we allocate multiple bios
427          * from the same bio_set() while running underneath submit_bio_noacct().
428          * If we were to allocate multiple bios (say a stacking block driver
429          * that was splitting bios), we would deadlock if we exhausted the
430          * mempool's reserve.
431          *
432          * We solve this, and guarantee forward progress, with a rescuer
433          * workqueue per bio_set. If we go to allocate and there are bios on
434          * current->bio_list, we first try the allocation without
435          * __GFP_DIRECT_RECLAIM; if that fails, we punt those bios we would be
436          * blocking to the rescuer workqueue before we retry with the original
437          * gfp_flags.
438          */
439         if (current->bio_list &&
440             (!bio_list_empty(&current->bio_list[0]) ||
441              !bio_list_empty(&current->bio_list[1])) &&
442             bs->rescue_workqueue)
443                 gfp_mask &= ~__GFP_DIRECT_RECLAIM;
444
445         p = mempool_alloc(&bs->bio_pool, gfp_mask);
446         if (!p && gfp_mask != saved_gfp) {
447                 punt_bios_to_rescuer(bs);
448                 gfp_mask = saved_gfp;
449                 p = mempool_alloc(&bs->bio_pool, gfp_mask);
450         }
451         if (unlikely(!p))
452                 return NULL;
453
454         bio = p + bs->front_pad;
455         if (nr_iovecs > BIO_INLINE_VECS) {
456                 unsigned long idx = 0;
457                 struct bio_vec *bvl = NULL;
458
459                 bvl = bvec_alloc(gfp_mask, nr_iovecs, &idx, &bs->bvec_pool);
460                 if (!bvl && gfp_mask != saved_gfp) {
461                         punt_bios_to_rescuer(bs);
462                         gfp_mask = saved_gfp;
463                         bvl = bvec_alloc(gfp_mask, nr_iovecs, &idx,
464                                          &bs->bvec_pool);
465                 }
466
467                 if (unlikely(!bvl))
468                         goto err_free;
469
470                 bio_init(bio, bvl, bvec_nr_vecs(idx));
471                 bio->bi_flags |= idx << BVEC_POOL_OFFSET;
472         } else if (nr_iovecs) {
473                 bio_init(bio, bio->bi_inline_vecs, BIO_INLINE_VECS);
474         } else {
475                 bio_init(bio, NULL, 0);
476         }
477
478         bio->bi_pool = bs;
479         return bio;
480
481 err_free:
482         mempool_free(p, &bs->bio_pool);
483         return NULL;
484 }
485 EXPORT_SYMBOL(bio_alloc_bioset);
486
487 /**
488  * bio_kmalloc - kmalloc a bio for I/O
489  * @gfp_mask:   the GFP_* mask given to the slab allocator
490  * @nr_iovecs:  number of iovecs to pre-allocate
491  *
492  * Use kmalloc to allocate and initialize a bio.
493  *
494  * Returns: Pointer to new bio on success, NULL on failure.
495  */
496 struct bio *bio_kmalloc(gfp_t gfp_mask, unsigned short nr_iovecs)
497 {
498         struct bio *bio;
499
500         if (nr_iovecs > UIO_MAXIOV)
501                 return NULL;
502
503         bio = kmalloc(struct_size(bio, bi_inline_vecs, nr_iovecs), gfp_mask);
504         if (unlikely(!bio))
505                 return NULL;
506         bio_init(bio, nr_iovecs ? bio->bi_inline_vecs : NULL, nr_iovecs);
507         bio->bi_pool = NULL;
508         return bio;
509 }
510 EXPORT_SYMBOL(bio_kmalloc);
511
512 void zero_fill_bio_iter(struct bio *bio, struct bvec_iter start)
513 {
514         unsigned long flags;
515         struct bio_vec bv;
516         struct bvec_iter iter;
517
518         __bio_for_each_segment(bv, bio, iter, start) {
519                 char *data = bvec_kmap_irq(&bv, &flags);
520                 memset(data, 0, bv.bv_len);
521                 flush_dcache_page(bv.bv_page);
522                 bvec_kunmap_irq(data, &flags);
523         }
524 }
525 EXPORT_SYMBOL(zero_fill_bio_iter);
526
527 /**
528  * bio_truncate - truncate the bio to small size of @new_size
529  * @bio:        the bio to be truncated
530  * @new_size:   new size for truncating the bio
531  *
532  * Description:
533  *   Truncate the bio to new size of @new_size. If bio_op(bio) is
534  *   REQ_OP_READ, zero the truncated part. This function should only
535  *   be used for handling corner cases, such as bio eod.
536  */
537 void bio_truncate(struct bio *bio, unsigned new_size)
538 {
539         struct bio_vec bv;
540         struct bvec_iter iter;
541         unsigned int done = 0;
542         bool truncated = false;
543
544         if (new_size >= bio->bi_iter.bi_size)
545                 return;
546
547         if (bio_op(bio) != REQ_OP_READ)
548                 goto exit;
549
550         bio_for_each_segment(bv, bio, iter) {
551                 if (done + bv.bv_len > new_size) {
552                         unsigned offset;
553
554                         if (!truncated)
555                                 offset = new_size - done;
556                         else
557                                 offset = 0;
558                         zero_user(bv.bv_page, offset, bv.bv_len - offset);
559                         truncated = true;
560                 }
561                 done += bv.bv_len;
562         }
563
564  exit:
565         /*
566          * Don't touch bvec table here and make it really immutable, since
567          * fs bio user has to retrieve all pages via bio_for_each_segment_all
568          * in its .end_bio() callback.
569          *
570          * It is enough to truncate bio by updating .bi_size since we can make
571          * correct bvec with the updated .bi_size for drivers.
572          */
573         bio->bi_iter.bi_size = new_size;
574 }
575
576 /**
577  * guard_bio_eod - truncate a BIO to fit the block device
578  * @bio:        bio to truncate
579  *
580  * This allows us to do IO even on the odd last sectors of a device, even if the
581  * block size is some multiple of the physical sector size.
582  *
583  * We'll just truncate the bio to the size of the device, and clear the end of
584  * the buffer head manually.  Truly out-of-range accesses will turn into actual
585  * I/O errors, this only handles the "we need to be able to do I/O at the final
586  * sector" case.
587  */
588 void guard_bio_eod(struct bio *bio)
589 {
590         sector_t maxsector = bdev_nr_sectors(bio->bi_bdev);
591
592         if (!maxsector)
593                 return;
594
595         /*
596          * If the *whole* IO is past the end of the device,
597          * let it through, and the IO layer will turn it into
598          * an EIO.
599          */
600         if (unlikely(bio->bi_iter.bi_sector >= maxsector))
601                 return;
602
603         maxsector -= bio->bi_iter.bi_sector;
604         if (likely((bio->bi_iter.bi_size >> 9) <= maxsector))
605                 return;
606
607         bio_truncate(bio, maxsector << 9);
608 }
609
610 /**
611  * bio_put - release a reference to a bio
612  * @bio:   bio to release reference to
613  *
614  * Description:
615  *   Put a reference to a &struct bio, either one you have gotten with
616  *   bio_alloc, bio_get or bio_clone_*. The last put of a bio will free it.
617  **/
618 void bio_put(struct bio *bio)
619 {
620         if (!bio_flagged(bio, BIO_REFFED))
621                 bio_free(bio);
622         else {
623                 BIO_BUG_ON(!atomic_read(&bio->__bi_cnt));
624
625                 /*
626                  * last put frees it
627                  */
628                 if (atomic_dec_and_test(&bio->__bi_cnt))
629                         bio_free(bio);
630         }
631 }
632 EXPORT_SYMBOL(bio_put);
633
634 /**
635  *      __bio_clone_fast - clone a bio that shares the original bio's biovec
636  *      @bio: destination bio
637  *      @bio_src: bio to clone
638  *
639  *      Clone a &bio. Caller will own the returned bio, but not
640  *      the actual data it points to. Reference count of returned
641  *      bio will be one.
642  *
643  *      Caller must ensure that @bio_src is not freed before @bio.
644  */
645 void __bio_clone_fast(struct bio *bio, struct bio *bio_src)
646 {
647         BUG_ON(bio->bi_pool && BVEC_POOL_IDX(bio));
648
649         /*
650          * most users will be overriding ->bi_bdev with a new target,
651          * so we don't set nor calculate new physical/hw segment counts here
652          */
653         bio->bi_bdev = bio_src->bi_bdev;
654         bio_set_flag(bio, BIO_CLONED);
655         if (bio_flagged(bio_src, BIO_THROTTLED))
656                 bio_set_flag(bio, BIO_THROTTLED);
657         if (bio_flagged(bio_src, BIO_REMAPPED))
658                 bio_set_flag(bio, BIO_REMAPPED);
659         bio->bi_opf = bio_src->bi_opf;
660         bio->bi_ioprio = bio_src->bi_ioprio;
661         bio->bi_write_hint = bio_src->bi_write_hint;
662         bio->bi_iter = bio_src->bi_iter;
663         bio->bi_io_vec = bio_src->bi_io_vec;
664
665         bio_clone_blkg_association(bio, bio_src);
666         blkcg_bio_issue_init(bio);
667 }
668 EXPORT_SYMBOL(__bio_clone_fast);
669
670 /**
671  *      bio_clone_fast - clone a bio that shares the original bio's biovec
672  *      @bio: bio to clone
673  *      @gfp_mask: allocation priority
674  *      @bs: bio_set to allocate from
675  *
676  *      Like __bio_clone_fast, only also allocates the returned bio
677  */
678 struct bio *bio_clone_fast(struct bio *bio, gfp_t gfp_mask, struct bio_set *bs)
679 {
680         struct bio *b;
681
682         b = bio_alloc_bioset(gfp_mask, 0, bs);
683         if (!b)
684                 return NULL;
685
686         __bio_clone_fast(b, bio);
687
688         if (bio_crypt_clone(b, bio, gfp_mask) < 0)
689                 goto err_put;
690
691         if (bio_integrity(bio) &&
692             bio_integrity_clone(b, bio, gfp_mask) < 0)
693                 goto err_put;
694
695         return b;
696
697 err_put:
698         bio_put(b);
699         return NULL;
700 }
701 EXPORT_SYMBOL(bio_clone_fast);
702
703 const char *bio_devname(struct bio *bio, char *buf)
704 {
705         return bdevname(bio->bi_bdev, buf);
706 }
707 EXPORT_SYMBOL(bio_devname);
708
709 static inline bool page_is_mergeable(const struct bio_vec *bv,
710                 struct page *page, unsigned int len, unsigned int off,
711                 bool *same_page)
712 {
713         size_t bv_end = bv->bv_offset + bv->bv_len;
714         phys_addr_t vec_end_addr = page_to_phys(bv->bv_page) + bv_end - 1;
715         phys_addr_t page_addr = page_to_phys(page);
716
717         if (vec_end_addr + 1 != page_addr + off)
718                 return false;
719         if (xen_domain() && !xen_biovec_phys_mergeable(bv, page))
720                 return false;
721
722         *same_page = ((vec_end_addr & PAGE_MASK) == page_addr);
723         if (*same_page)
724                 return true;
725         return (bv->bv_page + bv_end / PAGE_SIZE) == (page + off / PAGE_SIZE);
726 }
727
728 /*
729  * Try to merge a page into a segment, while obeying the hardware segment
730  * size limit.  This is not for normal read/write bios, but for passthrough
731  * or Zone Append operations that we can't split.
732  */
733 static bool bio_try_merge_hw_seg(struct request_queue *q, struct bio *bio,
734                                  struct page *page, unsigned len,
735                                  unsigned offset, bool *same_page)
736 {
737         struct bio_vec *bv = &bio->bi_io_vec[bio->bi_vcnt - 1];
738         unsigned long mask = queue_segment_boundary(q);
739         phys_addr_t addr1 = page_to_phys(bv->bv_page) + bv->bv_offset;
740         phys_addr_t addr2 = page_to_phys(page) + offset + len - 1;
741
742         if ((addr1 | mask) != (addr2 | mask))
743                 return false;
744         if (bv->bv_len + len > queue_max_segment_size(q))
745                 return false;
746         return __bio_try_merge_page(bio, page, len, offset, same_page);
747 }
748
749 /**
750  * bio_add_hw_page - attempt to add a page to a bio with hw constraints
751  * @q: the target queue
752  * @bio: destination bio
753  * @page: page to add
754  * @len: vec entry length
755  * @offset: vec entry offset
756  * @max_sectors: maximum number of sectors that can be added
757  * @same_page: return if the segment has been merged inside the same page
758  *
759  * Add a page to a bio while respecting the hardware max_sectors, max_segment
760  * and gap limitations.
761  */
762 int bio_add_hw_page(struct request_queue *q, struct bio *bio,
763                 struct page *page, unsigned int len, unsigned int offset,
764                 unsigned int max_sectors, bool *same_page)
765 {
766         struct bio_vec *bvec;
767
768         if (WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED)))
769                 return 0;
770
771         if (((bio->bi_iter.bi_size + len) >> 9) > max_sectors)
772                 return 0;
773
774         if (bio->bi_vcnt > 0) {
775                 if (bio_try_merge_hw_seg(q, bio, page, len, offset, same_page))
776                         return len;
777
778                 /*
779                  * If the queue doesn't support SG gaps and adding this segment
780                  * would create a gap, disallow it.
781                  */
782                 bvec = &bio->bi_io_vec[bio->bi_vcnt - 1];
783                 if (bvec_gap_to_prev(q, bvec, offset))
784                         return 0;
785         }
786
787         if (bio_full(bio, len))
788                 return 0;
789
790         if (bio->bi_vcnt >= queue_max_segments(q))
791                 return 0;
792
793         bvec = &bio->bi_io_vec[bio->bi_vcnt];
794         bvec->bv_page = page;
795         bvec->bv_len = len;
796         bvec->bv_offset = offset;
797         bio->bi_vcnt++;
798         bio->bi_iter.bi_size += len;
799         return len;
800 }
801
802 /**
803  * bio_add_pc_page      - attempt to add page to passthrough bio
804  * @q: the target queue
805  * @bio: destination bio
806  * @page: page to add
807  * @len: vec entry length
808  * @offset: vec entry offset
809  *
810  * Attempt to add a page to the bio_vec maplist. This can fail for a
811  * number of reasons, such as the bio being full or target block device
812  * limitations. The target block device must allow bio's up to PAGE_SIZE,
813  * so it is always possible to add a single page to an empty bio.
814  *
815  * This should only be used by passthrough bios.
816  */
817 int bio_add_pc_page(struct request_queue *q, struct bio *bio,
818                 struct page *page, unsigned int len, unsigned int offset)
819 {
820         bool same_page = false;
821         return bio_add_hw_page(q, bio, page, len, offset,
822                         queue_max_hw_sectors(q), &same_page);
823 }
824 EXPORT_SYMBOL(bio_add_pc_page);
825
826 /**
827  * __bio_try_merge_page - try appending data to an existing bvec.
828  * @bio: destination bio
829  * @page: start page to add
830  * @len: length of the data to add
831  * @off: offset of the data relative to @page
832  * @same_page: return if the segment has been merged inside the same page
833  *
834  * Try to add the data at @page + @off to the last bvec of @bio.  This is a
835  * useful optimisation for file systems with a block size smaller than the
836  * page size.
837  *
838  * Warn if (@len, @off) crosses pages in case that @same_page is true.
839  *
840  * Return %true on success or %false on failure.
841  */
842 bool __bio_try_merge_page(struct bio *bio, struct page *page,
843                 unsigned int len, unsigned int off, bool *same_page)
844 {
845         if (WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED)))
846                 return false;
847
848         if (bio->bi_vcnt > 0) {
849                 struct bio_vec *bv = &bio->bi_io_vec[bio->bi_vcnt - 1];
850
851                 if (page_is_mergeable(bv, page, len, off, same_page)) {
852                         if (bio->bi_iter.bi_size > UINT_MAX - len) {
853                                 *same_page = false;
854                                 return false;
855                         }
856                         bv->bv_len += len;
857                         bio->bi_iter.bi_size += len;
858                         return true;
859                 }
860         }
861         return false;
862 }
863 EXPORT_SYMBOL_GPL(__bio_try_merge_page);
864
865 /**
866  * __bio_add_page - add page(s) to a bio in a new segment
867  * @bio: destination bio
868  * @page: start page to add
869  * @len: length of the data to add, may cross pages
870  * @off: offset of the data relative to @page, may cross pages
871  *
872  * Add the data at @page + @off to @bio as a new bvec.  The caller must ensure
873  * that @bio has space for another bvec.
874  */
875 void __bio_add_page(struct bio *bio, struct page *page,
876                 unsigned int len, unsigned int off)
877 {
878         struct bio_vec *bv = &bio->bi_io_vec[bio->bi_vcnt];
879
880         WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
881         WARN_ON_ONCE(bio_full(bio, len));
882
883         bv->bv_page = page;
884         bv->bv_offset = off;
885         bv->bv_len = len;
886
887         bio->bi_iter.bi_size += len;
888         bio->bi_vcnt++;
889
890         if (!bio_flagged(bio, BIO_WORKINGSET) && unlikely(PageWorkingset(page)))
891                 bio_set_flag(bio, BIO_WORKINGSET);
892 }
893 EXPORT_SYMBOL_GPL(__bio_add_page);
894
895 /**
896  *      bio_add_page    -       attempt to add page(s) to bio
897  *      @bio: destination bio
898  *      @page: start page to add
899  *      @len: vec entry length, may cross pages
900  *      @offset: vec entry offset relative to @page, may cross pages
901  *
902  *      Attempt to add page(s) to the bio_vec maplist. This will only fail
903  *      if either bio->bi_vcnt == bio->bi_max_vecs or it's a cloned bio.
904  */
905 int bio_add_page(struct bio *bio, struct page *page,
906                  unsigned int len, unsigned int offset)
907 {
908         bool same_page = false;
909
910         if (!__bio_try_merge_page(bio, page, len, offset, &same_page)) {
911                 if (bio_full(bio, len))
912                         return 0;
913                 __bio_add_page(bio, page, len, offset);
914         }
915         return len;
916 }
917 EXPORT_SYMBOL(bio_add_page);
918
919 void bio_release_pages(struct bio *bio, bool mark_dirty)
920 {
921         struct bvec_iter_all iter_all;
922         struct bio_vec *bvec;
923
924         if (bio_flagged(bio, BIO_NO_PAGE_REF))
925                 return;
926
927         bio_for_each_segment_all(bvec, bio, iter_all) {
928                 if (mark_dirty && !PageCompound(bvec->bv_page))
929                         set_page_dirty_lock(bvec->bv_page);
930                 put_page(bvec->bv_page);
931         }
932 }
933 EXPORT_SYMBOL_GPL(bio_release_pages);
934
935 static int bio_iov_bvec_set(struct bio *bio, struct iov_iter *iter)
936 {
937         WARN_ON_ONCE(BVEC_POOL_IDX(bio) != 0);
938
939         bio->bi_vcnt = iter->nr_segs;
940         bio->bi_max_vecs = iter->nr_segs;
941         bio->bi_io_vec = (struct bio_vec *)iter->bvec;
942         bio->bi_iter.bi_bvec_done = iter->iov_offset;
943         bio->bi_iter.bi_size = iter->count;
944         bio_set_flag(bio, BIO_NO_PAGE_REF);
945
946         iov_iter_advance(iter, iter->count);
947         return 0;
948 }
949
950 #define PAGE_PTRS_PER_BVEC     (sizeof(struct bio_vec) / sizeof(struct page *))
951
952 /**
953  * __bio_iov_iter_get_pages - pin user or kernel pages and add them to a bio
954  * @bio: bio to add pages to
955  * @iter: iov iterator describing the region to be mapped
956  *
957  * Pins pages from *iter and appends them to @bio's bvec array. The
958  * pages will have to be released using put_page() when done.
959  * For multi-segment *iter, this function only adds pages from the
960  * next non-empty segment of the iov iterator.
961  */
962 static int __bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter)
963 {
964         unsigned short nr_pages = bio->bi_max_vecs - bio->bi_vcnt;
965         unsigned short entries_left = bio->bi_max_vecs - bio->bi_vcnt;
966         struct bio_vec *bv = bio->bi_io_vec + bio->bi_vcnt;
967         struct page **pages = (struct page **)bv;
968         bool same_page = false;
969         ssize_t size, left;
970         unsigned len, i;
971         size_t offset;
972
973         /*
974          * Move page array up in the allocated memory for the bio vecs as far as
975          * possible so that we can start filling biovecs from the beginning
976          * without overwriting the temporary page array.
977         */
978         BUILD_BUG_ON(PAGE_PTRS_PER_BVEC < 2);
979         pages += entries_left * (PAGE_PTRS_PER_BVEC - 1);
980
981         size = iov_iter_get_pages(iter, pages, LONG_MAX, nr_pages, &offset);
982         if (unlikely(size <= 0))
983                 return size ? size : -EFAULT;
984
985         for (left = size, i = 0; left > 0; left -= len, i++) {
986                 struct page *page = pages[i];
987
988                 len = min_t(size_t, PAGE_SIZE - offset, left);
989
990                 if (__bio_try_merge_page(bio, page, len, offset, &same_page)) {
991                         if (same_page)
992                                 put_page(page);
993                 } else {
994                         if (WARN_ON_ONCE(bio_full(bio, len)))
995                                 return -EINVAL;
996                         __bio_add_page(bio, page, len, offset);
997                 }
998                 offset = 0;
999         }
1000
1001         iov_iter_advance(iter, size);
1002         return 0;
1003 }
1004
1005 static int __bio_iov_append_get_pages(struct bio *bio, struct iov_iter *iter)
1006 {
1007         unsigned short nr_pages = bio->bi_max_vecs - bio->bi_vcnt;
1008         unsigned short entries_left = bio->bi_max_vecs - bio->bi_vcnt;
1009         struct request_queue *q = bio->bi_bdev->bd_disk->queue;
1010         unsigned int max_append_sectors = queue_max_zone_append_sectors(q);
1011         struct bio_vec *bv = bio->bi_io_vec + bio->bi_vcnt;
1012         struct page **pages = (struct page **)bv;
1013         ssize_t size, left;
1014         unsigned len, i;
1015         size_t offset;
1016         int ret = 0;
1017
1018         if (WARN_ON_ONCE(!max_append_sectors))
1019                 return 0;
1020
1021         /*
1022          * Move page array up in the allocated memory for the bio vecs as far as
1023          * possible so that we can start filling biovecs from the beginning
1024          * without overwriting the temporary page array.
1025          */
1026         BUILD_BUG_ON(PAGE_PTRS_PER_BVEC < 2);
1027         pages += entries_left * (PAGE_PTRS_PER_BVEC - 1);
1028
1029         size = iov_iter_get_pages(iter, pages, LONG_MAX, nr_pages, &offset);
1030         if (unlikely(size <= 0))
1031                 return size ? size : -EFAULT;
1032
1033         for (left = size, i = 0; left > 0; left -= len, i++) {
1034                 struct page *page = pages[i];
1035                 bool same_page = false;
1036
1037                 len = min_t(size_t, PAGE_SIZE - offset, left);
1038                 if (bio_add_hw_page(q, bio, page, len, offset,
1039                                 max_append_sectors, &same_page) != len) {
1040                         ret = -EINVAL;
1041                         break;
1042                 }
1043                 if (same_page)
1044                         put_page(page);
1045                 offset = 0;
1046         }
1047
1048         iov_iter_advance(iter, size - left);
1049         return ret;
1050 }
1051
1052 /**
1053  * bio_iov_iter_get_pages - add user or kernel pages to a bio
1054  * @bio: bio to add pages to
1055  * @iter: iov iterator describing the region to be added
1056  *
1057  * This takes either an iterator pointing to user memory, or one pointing to
1058  * kernel pages (BVEC iterator). If we're adding user pages, we pin them and
1059  * map them into the kernel. On IO completion, the caller should put those
1060  * pages. For bvec based iterators bio_iov_iter_get_pages() uses the provided
1061  * bvecs rather than copying them. Hence anyone issuing kiocb based IO needs
1062  * to ensure the bvecs and pages stay referenced until the submitted I/O is
1063  * completed by a call to ->ki_complete() or returns with an error other than
1064  * -EIOCBQUEUED. The caller needs to check if the bio is flagged BIO_NO_PAGE_REF
1065  * on IO completion. If it isn't, then pages should be released.
1066  *
1067  * The function tries, but does not guarantee, to pin as many pages as
1068  * fit into the bio, or are requested in @iter, whatever is smaller. If
1069  * MM encounters an error pinning the requested pages, it stops. Error
1070  * is returned only if 0 pages could be pinned.
1071  *
1072  * It's intended for direct IO, so doesn't do PSI tracking, the caller is
1073  * responsible for setting BIO_WORKINGSET if necessary.
1074  */
1075 int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter)
1076 {
1077         int ret = 0;
1078
1079         if (iov_iter_is_bvec(iter)) {
1080                 if (WARN_ON_ONCE(bio_op(bio) == REQ_OP_ZONE_APPEND))
1081                         return -EINVAL;
1082                 return bio_iov_bvec_set(bio, iter);
1083         }
1084
1085         do {
1086                 if (bio_op(bio) == REQ_OP_ZONE_APPEND)
1087                         ret = __bio_iov_append_get_pages(bio, iter);
1088                 else
1089                         ret = __bio_iov_iter_get_pages(bio, iter);
1090         } while (!ret && iov_iter_count(iter) && !bio_full(bio, 0));
1091
1092         /* don't account direct I/O as memory stall */
1093         bio_clear_flag(bio, BIO_WORKINGSET);
1094         return bio->bi_vcnt ? 0 : ret;
1095 }
1096 EXPORT_SYMBOL_GPL(bio_iov_iter_get_pages);
1097
1098 static void submit_bio_wait_endio(struct bio *bio)
1099 {
1100         complete(bio->bi_private);
1101 }
1102
1103 /**
1104  * submit_bio_wait - submit a bio, and wait until it completes
1105  * @bio: The &struct bio which describes the I/O
1106  *
1107  * Simple wrapper around submit_bio(). Returns 0 on success, or the error from
1108  * bio_endio() on failure.
1109  *
1110  * WARNING: Unlike to how submit_bio() is usually used, this function does not
1111  * result in bio reference to be consumed. The caller must drop the reference
1112  * on his own.
1113  */
1114 int submit_bio_wait(struct bio *bio)
1115 {
1116         DECLARE_COMPLETION_ONSTACK_MAP(done,
1117                         bio->bi_bdev->bd_disk->lockdep_map);
1118         unsigned long hang_check;
1119
1120         bio->bi_private = &done;
1121         bio->bi_end_io = submit_bio_wait_endio;
1122         bio->bi_opf |= REQ_SYNC;
1123         submit_bio(bio);
1124
1125         /* Prevent hang_check timer from firing at us during very long I/O */
1126         hang_check = sysctl_hung_task_timeout_secs;
1127         if (hang_check)
1128                 while (!wait_for_completion_io_timeout(&done,
1129                                         hang_check * (HZ/2)))
1130                         ;
1131         else
1132                 wait_for_completion_io(&done);
1133
1134         return blk_status_to_errno(bio->bi_status);
1135 }
1136 EXPORT_SYMBOL(submit_bio_wait);
1137
1138 /**
1139  * bio_advance - increment/complete a bio by some number of bytes
1140  * @bio:        bio to advance
1141  * @bytes:      number of bytes to complete
1142  *
1143  * This updates bi_sector, bi_size and bi_idx; if the number of bytes to
1144  * complete doesn't align with a bvec boundary, then bv_len and bv_offset will
1145  * be updated on the last bvec as well.
1146  *
1147  * @bio will then represent the remaining, uncompleted portion of the io.
1148  */
1149 void bio_advance(struct bio *bio, unsigned bytes)
1150 {
1151         if (bio_integrity(bio))
1152                 bio_integrity_advance(bio, bytes);
1153
1154         bio_crypt_advance(bio, bytes);
1155         bio_advance_iter(bio, &bio->bi_iter, bytes);
1156 }
1157 EXPORT_SYMBOL(bio_advance);
1158
1159 void bio_copy_data_iter(struct bio *dst, struct bvec_iter *dst_iter,
1160                         struct bio *src, struct bvec_iter *src_iter)
1161 {
1162         struct bio_vec src_bv, dst_bv;
1163         void *src_p, *dst_p;
1164         unsigned bytes;
1165
1166         while (src_iter->bi_size && dst_iter->bi_size) {
1167                 src_bv = bio_iter_iovec(src, *src_iter);
1168                 dst_bv = bio_iter_iovec(dst, *dst_iter);
1169
1170                 bytes = min(src_bv.bv_len, dst_bv.bv_len);
1171
1172                 src_p = kmap_atomic(src_bv.bv_page);
1173                 dst_p = kmap_atomic(dst_bv.bv_page);
1174
1175                 memcpy(dst_p + dst_bv.bv_offset,
1176                        src_p + src_bv.bv_offset,
1177                        bytes);
1178
1179                 kunmap_atomic(dst_p);
1180                 kunmap_atomic(src_p);
1181
1182                 flush_dcache_page(dst_bv.bv_page);
1183
1184                 bio_advance_iter_single(src, src_iter, bytes);
1185                 bio_advance_iter_single(dst, dst_iter, bytes);
1186         }
1187 }
1188 EXPORT_SYMBOL(bio_copy_data_iter);
1189
1190 /**
1191  * bio_copy_data - copy contents of data buffers from one bio to another
1192  * @src: source bio
1193  * @dst: destination bio
1194  *
1195  * Stops when it reaches the end of either @src or @dst - that is, copies
1196  * min(src->bi_size, dst->bi_size) bytes (or the equivalent for lists of bios).
1197  */
1198 void bio_copy_data(struct bio *dst, struct bio *src)
1199 {
1200         struct bvec_iter src_iter = src->bi_iter;
1201         struct bvec_iter dst_iter = dst->bi_iter;
1202
1203         bio_copy_data_iter(dst, &dst_iter, src, &src_iter);
1204 }
1205 EXPORT_SYMBOL(bio_copy_data);
1206
1207 /**
1208  * bio_list_copy_data - copy contents of data buffers from one chain of bios to
1209  * another
1210  * @src: source bio list
1211  * @dst: destination bio list
1212  *
1213  * Stops when it reaches the end of either the @src list or @dst list - that is,
1214  * copies min(src->bi_size, dst->bi_size) bytes (or the equivalent for lists of
1215  * bios).
1216  */
1217 void bio_list_copy_data(struct bio *dst, struct bio *src)
1218 {
1219         struct bvec_iter src_iter = src->bi_iter;
1220         struct bvec_iter dst_iter = dst->bi_iter;
1221
1222         while (1) {
1223                 if (!src_iter.bi_size) {
1224                         src = src->bi_next;
1225                         if (!src)
1226                                 break;
1227
1228                         src_iter = src->bi_iter;
1229                 }
1230
1231                 if (!dst_iter.bi_size) {
1232                         dst = dst->bi_next;
1233                         if (!dst)
1234                                 break;
1235
1236                         dst_iter = dst->bi_iter;
1237                 }
1238
1239                 bio_copy_data_iter(dst, &dst_iter, src, &src_iter);
1240         }
1241 }
1242 EXPORT_SYMBOL(bio_list_copy_data);
1243
1244 void bio_free_pages(struct bio *bio)
1245 {
1246         struct bio_vec *bvec;
1247         struct bvec_iter_all iter_all;
1248
1249         bio_for_each_segment_all(bvec, bio, iter_all)
1250                 __free_page(bvec->bv_page);
1251 }
1252 EXPORT_SYMBOL(bio_free_pages);
1253
1254 /*
1255  * bio_set_pages_dirty() and bio_check_pages_dirty() are support functions
1256  * for performing direct-IO in BIOs.
1257  *
1258  * The problem is that we cannot run set_page_dirty() from interrupt context
1259  * because the required locks are not interrupt-safe.  So what we can do is to
1260  * mark the pages dirty _before_ performing IO.  And in interrupt context,
1261  * check that the pages are still dirty.   If so, fine.  If not, redirty them
1262  * in process context.
1263  *
1264  * We special-case compound pages here: normally this means reads into hugetlb
1265  * pages.  The logic in here doesn't really work right for compound pages
1266  * because the VM does not uniformly chase down the head page in all cases.
1267  * But dirtiness of compound pages is pretty meaningless anyway: the VM doesn't
1268  * handle them at all.  So we skip compound pages here at an early stage.
1269  *
1270  * Note that this code is very hard to test under normal circumstances because
1271  * direct-io pins the pages with get_user_pages().  This makes
1272  * is_page_cache_freeable return false, and the VM will not clean the pages.
1273  * But other code (eg, flusher threads) could clean the pages if they are mapped
1274  * pagecache.
1275  *
1276  * Simply disabling the call to bio_set_pages_dirty() is a good way to test the
1277  * deferred bio dirtying paths.
1278  */
1279
1280 /*
1281  * bio_set_pages_dirty() will mark all the bio's pages as dirty.
1282  */
1283 void bio_set_pages_dirty(struct bio *bio)
1284 {
1285         struct bio_vec *bvec;
1286         struct bvec_iter_all iter_all;
1287
1288         bio_for_each_segment_all(bvec, bio, iter_all) {
1289                 if (!PageCompound(bvec->bv_page))
1290                         set_page_dirty_lock(bvec->bv_page);
1291         }
1292 }
1293
1294 /*
1295  * bio_check_pages_dirty() will check that all the BIO's pages are still dirty.
1296  * If they are, then fine.  If, however, some pages are clean then they must
1297  * have been written out during the direct-IO read.  So we take another ref on
1298  * the BIO and re-dirty the pages in process context.
1299  *
1300  * It is expected that bio_check_pages_dirty() will wholly own the BIO from
1301  * here on.  It will run one put_page() against each page and will run one
1302  * bio_put() against the BIO.
1303  */
1304
1305 static void bio_dirty_fn(struct work_struct *work);
1306
1307 static DECLARE_WORK(bio_dirty_work, bio_dirty_fn);
1308 static DEFINE_SPINLOCK(bio_dirty_lock);
1309 static struct bio *bio_dirty_list;
1310
1311 /*
1312  * This runs in process context
1313  */
1314 static void bio_dirty_fn(struct work_struct *work)
1315 {
1316         struct bio *bio, *next;
1317
1318         spin_lock_irq(&bio_dirty_lock);
1319         next = bio_dirty_list;
1320         bio_dirty_list = NULL;
1321         spin_unlock_irq(&bio_dirty_lock);
1322
1323         while ((bio = next) != NULL) {
1324                 next = bio->bi_private;
1325
1326                 bio_release_pages(bio, true);
1327                 bio_put(bio);
1328         }
1329 }
1330
1331 void bio_check_pages_dirty(struct bio *bio)
1332 {
1333         struct bio_vec *bvec;
1334         unsigned long flags;
1335         struct bvec_iter_all iter_all;
1336
1337         bio_for_each_segment_all(bvec, bio, iter_all) {
1338                 if (!PageDirty(bvec->bv_page) && !PageCompound(bvec->bv_page))
1339                         goto defer;
1340         }
1341
1342         bio_release_pages(bio, false);
1343         bio_put(bio);
1344         return;
1345 defer:
1346         spin_lock_irqsave(&bio_dirty_lock, flags);
1347         bio->bi_private = bio_dirty_list;
1348         bio_dirty_list = bio;
1349         spin_unlock_irqrestore(&bio_dirty_lock, flags);
1350         schedule_work(&bio_dirty_work);
1351 }
1352
1353 static inline bool bio_remaining_done(struct bio *bio)
1354 {
1355         /*
1356          * If we're not chaining, then ->__bi_remaining is always 1 and
1357          * we always end io on the first invocation.
1358          */
1359         if (!bio_flagged(bio, BIO_CHAIN))
1360                 return true;
1361
1362         BUG_ON(atomic_read(&bio->__bi_remaining) <= 0);
1363
1364         if (atomic_dec_and_test(&bio->__bi_remaining)) {
1365                 bio_clear_flag(bio, BIO_CHAIN);
1366                 return true;
1367         }
1368
1369         return false;
1370 }
1371
1372 /**
1373  * bio_endio - end I/O on a bio
1374  * @bio:        bio
1375  *
1376  * Description:
1377  *   bio_endio() will end I/O on the whole bio. bio_endio() is the preferred
1378  *   way to end I/O on a bio. No one should call bi_end_io() directly on a
1379  *   bio unless they own it and thus know that it has an end_io function.
1380  *
1381  *   bio_endio() can be called several times on a bio that has been chained
1382  *   using bio_chain().  The ->bi_end_io() function will only be called the
1383  *   last time.  At this point the BLK_TA_COMPLETE tracing event will be
1384  *   generated if BIO_TRACE_COMPLETION is set.
1385  **/
1386 void bio_endio(struct bio *bio)
1387 {
1388 again:
1389         if (!bio_remaining_done(bio))
1390                 return;
1391         if (!bio_integrity_endio(bio))
1392                 return;
1393
1394         if (bio->bi_bdev)
1395                 rq_qos_done_bio(bio->bi_bdev->bd_disk->queue, bio);
1396
1397         /*
1398          * Need to have a real endio function for chained bios, otherwise
1399          * various corner cases will break (like stacking block devices that
1400          * save/restore bi_end_io) - however, we want to avoid unbounded
1401          * recursion and blowing the stack. Tail call optimization would
1402          * handle this, but compiling with frame pointers also disables
1403          * gcc's sibling call optimization.
1404          */
1405         if (bio->bi_end_io == bio_chain_endio) {
1406                 bio = __bio_chain_endio(bio);
1407                 goto again;
1408         }
1409
1410         if (bio->bi_bdev && bio_flagged(bio, BIO_TRACE_COMPLETION)) {
1411                 trace_block_bio_complete(bio->bi_bdev->bd_disk->queue, bio);
1412                 bio_clear_flag(bio, BIO_TRACE_COMPLETION);
1413         }
1414
1415         blk_throtl_bio_endio(bio);
1416         /* release cgroup info */
1417         bio_uninit(bio);
1418         if (bio->bi_end_io)
1419                 bio->bi_end_io(bio);
1420 }
1421 EXPORT_SYMBOL(bio_endio);
1422
1423 /**
1424  * bio_split - split a bio
1425  * @bio:        bio to split
1426  * @sectors:    number of sectors to split from the front of @bio
1427  * @gfp:        gfp mask
1428  * @bs:         bio set to allocate from
1429  *
1430  * Allocates and returns a new bio which represents @sectors from the start of
1431  * @bio, and updates @bio to represent the remaining sectors.
1432  *
1433  * Unless this is a discard request the newly allocated bio will point
1434  * to @bio's bi_io_vec. It is the caller's responsibility to ensure that
1435  * neither @bio nor @bs are freed before the split bio.
1436  */
1437 struct bio *bio_split(struct bio *bio, int sectors,
1438                       gfp_t gfp, struct bio_set *bs)
1439 {
1440         struct bio *split;
1441
1442         BUG_ON(sectors <= 0);
1443         BUG_ON(sectors >= bio_sectors(bio));
1444
1445         /* Zone append commands cannot be split */
1446         if (WARN_ON_ONCE(bio_op(bio) == REQ_OP_ZONE_APPEND))
1447                 return NULL;
1448
1449         split = bio_clone_fast(bio, gfp, bs);
1450         if (!split)
1451                 return NULL;
1452
1453         split->bi_iter.bi_size = sectors << 9;
1454
1455         if (bio_integrity(split))
1456                 bio_integrity_trim(split);
1457
1458         bio_advance(bio, split->bi_iter.bi_size);
1459
1460         if (bio_flagged(bio, BIO_TRACE_COMPLETION))
1461                 bio_set_flag(split, BIO_TRACE_COMPLETION);
1462
1463         return split;
1464 }
1465 EXPORT_SYMBOL(bio_split);
1466
1467 /**
1468  * bio_trim - trim a bio
1469  * @bio:        bio to trim
1470  * @offset:     number of sectors to trim from the front of @bio
1471  * @size:       size we want to trim @bio to, in sectors
1472  */
1473 void bio_trim(struct bio *bio, int offset, int size)
1474 {
1475         /* 'bio' is a cloned bio which we need to trim to match
1476          * the given offset and size.
1477          */
1478
1479         size <<= 9;
1480         if (offset == 0 && size == bio->bi_iter.bi_size)
1481                 return;
1482
1483         bio_advance(bio, offset << 9);
1484         bio->bi_iter.bi_size = size;
1485
1486         if (bio_integrity(bio))
1487                 bio_integrity_trim(bio);
1488
1489 }
1490 EXPORT_SYMBOL_GPL(bio_trim);
1491
1492 /*
1493  * create memory pools for biovec's in a bio_set.
1494  * use the global biovec slabs created for general use.
1495  */
1496 int biovec_init_pool(mempool_t *pool, int pool_entries)
1497 {
1498         struct biovec_slab *bp = bvec_slabs + BVEC_POOL_MAX;
1499
1500         return mempool_init_slab_pool(pool, pool_entries, bp->slab);
1501 }
1502
1503 /*
1504  * bioset_exit - exit a bioset initialized with bioset_init()
1505  *
1506  * May be called on a zeroed but uninitialized bioset (i.e. allocated with
1507  * kzalloc()).
1508  */
1509 void bioset_exit(struct bio_set *bs)
1510 {
1511         if (bs->rescue_workqueue)
1512                 destroy_workqueue(bs->rescue_workqueue);
1513         bs->rescue_workqueue = NULL;
1514
1515         mempool_exit(&bs->bio_pool);
1516         mempool_exit(&bs->bvec_pool);
1517
1518         bioset_integrity_free(bs);
1519         if (bs->bio_slab)
1520                 bio_put_slab(bs);
1521         bs->bio_slab = NULL;
1522 }
1523 EXPORT_SYMBOL(bioset_exit);
1524
1525 /**
1526  * bioset_init - Initialize a bio_set
1527  * @bs:         pool to initialize
1528  * @pool_size:  Number of bio and bio_vecs to cache in the mempool
1529  * @front_pad:  Number of bytes to allocate in front of the returned bio
1530  * @flags:      Flags to modify behavior, currently %BIOSET_NEED_BVECS
1531  *              and %BIOSET_NEED_RESCUER
1532  *
1533  * Description:
1534  *    Set up a bio_set to be used with @bio_alloc_bioset. Allows the caller
1535  *    to ask for a number of bytes to be allocated in front of the bio.
1536  *    Front pad allocation is useful for embedding the bio inside
1537  *    another structure, to avoid allocating extra data to go with the bio.
1538  *    Note that the bio must be embedded at the END of that structure always,
1539  *    or things will break badly.
1540  *    If %BIOSET_NEED_BVECS is set in @flags, a separate pool will be allocated
1541  *    for allocating iovecs.  This pool is not needed e.g. for bio_clone_fast().
1542  *    If %BIOSET_NEED_RESCUER is set, a workqueue is created which can be used to
1543  *    dispatch queued requests when the mempool runs out of space.
1544  *
1545  */
1546 int bioset_init(struct bio_set *bs,
1547                 unsigned int pool_size,
1548                 unsigned int front_pad,
1549                 int flags)
1550 {
1551         bs->front_pad = front_pad;
1552         if (flags & BIOSET_NEED_BVECS)
1553                 bs->back_pad = BIO_INLINE_VECS * sizeof(struct bio_vec);
1554         else
1555                 bs->back_pad = 0;
1556
1557         spin_lock_init(&bs->rescue_lock);
1558         bio_list_init(&bs->rescue_list);
1559         INIT_WORK(&bs->rescue_work, bio_alloc_rescue);
1560
1561         bs->bio_slab = bio_find_or_create_slab(bs);
1562         if (!bs->bio_slab)
1563                 return -ENOMEM;
1564
1565         if (mempool_init_slab_pool(&bs->bio_pool, pool_size, bs->bio_slab))
1566                 goto bad;
1567
1568         if ((flags & BIOSET_NEED_BVECS) &&
1569             biovec_init_pool(&bs->bvec_pool, pool_size))
1570                 goto bad;
1571
1572         if (!(flags & BIOSET_NEED_RESCUER))
1573                 return 0;
1574
1575         bs->rescue_workqueue = alloc_workqueue("bioset", WQ_MEM_RECLAIM, 0);
1576         if (!bs->rescue_workqueue)
1577                 goto bad;
1578
1579         return 0;
1580 bad:
1581         bioset_exit(bs);
1582         return -ENOMEM;
1583 }
1584 EXPORT_SYMBOL(bioset_init);
1585
1586 /*
1587  * Initialize and setup a new bio_set, based on the settings from
1588  * another bio_set.
1589  */
1590 int bioset_init_from_src(struct bio_set *bs, struct bio_set *src)
1591 {
1592         int flags;
1593
1594         flags = 0;
1595         if (src->bvec_pool.min_nr)
1596                 flags |= BIOSET_NEED_BVECS;
1597         if (src->rescue_workqueue)
1598                 flags |= BIOSET_NEED_RESCUER;
1599
1600         return bioset_init(bs, src->bio_pool.min_nr, src->front_pad, flags);
1601 }
1602 EXPORT_SYMBOL(bioset_init_from_src);
1603
1604 static int __init init_bio(void)
1605 {
1606         int i;
1607
1608         BUILD_BUG_ON(BIO_FLAG_LAST > BVEC_POOL_OFFSET);
1609
1610         bio_integrity_init();
1611
1612         for (i = 0; i < ARRAY_SIZE(bvec_slabs); i++) {
1613                 struct biovec_slab *bvs = bvec_slabs + i;
1614
1615                 bvs->slab = kmem_cache_create(bvs->name,
1616                                 bvs->nr_vecs * sizeof(struct bio_vec), 0,
1617                                 SLAB_HWCACHE_ALIGN | SLAB_PANIC, NULL);
1618         }
1619
1620         if (bioset_init(&fs_bio_set, BIO_POOL_SIZE, 0, BIOSET_NEED_BVECS))
1621                 panic("bio: can't allocate bios\n");
1622
1623         if (bioset_integrity_create(&fs_bio_set, BIO_POOL_SIZE))
1624                 panic("bio: can't create integrity pool\n");
1625
1626         return 0;
1627 }
1628 subsys_initcall(init_bio);