blob: a1c4d2900c7a83b0107f06e2a0a6bda0e71d3add [file] [log] [blame]
Christoph Hellwig8c165672019-04-30 14:42:39 -04001// SPDX-License-Identifier: GPL-2.0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
Jens Axboe0fe23472006-09-04 15:41:16 +02003 * Copyright (C) 2001 Jens Axboe <axboe@kernel.dk>
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 */
5#include <linux/mm.h>
6#include <linux/swap.h>
7#include <linux/bio.h>
8#include <linux/blkdev.h>
Kent Overstreeta27bb332013-05-07 16:19:08 -07009#include <linux/uio.h>
Tejun Heo852c7882012-03-05 13:15:27 -080010#include <linux/iocontext.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <linux/slab.h>
12#include <linux/init.h>
13#include <linux/kernel.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050014#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/mempool.h>
16#include <linux/workqueue.h>
Tejun Heo852c7882012-03-05 13:15:27 -080017#include <linux/cgroup.h>
Josef Bacik08e18ea2018-07-03 11:14:50 -040018#include <linux/blk-cgroup.h>
Damien Le Moalb4c58752019-07-01 14:09:15 +090019#include <linux/highmem.h>
Ming Leide6a78b2020-03-18 11:43:36 +080020#include <linux/sched/sysctl.h>
Satya Tangiralaa892c8d2020-05-14 00:37:18 +000021#include <linux/blk-crypto.h>
Ming Lei49d1ec82021-01-11 11:05:52 +080022#include <linux/xarray.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023
Li Zefan55782132009-06-09 13:43:05 +080024#include <trace/events/block.h>
Shaohua Li9e234ee2017-03-27 10:51:41 -070025#include "blk.h"
Josef Bacik67b42d02018-07-03 11:15:00 -040026#include "blk-rq-qos.h"
Ingo Molnar0bfc2452008-11-26 11:59:56 +010027
Christoph Hellwigde76fd82021-02-02 18:19:23 +010028static struct biovec_slab {
Christoph Hellwig6ac0b712021-02-02 18:19:20 +010029 int nr_vecs;
30 char *name;
31 struct kmem_cache *slab;
Christoph Hellwigde76fd82021-02-02 18:19:23 +010032} 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" },
Linus Torvalds1da177e2005-04-16 15:20:36 -070037};
Christoph Hellwig6ac0b712021-02-02 18:19:20 +010038
Christoph Hellwig7a800a22021-02-02 18:19:29 +010039static struct biovec_slab *biovec_slab(unsigned short nr_vecs)
40{
41 switch (nr_vecs) {
42 /* smaller bios use inline vecs */
43 case 5 ... 16:
44 return &bvec_slabs[0];
45 case 17 ... 64:
46 return &bvec_slabs[1];
47 case 65 ... 128:
48 return &bvec_slabs[2];
49 case 129 ... BIO_MAX_PAGES:
50 return &bvec_slabs[3];
51 default:
52 BUG();
53 return NULL;
54 }
55}
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
57/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 * fs_bio_set is the bio_set containing bio and iovec memory pools used by
59 * IO code that does not need private memory pools.
60 */
Kent Overstreetf4f81542018-05-08 21:33:52 -040061struct bio_set fs_bio_set;
Kent Overstreet3f86a822012-09-06 15:35:01 -070062EXPORT_SYMBOL(fs_bio_set);
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
Jens Axboebb799ca2008-12-10 15:35:05 +010064/*
65 * Our slab pool management
66 */
67struct bio_slab {
68 struct kmem_cache *slab;
69 unsigned int slab_ref;
70 unsigned int slab_size;
71 char name[8];
72};
73static DEFINE_MUTEX(bio_slab_lock);
Ming Lei49d1ec82021-01-11 11:05:52 +080074static DEFINE_XARRAY(bio_slabs);
Jens Axboebb799ca2008-12-10 15:35:05 +010075
Ming Lei49d1ec82021-01-11 11:05:52 +080076static struct bio_slab *create_bio_slab(unsigned int size)
Jens Axboebb799ca2008-12-10 15:35:05 +010077{
Ming Lei49d1ec82021-01-11 11:05:52 +080078 struct bio_slab *bslab = kzalloc(sizeof(*bslab), GFP_KERNEL);
79
80 if (!bslab)
81 return NULL;
82
83 snprintf(bslab->name, sizeof(bslab->name), "bio-%d", size);
84 bslab->slab = kmem_cache_create(bslab->name, size,
85 ARCH_KMALLOC_MINALIGN, SLAB_HWCACHE_ALIGN, NULL);
86 if (!bslab->slab)
87 goto fail_alloc_slab;
88
89 bslab->slab_ref = 1;
90 bslab->slab_size = size;
91
92 if (!xa_err(xa_store(&bio_slabs, size, bslab, GFP_KERNEL)))
93 return bslab;
94
95 kmem_cache_destroy(bslab->slab);
96
97fail_alloc_slab:
98 kfree(bslab);
99 return NULL;
100}
101
102static inline unsigned int bs_bio_slab_size(struct bio_set *bs)
103{
Ming Lei9f180e32021-01-11 11:05:54 +0800104 return bs->front_pad + sizeof(struct bio) + bs->back_pad;
Ming Lei49d1ec82021-01-11 11:05:52 +0800105}
106
107static struct kmem_cache *bio_find_or_create_slab(struct bio_set *bs)
108{
109 unsigned int size = bs_bio_slab_size(bs);
110 struct bio_slab *bslab;
Jens Axboebb799ca2008-12-10 15:35:05 +0100111
112 mutex_lock(&bio_slab_lock);
Ming Lei49d1ec82021-01-11 11:05:52 +0800113 bslab = xa_load(&bio_slabs, size);
114 if (bslab)
115 bslab->slab_ref++;
116 else
117 bslab = create_bio_slab(size);
Jens Axboebb799ca2008-12-10 15:35:05 +0100118 mutex_unlock(&bio_slab_lock);
Ming Lei49d1ec82021-01-11 11:05:52 +0800119
120 if (bslab)
121 return bslab->slab;
122 return NULL;
Jens Axboebb799ca2008-12-10 15:35:05 +0100123}
124
125static void bio_put_slab(struct bio_set *bs)
126{
127 struct bio_slab *bslab = NULL;
Ming Lei49d1ec82021-01-11 11:05:52 +0800128 unsigned int slab_size = bs_bio_slab_size(bs);
Jens Axboebb799ca2008-12-10 15:35:05 +0100129
130 mutex_lock(&bio_slab_lock);
131
Ming Lei49d1ec82021-01-11 11:05:52 +0800132 bslab = xa_load(&bio_slabs, slab_size);
Jens Axboebb799ca2008-12-10 15:35:05 +0100133 if (WARN(!bslab, KERN_ERR "bio: unable to find slab!\n"))
134 goto out;
135
Ming Lei49d1ec82021-01-11 11:05:52 +0800136 WARN_ON_ONCE(bslab->slab != bs->bio_slab);
137
Jens Axboebb799ca2008-12-10 15:35:05 +0100138 WARN_ON(!bslab->slab_ref);
139
140 if (--bslab->slab_ref)
141 goto out;
142
Ming Lei49d1ec82021-01-11 11:05:52 +0800143 xa_erase(&bio_slabs, slab_size);
144
Jens Axboebb799ca2008-12-10 15:35:05 +0100145 kmem_cache_destroy(bslab->slab);
Ming Lei49d1ec82021-01-11 11:05:52 +0800146 kfree(bslab);
Jens Axboebb799ca2008-12-10 15:35:05 +0100147
148out:
149 mutex_unlock(&bio_slab_lock);
150}
151
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100152void bvec_free(mempool_t *pool, struct bio_vec *bv, unsigned short nr_vecs)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200153{
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100154 BIO_BUG_ON(nr_vecs > BIO_MAX_PAGES);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200155
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100156 if (nr_vecs == BIO_MAX_PAGES)
Kent Overstreet9f060e22012-10-12 15:29:33 -0700157 mempool_free(bv, pool);
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100158 else if (nr_vecs > BIO_INLINE_VECS)
159 kmem_cache_free(biovec_slab(nr_vecs)->slab, bv);
Jens Axboebb799ca2008-12-10 15:35:05 +0100160}
161
Christoph Hellwigf2c3eb92021-02-02 18:19:21 +0100162/*
163 * Make the first allocation restricted and don't dump info on allocation
164 * failures, since we'll fall back to the mempool in case of failure.
165 */
166static inline gfp_t bvec_alloc_gfp(gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167{
Christoph Hellwigf2c3eb92021-02-02 18:19:21 +0100168 return (gfp & ~(__GFP_DIRECT_RECLAIM | __GFP_IO)) |
169 __GFP_NOMEMALLOC | __GFP_NORETRY | __GFP_NOWARN;
170}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100172struct bio_vec *bvec_alloc(mempool_t *pool, unsigned short *nr_vecs,
173 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174{
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100175 struct biovec_slab *bvs = biovec_slab(*nr_vecs);
176
177 if (WARN_ON_ONCE(!bvs))
Jens Axboe7ff93452008-12-11 11:53:43 +0100178 return NULL;
Jens Axboe7ff93452008-12-11 11:53:43 +0100179
180 /*
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100181 * Upgrade the nr_vecs request to take full advantage of the allocation.
182 * We also rely on this in the bvec_free path.
Jens Axboe7ff93452008-12-11 11:53:43 +0100183 */
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100184 *nr_vecs = bvs->nr_vecs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 /*
Christoph Hellwigf007a3d2021-02-02 18:19:22 +0100187 * Try a slab allocation first for all smaller allocations. If that
188 * fails and __GFP_DIRECT_RECLAIM is set retry with the mempool.
189 * The mempool is sized to handle up to BIO_MAX_PAGES entries.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 */
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100191 if (*nr_vecs < BIO_MAX_PAGES) {
Christoph Hellwigf007a3d2021-02-02 18:19:22 +0100192 struct bio_vec *bvl;
Jens Axboe7ff93452008-12-11 11:53:43 +0100193
Christoph Hellwigf2c3eb92021-02-02 18:19:21 +0100194 bvl = kmem_cache_alloc(bvs->slab, bvec_alloc_gfp(gfp_mask));
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100195 if (likely(bvl) || !(gfp_mask & __GFP_DIRECT_RECLAIM))
Christoph Hellwigf007a3d2021-02-02 18:19:22 +0100196 return bvl;
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100197 *nr_vecs = BIO_MAX_PAGES;
Jens Axboe7ff93452008-12-11 11:53:43 +0100198 }
199
Christoph Hellwigf007a3d2021-02-02 18:19:22 +0100200 return mempool_alloc(pool, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201}
202
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600203void bio_uninit(struct bio *bio)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204{
Christoph Hellwigdb9819c2020-06-27 09:31:47 +0200205#ifdef CONFIG_BLK_CGROUP
206 if (bio->bi_blkg) {
207 blkg_put(bio->bi_blkg);
208 bio->bi_blkg = NULL;
209 }
210#endif
Justin Teeece841a2019-12-05 10:09:01 +0800211 if (bio_integrity(bio))
212 bio_integrity_free(bio);
Satya Tangiralaa892c8d2020-05-14 00:37:18 +0000213
214 bio_crypt_free_ctx(bio);
Kent Overstreet4254bba2012-09-06 15:35:00 -0700215}
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600216EXPORT_SYMBOL(bio_uninit);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200217
Kent Overstreet4254bba2012-09-06 15:35:00 -0700218static void bio_free(struct bio *bio)
219{
220 struct bio_set *bs = bio->bi_pool;
221 void *p;
222
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600223 bio_uninit(bio);
Kent Overstreet4254bba2012-09-06 15:35:00 -0700224
225 if (bs) {
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100226 bvec_free(&bs->bvec_pool, bio->bi_io_vec, bio->bi_max_vecs);
Kent Overstreet4254bba2012-09-06 15:35:00 -0700227
228 /*
229 * If we have front padding, adjust the bio pointer before freeing
230 */
231 p = bio;
Jens Axboebb799ca2008-12-10 15:35:05 +0100232 p -= bs->front_pad;
233
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400234 mempool_free(p, &bs->bio_pool);
Kent Overstreet4254bba2012-09-06 15:35:00 -0700235 } else {
236 /* Bio was allocated by bio_kmalloc() */
237 kfree(bio);
238 }
Peter Osterlund36763472005-09-06 15:16:42 -0700239}
240
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600241/*
242 * Users of this function have their own bio allocation. Subsequently,
243 * they must remember to pair any call to bio_init() with bio_uninit()
244 * when IO has completed, or when the bio is released.
245 */
Ming Lei3a83f462016-11-22 08:57:21 -0700246void bio_init(struct bio *bio, struct bio_vec *table,
247 unsigned short max_vecs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248{
Jens Axboe2b94de52007-07-18 13:14:03 +0200249 memset(bio, 0, sizeof(*bio));
Jens Axboec4cf5262015-04-17 16:15:18 -0600250 atomic_set(&bio->__bi_remaining, 1);
Jens Axboedac56212015-04-17 16:23:59 -0600251 atomic_set(&bio->__bi_cnt, 1);
Ming Lei3a83f462016-11-22 08:57:21 -0700252
253 bio->bi_io_vec = table;
254 bio->bi_max_vecs = max_vecs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200256EXPORT_SYMBOL(bio_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257
258/**
Kent Overstreetf44b48c72012-09-06 15:34:58 -0700259 * bio_reset - reinitialize a bio
260 * @bio: bio to reset
261 *
262 * Description:
263 * After calling bio_reset(), @bio will be in the same state as a freshly
264 * allocated bio returned bio bio_alloc_bioset() - the only fields that are
265 * preserved are the ones that are initialized by bio_alloc_bioset(). See
266 * comment in struct bio.
267 */
268void bio_reset(struct bio *bio)
269{
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600270 bio_uninit(bio);
Kent Overstreetf44b48c72012-09-06 15:34:58 -0700271 memset(bio, 0, BIO_RESET_BYTES);
Jens Axboec4cf5262015-04-17 16:15:18 -0600272 atomic_set(&bio->__bi_remaining, 1);
Kent Overstreetf44b48c72012-09-06 15:34:58 -0700273}
274EXPORT_SYMBOL(bio_reset);
275
Christoph Hellwig38f8baa2016-03-11 17:34:51 +0100276static struct bio *__bio_chain_endio(struct bio *bio)
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800277{
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200278 struct bio *parent = bio->bi_private;
279
Christoph Hellwig4e4cbee2017-06-03 09:38:06 +0200280 if (!parent->bi_status)
281 parent->bi_status = bio->bi_status;
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800282 bio_put(bio);
Christoph Hellwig38f8baa2016-03-11 17:34:51 +0100283 return parent;
284}
285
286static void bio_chain_endio(struct bio *bio)
287{
288 bio_endio(__bio_chain_endio(bio));
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800289}
290
291/**
292 * bio_chain - chain bio completions
Randy Dunlap1051a902014-04-20 16:03:31 -0700293 * @bio: the target bio
Mauro Carvalho Chehab5b874af2020-08-27 07:51:44 +0200294 * @parent: the parent bio of @bio
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800295 *
296 * The caller won't have a bi_end_io called when @bio completes - instead,
297 * @parent's bi_end_io won't be called until both @parent and @bio have
298 * completed; the chained bio will also be freed when it completes.
299 *
300 * The caller must not set bi_private or bi_end_io in @bio.
301 */
302void bio_chain(struct bio *bio, struct bio *parent)
303{
304 BUG_ON(bio->bi_private || bio->bi_end_io);
305
306 bio->bi_private = parent;
307 bio->bi_end_io = bio_chain_endio;
Jens Axboec4cf5262015-04-17 16:15:18 -0600308 bio_inc_remaining(parent);
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800309}
310EXPORT_SYMBOL(bio_chain);
311
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700312static void bio_alloc_rescue(struct work_struct *work)
313{
314 struct bio_set *bs = container_of(work, struct bio_set, rescue_work);
315 struct bio *bio;
316
317 while (1) {
318 spin_lock(&bs->rescue_lock);
319 bio = bio_list_pop(&bs->rescue_list);
320 spin_unlock(&bs->rescue_lock);
321
322 if (!bio)
323 break;
324
Christoph Hellwiged00aab2020-07-01 10:59:44 +0200325 submit_bio_noacct(bio);
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700326 }
327}
328
329static void punt_bios_to_rescuer(struct bio_set *bs)
330{
331 struct bio_list punt, nopunt;
332 struct bio *bio;
333
NeilBrown47e0fb42017-06-18 14:38:57 +1000334 if (WARN_ON_ONCE(!bs->rescue_workqueue))
335 return;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700336 /*
337 * In order to guarantee forward progress we must punt only bios that
338 * were allocated from this bio_set; otherwise, if there was a bio on
339 * there for a stacking driver higher up in the stack, processing it
340 * could require allocating bios from this bio_set, and doing that from
341 * our own rescuer would be bad.
342 *
343 * Since bio lists are singly linked, pop them all instead of trying to
344 * remove from the middle of the list:
345 */
346
347 bio_list_init(&punt);
348 bio_list_init(&nopunt);
349
NeilBrownf5fe1b52017-03-10 17:00:47 +1100350 while ((bio = bio_list_pop(&current->bio_list[0])))
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700351 bio_list_add(bio->bi_pool == bs ? &punt : &nopunt, bio);
NeilBrownf5fe1b52017-03-10 17:00:47 +1100352 current->bio_list[0] = nopunt;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700353
NeilBrownf5fe1b52017-03-10 17:00:47 +1100354 bio_list_init(&nopunt);
355 while ((bio = bio_list_pop(&current->bio_list[1])))
356 bio_list_add(bio->bi_pool == bs ? &punt : &nopunt, bio);
357 current->bio_list[1] = nopunt;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700358
359 spin_lock(&bs->rescue_lock);
360 bio_list_merge(&bs->rescue_list, &punt);
361 spin_unlock(&bs->rescue_lock);
362
363 queue_work(bs->rescue_workqueue, &bs->rescue_work);
364}
365
Kent Overstreetf44b48c72012-09-06 15:34:58 -0700366/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700367 * bio_alloc_bioset - allocate a bio for I/O
Randy Dunlap519c8e92017-10-16 11:01:00 -0700368 * @gfp_mask: the GFP_* mask given to the slab allocator
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 * @nr_iovecs: number of iovecs to pre-allocate
Jaak Ristiojadb18efa2010-01-15 12:05:07 +0200370 * @bs: the bio_set to allocate from.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371 *
Christoph Hellwig31751992021-01-26 15:52:34 +0100372 * Allocate a bio from the mempools in @bs.
Kent Overstreet3f86a822012-09-06 15:35:01 -0700373 *
Christoph Hellwig31751992021-01-26 15:52:34 +0100374 * If %__GFP_DIRECT_RECLAIM is set then bio_alloc will always be able to
375 * allocate a bio. This is due to the mempool guarantees. To make this work,
376 * callers must never allocate more than 1 bio at a time from the general pool.
377 * Callers that need to allocate more than 1 bio must always submit the
378 * previously allocated bio for IO before attempting to allocate a new one.
379 * Failure to do so can cause deadlocks under memory pressure.
Kent Overstreet3f86a822012-09-06 15:35:01 -0700380 *
Christoph Hellwig31751992021-01-26 15:52:34 +0100381 * Note that when running under submit_bio_noacct() (i.e. any block driver),
382 * bios are not submitted until after you return - see the code in
383 * submit_bio_noacct() that converts recursion into iteration, to prevent
384 * stack overflows.
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700385 *
Christoph Hellwig31751992021-01-26 15:52:34 +0100386 * This would normally mean allocating multiple bios under submit_bio_noacct()
387 * would be susceptible to deadlocks, but we have
388 * deadlock avoidance code that resubmits any blocked bios from a rescuer
389 * thread.
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700390 *
Christoph Hellwig31751992021-01-26 15:52:34 +0100391 * However, we do not guarantee forward progress for allocations from other
392 * mempools. Doing multiple allocations from the same mempool under
393 * submit_bio_noacct() should be avoided - instead, use bio_set's front_pad
394 * for per bio allocations.
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700395 *
Christoph Hellwig31751992021-01-26 15:52:34 +0100396 * Returns: Pointer to new bio on success, NULL on failure.
Kent Overstreet3f86a822012-09-06 15:35:01 -0700397 */
Christoph Hellwig0f2e6ab2021-02-02 18:19:24 +0100398struct bio *bio_alloc_bioset(gfp_t gfp_mask, unsigned short nr_iovecs,
Dan Carpenter7a88fa12017-03-23 13:24:55 +0300399 struct bio_set *bs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400{
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700401 gfp_t saved_gfp = gfp_mask;
Tejun Heo451a9eb2009-04-15 19:50:51 +0200402 struct bio *bio;
403 void *p;
Jens Axboe0a0d96b2008-09-11 13:17:37 +0200404
Christoph Hellwig31751992021-01-26 15:52:34 +0100405 /* should not use nobvec bioset for nr_iovecs > 0 */
406 if (WARN_ON_ONCE(!mempool_initialized(&bs->bvec_pool) && nr_iovecs > 0))
407 return NULL;
Kent Overstreet3f86a822012-09-06 15:35:01 -0700408
Christoph Hellwig31751992021-01-26 15:52:34 +0100409 /*
410 * submit_bio_noacct() converts recursion to iteration; this means if
411 * we're running beneath it, any bios we allocate and submit will not be
412 * submitted (and thus freed) until after we return.
413 *
414 * This exposes us to a potential deadlock if we allocate multiple bios
415 * from the same bio_set() while running underneath submit_bio_noacct().
416 * If we were to allocate multiple bios (say a stacking block driver
417 * that was splitting bios), we would deadlock if we exhausted the
418 * mempool's reserve.
419 *
420 * We solve this, and guarantee forward progress, with a rescuer
421 * workqueue per bio_set. If we go to allocate and there are bios on
422 * current->bio_list, we first try the allocation without
423 * __GFP_DIRECT_RECLAIM; if that fails, we punt those bios we would be
424 * blocking to the rescuer workqueue before we retry with the original
425 * gfp_flags.
426 */
427 if (current->bio_list &&
428 (!bio_list_empty(&current->bio_list[0]) ||
429 !bio_list_empty(&current->bio_list[1])) &&
430 bs->rescue_workqueue)
431 gfp_mask &= ~__GFP_DIRECT_RECLAIM;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700432
Christoph Hellwig31751992021-01-26 15:52:34 +0100433 p = mempool_alloc(&bs->bio_pool, gfp_mask);
434 if (!p && gfp_mask != saved_gfp) {
435 punt_bios_to_rescuer(bs);
436 gfp_mask = saved_gfp;
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400437 p = mempool_alloc(&bs->bio_pool, gfp_mask);
Kent Overstreet3f86a822012-09-06 15:35:01 -0700438 }
Tejun Heo451a9eb2009-04-15 19:50:51 +0200439 if (unlikely(!p))
440 return NULL;
Ingo Molnar34053972009-02-21 11:16:36 +0100441
Christoph Hellwig31751992021-01-26 15:52:34 +0100442 bio = p + bs->front_pad;
443 if (nr_iovecs > BIO_INLINE_VECS) {
Christoph Hellwig31751992021-01-26 15:52:34 +0100444 struct bio_vec *bvl = NULL;
Ingo Molnar34053972009-02-21 11:16:36 +0100445
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100446 bvl = bvec_alloc(&bs->bvec_pool, &nr_iovecs, gfp_mask);
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700447 if (!bvl && gfp_mask != saved_gfp) {
448 punt_bios_to_rescuer(bs);
449 gfp_mask = saved_gfp;
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100450 bvl = bvec_alloc(&bs->bvec_pool, &nr_iovecs, gfp_mask);
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700451 }
Ingo Molnar34053972009-02-21 11:16:36 +0100452 if (unlikely(!bvl))
453 goto err_free;
Kent Overstreeta38352e2012-05-25 13:03:11 -0700454
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100455 bio_init(bio, bvl, nr_iovecs);
Kent Overstreet3f86a822012-09-06 15:35:01 -0700456 } else if (nr_iovecs) {
Christoph Hellwig31751992021-01-26 15:52:34 +0100457 bio_init(bio, bio->bi_inline_vecs, BIO_INLINE_VECS);
458 } else {
459 bio_init(bio, NULL, 0);
Ingo Molnar34053972009-02-21 11:16:36 +0100460 }
Kent Overstreet3f86a822012-09-06 15:35:01 -0700461
462 bio->bi_pool = bs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 return bio;
Ingo Molnar34053972009-02-21 11:16:36 +0100464
465err_free:
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400466 mempool_free(p, &bs->bio_pool);
Ingo Molnar34053972009-02-21 11:16:36 +0100467 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200469EXPORT_SYMBOL(bio_alloc_bioset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470
Christoph Hellwig31751992021-01-26 15:52:34 +0100471/**
472 * bio_kmalloc - kmalloc a bio for I/O
473 * @gfp_mask: the GFP_* mask given to the slab allocator
474 * @nr_iovecs: number of iovecs to pre-allocate
475 *
476 * Use kmalloc to allocate and initialize a bio.
477 *
478 * Returns: Pointer to new bio on success, NULL on failure.
479 */
Christoph Hellwig0f2e6ab2021-02-02 18:19:24 +0100480struct bio *bio_kmalloc(gfp_t gfp_mask, unsigned short nr_iovecs)
Christoph Hellwig31751992021-01-26 15:52:34 +0100481{
482 struct bio *bio;
483
484 if (nr_iovecs > UIO_MAXIOV)
485 return NULL;
486
487 bio = kmalloc(struct_size(bio, bi_inline_vecs, nr_iovecs), gfp_mask);
488 if (unlikely(!bio))
489 return NULL;
490 bio_init(bio, nr_iovecs ? bio->bi_inline_vecs : NULL, nr_iovecs);
491 bio->bi_pool = NULL;
492 return bio;
493}
494EXPORT_SYMBOL(bio_kmalloc);
495
Kent Overstreet38a72da2018-05-08 21:33:53 -0400496void zero_fill_bio_iter(struct bio *bio, struct bvec_iter start)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497{
498 unsigned long flags;
Kent Overstreet79886132013-11-23 17:19:00 -0800499 struct bio_vec bv;
500 struct bvec_iter iter;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501
Kent Overstreet38a72da2018-05-08 21:33:53 -0400502 __bio_for_each_segment(bv, bio, iter, start) {
Kent Overstreet79886132013-11-23 17:19:00 -0800503 char *data = bvec_kmap_irq(&bv, &flags);
504 memset(data, 0, bv.bv_len);
505 flush_dcache_page(bv.bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506 bvec_kunmap_irq(data, &flags);
507 }
508}
Kent Overstreet38a72da2018-05-08 21:33:53 -0400509EXPORT_SYMBOL(zero_fill_bio_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510
Ming Lei83c9c542020-01-05 09:41:14 +0800511/**
512 * bio_truncate - truncate the bio to small size of @new_size
513 * @bio: the bio to be truncated
514 * @new_size: new size for truncating the bio
515 *
516 * Description:
517 * Truncate the bio to new size of @new_size. If bio_op(bio) is
518 * REQ_OP_READ, zero the truncated part. This function should only
519 * be used for handling corner cases, such as bio eod.
520 */
Ming Lei85a8ce62019-12-28 07:05:48 +0800521void bio_truncate(struct bio *bio, unsigned new_size)
522{
523 struct bio_vec bv;
524 struct bvec_iter iter;
525 unsigned int done = 0;
526 bool truncated = false;
527
528 if (new_size >= bio->bi_iter.bi_size)
529 return;
530
Ming Lei83c9c542020-01-05 09:41:14 +0800531 if (bio_op(bio) != REQ_OP_READ)
Ming Lei85a8ce62019-12-28 07:05:48 +0800532 goto exit;
533
534 bio_for_each_segment(bv, bio, iter) {
535 if (done + bv.bv_len > new_size) {
536 unsigned offset;
537
538 if (!truncated)
539 offset = new_size - done;
540 else
541 offset = 0;
542 zero_user(bv.bv_page, offset, bv.bv_len - offset);
543 truncated = true;
544 }
545 done += bv.bv_len;
546 }
547
548 exit:
549 /*
550 * Don't touch bvec table here and make it really immutable, since
551 * fs bio user has to retrieve all pages via bio_for_each_segment_all
552 * in its .end_bio() callback.
553 *
554 * It is enough to truncate bio by updating .bi_size since we can make
555 * correct bvec with the updated .bi_size for drivers.
556 */
557 bio->bi_iter.bi_size = new_size;
558}
559
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560/**
Christoph Hellwig29125ed2020-03-25 16:48:40 +0100561 * guard_bio_eod - truncate a BIO to fit the block device
562 * @bio: bio to truncate
563 *
564 * This allows us to do IO even on the odd last sectors of a device, even if the
565 * block size is some multiple of the physical sector size.
566 *
567 * We'll just truncate the bio to the size of the device, and clear the end of
568 * the buffer head manually. Truly out-of-range accesses will turn into actual
569 * I/O errors, this only handles the "we need to be able to do I/O at the final
570 * sector" case.
571 */
572void guard_bio_eod(struct bio *bio)
573{
Christoph Hellwig309dca302021-01-24 11:02:34 +0100574 sector_t maxsector = bdev_nr_sectors(bio->bi_bdev);
Christoph Hellwig29125ed2020-03-25 16:48:40 +0100575
576 if (!maxsector)
577 return;
578
579 /*
580 * If the *whole* IO is past the end of the device,
581 * let it through, and the IO layer will turn it into
582 * an EIO.
583 */
584 if (unlikely(bio->bi_iter.bi_sector >= maxsector))
585 return;
586
587 maxsector -= bio->bi_iter.bi_sector;
588 if (likely((bio->bi_iter.bi_size >> 9) <= maxsector))
589 return;
590
591 bio_truncate(bio, maxsector << 9);
592}
593
594/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 * bio_put - release a reference to a bio
596 * @bio: bio to release reference to
597 *
598 * Description:
599 * Put a reference to a &struct bio, either one you have gotten with
NeilBrown9b10f6a2017-06-18 14:38:59 +1000600 * bio_alloc, bio_get or bio_clone_*. The last put of a bio will free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 **/
602void bio_put(struct bio *bio)
603{
Jens Axboedac56212015-04-17 16:23:59 -0600604 if (!bio_flagged(bio, BIO_REFFED))
Kent Overstreet4254bba2012-09-06 15:35:00 -0700605 bio_free(bio);
Jens Axboedac56212015-04-17 16:23:59 -0600606 else {
607 BIO_BUG_ON(!atomic_read(&bio->__bi_cnt));
608
609 /*
610 * last put frees it
611 */
612 if (atomic_dec_and_test(&bio->__bi_cnt))
613 bio_free(bio);
614 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200616EXPORT_SYMBOL(bio_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618/**
Kent Overstreet59d276f2013-11-23 18:19:27 -0800619 * __bio_clone_fast - clone a bio that shares the original bio's biovec
620 * @bio: destination bio
621 * @bio_src: bio to clone
622 *
623 * Clone a &bio. Caller will own the returned bio, but not
624 * the actual data it points to. Reference count of returned
625 * bio will be one.
626 *
627 * Caller must ensure that @bio_src is not freed before @bio.
628 */
629void __bio_clone_fast(struct bio *bio, struct bio *bio_src)
630{
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100631 WARN_ON_ONCE(bio->bi_pool && bio->bi_max_vecs);
Kent Overstreet59d276f2013-11-23 18:19:27 -0800632
633 /*
Christoph Hellwig309dca302021-01-24 11:02:34 +0100634 * most users will be overriding ->bi_bdev with a new target,
Kent Overstreet59d276f2013-11-23 18:19:27 -0800635 * so we don't set nor calculate new physical/hw segment counts here
636 */
Christoph Hellwig309dca302021-01-24 11:02:34 +0100637 bio->bi_bdev = bio_src->bi_bdev;
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600638 bio_set_flag(bio, BIO_CLONED);
Shaohua Li111be882017-12-20 11:10:17 -0700639 if (bio_flagged(bio_src, BIO_THROTTLED))
640 bio_set_flag(bio, BIO_THROTTLED);
Christoph Hellwig46bbf652021-01-26 15:33:08 +0100641 if (bio_flagged(bio_src, BIO_REMAPPED))
642 bio_set_flag(bio, BIO_REMAPPED);
Jens Axboe1eff9d32016-08-05 15:35:16 -0600643 bio->bi_opf = bio_src->bi_opf;
Hannes Reineckeca474b72018-11-12 10:35:25 -0700644 bio->bi_ioprio = bio_src->bi_ioprio;
Jens Axboecb6934f2017-06-27 09:22:02 -0600645 bio->bi_write_hint = bio_src->bi_write_hint;
Kent Overstreet59d276f2013-11-23 18:19:27 -0800646 bio->bi_iter = bio_src->bi_iter;
647 bio->bi_io_vec = bio_src->bi_io_vec;
Paolo Valente20bd7232016-07-27 07:22:05 +0200648
Dennis Zhoudb6638d2018-12-05 12:10:35 -0500649 bio_clone_blkg_association(bio, bio_src);
Dennis Zhoue439bed2018-12-05 12:10:32 -0500650 blkcg_bio_issue_init(bio);
Kent Overstreet59d276f2013-11-23 18:19:27 -0800651}
652EXPORT_SYMBOL(__bio_clone_fast);
653
654/**
655 * bio_clone_fast - clone a bio that shares the original bio's biovec
656 * @bio: bio to clone
657 * @gfp_mask: allocation priority
658 * @bs: bio_set to allocate from
659 *
660 * Like __bio_clone_fast, only also allocates the returned bio
661 */
662struct bio *bio_clone_fast(struct bio *bio, gfp_t gfp_mask, struct bio_set *bs)
663{
664 struct bio *b;
665
666 b = bio_alloc_bioset(gfp_mask, 0, bs);
667 if (!b)
668 return NULL;
669
670 __bio_clone_fast(b, bio);
671
Eric Biggers07560152020-09-15 20:53:13 -0700672 if (bio_crypt_clone(b, bio, gfp_mask) < 0)
673 goto err_put;
Satya Tangiralaa892c8d2020-05-14 00:37:18 +0000674
Eric Biggers07560152020-09-15 20:53:13 -0700675 if (bio_integrity(bio) &&
676 bio_integrity_clone(b, bio, gfp_mask) < 0)
677 goto err_put;
Kent Overstreet59d276f2013-11-23 18:19:27 -0800678
679 return b;
Eric Biggers07560152020-09-15 20:53:13 -0700680
681err_put:
682 bio_put(b);
683 return NULL;
Kent Overstreet59d276f2013-11-23 18:19:27 -0800684}
685EXPORT_SYMBOL(bio_clone_fast);
686
Christoph Hellwig5cbd28e2020-03-24 08:25:12 +0100687const char *bio_devname(struct bio *bio, char *buf)
688{
Christoph Hellwig309dca302021-01-24 11:02:34 +0100689 return bdevname(bio->bi_bdev, buf);
Christoph Hellwig5cbd28e2020-03-24 08:25:12 +0100690}
691EXPORT_SYMBOL(bio_devname);
692
Ming Lei59194822019-03-17 18:01:07 +0800693static inline bool page_is_mergeable(const struct bio_vec *bv,
694 struct page *page, unsigned int len, unsigned int off,
Christoph Hellwigff896732019-06-17 11:14:11 +0200695 bool *same_page)
Ming Lei59194822019-03-17 18:01:07 +0800696{
Matthew Wilcox (Oracle)d8166512020-08-17 20:52:06 +0100697 size_t bv_end = bv->bv_offset + bv->bv_len;
698 phys_addr_t vec_end_addr = page_to_phys(bv->bv_page) + bv_end - 1;
Ming Lei59194822019-03-17 18:01:07 +0800699 phys_addr_t page_addr = page_to_phys(page);
700
701 if (vec_end_addr + 1 != page_addr + off)
702 return false;
703 if (xen_domain() && !xen_biovec_phys_mergeable(bv, page))
704 return false;
Christoph Hellwig52d52d12019-04-11 08:23:31 +0200705
Christoph Hellwigff896732019-06-17 11:14:11 +0200706 *same_page = ((vec_end_addr & PAGE_MASK) == page_addr);
Matthew Wilcox (Oracle)d8166512020-08-17 20:52:06 +0100707 if (*same_page)
708 return true;
709 return (bv->bv_page + bv_end / PAGE_SIZE) == (page + off / PAGE_SIZE);
Ming Lei59194822019-03-17 18:01:07 +0800710}
711
Christoph Hellwige4581102020-05-12 17:55:46 +0900712/*
713 * Try to merge a page into a segment, while obeying the hardware segment
714 * size limit. This is not for normal read/write bios, but for passthrough
715 * or Zone Append operations that we can't split.
716 */
717static bool bio_try_merge_hw_seg(struct request_queue *q, struct bio *bio,
718 struct page *page, unsigned len,
719 unsigned offset, bool *same_page)
Ming Lei489fbbc2019-03-29 15:08:00 +0800720{
Christoph Hellwig384209c2019-08-12 17:39:57 +0200721 struct bio_vec *bv = &bio->bi_io_vec[bio->bi_vcnt - 1];
Ming Lei489fbbc2019-03-29 15:08:00 +0800722 unsigned long mask = queue_segment_boundary(q);
723 phys_addr_t addr1 = page_to_phys(bv->bv_page) + bv->bv_offset;
724 phys_addr_t addr2 = page_to_phys(page) + offset + len - 1;
725
726 if ((addr1 | mask) != (addr2 | mask))
727 return false;
Ming Lei489fbbc2019-03-29 15:08:00 +0800728 if (bv->bv_len + len > queue_max_segment_size(q))
729 return false;
Christoph Hellwig384209c2019-08-12 17:39:57 +0200730 return __bio_try_merge_page(bio, page, len, offset, same_page);
Ming Lei489fbbc2019-03-29 15:08:00 +0800731}
732
Shaohua Lif4595872017-03-24 10:34:43 -0700733/**
Christoph Hellwige4581102020-05-12 17:55:46 +0900734 * bio_add_hw_page - attempt to add a page to a bio with hw constraints
735 * @q: the target queue
736 * @bio: destination bio
737 * @page: page to add
738 * @len: vec entry length
739 * @offset: vec entry offset
740 * @max_sectors: maximum number of sectors that can be added
741 * @same_page: return if the segment has been merged inside the same page
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 *
Christoph Hellwige4581102020-05-12 17:55:46 +0900743 * Add a page to a bio while respecting the hardware max_sectors, max_segment
744 * and gap limitations.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 */
Christoph Hellwige4581102020-05-12 17:55:46 +0900746int bio_add_hw_page(struct request_queue *q, struct bio *bio,
Ming Lei19047082019-03-17 18:01:08 +0800747 struct page *page, unsigned int len, unsigned int offset,
Christoph Hellwige4581102020-05-12 17:55:46 +0900748 unsigned int max_sectors, bool *same_page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750 struct bio_vec *bvec;
751
Christoph Hellwige4581102020-05-12 17:55:46 +0900752 if (WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753 return 0;
754
Christoph Hellwige4581102020-05-12 17:55:46 +0900755 if (((bio->bi_iter.bi_size + len) >> 9) > max_sectors)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 return 0;
757
Jens Axboe80cfd542006-01-06 09:43:28 +0100758 if (bio->bi_vcnt > 0) {
Christoph Hellwige4581102020-05-12 17:55:46 +0900759 if (bio_try_merge_hw_seg(q, bio, page, len, offset, same_page))
Christoph Hellwig384209c2019-08-12 17:39:57 +0200760 return len;
Christoph Hellwig320ea862019-08-12 17:39:56 +0200761
762 /*
763 * If the queue doesn't support SG gaps and adding this segment
764 * would create a gap, disallow it.
765 */
Christoph Hellwig384209c2019-08-12 17:39:57 +0200766 bvec = &bio->bi_io_vec[bio->bi_vcnt - 1];
Christoph Hellwig320ea862019-08-12 17:39:56 +0200767 if (bvec_gap_to_prev(q, bvec, offset))
768 return 0;
Jens Axboe80cfd542006-01-06 09:43:28 +0100769 }
770
Ming Lei79d08f82019-07-01 15:14:46 +0800771 if (bio_full(bio, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 return 0;
773
Christoph Hellwig14ccb662019-06-06 12:29:01 +0200774 if (bio->bi_vcnt >= queue_max_segments(q))
Ming Lei489fbbc2019-03-29 15:08:00 +0800775 return 0;
776
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 bvec = &bio->bi_io_vec[bio->bi_vcnt];
778 bvec->bv_page = page;
779 bvec->bv_len = len;
780 bvec->bv_offset = offset;
Maurizio Lombardifcbf6a02014-12-10 14:16:53 -0800781 bio->bi_vcnt++;
Christoph Hellwigdcdca752019-04-25 09:04:35 +0200782 bio->bi_iter.bi_size += len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 return len;
784}
Ming Lei19047082019-03-17 18:01:08 +0800785
Christoph Hellwige4581102020-05-12 17:55:46 +0900786/**
787 * bio_add_pc_page - attempt to add page to passthrough bio
788 * @q: the target queue
789 * @bio: destination bio
790 * @page: page to add
791 * @len: vec entry length
792 * @offset: vec entry offset
793 *
794 * Attempt to add a page to the bio_vec maplist. This can fail for a
795 * number of reasons, such as the bio being full or target block device
796 * limitations. The target block device must allow bio's up to PAGE_SIZE,
797 * so it is always possible to add a single page to an empty bio.
798 *
799 * This should only be used by passthrough bios.
800 */
Ming Lei19047082019-03-17 18:01:08 +0800801int bio_add_pc_page(struct request_queue *q, struct bio *bio,
802 struct page *page, unsigned int len, unsigned int offset)
803{
Christoph Hellwigd1916c82019-08-12 17:39:58 +0200804 bool same_page = false;
Christoph Hellwige4581102020-05-12 17:55:46 +0900805 return bio_add_hw_page(q, bio, page, len, offset,
806 queue_max_hw_sectors(q), &same_page);
Ming Lei19047082019-03-17 18:01:08 +0800807}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200808EXPORT_SYMBOL(bio_add_pc_page);
Mike Christie6e68af62005-11-11 05:30:27 -0600809
810/**
Johannes Thumshirnae293332021-02-04 19:21:40 +0900811 * bio_add_zone_append_page - attempt to add page to zone-append bio
812 * @bio: destination bio
813 * @page: page to add
814 * @len: vec entry length
815 * @offset: vec entry offset
816 *
817 * Attempt to add a page to the bio_vec maplist of a bio that will be submitted
818 * for a zone-append request. This can fail for a number of reasons, such as the
819 * bio being full or the target block device is not a zoned block device or
820 * other limitations of the target block device. The target block device must
821 * allow bio's up to PAGE_SIZE, so it is always possible to add a single page
822 * to an empty bio.
823 *
824 * Returns: number of bytes added to the bio, or 0 in case of a failure.
825 */
826int bio_add_zone_append_page(struct bio *bio, struct page *page,
827 unsigned int len, unsigned int offset)
828{
Linus Torvalds582cd912021-02-21 11:02:48 -0800829 struct request_queue *q = bio->bi_bdev->bd_disk->queue;
Johannes Thumshirnae293332021-02-04 19:21:40 +0900830 bool same_page = false;
831
832 if (WARN_ON_ONCE(bio_op(bio) != REQ_OP_ZONE_APPEND))
833 return 0;
834
835 if (WARN_ON_ONCE(!blk_queue_is_zoned(q)))
836 return 0;
837
838 return bio_add_hw_page(q, bio, page, len, offset,
839 queue_max_zone_append_sectors(q), &same_page);
840}
841EXPORT_SYMBOL_GPL(bio_add_zone_append_page);
842
843/**
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700844 * __bio_try_merge_page - try appending data to an existing bvec.
845 * @bio: destination bio
Ming Lei551879a2019-04-23 10:51:04 +0800846 * @page: start page to add
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700847 * @len: length of the data to add
Ming Lei551879a2019-04-23 10:51:04 +0800848 * @off: offset of the data relative to @page
Christoph Hellwigff896732019-06-17 11:14:11 +0200849 * @same_page: return if the segment has been merged inside the same page
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700850 *
851 * Try to add the data at @page + @off to the last bvec of @bio. This is a
Randy Dunlap3cf14882020-07-30 18:42:28 -0700852 * useful optimisation for file systems with a block size smaller than the
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700853 * page size.
854 *
Ming Lei551879a2019-04-23 10:51:04 +0800855 * Warn if (@len, @off) crosses pages in case that @same_page is true.
856 *
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700857 * Return %true on success or %false on failure.
858 */
859bool __bio_try_merge_page(struct bio *bio, struct page *page,
Christoph Hellwigff896732019-06-17 11:14:11 +0200860 unsigned int len, unsigned int off, bool *same_page)
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700861{
862 if (WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED)))
863 return false;
864
Andreas Gruenbachercc90bc62019-12-09 20:11:14 +0100865 if (bio->bi_vcnt > 0) {
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700866 struct bio_vec *bv = &bio->bi_io_vec[bio->bi_vcnt - 1];
867
Ming Lei59194822019-03-17 18:01:07 +0800868 if (page_is_mergeable(bv, page, len, off, same_page)) {
Ritesh Harjani2cd896a2020-09-09 08:44:25 +0530869 if (bio->bi_iter.bi_size > UINT_MAX - len) {
870 *same_page = false;
Andreas Gruenbachercc90bc62019-12-09 20:11:14 +0100871 return false;
Ritesh Harjani2cd896a2020-09-09 08:44:25 +0530872 }
Ming Lei59194822019-03-17 18:01:07 +0800873 bv->bv_len += len;
874 bio->bi_iter.bi_size += len;
875 return true;
876 }
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700877 }
878 return false;
879}
880EXPORT_SYMBOL_GPL(__bio_try_merge_page);
881
882/**
Ming Lei551879a2019-04-23 10:51:04 +0800883 * __bio_add_page - add page(s) to a bio in a new segment
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700884 * @bio: destination bio
Ming Lei551879a2019-04-23 10:51:04 +0800885 * @page: start page to add
886 * @len: length of the data to add, may cross pages
887 * @off: offset of the data relative to @page, may cross pages
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700888 *
889 * Add the data at @page + @off to @bio as a new bvec. The caller must ensure
890 * that @bio has space for another bvec.
891 */
892void __bio_add_page(struct bio *bio, struct page *page,
893 unsigned int len, unsigned int off)
894{
895 struct bio_vec *bv = &bio->bi_io_vec[bio->bi_vcnt];
896
897 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
Ming Lei79d08f82019-07-01 15:14:46 +0800898 WARN_ON_ONCE(bio_full(bio, len));
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700899
900 bv->bv_page = page;
901 bv->bv_offset = off;
902 bv->bv_len = len;
903
904 bio->bi_iter.bi_size += len;
905 bio->bi_vcnt++;
Johannes Weinerb8e24a92019-08-08 15:03:00 -0400906
907 if (!bio_flagged(bio, BIO_WORKINGSET) && unlikely(PageWorkingset(page)))
908 bio_set_flag(bio, BIO_WORKINGSET);
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700909}
910EXPORT_SYMBOL_GPL(__bio_add_page);
911
912/**
Ming Lei551879a2019-04-23 10:51:04 +0800913 * bio_add_page - attempt to add page(s) to bio
Linus Torvalds1da177e2005-04-16 15:20:36 -0700914 * @bio: destination bio
Ming Lei551879a2019-04-23 10:51:04 +0800915 * @page: start page to add
916 * @len: vec entry length, may cross pages
917 * @offset: vec entry offset relative to @page, may cross pages
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918 *
Ming Lei551879a2019-04-23 10:51:04 +0800919 * Attempt to add page(s) to the bio_vec maplist. This will only fail
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800920 * if either bio->bi_vcnt == bio->bi_max_vecs or it's a cloned bio.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921 */
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800922int bio_add_page(struct bio *bio, struct page *page,
923 unsigned int len, unsigned int offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924{
Christoph Hellwigff896732019-06-17 11:14:11 +0200925 bool same_page = false;
926
927 if (!__bio_try_merge_page(bio, page, len, offset, &same_page)) {
Ming Lei79d08f82019-07-01 15:14:46 +0800928 if (bio_full(bio, len))
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700929 return 0;
930 __bio_add_page(bio, page, len, offset);
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800931 }
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800932 return len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200934EXPORT_SYMBOL(bio_add_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935
Christoph Hellwigd241a952019-06-26 15:49:21 +0200936void bio_release_pages(struct bio *bio, bool mark_dirty)
Christoph Hellwig7321ecb2019-04-11 08:23:30 +0200937{
938 struct bvec_iter_all iter_all;
939 struct bio_vec *bvec;
Christoph Hellwig7321ecb2019-04-11 08:23:30 +0200940
Christoph Hellwigb2d0d992019-06-26 15:49:20 +0200941 if (bio_flagged(bio, BIO_NO_PAGE_REF))
942 return;
943
Christoph Hellwigd241a952019-06-26 15:49:21 +0200944 bio_for_each_segment_all(bvec, bio, iter_all) {
945 if (mark_dirty && !PageCompound(bvec->bv_page))
946 set_page_dirty_lock(bvec->bv_page);
Christoph Hellwig7321ecb2019-04-11 08:23:30 +0200947 put_page(bvec->bv_page);
Christoph Hellwigd241a952019-06-26 15:49:21 +0200948 }
Christoph Hellwig7321ecb2019-04-11 08:23:30 +0200949}
Johannes Thumshirn29b2a3a2020-05-12 17:55:53 +0900950EXPORT_SYMBOL_GPL(bio_release_pages);
Christoph Hellwig7321ecb2019-04-11 08:23:30 +0200951
Pavel Begunkovc42bca92021-01-09 16:03:03 +0000952static int bio_iov_bvec_set(struct bio *bio, struct iov_iter *iter)
Jens Axboe6d0c48a2018-11-30 08:47:03 -0700953{
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100954 WARN_ON_ONCE(bio->bi_max_vecs);
Jens Axboe6d0c48a2018-11-30 08:47:03 -0700955
Pavel Begunkovc42bca92021-01-09 16:03:03 +0000956 bio->bi_vcnt = iter->nr_segs;
Pavel Begunkovc42bca92021-01-09 16:03:03 +0000957 bio->bi_io_vec = (struct bio_vec *)iter->bvec;
958 bio->bi_iter.bi_bvec_done = iter->iov_offset;
959 bio->bi_iter.bi_size = iter->count;
Christoph Hellwiged97ce52021-02-02 18:19:26 +0100960 bio_set_flag(bio, BIO_NO_PAGE_REF);
Christoph Hellwig977be012021-02-02 18:19:27 +0100961 bio_set_flag(bio, BIO_CLONED);
Jens Axboe6d0c48a2018-11-30 08:47:03 -0700962
Pavel Begunkovc42bca92021-01-09 16:03:03 +0000963 iov_iter_advance(iter, iter->count);
Christoph Hellwiga10584c2019-04-11 08:23:28 +0200964 return 0;
Jens Axboe6d0c48a2018-11-30 08:47:03 -0700965}
966
Christoph Hellwig576ed912018-09-20 08:28:21 +0200967#define PAGE_PTRS_PER_BVEC (sizeof(struct bio_vec) / sizeof(struct page *))
968
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600969/**
Martin Wilck17d51b12018-07-25 23:15:09 +0200970 * __bio_iov_iter_get_pages - pin user or kernel pages and add them to a bio
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600971 * @bio: bio to add pages to
972 * @iter: iov iterator describing the region to be mapped
973 *
Martin Wilck17d51b12018-07-25 23:15:09 +0200974 * Pins pages from *iter and appends them to @bio's bvec array. The
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600975 * pages will have to be released using put_page() when done.
Martin Wilck17d51b12018-07-25 23:15:09 +0200976 * For multi-segment *iter, this function only adds pages from the
Randy Dunlap3cf14882020-07-30 18:42:28 -0700977 * next non-empty segment of the iov iterator.
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600978 */
Martin Wilck17d51b12018-07-25 23:15:09 +0200979static int __bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter)
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600980{
Christoph Hellwig576ed912018-09-20 08:28:21 +0200981 unsigned short nr_pages = bio->bi_max_vecs - bio->bi_vcnt;
982 unsigned short entries_left = bio->bi_max_vecs - bio->bi_vcnt;
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600983 struct bio_vec *bv = bio->bi_io_vec + bio->bi_vcnt;
984 struct page **pages = (struct page **)bv;
Christoph Hellwig45691802019-06-17 11:14:12 +0200985 bool same_page = false;
Christoph Hellwig576ed912018-09-20 08:28:21 +0200986 ssize_t size, left;
987 unsigned len, i;
Martin Wilckb403ea22018-07-25 23:15:07 +0200988 size_t offset;
Christoph Hellwig576ed912018-09-20 08:28:21 +0200989
990 /*
991 * Move page array up in the allocated memory for the bio vecs as far as
992 * possible so that we can start filling biovecs from the beginning
993 * without overwriting the temporary page array.
994 */
995 BUILD_BUG_ON(PAGE_PTRS_PER_BVEC < 2);
996 pages += entries_left * (PAGE_PTRS_PER_BVEC - 1);
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600997
998 size = iov_iter_get_pages(iter, pages, LONG_MAX, nr_pages, &offset);
999 if (unlikely(size <= 0))
1000 return size ? size : -EFAULT;
Kent Overstreet2cefe4d2016-10-31 11:59:24 -06001001
Christoph Hellwig576ed912018-09-20 08:28:21 +02001002 for (left = size, i = 0; left > 0; left -= len, i++) {
1003 struct page *page = pages[i];
Kent Overstreet2cefe4d2016-10-31 11:59:24 -06001004
Christoph Hellwig576ed912018-09-20 08:28:21 +02001005 len = min_t(size_t, PAGE_SIZE - offset, left);
Christoph Hellwig45691802019-06-17 11:14:12 +02001006
1007 if (__bio_try_merge_page(bio, page, len, offset, &same_page)) {
1008 if (same_page)
1009 put_page(page);
1010 } else {
Ming Lei79d08f82019-07-01 15:14:46 +08001011 if (WARN_ON_ONCE(bio_full(bio, len)))
Christoph Hellwig45691802019-06-17 11:14:12 +02001012 return -EINVAL;
1013 __bio_add_page(bio, page, len, offset);
1014 }
Christoph Hellwig576ed912018-09-20 08:28:21 +02001015 offset = 0;
Kent Overstreet2cefe4d2016-10-31 11:59:24 -06001016 }
1017
Kent Overstreet2cefe4d2016-10-31 11:59:24 -06001018 iov_iter_advance(iter, size);
1019 return 0;
1020}
Martin Wilck17d51b12018-07-25 23:15:09 +02001021
Keith Busch0512a752020-05-12 17:55:47 +09001022static int __bio_iov_append_get_pages(struct bio *bio, struct iov_iter *iter)
1023{
1024 unsigned short nr_pages = bio->bi_max_vecs - bio->bi_vcnt;
1025 unsigned short entries_left = bio->bi_max_vecs - bio->bi_vcnt;
Christoph Hellwig309dca302021-01-24 11:02:34 +01001026 struct request_queue *q = bio->bi_bdev->bd_disk->queue;
Keith Busch0512a752020-05-12 17:55:47 +09001027 unsigned int max_append_sectors = queue_max_zone_append_sectors(q);
1028 struct bio_vec *bv = bio->bi_io_vec + bio->bi_vcnt;
1029 struct page **pages = (struct page **)bv;
1030 ssize_t size, left;
1031 unsigned len, i;
1032 size_t offset;
Naohiro Aota4977d122020-10-28 16:25:36 +09001033 int ret = 0;
Keith Busch0512a752020-05-12 17:55:47 +09001034
1035 if (WARN_ON_ONCE(!max_append_sectors))
1036 return 0;
1037
1038 /*
1039 * Move page array up in the allocated memory for the bio vecs as far as
1040 * possible so that we can start filling biovecs from the beginning
1041 * without overwriting the temporary page array.
1042 */
1043 BUILD_BUG_ON(PAGE_PTRS_PER_BVEC < 2);
1044 pages += entries_left * (PAGE_PTRS_PER_BVEC - 1);
1045
1046 size = iov_iter_get_pages(iter, pages, LONG_MAX, nr_pages, &offset);
1047 if (unlikely(size <= 0))
1048 return size ? size : -EFAULT;
1049
1050 for (left = size, i = 0; left > 0; left -= len, i++) {
1051 struct page *page = pages[i];
1052 bool same_page = false;
1053
1054 len = min_t(size_t, PAGE_SIZE - offset, left);
1055 if (bio_add_hw_page(q, bio, page, len, offset,
Naohiro Aota4977d122020-10-28 16:25:36 +09001056 max_append_sectors, &same_page) != len) {
1057 ret = -EINVAL;
1058 break;
1059 }
Keith Busch0512a752020-05-12 17:55:47 +09001060 if (same_page)
1061 put_page(page);
1062 offset = 0;
1063 }
1064
Naohiro Aota4977d122020-10-28 16:25:36 +09001065 iov_iter_advance(iter, size - left);
1066 return ret;
Keith Busch0512a752020-05-12 17:55:47 +09001067}
1068
Martin Wilck17d51b12018-07-25 23:15:09 +02001069/**
Jens Axboe6d0c48a2018-11-30 08:47:03 -07001070 * bio_iov_iter_get_pages - add user or kernel pages to a bio
Martin Wilck17d51b12018-07-25 23:15:09 +02001071 * @bio: bio to add pages to
Jens Axboe6d0c48a2018-11-30 08:47:03 -07001072 * @iter: iov iterator describing the region to be added
Martin Wilck17d51b12018-07-25 23:15:09 +02001073 *
Jens Axboe6d0c48a2018-11-30 08:47:03 -07001074 * This takes either an iterator pointing to user memory, or one pointing to
1075 * kernel pages (BVEC iterator). If we're adding user pages, we pin them and
1076 * map them into the kernel. On IO completion, the caller should put those
Pavel Begunkovc42bca92021-01-09 16:03:03 +00001077 * pages. For bvec based iterators bio_iov_iter_get_pages() uses the provided
1078 * bvecs rather than copying them. Hence anyone issuing kiocb based IO needs
1079 * to ensure the bvecs and pages stay referenced until the submitted I/O is
1080 * completed by a call to ->ki_complete() or returns with an error other than
1081 * -EIOCBQUEUED. The caller needs to check if the bio is flagged BIO_NO_PAGE_REF
1082 * on IO completion. If it isn't, then pages should be released.
Jens Axboe6d0c48a2018-11-30 08:47:03 -07001083 *
Martin Wilck17d51b12018-07-25 23:15:09 +02001084 * The function tries, but does not guarantee, to pin as many pages as
Mauro Carvalho Chehab5cd3ddc2020-09-09 11:44:33 +02001085 * fit into the bio, or are requested in @iter, whatever is smaller. If
Jens Axboe6d0c48a2018-11-30 08:47:03 -07001086 * MM encounters an error pinning the requested pages, it stops. Error
1087 * is returned only if 0 pages could be pinned.
Pavel Begunkov0cf41e52021-01-09 16:02:59 +00001088 *
1089 * It's intended for direct IO, so doesn't do PSI tracking, the caller is
1090 * responsible for setting BIO_WORKINGSET if necessary.
Martin Wilck17d51b12018-07-25 23:15:09 +02001091 */
1092int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter)
1093{
Pavel Begunkovc42bca92021-01-09 16:03:03 +00001094 int ret = 0;
Christoph Hellwig14eacf12019-04-11 08:23:29 +02001095
Pavel Begunkovc42bca92021-01-09 16:03:03 +00001096 if (iov_iter_is_bvec(iter)) {
1097 if (WARN_ON_ONCE(bio_op(bio) == REQ_OP_ZONE_APPEND))
1098 return -EINVAL;
Christoph Hellwiged97ce52021-02-02 18:19:26 +01001099 return bio_iov_bvec_set(bio, iter);
Pavel Begunkovc42bca92021-01-09 16:03:03 +00001100 }
Martin Wilck17d51b12018-07-25 23:15:09 +02001101
1102 do {
Christoph Hellwig86004512021-02-02 18:19:25 +01001103 if (bio_op(bio) == REQ_OP_ZONE_APPEND)
Keith Busch0512a752020-05-12 17:55:47 +09001104 ret = __bio_iov_append_get_pages(bio, iter);
Christoph Hellwig86004512021-02-02 18:19:25 +01001105 else
1106 ret = __bio_iov_iter_get_pages(bio, iter);
Ming Lei79d08f82019-07-01 15:14:46 +08001107 } while (!ret && iov_iter_count(iter) && !bio_full(bio, 0));
Martin Wilck17d51b12018-07-25 23:15:09 +02001108
Pavel Begunkov0cf41e52021-01-09 16:02:59 +00001109 /* don't account direct I/O as memory stall */
1110 bio_clear_flag(bio, BIO_WORKINGSET);
Christoph Hellwig14eacf12019-04-11 08:23:29 +02001111 return bio->bi_vcnt ? 0 : ret;
Martin Wilck17d51b12018-07-25 23:15:09 +02001112}
Johannes Thumshirn29b2a3a2020-05-12 17:55:53 +09001113EXPORT_SYMBOL_GPL(bio_iov_iter_get_pages);
Kent Overstreet2cefe4d2016-10-31 11:59:24 -06001114
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001115static void submit_bio_wait_endio(struct bio *bio)
Kent Overstreet9e882242012-09-10 14:41:12 -07001116{
Christoph Hellwig65e53aa2017-10-25 17:55:57 +09001117 complete(bio->bi_private);
Kent Overstreet9e882242012-09-10 14:41:12 -07001118}
1119
1120/**
1121 * submit_bio_wait - submit a bio, and wait until it completes
Kent Overstreet9e882242012-09-10 14:41:12 -07001122 * @bio: The &struct bio which describes the I/O
1123 *
1124 * Simple wrapper around submit_bio(). Returns 0 on success, or the error from
1125 * bio_endio() on failure.
Jan Kara3d289d62017-08-02 10:25:21 +02001126 *
1127 * WARNING: Unlike to how submit_bio() is usually used, this function does not
1128 * result in bio reference to be consumed. The caller must drop the reference
1129 * on his own.
Kent Overstreet9e882242012-09-10 14:41:12 -07001130 */
Mike Christie4e49ea42016-06-05 14:31:41 -05001131int submit_bio_wait(struct bio *bio)
Kent Overstreet9e882242012-09-10 14:41:12 -07001132{
Christoph Hellwig309dca302021-01-24 11:02:34 +01001133 DECLARE_COMPLETION_ONSTACK_MAP(done,
1134 bio->bi_bdev->bd_disk->lockdep_map);
Ming Leide6a78b2020-03-18 11:43:36 +08001135 unsigned long hang_check;
Kent Overstreet9e882242012-09-10 14:41:12 -07001136
Christoph Hellwig65e53aa2017-10-25 17:55:57 +09001137 bio->bi_private = &done;
Kent Overstreet9e882242012-09-10 14:41:12 -07001138 bio->bi_end_io = submit_bio_wait_endio;
Jens Axboe1eff9d32016-08-05 15:35:16 -06001139 bio->bi_opf |= REQ_SYNC;
Mike Christie4e49ea42016-06-05 14:31:41 -05001140 submit_bio(bio);
Ming Leide6a78b2020-03-18 11:43:36 +08001141
1142 /* Prevent hang_check timer from firing at us during very long I/O */
1143 hang_check = sysctl_hung_task_timeout_secs;
1144 if (hang_check)
1145 while (!wait_for_completion_io_timeout(&done,
1146 hang_check * (HZ/2)))
1147 ;
1148 else
1149 wait_for_completion_io(&done);
Kent Overstreet9e882242012-09-10 14:41:12 -07001150
Christoph Hellwig65e53aa2017-10-25 17:55:57 +09001151 return blk_status_to_errno(bio->bi_status);
Kent Overstreet9e882242012-09-10 14:41:12 -07001152}
1153EXPORT_SYMBOL(submit_bio_wait);
1154
Kent Overstreet054bdf62012-09-28 13:17:55 -07001155/**
1156 * bio_advance - increment/complete a bio by some number of bytes
1157 * @bio: bio to advance
1158 * @bytes: number of bytes to complete
1159 *
1160 * This updates bi_sector, bi_size and bi_idx; if the number of bytes to
1161 * complete doesn't align with a bvec boundary, then bv_len and bv_offset will
1162 * be updated on the last bvec as well.
1163 *
1164 * @bio will then represent the remaining, uncompleted portion of the io.
1165 */
1166void bio_advance(struct bio *bio, unsigned bytes)
1167{
1168 if (bio_integrity(bio))
1169 bio_integrity_advance(bio, bytes);
1170
Satya Tangiralaa892c8d2020-05-14 00:37:18 +00001171 bio_crypt_advance(bio, bytes);
Kent Overstreet4550dd62013-08-07 14:26:21 -07001172 bio_advance_iter(bio, &bio->bi_iter, bytes);
Kent Overstreet054bdf62012-09-28 13:17:55 -07001173}
1174EXPORT_SYMBOL(bio_advance);
1175
Kent Overstreet45db54d2018-05-08 21:33:54 -04001176void bio_copy_data_iter(struct bio *dst, struct bvec_iter *dst_iter,
1177 struct bio *src, struct bvec_iter *src_iter)
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001178{
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001179 struct bio_vec src_bv, dst_bv;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001180 void *src_p, *dst_p;
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001181 unsigned bytes;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001182
Kent Overstreet45db54d2018-05-08 21:33:54 -04001183 while (src_iter->bi_size && dst_iter->bi_size) {
1184 src_bv = bio_iter_iovec(src, *src_iter);
1185 dst_bv = bio_iter_iovec(dst, *dst_iter);
1186
1187 bytes = min(src_bv.bv_len, dst_bv.bv_len);
1188
1189 src_p = kmap_atomic(src_bv.bv_page);
1190 dst_p = kmap_atomic(dst_bv.bv_page);
1191
1192 memcpy(dst_p + dst_bv.bv_offset,
1193 src_p + src_bv.bv_offset,
1194 bytes);
1195
1196 kunmap_atomic(dst_p);
1197 kunmap_atomic(src_p);
1198
Kent Overstreet6e6e8112018-05-08 21:33:55 -04001199 flush_dcache_page(dst_bv.bv_page);
1200
Pavel Begunkov22b56c22020-11-24 17:58:13 +00001201 bio_advance_iter_single(src, src_iter, bytes);
1202 bio_advance_iter_single(dst, dst_iter, bytes);
Kent Overstreet45db54d2018-05-08 21:33:54 -04001203 }
1204}
1205EXPORT_SYMBOL(bio_copy_data_iter);
1206
1207/**
1208 * bio_copy_data - copy contents of data buffers from one bio to another
1209 * @src: source bio
1210 * @dst: destination bio
1211 *
1212 * Stops when it reaches the end of either @src or @dst - that is, copies
1213 * min(src->bi_size, dst->bi_size) bytes (or the equivalent for lists of bios).
1214 */
1215void bio_copy_data(struct bio *dst, struct bio *src)
1216{
1217 struct bvec_iter src_iter = src->bi_iter;
1218 struct bvec_iter dst_iter = dst->bi_iter;
1219
1220 bio_copy_data_iter(dst, &dst_iter, src, &src_iter);
1221}
1222EXPORT_SYMBOL(bio_copy_data);
1223
1224/**
1225 * bio_list_copy_data - copy contents of data buffers from one chain of bios to
1226 * another
1227 * @src: source bio list
1228 * @dst: destination bio list
1229 *
1230 * Stops when it reaches the end of either the @src list or @dst list - that is,
1231 * copies min(src->bi_size, dst->bi_size) bytes (or the equivalent for lists of
1232 * bios).
1233 */
1234void bio_list_copy_data(struct bio *dst, struct bio *src)
1235{
1236 struct bvec_iter src_iter = src->bi_iter;
1237 struct bvec_iter dst_iter = dst->bi_iter;
1238
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001239 while (1) {
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001240 if (!src_iter.bi_size) {
1241 src = src->bi_next;
1242 if (!src)
1243 break;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001244
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001245 src_iter = src->bi_iter;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001246 }
1247
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001248 if (!dst_iter.bi_size) {
1249 dst = dst->bi_next;
1250 if (!dst)
1251 break;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001252
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001253 dst_iter = dst->bi_iter;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001254 }
1255
Kent Overstreet45db54d2018-05-08 21:33:54 -04001256 bio_copy_data_iter(dst, &dst_iter, src, &src_iter);
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001257 }
1258}
Kent Overstreet45db54d2018-05-08 21:33:54 -04001259EXPORT_SYMBOL(bio_list_copy_data);
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001260
Guoqing Jiang491221f2016-09-22 03:10:01 -04001261void bio_free_pages(struct bio *bio)
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001262{
1263 struct bio_vec *bvec;
Ming Lei6dc4f102019-02-15 19:13:19 +08001264 struct bvec_iter_all iter_all;
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001265
Christoph Hellwig2b070cf2019-04-25 09:03:00 +02001266 bio_for_each_segment_all(bvec, bio, iter_all)
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001267 __free_page(bvec->bv_page);
1268}
Guoqing Jiang491221f2016-09-22 03:10:01 -04001269EXPORT_SYMBOL(bio_free_pages);
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001270
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271/*
1272 * bio_set_pages_dirty() and bio_check_pages_dirty() are support functions
1273 * for performing direct-IO in BIOs.
1274 *
1275 * The problem is that we cannot run set_page_dirty() from interrupt context
1276 * because the required locks are not interrupt-safe. So what we can do is to
1277 * mark the pages dirty _before_ performing IO. And in interrupt context,
1278 * check that the pages are still dirty. If so, fine. If not, redirty them
1279 * in process context.
1280 *
1281 * We special-case compound pages here: normally this means reads into hugetlb
1282 * pages. The logic in here doesn't really work right for compound pages
1283 * because the VM does not uniformly chase down the head page in all cases.
1284 * But dirtiness of compound pages is pretty meaningless anyway: the VM doesn't
1285 * handle them at all. So we skip compound pages here at an early stage.
1286 *
1287 * Note that this code is very hard to test under normal circumstances because
1288 * direct-io pins the pages with get_user_pages(). This makes
1289 * is_page_cache_freeable return false, and the VM will not clean the pages.
Artem Bityutskiy0d5c3eb2012-07-25 18:12:08 +03001290 * But other code (eg, flusher threads) could clean the pages if they are mapped
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 * pagecache.
1292 *
1293 * Simply disabling the call to bio_set_pages_dirty() is a good way to test the
1294 * deferred bio dirtying paths.
1295 */
1296
1297/*
1298 * bio_set_pages_dirty() will mark all the bio's pages as dirty.
1299 */
1300void bio_set_pages_dirty(struct bio *bio)
1301{
Kent Overstreetcb34e052012-09-05 15:22:02 -07001302 struct bio_vec *bvec;
Ming Lei6dc4f102019-02-15 19:13:19 +08001303 struct bvec_iter_all iter_all;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304
Christoph Hellwig2b070cf2019-04-25 09:03:00 +02001305 bio_for_each_segment_all(bvec, bio, iter_all) {
Christoph Hellwig3bb50982018-07-24 14:04:13 +02001306 if (!PageCompound(bvec->bv_page))
1307 set_page_dirty_lock(bvec->bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 }
1309}
1310
Linus Torvalds1da177e2005-04-16 15:20:36 -07001311/*
1312 * bio_check_pages_dirty() will check that all the BIO's pages are still dirty.
1313 * If they are, then fine. If, however, some pages are clean then they must
1314 * have been written out during the direct-IO read. So we take another ref on
Christoph Hellwig24d54932018-07-24 14:04:12 +02001315 * the BIO and re-dirty the pages in process context.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 *
1317 * It is expected that bio_check_pages_dirty() will wholly own the BIO from
Kirill A. Shutemovea1754a2016-04-01 15:29:48 +03001318 * here on. It will run one put_page() against each page and will run one
1319 * bio_put() against the BIO.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 */
1321
David Howells65f27f32006-11-22 14:55:48 +00001322static void bio_dirty_fn(struct work_struct *work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323
David Howells65f27f32006-11-22 14:55:48 +00001324static DECLARE_WORK(bio_dirty_work, bio_dirty_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325static DEFINE_SPINLOCK(bio_dirty_lock);
1326static struct bio *bio_dirty_list;
1327
1328/*
1329 * This runs in process context
1330 */
David Howells65f27f32006-11-22 14:55:48 +00001331static void bio_dirty_fn(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001332{
Christoph Hellwig24d54932018-07-24 14:04:12 +02001333 struct bio *bio, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001334
Christoph Hellwig24d54932018-07-24 14:04:12 +02001335 spin_lock_irq(&bio_dirty_lock);
1336 next = bio_dirty_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337 bio_dirty_list = NULL;
Christoph Hellwig24d54932018-07-24 14:04:12 +02001338 spin_unlock_irq(&bio_dirty_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339
Christoph Hellwig24d54932018-07-24 14:04:12 +02001340 while ((bio = next) != NULL) {
1341 next = bio->bi_private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001342
Christoph Hellwigd241a952019-06-26 15:49:21 +02001343 bio_release_pages(bio, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344 bio_put(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345 }
1346}
1347
1348void bio_check_pages_dirty(struct bio *bio)
1349{
Kent Overstreetcb34e052012-09-05 15:22:02 -07001350 struct bio_vec *bvec;
Christoph Hellwig24d54932018-07-24 14:04:12 +02001351 unsigned long flags;
Ming Lei6dc4f102019-02-15 19:13:19 +08001352 struct bvec_iter_all iter_all;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353
Christoph Hellwig2b070cf2019-04-25 09:03:00 +02001354 bio_for_each_segment_all(bvec, bio, iter_all) {
Christoph Hellwig24d54932018-07-24 14:04:12 +02001355 if (!PageDirty(bvec->bv_page) && !PageCompound(bvec->bv_page))
1356 goto defer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357 }
1358
Christoph Hellwigd241a952019-06-26 15:49:21 +02001359 bio_release_pages(bio, false);
Christoph Hellwig24d54932018-07-24 14:04:12 +02001360 bio_put(bio);
1361 return;
1362defer:
1363 spin_lock_irqsave(&bio_dirty_lock, flags);
1364 bio->bi_private = bio_dirty_list;
1365 bio_dirty_list = bio;
1366 spin_unlock_irqrestore(&bio_dirty_lock, flags);
1367 schedule_work(&bio_dirty_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368}
1369
Jens Axboec4cf5262015-04-17 16:15:18 -06001370static inline bool bio_remaining_done(struct bio *bio)
1371{
1372 /*
1373 * If we're not chaining, then ->__bi_remaining is always 1 and
1374 * we always end io on the first invocation.
1375 */
1376 if (!bio_flagged(bio, BIO_CHAIN))
1377 return true;
1378
1379 BUG_ON(atomic_read(&bio->__bi_remaining) <= 0);
1380
Mike Snitzer326e1db2015-05-22 09:14:03 -04001381 if (atomic_dec_and_test(&bio->__bi_remaining)) {
Jens Axboeb7c44ed2015-07-24 12:37:59 -06001382 bio_clear_flag(bio, BIO_CHAIN);
Jens Axboec4cf5262015-04-17 16:15:18 -06001383 return true;
Mike Snitzer326e1db2015-05-22 09:14:03 -04001384 }
Jens Axboec4cf5262015-04-17 16:15:18 -06001385
1386 return false;
1387}
1388
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389/**
1390 * bio_endio - end I/O on a bio
1391 * @bio: bio
Linus Torvalds1da177e2005-04-16 15:20:36 -07001392 *
1393 * Description:
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001394 * bio_endio() will end I/O on the whole bio. bio_endio() is the preferred
1395 * way to end I/O on a bio. No one should call bi_end_io() directly on a
1396 * bio unless they own it and thus know that it has an end_io function.
NeilBrownfbbaf702017-04-07 09:40:52 -06001397 *
1398 * bio_endio() can be called several times on a bio that has been chained
1399 * using bio_chain(). The ->bi_end_io() function will only be called the
1400 * last time. At this point the BLK_TA_COMPLETE tracing event will be
1401 * generated if BIO_TRACE_COMPLETION is set.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402 **/
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001403void bio_endio(struct bio *bio)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404{
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001405again:
Christoph Hellwig2b885512016-03-11 17:34:53 +01001406 if (!bio_remaining_done(bio))
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001407 return;
Christoph Hellwig7c20f112017-07-03 16:58:43 -06001408 if (!bio_integrity_endio(bio))
1409 return;
Kent Overstreet196d38bc2013-11-23 18:34:15 -08001410
Christoph Hellwig309dca302021-01-24 11:02:34 +01001411 if (bio->bi_bdev)
1412 rq_qos_done_bio(bio->bi_bdev->bd_disk->queue, bio);
Josef Bacik67b42d02018-07-03 11:15:00 -04001413
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001414 /*
1415 * Need to have a real endio function for chained bios, otherwise
1416 * various corner cases will break (like stacking block devices that
1417 * save/restore bi_end_io) - however, we want to avoid unbounded
1418 * recursion and blowing the stack. Tail call optimization would
1419 * handle this, but compiling with frame pointers also disables
1420 * gcc's sibling call optimization.
1421 */
1422 if (bio->bi_end_io == bio_chain_endio) {
1423 bio = __bio_chain_endio(bio);
1424 goto again;
Kent Overstreet196d38bc2013-11-23 18:34:15 -08001425 }
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001426
Christoph Hellwig309dca302021-01-24 11:02:34 +01001427 if (bio->bi_bdev && bio_flagged(bio, BIO_TRACE_COMPLETION)) {
1428 trace_block_bio_complete(bio->bi_bdev->bd_disk->queue, bio);
NeilBrownfbbaf702017-04-07 09:40:52 -06001429 bio_clear_flag(bio, BIO_TRACE_COMPLETION);
1430 }
1431
Shaohua Li9e234ee2017-03-27 10:51:41 -07001432 blk_throtl_bio_endio(bio);
Shaohua Lib222dd22017-07-10 11:40:17 -07001433 /* release cgroup info */
1434 bio_uninit(bio);
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001435 if (bio->bi_end_io)
1436 bio->bi_end_io(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437}
H Hartley Sweetena112a712009-09-26 16:19:21 +02001438EXPORT_SYMBOL(bio_endio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001439
Kent Overstreet196d38bc2013-11-23 18:34:15 -08001440/**
Kent Overstreet20d01892013-11-23 18:21:01 -08001441 * bio_split - split a bio
1442 * @bio: bio to split
1443 * @sectors: number of sectors to split from the front of @bio
1444 * @gfp: gfp mask
1445 * @bs: bio set to allocate from
1446 *
1447 * Allocates and returns a new bio which represents @sectors from the start of
1448 * @bio, and updates @bio to represent the remaining sectors.
1449 *
Martin K. Petersenf3f5da62015-07-22 07:57:12 -04001450 * Unless this is a discard request the newly allocated bio will point
Bart Van Asschedad77582019-08-01 15:50:41 -07001451 * to @bio's bi_io_vec. It is the caller's responsibility to ensure that
1452 * neither @bio nor @bs are freed before the split bio.
Kent Overstreet20d01892013-11-23 18:21:01 -08001453 */
1454struct bio *bio_split(struct bio *bio, int sectors,
1455 gfp_t gfp, struct bio_set *bs)
1456{
Mikulas Patockaf341a4d2017-11-22 13:18:05 -05001457 struct bio *split;
Kent Overstreet20d01892013-11-23 18:21:01 -08001458
1459 BUG_ON(sectors <= 0);
1460 BUG_ON(sectors >= bio_sectors(bio));
1461
Keith Busch0512a752020-05-12 17:55:47 +09001462 /* Zone append commands cannot be split */
1463 if (WARN_ON_ONCE(bio_op(bio) == REQ_OP_ZONE_APPEND))
1464 return NULL;
1465
Christoph Hellwigf9d03f92016-12-08 15:20:32 -07001466 split = bio_clone_fast(bio, gfp, bs);
Kent Overstreet20d01892013-11-23 18:21:01 -08001467 if (!split)
1468 return NULL;
1469
1470 split->bi_iter.bi_size = sectors << 9;
1471
1472 if (bio_integrity(split))
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -07001473 bio_integrity_trim(split);
Kent Overstreet20d01892013-11-23 18:21:01 -08001474
1475 bio_advance(bio, split->bi_iter.bi_size);
1476
NeilBrownfbbaf702017-04-07 09:40:52 -06001477 if (bio_flagged(bio, BIO_TRACE_COMPLETION))
Goldwyn Rodrigues20d59022018-01-23 09:10:19 -07001478 bio_set_flag(split, BIO_TRACE_COMPLETION);
NeilBrownfbbaf702017-04-07 09:40:52 -06001479
Kent Overstreet20d01892013-11-23 18:21:01 -08001480 return split;
1481}
1482EXPORT_SYMBOL(bio_split);
1483
Martin K. Petersenad3316b2008-10-01 22:42:53 -04001484/**
Kent Overstreet6678d832013-08-07 11:14:32 -07001485 * bio_trim - trim a bio
1486 * @bio: bio to trim
1487 * @offset: number of sectors to trim from the front of @bio
1488 * @size: size we want to trim @bio to, in sectors
1489 */
1490void bio_trim(struct bio *bio, int offset, int size)
1491{
1492 /* 'bio' is a cloned bio which we need to trim to match
1493 * the given offset and size.
Kent Overstreet6678d832013-08-07 11:14:32 -07001494 */
Kent Overstreet6678d832013-08-07 11:14:32 -07001495
1496 size <<= 9;
Kent Overstreet4f024f32013-10-11 15:44:27 -07001497 if (offset == 0 && size == bio->bi_iter.bi_size)
Kent Overstreet6678d832013-08-07 11:14:32 -07001498 return;
1499
Kent Overstreet6678d832013-08-07 11:14:32 -07001500 bio_advance(bio, offset << 9);
Kent Overstreet4f024f32013-10-11 15:44:27 -07001501 bio->bi_iter.bi_size = size;
Dmitry Monakhov376a78a2017-06-29 11:31:08 -07001502
1503 if (bio_integrity(bio))
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -07001504 bio_integrity_trim(bio);
Dmitry Monakhov376a78a2017-06-29 11:31:08 -07001505
Kent Overstreet6678d832013-08-07 11:14:32 -07001506}
1507EXPORT_SYMBOL_GPL(bio_trim);
1508
Linus Torvalds1da177e2005-04-16 15:20:36 -07001509/*
1510 * create memory pools for biovec's in a bio_set.
1511 * use the global biovec slabs created for general use.
1512 */
Kent Overstreet8aa6ba22018-05-08 21:33:50 -04001513int biovec_init_pool(mempool_t *pool, int pool_entries)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001514{
Christoph Hellwig7a800a22021-02-02 18:19:29 +01001515 struct biovec_slab *bp = bvec_slabs + ARRAY_SIZE(bvec_slabs) - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516
Kent Overstreet8aa6ba22018-05-08 21:33:50 -04001517 return mempool_init_slab_pool(pool, pool_entries, bp->slab);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518}
1519
Kent Overstreet917a38c2018-05-08 21:33:51 -04001520/*
1521 * bioset_exit - exit a bioset initialized with bioset_init()
1522 *
1523 * May be called on a zeroed but uninitialized bioset (i.e. allocated with
1524 * kzalloc()).
1525 */
1526void bioset_exit(struct bio_set *bs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527{
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -07001528 if (bs->rescue_workqueue)
1529 destroy_workqueue(bs->rescue_workqueue);
Kent Overstreet917a38c2018-05-08 21:33:51 -04001530 bs->rescue_workqueue = NULL;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -07001531
Kent Overstreet8aa6ba22018-05-08 21:33:50 -04001532 mempool_exit(&bs->bio_pool);
1533 mempool_exit(&bs->bvec_pool);
Kent Overstreet9f060e22012-10-12 15:29:33 -07001534
Martin K. Petersen7878cba2009-06-26 15:37:49 +02001535 bioset_integrity_free(bs);
Kent Overstreet917a38c2018-05-08 21:33:51 -04001536 if (bs->bio_slab)
1537 bio_put_slab(bs);
1538 bs->bio_slab = NULL;
1539}
1540EXPORT_SYMBOL(bioset_exit);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541
NeilBrown011067b2017-06-18 14:38:57 +10001542/**
Kent Overstreet917a38c2018-05-08 21:33:51 -04001543 * bioset_init - Initialize a bio_set
Kent Overstreetdad08522018-05-20 18:25:58 -04001544 * @bs: pool to initialize
Kent Overstreet917a38c2018-05-08 21:33:51 -04001545 * @pool_size: Number of bio and bio_vecs to cache in the mempool
1546 * @front_pad: Number of bytes to allocate in front of the returned bio
1547 * @flags: Flags to modify behavior, currently %BIOSET_NEED_BVECS
1548 * and %BIOSET_NEED_RESCUER
1549 *
Kent Overstreetdad08522018-05-20 18:25:58 -04001550 * Description:
1551 * Set up a bio_set to be used with @bio_alloc_bioset. Allows the caller
1552 * to ask for a number of bytes to be allocated in front of the bio.
1553 * Front pad allocation is useful for embedding the bio inside
1554 * another structure, to avoid allocating extra data to go with the bio.
1555 * Note that the bio must be embedded at the END of that structure always,
1556 * or things will break badly.
1557 * If %BIOSET_NEED_BVECS is set in @flags, a separate pool will be allocated
1558 * for allocating iovecs. This pool is not needed e.g. for bio_clone_fast().
1559 * If %BIOSET_NEED_RESCUER is set, a workqueue is created which can be used to
1560 * dispatch queued requests when the mempool runs out of space.
1561 *
Kent Overstreet917a38c2018-05-08 21:33:51 -04001562 */
1563int bioset_init(struct bio_set *bs,
1564 unsigned int pool_size,
1565 unsigned int front_pad,
1566 int flags)
1567{
Kent Overstreet917a38c2018-05-08 21:33:51 -04001568 bs->front_pad = front_pad;
Ming Lei9f180e32021-01-11 11:05:54 +08001569 if (flags & BIOSET_NEED_BVECS)
1570 bs->back_pad = BIO_INLINE_VECS * sizeof(struct bio_vec);
1571 else
1572 bs->back_pad = 0;
Kent Overstreet917a38c2018-05-08 21:33:51 -04001573
1574 spin_lock_init(&bs->rescue_lock);
1575 bio_list_init(&bs->rescue_list);
1576 INIT_WORK(&bs->rescue_work, bio_alloc_rescue);
1577
Ming Lei49d1ec82021-01-11 11:05:52 +08001578 bs->bio_slab = bio_find_or_create_slab(bs);
Kent Overstreet917a38c2018-05-08 21:33:51 -04001579 if (!bs->bio_slab)
1580 return -ENOMEM;
1581
1582 if (mempool_init_slab_pool(&bs->bio_pool, pool_size, bs->bio_slab))
1583 goto bad;
1584
1585 if ((flags & BIOSET_NEED_BVECS) &&
1586 biovec_init_pool(&bs->bvec_pool, pool_size))
1587 goto bad;
1588
1589 if (!(flags & BIOSET_NEED_RESCUER))
1590 return 0;
1591
1592 bs->rescue_workqueue = alloc_workqueue("bioset", WQ_MEM_RECLAIM, 0);
1593 if (!bs->rescue_workqueue)
1594 goto bad;
1595
1596 return 0;
1597bad:
1598 bioset_exit(bs);
1599 return -ENOMEM;
1600}
1601EXPORT_SYMBOL(bioset_init);
1602
Jens Axboe28e89fd92018-06-07 14:42:05 -06001603/*
1604 * Initialize and setup a new bio_set, based on the settings from
1605 * another bio_set.
1606 */
1607int bioset_init_from_src(struct bio_set *bs, struct bio_set *src)
1608{
1609 int flags;
1610
1611 flags = 0;
1612 if (src->bvec_pool.min_nr)
1613 flags |= BIOSET_NEED_BVECS;
1614 if (src->rescue_workqueue)
1615 flags |= BIOSET_NEED_RESCUER;
1616
1617 return bioset_init(bs, src->bio_pool.min_nr, src->front_pad, flags);
1618}
1619EXPORT_SYMBOL(bioset_init_from_src);
1620
Christoph Hellwigde76fd82021-02-02 18:19:23 +01001621static int __init init_bio(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001622{
1623 int i;
1624
Martin K. Petersen7878cba2009-06-26 15:37:49 +02001625 bio_integrity_init();
Christoph Hellwigde76fd82021-02-02 18:19:23 +01001626
1627 for (i = 0; i < ARRAY_SIZE(bvec_slabs); i++) {
Jens Axboea7fcd372008-12-05 16:10:29 +01001628 struct biovec_slab *bvs = bvec_slabs + i;
1629
Christoph Hellwigde76fd82021-02-02 18:19:23 +01001630 bvs->slab = kmem_cache_create(bvs->name,
1631 bvs->nr_vecs * sizeof(struct bio_vec), 0,
1632 SLAB_HWCACHE_ALIGN | SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001633 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001634
Kent Overstreetf4f81542018-05-08 21:33:52 -04001635 if (bioset_init(&fs_bio_set, BIO_POOL_SIZE, 0, BIOSET_NEED_BVECS))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001636 panic("bio: can't allocate bios\n");
1637
Kent Overstreetf4f81542018-05-08 21:33:52 -04001638 if (bioset_integrity_create(&fs_bio_set, BIO_POOL_SIZE))
Martin K. Petersena91a2782011-03-17 11:11:05 +01001639 panic("bio: can't create integrity pool\n");
1640
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641 return 0;
1642}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643subsys_initcall(init_bio);