blob: ef88fa3afe4cb160a4f36c3a6203388e2ee5020c [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
Jens Axboebe4d2342021-03-08 11:37:47 -070028struct bio_alloc_cache {
29 struct bio_list free_list;
30 unsigned int nr;
31};
32
Christoph Hellwigde76fd82021-02-02 18:19:23 +010033static struct biovec_slab {
Christoph Hellwig6ac0b712021-02-02 18:19:20 +010034 int nr_vecs;
35 char *name;
36 struct kmem_cache *slab;
Christoph Hellwigde76fd82021-02-02 18:19:23 +010037} bvec_slabs[] __read_mostly = {
38 { .nr_vecs = 16, .name = "biovec-16" },
39 { .nr_vecs = 64, .name = "biovec-64" },
40 { .nr_vecs = 128, .name = "biovec-128" },
Christoph Hellwiga8affc02021-03-11 12:01:37 +010041 { .nr_vecs = BIO_MAX_VECS, .name = "biovec-max" },
Linus Torvalds1da177e2005-04-16 15:20:36 -070042};
Christoph Hellwig6ac0b712021-02-02 18:19:20 +010043
Christoph Hellwig7a800a22021-02-02 18:19:29 +010044static struct biovec_slab *biovec_slab(unsigned short nr_vecs)
45{
46 switch (nr_vecs) {
47 /* smaller bios use inline vecs */
48 case 5 ... 16:
49 return &bvec_slabs[0];
50 case 17 ... 64:
51 return &bvec_slabs[1];
52 case 65 ... 128:
53 return &bvec_slabs[2];
Christoph Hellwiga8affc02021-03-11 12:01:37 +010054 case 129 ... BIO_MAX_VECS:
Christoph Hellwig7a800a22021-02-02 18:19:29 +010055 return &bvec_slabs[3];
56 default:
57 BUG();
58 return NULL;
59 }
60}
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
62/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070063 * fs_bio_set is the bio_set containing bio and iovec memory pools used by
64 * IO code that does not need private memory pools.
65 */
Kent Overstreetf4f81542018-05-08 21:33:52 -040066struct bio_set fs_bio_set;
Kent Overstreet3f86a822012-09-06 15:35:01 -070067EXPORT_SYMBOL(fs_bio_set);
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
Jens Axboebb799ca2008-12-10 15:35:05 +010069/*
70 * Our slab pool management
71 */
72struct bio_slab {
73 struct kmem_cache *slab;
74 unsigned int slab_ref;
75 unsigned int slab_size;
76 char name[8];
77};
78static DEFINE_MUTEX(bio_slab_lock);
Ming Lei49d1ec82021-01-11 11:05:52 +080079static DEFINE_XARRAY(bio_slabs);
Jens Axboebb799ca2008-12-10 15:35:05 +010080
Ming Lei49d1ec82021-01-11 11:05:52 +080081static struct bio_slab *create_bio_slab(unsigned int size)
Jens Axboebb799ca2008-12-10 15:35:05 +010082{
Ming Lei49d1ec82021-01-11 11:05:52 +080083 struct bio_slab *bslab = kzalloc(sizeof(*bslab), GFP_KERNEL);
84
85 if (!bslab)
86 return NULL;
87
88 snprintf(bslab->name, sizeof(bslab->name), "bio-%d", size);
89 bslab->slab = kmem_cache_create(bslab->name, size,
90 ARCH_KMALLOC_MINALIGN, SLAB_HWCACHE_ALIGN, NULL);
91 if (!bslab->slab)
92 goto fail_alloc_slab;
93
94 bslab->slab_ref = 1;
95 bslab->slab_size = size;
96
97 if (!xa_err(xa_store(&bio_slabs, size, bslab, GFP_KERNEL)))
98 return bslab;
99
100 kmem_cache_destroy(bslab->slab);
101
102fail_alloc_slab:
103 kfree(bslab);
104 return NULL;
105}
106
107static inline unsigned int bs_bio_slab_size(struct bio_set *bs)
108{
Ming Lei9f180e32021-01-11 11:05:54 +0800109 return bs->front_pad + sizeof(struct bio) + bs->back_pad;
Ming Lei49d1ec82021-01-11 11:05:52 +0800110}
111
112static struct kmem_cache *bio_find_or_create_slab(struct bio_set *bs)
113{
114 unsigned int size = bs_bio_slab_size(bs);
115 struct bio_slab *bslab;
Jens Axboebb799ca2008-12-10 15:35:05 +0100116
117 mutex_lock(&bio_slab_lock);
Ming Lei49d1ec82021-01-11 11:05:52 +0800118 bslab = xa_load(&bio_slabs, size);
119 if (bslab)
120 bslab->slab_ref++;
121 else
122 bslab = create_bio_slab(size);
Jens Axboebb799ca2008-12-10 15:35:05 +0100123 mutex_unlock(&bio_slab_lock);
Ming Lei49d1ec82021-01-11 11:05:52 +0800124
125 if (bslab)
126 return bslab->slab;
127 return NULL;
Jens Axboebb799ca2008-12-10 15:35:05 +0100128}
129
130static void bio_put_slab(struct bio_set *bs)
131{
132 struct bio_slab *bslab = NULL;
Ming Lei49d1ec82021-01-11 11:05:52 +0800133 unsigned int slab_size = bs_bio_slab_size(bs);
Jens Axboebb799ca2008-12-10 15:35:05 +0100134
135 mutex_lock(&bio_slab_lock);
136
Ming Lei49d1ec82021-01-11 11:05:52 +0800137 bslab = xa_load(&bio_slabs, slab_size);
Jens Axboebb799ca2008-12-10 15:35:05 +0100138 if (WARN(!bslab, KERN_ERR "bio: unable to find slab!\n"))
139 goto out;
140
Ming Lei49d1ec82021-01-11 11:05:52 +0800141 WARN_ON_ONCE(bslab->slab != bs->bio_slab);
142
Jens Axboebb799ca2008-12-10 15:35:05 +0100143 WARN_ON(!bslab->slab_ref);
144
145 if (--bslab->slab_ref)
146 goto out;
147
Ming Lei49d1ec82021-01-11 11:05:52 +0800148 xa_erase(&bio_slabs, slab_size);
149
Jens Axboebb799ca2008-12-10 15:35:05 +0100150 kmem_cache_destroy(bslab->slab);
Ming Lei49d1ec82021-01-11 11:05:52 +0800151 kfree(bslab);
Jens Axboebb799ca2008-12-10 15:35:05 +0100152
153out:
154 mutex_unlock(&bio_slab_lock);
155}
156
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100157void bvec_free(mempool_t *pool, struct bio_vec *bv, unsigned short nr_vecs)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200158{
Christoph Hellwiga8affc02021-03-11 12:01:37 +0100159 BIO_BUG_ON(nr_vecs > BIO_MAX_VECS);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200160
Christoph Hellwiga8affc02021-03-11 12:01:37 +0100161 if (nr_vecs == BIO_MAX_VECS)
Kent Overstreet9f060e22012-10-12 15:29:33 -0700162 mempool_free(bv, pool);
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100163 else if (nr_vecs > BIO_INLINE_VECS)
164 kmem_cache_free(biovec_slab(nr_vecs)->slab, bv);
Jens Axboebb799ca2008-12-10 15:35:05 +0100165}
166
Christoph Hellwigf2c3eb92021-02-02 18:19:21 +0100167/*
168 * Make the first allocation restricted and don't dump info on allocation
169 * failures, since we'll fall back to the mempool in case of failure.
170 */
171static inline gfp_t bvec_alloc_gfp(gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172{
Christoph Hellwigf2c3eb92021-02-02 18:19:21 +0100173 return (gfp & ~(__GFP_DIRECT_RECLAIM | __GFP_IO)) |
174 __GFP_NOMEMALLOC | __GFP_NORETRY | __GFP_NOWARN;
175}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100177struct bio_vec *bvec_alloc(mempool_t *pool, unsigned short *nr_vecs,
178 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179{
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100180 struct biovec_slab *bvs = biovec_slab(*nr_vecs);
181
182 if (WARN_ON_ONCE(!bvs))
Jens Axboe7ff93452008-12-11 11:53:43 +0100183 return NULL;
Jens Axboe7ff93452008-12-11 11:53:43 +0100184
185 /*
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100186 * Upgrade the nr_vecs request to take full advantage of the allocation.
187 * We also rely on this in the bvec_free path.
Jens Axboe7ff93452008-12-11 11:53:43 +0100188 */
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100189 *nr_vecs = bvs->nr_vecs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 /*
Christoph Hellwigf007a3d2021-02-02 18:19:22 +0100192 * Try a slab allocation first for all smaller allocations. If that
193 * fails and __GFP_DIRECT_RECLAIM is set retry with the mempool.
Christoph Hellwiga8affc02021-03-11 12:01:37 +0100194 * The mempool is sized to handle up to BIO_MAX_VECS entries.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 */
Christoph Hellwiga8affc02021-03-11 12:01:37 +0100196 if (*nr_vecs < BIO_MAX_VECS) {
Christoph Hellwigf007a3d2021-02-02 18:19:22 +0100197 struct bio_vec *bvl;
Jens Axboe7ff93452008-12-11 11:53:43 +0100198
Christoph Hellwigf2c3eb92021-02-02 18:19:21 +0100199 bvl = kmem_cache_alloc(bvs->slab, bvec_alloc_gfp(gfp_mask));
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100200 if (likely(bvl) || !(gfp_mask & __GFP_DIRECT_RECLAIM))
Christoph Hellwigf007a3d2021-02-02 18:19:22 +0100201 return bvl;
Christoph Hellwiga8affc02021-03-11 12:01:37 +0100202 *nr_vecs = BIO_MAX_VECS;
Jens Axboe7ff93452008-12-11 11:53:43 +0100203 }
204
Christoph Hellwigf007a3d2021-02-02 18:19:22 +0100205 return mempool_alloc(pool, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206}
207
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600208void bio_uninit(struct bio *bio)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700209{
Christoph Hellwigdb9819c2020-06-27 09:31:47 +0200210#ifdef CONFIG_BLK_CGROUP
211 if (bio->bi_blkg) {
212 blkg_put(bio->bi_blkg);
213 bio->bi_blkg = NULL;
214 }
215#endif
Justin Teeece841a2019-12-05 10:09:01 +0800216 if (bio_integrity(bio))
217 bio_integrity_free(bio);
Satya Tangiralaa892c8d2020-05-14 00:37:18 +0000218
219 bio_crypt_free_ctx(bio);
Kent Overstreet4254bba2012-09-06 15:35:00 -0700220}
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600221EXPORT_SYMBOL(bio_uninit);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200222
Kent Overstreet4254bba2012-09-06 15:35:00 -0700223static void bio_free(struct bio *bio)
224{
225 struct bio_set *bs = bio->bi_pool;
226 void *p;
227
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600228 bio_uninit(bio);
Kent Overstreet4254bba2012-09-06 15:35:00 -0700229
230 if (bs) {
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100231 bvec_free(&bs->bvec_pool, bio->bi_io_vec, bio->bi_max_vecs);
Kent Overstreet4254bba2012-09-06 15:35:00 -0700232
233 /*
234 * If we have front padding, adjust the bio pointer before freeing
235 */
236 p = bio;
Jens Axboebb799ca2008-12-10 15:35:05 +0100237 p -= bs->front_pad;
238
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400239 mempool_free(p, &bs->bio_pool);
Kent Overstreet4254bba2012-09-06 15:35:00 -0700240 } else {
241 /* Bio was allocated by bio_kmalloc() */
242 kfree(bio);
243 }
Peter Osterlund36763472005-09-06 15:16:42 -0700244}
245
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600246/*
247 * Users of this function have their own bio allocation. Subsequently,
248 * they must remember to pair any call to bio_init() with bio_uninit()
249 * when IO has completed, or when the bio is released.
250 */
Ming Lei3a83f462016-11-22 08:57:21 -0700251void bio_init(struct bio *bio, struct bio_vec *table,
252 unsigned short max_vecs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253{
Jens Axboeda521622021-08-11 09:20:04 -0600254 bio->bi_next = NULL;
255 bio->bi_bdev = NULL;
256 bio->bi_opf = 0;
257 bio->bi_flags = 0;
258 bio->bi_ioprio = 0;
259 bio->bi_write_hint = 0;
260 bio->bi_status = 0;
261 bio->bi_iter.bi_sector = 0;
262 bio->bi_iter.bi_size = 0;
263 bio->bi_iter.bi_idx = 0;
264 bio->bi_iter.bi_bvec_done = 0;
265 bio->bi_end_io = NULL;
266 bio->bi_private = NULL;
267#ifdef CONFIG_BLK_CGROUP
268 bio->bi_blkg = NULL;
269 bio->bi_issue.value = 0;
270#ifdef CONFIG_BLK_CGROUP_IOCOST
271 bio->bi_iocost_cost = 0;
272#endif
273#endif
274#ifdef CONFIG_BLK_INLINE_ENCRYPTION
275 bio->bi_crypt_context = NULL;
276#endif
277#ifdef CONFIG_BLK_DEV_INTEGRITY
278 bio->bi_integrity = NULL;
279#endif
280 bio->bi_vcnt = 0;
281
Jens Axboec4cf5262015-04-17 16:15:18 -0600282 atomic_set(&bio->__bi_remaining, 1);
Jens Axboedac56212015-04-17 16:23:59 -0600283 atomic_set(&bio->__bi_cnt, 1);
Ming Lei3a83f462016-11-22 08:57:21 -0700284
Ming Lei3a83f462016-11-22 08:57:21 -0700285 bio->bi_max_vecs = max_vecs;
Jens Axboeda521622021-08-11 09:20:04 -0600286 bio->bi_io_vec = table;
287 bio->bi_pool = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200289EXPORT_SYMBOL(bio_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290
291/**
Kent Overstreetf44b48c72012-09-06 15:34:58 -0700292 * bio_reset - reinitialize a bio
293 * @bio: bio to reset
294 *
295 * Description:
296 * After calling bio_reset(), @bio will be in the same state as a freshly
297 * allocated bio returned bio bio_alloc_bioset() - the only fields that are
298 * preserved are the ones that are initialized by bio_alloc_bioset(). See
299 * comment in struct bio.
300 */
301void bio_reset(struct bio *bio)
302{
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600303 bio_uninit(bio);
Kent Overstreetf44b48c72012-09-06 15:34:58 -0700304 memset(bio, 0, BIO_RESET_BYTES);
Jens Axboec4cf5262015-04-17 16:15:18 -0600305 atomic_set(&bio->__bi_remaining, 1);
Kent Overstreetf44b48c72012-09-06 15:34:58 -0700306}
307EXPORT_SYMBOL(bio_reset);
308
Christoph Hellwig38f8baa2016-03-11 17:34:51 +0100309static struct bio *__bio_chain_endio(struct bio *bio)
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800310{
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200311 struct bio *parent = bio->bi_private;
312
Yufen Yu3edf5342021-03-31 07:53:59 -0400313 if (bio->bi_status && !parent->bi_status)
Christoph Hellwig4e4cbee2017-06-03 09:38:06 +0200314 parent->bi_status = bio->bi_status;
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800315 bio_put(bio);
Christoph Hellwig38f8baa2016-03-11 17:34:51 +0100316 return parent;
317}
318
319static void bio_chain_endio(struct bio *bio)
320{
321 bio_endio(__bio_chain_endio(bio));
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800322}
323
324/**
325 * bio_chain - chain bio completions
Randy Dunlap1051a902014-04-20 16:03:31 -0700326 * @bio: the target bio
Mauro Carvalho Chehab5b874af2020-08-27 07:51:44 +0200327 * @parent: the parent bio of @bio
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800328 *
329 * The caller won't have a bi_end_io called when @bio completes - instead,
330 * @parent's bi_end_io won't be called until both @parent and @bio have
331 * completed; the chained bio will also be freed when it completes.
332 *
333 * The caller must not set bi_private or bi_end_io in @bio.
334 */
335void bio_chain(struct bio *bio, struct bio *parent)
336{
337 BUG_ON(bio->bi_private || bio->bi_end_io);
338
339 bio->bi_private = parent;
340 bio->bi_end_io = bio_chain_endio;
Jens Axboec4cf5262015-04-17 16:15:18 -0600341 bio_inc_remaining(parent);
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800342}
343EXPORT_SYMBOL(bio_chain);
344
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700345static void bio_alloc_rescue(struct work_struct *work)
346{
347 struct bio_set *bs = container_of(work, struct bio_set, rescue_work);
348 struct bio *bio;
349
350 while (1) {
351 spin_lock(&bs->rescue_lock);
352 bio = bio_list_pop(&bs->rescue_list);
353 spin_unlock(&bs->rescue_lock);
354
355 if (!bio)
356 break;
357
Christoph Hellwiged00aab2020-07-01 10:59:44 +0200358 submit_bio_noacct(bio);
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700359 }
360}
361
362static void punt_bios_to_rescuer(struct bio_set *bs)
363{
364 struct bio_list punt, nopunt;
365 struct bio *bio;
366
NeilBrown47e0fb42017-06-18 14:38:57 +1000367 if (WARN_ON_ONCE(!bs->rescue_workqueue))
368 return;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700369 /*
370 * In order to guarantee forward progress we must punt only bios that
371 * were allocated from this bio_set; otherwise, if there was a bio on
372 * there for a stacking driver higher up in the stack, processing it
373 * could require allocating bios from this bio_set, and doing that from
374 * our own rescuer would be bad.
375 *
376 * Since bio lists are singly linked, pop them all instead of trying to
377 * remove from the middle of the list:
378 */
379
380 bio_list_init(&punt);
381 bio_list_init(&nopunt);
382
NeilBrownf5fe1b52017-03-10 17:00:47 +1100383 while ((bio = bio_list_pop(&current->bio_list[0])))
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700384 bio_list_add(bio->bi_pool == bs ? &punt : &nopunt, bio);
NeilBrownf5fe1b52017-03-10 17:00:47 +1100385 current->bio_list[0] = nopunt;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700386
NeilBrownf5fe1b52017-03-10 17:00:47 +1100387 bio_list_init(&nopunt);
388 while ((bio = bio_list_pop(&current->bio_list[1])))
389 bio_list_add(bio->bi_pool == bs ? &punt : &nopunt, bio);
390 current->bio_list[1] = nopunt;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700391
392 spin_lock(&bs->rescue_lock);
393 bio_list_merge(&bs->rescue_list, &punt);
394 spin_unlock(&bs->rescue_lock);
395
396 queue_work(bs->rescue_workqueue, &bs->rescue_work);
397}
398
Kent Overstreetf44b48c72012-09-06 15:34:58 -0700399/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 * bio_alloc_bioset - allocate a bio for I/O
Randy Dunlap519c8e92017-10-16 11:01:00 -0700401 * @gfp_mask: the GFP_* mask given to the slab allocator
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 * @nr_iovecs: number of iovecs to pre-allocate
Jaak Ristiojadb18efa2010-01-15 12:05:07 +0200403 * @bs: the bio_set to allocate from.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 *
Christoph Hellwig31751992021-01-26 15:52:34 +0100405 * Allocate a bio from the mempools in @bs.
Kent Overstreet3f86a822012-09-06 15:35:01 -0700406 *
Christoph Hellwig31751992021-01-26 15:52:34 +0100407 * If %__GFP_DIRECT_RECLAIM is set then bio_alloc will always be able to
408 * allocate a bio. This is due to the mempool guarantees. To make this work,
409 * callers must never allocate more than 1 bio at a time from the general pool.
410 * Callers that need to allocate more than 1 bio must always submit the
411 * previously allocated bio for IO before attempting to allocate a new one.
412 * Failure to do so can cause deadlocks under memory pressure.
Kent Overstreet3f86a822012-09-06 15:35:01 -0700413 *
Christoph Hellwig31751992021-01-26 15:52:34 +0100414 * Note that when running under submit_bio_noacct() (i.e. any block driver),
415 * bios are not submitted until after you return - see the code in
416 * submit_bio_noacct() that converts recursion into iteration, to prevent
417 * stack overflows.
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700418 *
Christoph Hellwig31751992021-01-26 15:52:34 +0100419 * This would normally mean allocating multiple bios under submit_bio_noacct()
420 * would be susceptible to deadlocks, but we have
421 * deadlock avoidance code that resubmits any blocked bios from a rescuer
422 * thread.
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700423 *
Christoph Hellwig31751992021-01-26 15:52:34 +0100424 * However, we do not guarantee forward progress for allocations from other
425 * mempools. Doing multiple allocations from the same mempool under
426 * submit_bio_noacct() should be avoided - instead, use bio_set's front_pad
427 * for per bio allocations.
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700428 *
Christoph Hellwig31751992021-01-26 15:52:34 +0100429 * Returns: Pointer to new bio on success, NULL on failure.
Kent Overstreet3f86a822012-09-06 15:35:01 -0700430 */
Christoph Hellwig0f2e6ab2021-02-02 18:19:24 +0100431struct bio *bio_alloc_bioset(gfp_t gfp_mask, unsigned short nr_iovecs,
Dan Carpenter7a88fa12017-03-23 13:24:55 +0300432 struct bio_set *bs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700433{
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700434 gfp_t saved_gfp = gfp_mask;
Tejun Heo451a9eb2009-04-15 19:50:51 +0200435 struct bio *bio;
436 void *p;
Jens Axboe0a0d96b2008-09-11 13:17:37 +0200437
Christoph Hellwig31751992021-01-26 15:52:34 +0100438 /* should not use nobvec bioset for nr_iovecs > 0 */
439 if (WARN_ON_ONCE(!mempool_initialized(&bs->bvec_pool) && nr_iovecs > 0))
440 return NULL;
Kent Overstreet3f86a822012-09-06 15:35:01 -0700441
Christoph Hellwig31751992021-01-26 15:52:34 +0100442 /*
443 * submit_bio_noacct() converts recursion to iteration; this means if
444 * we're running beneath it, any bios we allocate and submit will not be
445 * submitted (and thus freed) until after we return.
446 *
447 * This exposes us to a potential deadlock if we allocate multiple bios
448 * from the same bio_set() while running underneath submit_bio_noacct().
449 * If we were to allocate multiple bios (say a stacking block driver
450 * that was splitting bios), we would deadlock if we exhausted the
451 * mempool's reserve.
452 *
453 * We solve this, and guarantee forward progress, with a rescuer
454 * workqueue per bio_set. If we go to allocate and there are bios on
455 * current->bio_list, we first try the allocation without
456 * __GFP_DIRECT_RECLAIM; if that fails, we punt those bios we would be
457 * blocking to the rescuer workqueue before we retry with the original
458 * gfp_flags.
459 */
460 if (current->bio_list &&
461 (!bio_list_empty(&current->bio_list[0]) ||
462 !bio_list_empty(&current->bio_list[1])) &&
463 bs->rescue_workqueue)
464 gfp_mask &= ~__GFP_DIRECT_RECLAIM;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700465
Christoph Hellwig31751992021-01-26 15:52:34 +0100466 p = mempool_alloc(&bs->bio_pool, gfp_mask);
467 if (!p && gfp_mask != saved_gfp) {
468 punt_bios_to_rescuer(bs);
469 gfp_mask = saved_gfp;
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400470 p = mempool_alloc(&bs->bio_pool, gfp_mask);
Kent Overstreet3f86a822012-09-06 15:35:01 -0700471 }
Tejun Heo451a9eb2009-04-15 19:50:51 +0200472 if (unlikely(!p))
473 return NULL;
Ingo Molnar34053972009-02-21 11:16:36 +0100474
Christoph Hellwig31751992021-01-26 15:52:34 +0100475 bio = p + bs->front_pad;
476 if (nr_iovecs > BIO_INLINE_VECS) {
Christoph Hellwig31751992021-01-26 15:52:34 +0100477 struct bio_vec *bvl = NULL;
Ingo Molnar34053972009-02-21 11:16:36 +0100478
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100479 bvl = bvec_alloc(&bs->bvec_pool, &nr_iovecs, gfp_mask);
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700480 if (!bvl && gfp_mask != saved_gfp) {
481 punt_bios_to_rescuer(bs);
482 gfp_mask = saved_gfp;
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100483 bvl = bvec_alloc(&bs->bvec_pool, &nr_iovecs, gfp_mask);
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700484 }
Ingo Molnar34053972009-02-21 11:16:36 +0100485 if (unlikely(!bvl))
486 goto err_free;
Kent Overstreeta38352e2012-05-25 13:03:11 -0700487
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100488 bio_init(bio, bvl, nr_iovecs);
Kent Overstreet3f86a822012-09-06 15:35:01 -0700489 } else if (nr_iovecs) {
Christoph Hellwig31751992021-01-26 15:52:34 +0100490 bio_init(bio, bio->bi_inline_vecs, BIO_INLINE_VECS);
491 } else {
492 bio_init(bio, NULL, 0);
Ingo Molnar34053972009-02-21 11:16:36 +0100493 }
Kent Overstreet3f86a822012-09-06 15:35:01 -0700494
495 bio->bi_pool = bs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496 return bio;
Ingo Molnar34053972009-02-21 11:16:36 +0100497
498err_free:
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400499 mempool_free(p, &bs->bio_pool);
Ingo Molnar34053972009-02-21 11:16:36 +0100500 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200502EXPORT_SYMBOL(bio_alloc_bioset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700503
Christoph Hellwig31751992021-01-26 15:52:34 +0100504/**
505 * bio_kmalloc - kmalloc a bio for I/O
506 * @gfp_mask: the GFP_* mask given to the slab allocator
507 * @nr_iovecs: number of iovecs to pre-allocate
508 *
509 * Use kmalloc to allocate and initialize a bio.
510 *
511 * Returns: Pointer to new bio on success, NULL on failure.
512 */
Christoph Hellwig0f2e6ab2021-02-02 18:19:24 +0100513struct bio *bio_kmalloc(gfp_t gfp_mask, unsigned short nr_iovecs)
Christoph Hellwig31751992021-01-26 15:52:34 +0100514{
515 struct bio *bio;
516
517 if (nr_iovecs > UIO_MAXIOV)
518 return NULL;
519
520 bio = kmalloc(struct_size(bio, bi_inline_vecs, nr_iovecs), gfp_mask);
521 if (unlikely(!bio))
522 return NULL;
523 bio_init(bio, nr_iovecs ? bio->bi_inline_vecs : NULL, nr_iovecs);
524 bio->bi_pool = NULL;
525 return bio;
526}
527EXPORT_SYMBOL(bio_kmalloc);
528
Christoph Hellwig6f822e12021-04-12 15:46:57 +0200529void zero_fill_bio(struct bio *bio)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530{
531 unsigned long flags;
Kent Overstreet79886132013-11-23 17:19:00 -0800532 struct bio_vec bv;
533 struct bvec_iter iter;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534
Christoph Hellwig6f822e12021-04-12 15:46:57 +0200535 bio_for_each_segment(bv, bio, iter) {
Kent Overstreet79886132013-11-23 17:19:00 -0800536 char *data = bvec_kmap_irq(&bv, &flags);
537 memset(data, 0, bv.bv_len);
538 flush_dcache_page(bv.bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 bvec_kunmap_irq(data, &flags);
540 }
541}
Christoph Hellwig6f822e12021-04-12 15:46:57 +0200542EXPORT_SYMBOL(zero_fill_bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543
Ming Lei83c9c542020-01-05 09:41:14 +0800544/**
545 * bio_truncate - truncate the bio to small size of @new_size
546 * @bio: the bio to be truncated
547 * @new_size: new size for truncating the bio
548 *
549 * Description:
550 * Truncate the bio to new size of @new_size. If bio_op(bio) is
551 * REQ_OP_READ, zero the truncated part. This function should only
552 * be used for handling corner cases, such as bio eod.
553 */
Ming Lei85a8ce62019-12-28 07:05:48 +0800554void bio_truncate(struct bio *bio, unsigned new_size)
555{
556 struct bio_vec bv;
557 struct bvec_iter iter;
558 unsigned int done = 0;
559 bool truncated = false;
560
561 if (new_size >= bio->bi_iter.bi_size)
562 return;
563
Ming Lei83c9c542020-01-05 09:41:14 +0800564 if (bio_op(bio) != REQ_OP_READ)
Ming Lei85a8ce62019-12-28 07:05:48 +0800565 goto exit;
566
567 bio_for_each_segment(bv, bio, iter) {
568 if (done + bv.bv_len > new_size) {
569 unsigned offset;
570
571 if (!truncated)
572 offset = new_size - done;
573 else
574 offset = 0;
575 zero_user(bv.bv_page, offset, bv.bv_len - offset);
576 truncated = true;
577 }
578 done += bv.bv_len;
579 }
580
581 exit:
582 /*
583 * Don't touch bvec table here and make it really immutable, since
584 * fs bio user has to retrieve all pages via bio_for_each_segment_all
585 * in its .end_bio() callback.
586 *
587 * It is enough to truncate bio by updating .bi_size since we can make
588 * correct bvec with the updated .bi_size for drivers.
589 */
590 bio->bi_iter.bi_size = new_size;
591}
592
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593/**
Christoph Hellwig29125ed2020-03-25 16:48:40 +0100594 * guard_bio_eod - truncate a BIO to fit the block device
595 * @bio: bio to truncate
596 *
597 * This allows us to do IO even on the odd last sectors of a device, even if the
598 * block size is some multiple of the physical sector size.
599 *
600 * We'll just truncate the bio to the size of the device, and clear the end of
601 * the buffer head manually. Truly out-of-range accesses will turn into actual
602 * I/O errors, this only handles the "we need to be able to do I/O at the final
603 * sector" case.
604 */
605void guard_bio_eod(struct bio *bio)
606{
Christoph Hellwig309dca302021-01-24 11:02:34 +0100607 sector_t maxsector = bdev_nr_sectors(bio->bi_bdev);
Christoph Hellwig29125ed2020-03-25 16:48:40 +0100608
609 if (!maxsector)
610 return;
611
612 /*
613 * If the *whole* IO is past the end of the device,
614 * let it through, and the IO layer will turn it into
615 * an EIO.
616 */
617 if (unlikely(bio->bi_iter.bi_sector >= maxsector))
618 return;
619
620 maxsector -= bio->bi_iter.bi_sector;
621 if (likely((bio->bi_iter.bi_size >> 9) <= maxsector))
622 return;
623
624 bio_truncate(bio, maxsector << 9);
625}
626
Jens Axboebe4d2342021-03-08 11:37:47 -0700627#define ALLOC_CACHE_MAX 512
628#define ALLOC_CACHE_SLACK 64
629
630static void bio_alloc_cache_prune(struct bio_alloc_cache *cache,
631 unsigned int nr)
632{
633 unsigned int i = 0;
634 struct bio *bio;
635
636 while ((bio = bio_list_pop(&cache->free_list)) != NULL) {
637 cache->nr--;
638 bio_free(bio);
639 if (++i == nr)
640 break;
641 }
642}
643
644static int bio_cpu_dead(unsigned int cpu, struct hlist_node *node)
645{
646 struct bio_set *bs;
647
648 bs = hlist_entry_safe(node, struct bio_set, cpuhp_dead);
649 if (bs->cache) {
650 struct bio_alloc_cache *cache = per_cpu_ptr(bs->cache, cpu);
651
652 bio_alloc_cache_prune(cache, -1U);
653 }
654 return 0;
655}
656
657static void bio_alloc_cache_destroy(struct bio_set *bs)
658{
659 int cpu;
660
661 if (!bs->cache)
662 return;
663
664 cpuhp_state_remove_instance_nocalls(CPUHP_BIO_DEAD, &bs->cpuhp_dead);
665 for_each_possible_cpu(cpu) {
666 struct bio_alloc_cache *cache;
667
668 cache = per_cpu_ptr(bs->cache, cpu);
669 bio_alloc_cache_prune(cache, -1U);
670 }
671 free_percpu(bs->cache);
672}
673
Christoph Hellwig29125ed2020-03-25 16:48:40 +0100674/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 * bio_put - release a reference to a bio
676 * @bio: bio to release reference to
677 *
678 * Description:
679 * Put a reference to a &struct bio, either one you have gotten with
NeilBrown9b10f6a2017-06-18 14:38:59 +1000680 * bio_alloc, bio_get or bio_clone_*. The last put of a bio will free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 **/
682void bio_put(struct bio *bio)
683{
Jens Axboebe4d2342021-03-08 11:37:47 -0700684 if (unlikely(bio_flagged(bio, BIO_REFFED))) {
Jens Axboedac56212015-04-17 16:23:59 -0600685 BIO_BUG_ON(!atomic_read(&bio->__bi_cnt));
Jens Axboebe4d2342021-03-08 11:37:47 -0700686 if (!atomic_dec_and_test(&bio->__bi_cnt))
687 return;
688 }
Jens Axboedac56212015-04-17 16:23:59 -0600689
Jens Axboebe4d2342021-03-08 11:37:47 -0700690 if (bio_flagged(bio, BIO_PERCPU_CACHE)) {
691 struct bio_alloc_cache *cache;
692
693 bio_uninit(bio);
694 cache = per_cpu_ptr(bio->bi_pool->cache, get_cpu());
695 bio_list_add_head(&cache->free_list, bio);
696 if (++cache->nr > ALLOC_CACHE_MAX + ALLOC_CACHE_SLACK)
697 bio_alloc_cache_prune(cache, ALLOC_CACHE_SLACK);
698 put_cpu();
699 } else {
700 bio_free(bio);
Jens Axboedac56212015-04-17 16:23:59 -0600701 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200703EXPORT_SYMBOL(bio_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705/**
Kent Overstreet59d276f2013-11-23 18:19:27 -0800706 * __bio_clone_fast - clone a bio that shares the original bio's biovec
707 * @bio: destination bio
708 * @bio_src: bio to clone
709 *
710 * Clone a &bio. Caller will own the returned bio, but not
711 * the actual data it points to. Reference count of returned
712 * bio will be one.
713 *
714 * Caller must ensure that @bio_src is not freed before @bio.
715 */
716void __bio_clone_fast(struct bio *bio, struct bio *bio_src)
717{
Christoph Hellwig7a800a22021-02-02 18:19:29 +0100718 WARN_ON_ONCE(bio->bi_pool && bio->bi_max_vecs);
Kent Overstreet59d276f2013-11-23 18:19:27 -0800719
720 /*
Christoph Hellwig309dca302021-01-24 11:02:34 +0100721 * most users will be overriding ->bi_bdev with a new target,
Kent Overstreet59d276f2013-11-23 18:19:27 -0800722 * so we don't set nor calculate new physical/hw segment counts here
723 */
Christoph Hellwig309dca302021-01-24 11:02:34 +0100724 bio->bi_bdev = bio_src->bi_bdev;
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600725 bio_set_flag(bio, BIO_CLONED);
Shaohua Li111be882017-12-20 11:10:17 -0700726 if (bio_flagged(bio_src, BIO_THROTTLED))
727 bio_set_flag(bio, BIO_THROTTLED);
Christoph Hellwig46bbf652021-01-26 15:33:08 +0100728 if (bio_flagged(bio_src, BIO_REMAPPED))
729 bio_set_flag(bio, BIO_REMAPPED);
Jens Axboe1eff9d32016-08-05 15:35:16 -0600730 bio->bi_opf = bio_src->bi_opf;
Hannes Reineckeca474b72018-11-12 10:35:25 -0700731 bio->bi_ioprio = bio_src->bi_ioprio;
Jens Axboecb6934f2017-06-27 09:22:02 -0600732 bio->bi_write_hint = bio_src->bi_write_hint;
Kent Overstreet59d276f2013-11-23 18:19:27 -0800733 bio->bi_iter = bio_src->bi_iter;
734 bio->bi_io_vec = bio_src->bi_io_vec;
Paolo Valente20bd7232016-07-27 07:22:05 +0200735
Dennis Zhoudb6638d2018-12-05 12:10:35 -0500736 bio_clone_blkg_association(bio, bio_src);
Dennis Zhoue439bed2018-12-05 12:10:32 -0500737 blkcg_bio_issue_init(bio);
Kent Overstreet59d276f2013-11-23 18:19:27 -0800738}
739EXPORT_SYMBOL(__bio_clone_fast);
740
741/**
742 * bio_clone_fast - clone a bio that shares the original bio's biovec
743 * @bio: bio to clone
744 * @gfp_mask: allocation priority
745 * @bs: bio_set to allocate from
746 *
747 * Like __bio_clone_fast, only also allocates the returned bio
748 */
749struct bio *bio_clone_fast(struct bio *bio, gfp_t gfp_mask, struct bio_set *bs)
750{
751 struct bio *b;
752
753 b = bio_alloc_bioset(gfp_mask, 0, bs);
754 if (!b)
755 return NULL;
756
757 __bio_clone_fast(b, bio);
758
Eric Biggers07560152020-09-15 20:53:13 -0700759 if (bio_crypt_clone(b, bio, gfp_mask) < 0)
760 goto err_put;
Satya Tangiralaa892c8d2020-05-14 00:37:18 +0000761
Eric Biggers07560152020-09-15 20:53:13 -0700762 if (bio_integrity(bio) &&
763 bio_integrity_clone(b, bio, gfp_mask) < 0)
764 goto err_put;
Kent Overstreet59d276f2013-11-23 18:19:27 -0800765
766 return b;
Eric Biggers07560152020-09-15 20:53:13 -0700767
768err_put:
769 bio_put(b);
770 return NULL;
Kent Overstreet59d276f2013-11-23 18:19:27 -0800771}
772EXPORT_SYMBOL(bio_clone_fast);
773
Christoph Hellwig5cbd28e2020-03-24 08:25:12 +0100774const char *bio_devname(struct bio *bio, char *buf)
775{
Christoph Hellwig309dca302021-01-24 11:02:34 +0100776 return bdevname(bio->bi_bdev, buf);
Christoph Hellwig5cbd28e2020-03-24 08:25:12 +0100777}
778EXPORT_SYMBOL(bio_devname);
779
Ming Lei59194822019-03-17 18:01:07 +0800780static inline bool page_is_mergeable(const struct bio_vec *bv,
781 struct page *page, unsigned int len, unsigned int off,
Christoph Hellwigff896732019-06-17 11:14:11 +0200782 bool *same_page)
Ming Lei59194822019-03-17 18:01:07 +0800783{
Matthew Wilcox (Oracle)d8166512020-08-17 20:52:06 +0100784 size_t bv_end = bv->bv_offset + bv->bv_len;
785 phys_addr_t vec_end_addr = page_to_phys(bv->bv_page) + bv_end - 1;
Ming Lei59194822019-03-17 18:01:07 +0800786 phys_addr_t page_addr = page_to_phys(page);
787
788 if (vec_end_addr + 1 != page_addr + off)
789 return false;
790 if (xen_domain() && !xen_biovec_phys_mergeable(bv, page))
791 return false;
Christoph Hellwig52d52d12019-04-11 08:23:31 +0200792
Christoph Hellwigff896732019-06-17 11:14:11 +0200793 *same_page = ((vec_end_addr & PAGE_MASK) == page_addr);
Matthew Wilcox (Oracle)d8166512020-08-17 20:52:06 +0100794 if (*same_page)
795 return true;
796 return (bv->bv_page + bv_end / PAGE_SIZE) == (page + off / PAGE_SIZE);
Ming Lei59194822019-03-17 18:01:07 +0800797}
798
Christoph Hellwige4581102020-05-12 17:55:46 +0900799/*
800 * Try to merge a page into a segment, while obeying the hardware segment
801 * size limit. This is not for normal read/write bios, but for passthrough
802 * or Zone Append operations that we can't split.
803 */
804static bool bio_try_merge_hw_seg(struct request_queue *q, struct bio *bio,
805 struct page *page, unsigned len,
806 unsigned offset, bool *same_page)
Ming Lei489fbbc2019-03-29 15:08:00 +0800807{
Christoph Hellwig384209c2019-08-12 17:39:57 +0200808 struct bio_vec *bv = &bio->bi_io_vec[bio->bi_vcnt - 1];
Ming Lei489fbbc2019-03-29 15:08:00 +0800809 unsigned long mask = queue_segment_boundary(q);
810 phys_addr_t addr1 = page_to_phys(bv->bv_page) + bv->bv_offset;
811 phys_addr_t addr2 = page_to_phys(page) + offset + len - 1;
812
813 if ((addr1 | mask) != (addr2 | mask))
814 return false;
Ming Lei489fbbc2019-03-29 15:08:00 +0800815 if (bv->bv_len + len > queue_max_segment_size(q))
816 return false;
Christoph Hellwig384209c2019-08-12 17:39:57 +0200817 return __bio_try_merge_page(bio, page, len, offset, same_page);
Ming Lei489fbbc2019-03-29 15:08:00 +0800818}
819
Shaohua Lif4595872017-03-24 10:34:43 -0700820/**
Christoph Hellwige4581102020-05-12 17:55:46 +0900821 * bio_add_hw_page - attempt to add a page to a bio with hw constraints
822 * @q: the target queue
823 * @bio: destination bio
824 * @page: page to add
825 * @len: vec entry length
826 * @offset: vec entry offset
827 * @max_sectors: maximum number of sectors that can be added
828 * @same_page: return if the segment has been merged inside the same page
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 *
Christoph Hellwige4581102020-05-12 17:55:46 +0900830 * Add a page to a bio while respecting the hardware max_sectors, max_segment
831 * and gap limitations.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 */
Christoph Hellwige4581102020-05-12 17:55:46 +0900833int bio_add_hw_page(struct request_queue *q, struct bio *bio,
Ming Lei19047082019-03-17 18:01:08 +0800834 struct page *page, unsigned int len, unsigned int offset,
Christoph Hellwige4581102020-05-12 17:55:46 +0900835 unsigned int max_sectors, bool *same_page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 struct bio_vec *bvec;
838
Christoph Hellwige4581102020-05-12 17:55:46 +0900839 if (WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED)))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840 return 0;
841
Christoph Hellwige4581102020-05-12 17:55:46 +0900842 if (((bio->bi_iter.bi_size + len) >> 9) > max_sectors)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 return 0;
844
Jens Axboe80cfd542006-01-06 09:43:28 +0100845 if (bio->bi_vcnt > 0) {
Christoph Hellwige4581102020-05-12 17:55:46 +0900846 if (bio_try_merge_hw_seg(q, bio, page, len, offset, same_page))
Christoph Hellwig384209c2019-08-12 17:39:57 +0200847 return len;
Christoph Hellwig320ea862019-08-12 17:39:56 +0200848
849 /*
850 * If the queue doesn't support SG gaps and adding this segment
851 * would create a gap, disallow it.
852 */
Christoph Hellwig384209c2019-08-12 17:39:57 +0200853 bvec = &bio->bi_io_vec[bio->bi_vcnt - 1];
Christoph Hellwig320ea862019-08-12 17:39:56 +0200854 if (bvec_gap_to_prev(q, bvec, offset))
855 return 0;
Jens Axboe80cfd542006-01-06 09:43:28 +0100856 }
857
Ming Lei79d08f82019-07-01 15:14:46 +0800858 if (bio_full(bio, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 return 0;
860
Christoph Hellwig14ccb662019-06-06 12:29:01 +0200861 if (bio->bi_vcnt >= queue_max_segments(q))
Ming Lei489fbbc2019-03-29 15:08:00 +0800862 return 0;
863
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 bvec = &bio->bi_io_vec[bio->bi_vcnt];
865 bvec->bv_page = page;
866 bvec->bv_len = len;
867 bvec->bv_offset = offset;
Maurizio Lombardifcbf6a02014-12-10 14:16:53 -0800868 bio->bi_vcnt++;
Christoph Hellwigdcdca752019-04-25 09:04:35 +0200869 bio->bi_iter.bi_size += len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 return len;
871}
Ming Lei19047082019-03-17 18:01:08 +0800872
Christoph Hellwige4581102020-05-12 17:55:46 +0900873/**
874 * bio_add_pc_page - attempt to add page to passthrough bio
875 * @q: the target queue
876 * @bio: destination bio
877 * @page: page to add
878 * @len: vec entry length
879 * @offset: vec entry offset
880 *
881 * Attempt to add a page to the bio_vec maplist. This can fail for a
882 * number of reasons, such as the bio being full or target block device
883 * limitations. The target block device must allow bio's up to PAGE_SIZE,
884 * so it is always possible to add a single page to an empty bio.
885 *
886 * This should only be used by passthrough bios.
887 */
Ming Lei19047082019-03-17 18:01:08 +0800888int bio_add_pc_page(struct request_queue *q, struct bio *bio,
889 struct page *page, unsigned int len, unsigned int offset)
890{
Christoph Hellwigd1916c82019-08-12 17:39:58 +0200891 bool same_page = false;
Christoph Hellwige4581102020-05-12 17:55:46 +0900892 return bio_add_hw_page(q, bio, page, len, offset,
893 queue_max_hw_sectors(q), &same_page);
Ming Lei19047082019-03-17 18:01:08 +0800894}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200895EXPORT_SYMBOL(bio_add_pc_page);
Mike Christie6e68af62005-11-11 05:30:27 -0600896
897/**
Johannes Thumshirnae293332021-02-04 19:21:40 +0900898 * bio_add_zone_append_page - attempt to add page to zone-append bio
899 * @bio: destination bio
900 * @page: page to add
901 * @len: vec entry length
902 * @offset: vec entry offset
903 *
904 * Attempt to add a page to the bio_vec maplist of a bio that will be submitted
905 * for a zone-append request. This can fail for a number of reasons, such as the
906 * bio being full or the target block device is not a zoned block device or
907 * other limitations of the target block device. The target block device must
908 * allow bio's up to PAGE_SIZE, so it is always possible to add a single page
909 * to an empty bio.
910 *
911 * Returns: number of bytes added to the bio, or 0 in case of a failure.
912 */
913int bio_add_zone_append_page(struct bio *bio, struct page *page,
914 unsigned int len, unsigned int offset)
915{
Linus Torvalds582cd912021-02-21 11:02:48 -0800916 struct request_queue *q = bio->bi_bdev->bd_disk->queue;
Johannes Thumshirnae293332021-02-04 19:21:40 +0900917 bool same_page = false;
918
919 if (WARN_ON_ONCE(bio_op(bio) != REQ_OP_ZONE_APPEND))
920 return 0;
921
922 if (WARN_ON_ONCE(!blk_queue_is_zoned(q)))
923 return 0;
924
925 return bio_add_hw_page(q, bio, page, len, offset,
926 queue_max_zone_append_sectors(q), &same_page);
927}
928EXPORT_SYMBOL_GPL(bio_add_zone_append_page);
929
930/**
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700931 * __bio_try_merge_page - try appending data to an existing bvec.
932 * @bio: destination bio
Ming Lei551879a2019-04-23 10:51:04 +0800933 * @page: start page to add
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700934 * @len: length of the data to add
Ming Lei551879a2019-04-23 10:51:04 +0800935 * @off: offset of the data relative to @page
Christoph Hellwigff896732019-06-17 11:14:11 +0200936 * @same_page: return if the segment has been merged inside the same page
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700937 *
938 * Try to add the data at @page + @off to the last bvec of @bio. This is a
Randy Dunlap3cf14882020-07-30 18:42:28 -0700939 * useful optimisation for file systems with a block size smaller than the
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700940 * page size.
941 *
Ming Lei551879a2019-04-23 10:51:04 +0800942 * Warn if (@len, @off) crosses pages in case that @same_page is true.
943 *
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700944 * Return %true on success or %false on failure.
945 */
946bool __bio_try_merge_page(struct bio *bio, struct page *page,
Christoph Hellwigff896732019-06-17 11:14:11 +0200947 unsigned int len, unsigned int off, bool *same_page)
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700948{
949 if (WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED)))
950 return false;
951
Andreas Gruenbachercc90bc62019-12-09 20:11:14 +0100952 if (bio->bi_vcnt > 0) {
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700953 struct bio_vec *bv = &bio->bi_io_vec[bio->bi_vcnt - 1];
954
Ming Lei59194822019-03-17 18:01:07 +0800955 if (page_is_mergeable(bv, page, len, off, same_page)) {
Jens Axboe35c820e2021-05-08 21:49:48 -0600956 if (bio->bi_iter.bi_size > UINT_MAX - len) {
Ritesh Harjani2cd896a2020-09-09 08:44:25 +0530957 *same_page = false;
Andreas Gruenbachercc90bc62019-12-09 20:11:14 +0100958 return false;
Ritesh Harjani2cd896a2020-09-09 08:44:25 +0530959 }
Ming Lei59194822019-03-17 18:01:07 +0800960 bv->bv_len += len;
961 bio->bi_iter.bi_size += len;
962 return true;
963 }
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700964 }
965 return false;
966}
967EXPORT_SYMBOL_GPL(__bio_try_merge_page);
968
969/**
Ming Lei551879a2019-04-23 10:51:04 +0800970 * __bio_add_page - add page(s) to a bio in a new segment
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700971 * @bio: destination bio
Ming Lei551879a2019-04-23 10:51:04 +0800972 * @page: start page to add
973 * @len: length of the data to add, may cross pages
974 * @off: offset of the data relative to @page, may cross pages
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700975 *
976 * Add the data at @page + @off to @bio as a new bvec. The caller must ensure
977 * that @bio has space for another bvec.
978 */
979void __bio_add_page(struct bio *bio, struct page *page,
980 unsigned int len, unsigned int off)
981{
982 struct bio_vec *bv = &bio->bi_io_vec[bio->bi_vcnt];
983
984 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
Ming Lei79d08f82019-07-01 15:14:46 +0800985 WARN_ON_ONCE(bio_full(bio, len));
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700986
987 bv->bv_page = page;
988 bv->bv_offset = off;
989 bv->bv_len = len;
990
991 bio->bi_iter.bi_size += len;
992 bio->bi_vcnt++;
Johannes Weinerb8e24a92019-08-08 15:03:00 -0400993
994 if (!bio_flagged(bio, BIO_WORKINGSET) && unlikely(PageWorkingset(page)))
995 bio_set_flag(bio, BIO_WORKINGSET);
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700996}
997EXPORT_SYMBOL_GPL(__bio_add_page);
998
999/**
Ming Lei551879a2019-04-23 10:51:04 +08001000 * bio_add_page - attempt to add page(s) to bio
Linus Torvalds1da177e2005-04-16 15:20:36 -07001001 * @bio: destination bio
Ming Lei551879a2019-04-23 10:51:04 +08001002 * @page: start page to add
1003 * @len: vec entry length, may cross pages
1004 * @offset: vec entry offset relative to @page, may cross pages
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005 *
Ming Lei551879a2019-04-23 10:51:04 +08001006 * Attempt to add page(s) to the bio_vec maplist. This will only fail
Kent Overstreetc66a14d2013-11-23 22:30:22 -08001007 * if either bio->bi_vcnt == bio->bi_max_vecs or it's a cloned bio.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 */
Kent Overstreetc66a14d2013-11-23 22:30:22 -08001009int bio_add_page(struct bio *bio, struct page *page,
1010 unsigned int len, unsigned int offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011{
Christoph Hellwigff896732019-06-17 11:14:11 +02001012 bool same_page = false;
1013
1014 if (!__bio_try_merge_page(bio, page, len, offset, &same_page)) {
Ming Lei79d08f82019-07-01 15:14:46 +08001015 if (bio_full(bio, len))
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -07001016 return 0;
1017 __bio_add_page(bio, page, len, offset);
Kent Overstreetc66a14d2013-11-23 22:30:22 -08001018 }
Kent Overstreetc66a14d2013-11-23 22:30:22 -08001019 return len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001020}
H Hartley Sweetena112a712009-09-26 16:19:21 +02001021EXPORT_SYMBOL(bio_add_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001022
Christoph Hellwigd241a952019-06-26 15:49:21 +02001023void bio_release_pages(struct bio *bio, bool mark_dirty)
Christoph Hellwig7321ecb2019-04-11 08:23:30 +02001024{
1025 struct bvec_iter_all iter_all;
1026 struct bio_vec *bvec;
Christoph Hellwig7321ecb2019-04-11 08:23:30 +02001027
Christoph Hellwigb2d0d992019-06-26 15:49:20 +02001028 if (bio_flagged(bio, BIO_NO_PAGE_REF))
1029 return;
1030
Christoph Hellwigd241a952019-06-26 15:49:21 +02001031 bio_for_each_segment_all(bvec, bio, iter_all) {
1032 if (mark_dirty && !PageCompound(bvec->bv_page))
1033 set_page_dirty_lock(bvec->bv_page);
Christoph Hellwig7321ecb2019-04-11 08:23:30 +02001034 put_page(bvec->bv_page);
Christoph Hellwigd241a952019-06-26 15:49:21 +02001035 }
Christoph Hellwig7321ecb2019-04-11 08:23:30 +02001036}
Johannes Thumshirn29b2a3a2020-05-12 17:55:53 +09001037EXPORT_SYMBOL_GPL(bio_release_pages);
Christoph Hellwig7321ecb2019-04-11 08:23:30 +02001038
Johannes Thumshirn7de55b72021-03-25 00:47:26 +09001039static void __bio_iov_bvec_set(struct bio *bio, struct iov_iter *iter)
Jens Axboe6d0c48a2018-11-30 08:47:03 -07001040{
Christoph Hellwig7a800a22021-02-02 18:19:29 +01001041 WARN_ON_ONCE(bio->bi_max_vecs);
Jens Axboe6d0c48a2018-11-30 08:47:03 -07001042
Pavel Begunkovc42bca92021-01-09 16:03:03 +00001043 bio->bi_vcnt = iter->nr_segs;
Pavel Begunkovc42bca92021-01-09 16:03:03 +00001044 bio->bi_io_vec = (struct bio_vec *)iter->bvec;
1045 bio->bi_iter.bi_bvec_done = iter->iov_offset;
1046 bio->bi_iter.bi_size = iter->count;
Christoph Hellwiged97ce52021-02-02 18:19:26 +01001047 bio_set_flag(bio, BIO_NO_PAGE_REF);
Christoph Hellwig977be012021-02-02 18:19:27 +01001048 bio_set_flag(bio, BIO_CLONED);
Johannes Thumshirn7de55b72021-03-25 00:47:26 +09001049}
Jens Axboe6d0c48a2018-11-30 08:47:03 -07001050
Johannes Thumshirn7de55b72021-03-25 00:47:26 +09001051static int bio_iov_bvec_set(struct bio *bio, struct iov_iter *iter)
1052{
1053 __bio_iov_bvec_set(bio, iter);
Pavel Begunkovc42bca92021-01-09 16:03:03 +00001054 iov_iter_advance(iter, iter->count);
Christoph Hellwiga10584c2019-04-11 08:23:28 +02001055 return 0;
Jens Axboe6d0c48a2018-11-30 08:47:03 -07001056}
1057
Johannes Thumshirn7de55b72021-03-25 00:47:26 +09001058static int bio_iov_bvec_set_append(struct bio *bio, struct iov_iter *iter)
1059{
1060 struct request_queue *q = bio->bi_bdev->bd_disk->queue;
1061 struct iov_iter i = *iter;
1062
1063 iov_iter_truncate(&i, queue_max_zone_append_sectors(q) << 9);
1064 __bio_iov_bvec_set(bio, &i);
1065 iov_iter_advance(iter, i.count);
1066 return 0;
1067}
1068
Christoph Hellwig576ed912018-09-20 08:28:21 +02001069#define PAGE_PTRS_PER_BVEC (sizeof(struct bio_vec) / sizeof(struct page *))
1070
Kent Overstreet2cefe4d2016-10-31 11:59:24 -06001071/**
Martin Wilck17d51b12018-07-25 23:15:09 +02001072 * __bio_iov_iter_get_pages - pin user or kernel pages and add them to a bio
Kent Overstreet2cefe4d2016-10-31 11:59:24 -06001073 * @bio: bio to add pages to
1074 * @iter: iov iterator describing the region to be mapped
1075 *
Martin Wilck17d51b12018-07-25 23:15:09 +02001076 * Pins pages from *iter and appends them to @bio's bvec array. The
Kent Overstreet2cefe4d2016-10-31 11:59:24 -06001077 * pages will have to be released using put_page() when done.
Martin Wilck17d51b12018-07-25 23:15:09 +02001078 * For multi-segment *iter, this function only adds pages from the
Randy Dunlap3cf14882020-07-30 18:42:28 -07001079 * next non-empty segment of the iov iterator.
Kent Overstreet2cefe4d2016-10-31 11:59:24 -06001080 */
Martin Wilck17d51b12018-07-25 23:15:09 +02001081static int __bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter)
Kent Overstreet2cefe4d2016-10-31 11:59:24 -06001082{
Christoph Hellwig576ed912018-09-20 08:28:21 +02001083 unsigned short nr_pages = bio->bi_max_vecs - bio->bi_vcnt;
1084 unsigned short entries_left = bio->bi_max_vecs - bio->bi_vcnt;
Kent Overstreet2cefe4d2016-10-31 11:59:24 -06001085 struct bio_vec *bv = bio->bi_io_vec + bio->bi_vcnt;
1086 struct page **pages = (struct page **)bv;
Christoph Hellwig45691802019-06-17 11:14:12 +02001087 bool same_page = false;
Christoph Hellwig576ed912018-09-20 08:28:21 +02001088 ssize_t size, left;
1089 unsigned len, i;
Martin Wilckb403ea22018-07-25 23:15:07 +02001090 size_t offset;
Christoph Hellwig576ed912018-09-20 08:28:21 +02001091
1092 /*
1093 * Move page array up in the allocated memory for the bio vecs as far as
1094 * possible so that we can start filling biovecs from the beginning
1095 * without overwriting the temporary page array.
1096 */
1097 BUILD_BUG_ON(PAGE_PTRS_PER_BVEC < 2);
1098 pages += entries_left * (PAGE_PTRS_PER_BVEC - 1);
Kent Overstreet2cefe4d2016-10-31 11:59:24 -06001099
Jens Axboe35c820e2021-05-08 21:49:48 -06001100 size = iov_iter_get_pages(iter, pages, LONG_MAX, nr_pages, &offset);
Kent Overstreet2cefe4d2016-10-31 11:59:24 -06001101 if (unlikely(size <= 0))
1102 return size ? size : -EFAULT;
Kent Overstreet2cefe4d2016-10-31 11:59:24 -06001103
Christoph Hellwig576ed912018-09-20 08:28:21 +02001104 for (left = size, i = 0; left > 0; left -= len, i++) {
1105 struct page *page = pages[i];
Kent Overstreet2cefe4d2016-10-31 11:59:24 -06001106
Christoph Hellwig576ed912018-09-20 08:28:21 +02001107 len = min_t(size_t, PAGE_SIZE - offset, left);
Christoph Hellwig45691802019-06-17 11:14:12 +02001108
1109 if (__bio_try_merge_page(bio, page, len, offset, &same_page)) {
1110 if (same_page)
1111 put_page(page);
1112 } else {
Ming Lei79d08f82019-07-01 15:14:46 +08001113 if (WARN_ON_ONCE(bio_full(bio, len)))
Christoph Hellwig45691802019-06-17 11:14:12 +02001114 return -EINVAL;
1115 __bio_add_page(bio, page, len, offset);
1116 }
Christoph Hellwig576ed912018-09-20 08:28:21 +02001117 offset = 0;
Kent Overstreet2cefe4d2016-10-31 11:59:24 -06001118 }
1119
Kent Overstreet2cefe4d2016-10-31 11:59:24 -06001120 iov_iter_advance(iter, size);
1121 return 0;
1122}
Martin Wilck17d51b12018-07-25 23:15:09 +02001123
Keith Busch0512a752020-05-12 17:55:47 +09001124static int __bio_iov_append_get_pages(struct bio *bio, struct iov_iter *iter)
1125{
1126 unsigned short nr_pages = bio->bi_max_vecs - bio->bi_vcnt;
1127 unsigned short entries_left = bio->bi_max_vecs - bio->bi_vcnt;
Christoph Hellwig309dca302021-01-24 11:02:34 +01001128 struct request_queue *q = bio->bi_bdev->bd_disk->queue;
Keith Busch0512a752020-05-12 17:55:47 +09001129 unsigned int max_append_sectors = queue_max_zone_append_sectors(q);
1130 struct bio_vec *bv = bio->bi_io_vec + bio->bi_vcnt;
1131 struct page **pages = (struct page **)bv;
1132 ssize_t size, left;
1133 unsigned len, i;
1134 size_t offset;
Naohiro Aota4977d122020-10-28 16:25:36 +09001135 int ret = 0;
Keith Busch0512a752020-05-12 17:55:47 +09001136
1137 if (WARN_ON_ONCE(!max_append_sectors))
1138 return 0;
1139
1140 /*
1141 * Move page array up in the allocated memory for the bio vecs as far as
1142 * possible so that we can start filling biovecs from the beginning
1143 * without overwriting the temporary page array.
1144 */
1145 BUILD_BUG_ON(PAGE_PTRS_PER_BVEC < 2);
1146 pages += entries_left * (PAGE_PTRS_PER_BVEC - 1);
1147
1148 size = iov_iter_get_pages(iter, pages, LONG_MAX, nr_pages, &offset);
1149 if (unlikely(size <= 0))
1150 return size ? size : -EFAULT;
1151
1152 for (left = size, i = 0; left > 0; left -= len, i++) {
1153 struct page *page = pages[i];
1154 bool same_page = false;
1155
1156 len = min_t(size_t, PAGE_SIZE - offset, left);
1157 if (bio_add_hw_page(q, bio, page, len, offset,
Naohiro Aota4977d122020-10-28 16:25:36 +09001158 max_append_sectors, &same_page) != len) {
1159 ret = -EINVAL;
1160 break;
1161 }
Keith Busch0512a752020-05-12 17:55:47 +09001162 if (same_page)
1163 put_page(page);
1164 offset = 0;
1165 }
1166
Naohiro Aota4977d122020-10-28 16:25:36 +09001167 iov_iter_advance(iter, size - left);
1168 return ret;
Keith Busch0512a752020-05-12 17:55:47 +09001169}
1170
Martin Wilck17d51b12018-07-25 23:15:09 +02001171/**
Jens Axboe6d0c48a2018-11-30 08:47:03 -07001172 * bio_iov_iter_get_pages - add user or kernel pages to a bio
Martin Wilck17d51b12018-07-25 23:15:09 +02001173 * @bio: bio to add pages to
Jens Axboe6d0c48a2018-11-30 08:47:03 -07001174 * @iter: iov iterator describing the region to be added
Martin Wilck17d51b12018-07-25 23:15:09 +02001175 *
Jens Axboe6d0c48a2018-11-30 08:47:03 -07001176 * This takes either an iterator pointing to user memory, or one pointing to
1177 * kernel pages (BVEC iterator). If we're adding user pages, we pin them and
1178 * map them into the kernel. On IO completion, the caller should put those
Pavel Begunkovc42bca92021-01-09 16:03:03 +00001179 * pages. For bvec based iterators bio_iov_iter_get_pages() uses the provided
1180 * bvecs rather than copying them. Hence anyone issuing kiocb based IO needs
1181 * to ensure the bvecs and pages stay referenced until the submitted I/O is
1182 * completed by a call to ->ki_complete() or returns with an error other than
1183 * -EIOCBQUEUED. The caller needs to check if the bio is flagged BIO_NO_PAGE_REF
1184 * on IO completion. If it isn't, then pages should be released.
Jens Axboe6d0c48a2018-11-30 08:47:03 -07001185 *
Martin Wilck17d51b12018-07-25 23:15:09 +02001186 * The function tries, but does not guarantee, to pin as many pages as
Mauro Carvalho Chehab5cd3ddc2020-09-09 11:44:33 +02001187 * fit into the bio, or are requested in @iter, whatever is smaller. If
Jens Axboe6d0c48a2018-11-30 08:47:03 -07001188 * MM encounters an error pinning the requested pages, it stops. Error
1189 * is returned only if 0 pages could be pinned.
Pavel Begunkov0cf41e52021-01-09 16:02:59 +00001190 *
1191 * It's intended for direct IO, so doesn't do PSI tracking, the caller is
1192 * responsible for setting BIO_WORKINGSET if necessary.
Martin Wilck17d51b12018-07-25 23:15:09 +02001193 */
1194int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter)
1195{
Pavel Begunkovc42bca92021-01-09 16:03:03 +00001196 int ret = 0;
Christoph Hellwig14eacf12019-04-11 08:23:29 +02001197
Pavel Begunkovc42bca92021-01-09 16:03:03 +00001198 if (iov_iter_is_bvec(iter)) {
Johannes Thumshirn7de55b72021-03-25 00:47:26 +09001199 if (bio_op(bio) == REQ_OP_ZONE_APPEND)
1200 return bio_iov_bvec_set_append(bio, iter);
Christoph Hellwiged97ce52021-02-02 18:19:26 +01001201 return bio_iov_bvec_set(bio, iter);
Pavel Begunkovc42bca92021-01-09 16:03:03 +00001202 }
Martin Wilck17d51b12018-07-25 23:15:09 +02001203
1204 do {
Christoph Hellwig86004512021-02-02 18:19:25 +01001205 if (bio_op(bio) == REQ_OP_ZONE_APPEND)
Keith Busch0512a752020-05-12 17:55:47 +09001206 ret = __bio_iov_append_get_pages(bio, iter);
Christoph Hellwig86004512021-02-02 18:19:25 +01001207 else
1208 ret = __bio_iov_iter_get_pages(bio, iter);
Ming Lei79d08f82019-07-01 15:14:46 +08001209 } while (!ret && iov_iter_count(iter) && !bio_full(bio, 0));
Martin Wilck17d51b12018-07-25 23:15:09 +02001210
Pavel Begunkov0cf41e52021-01-09 16:02:59 +00001211 /* don't account direct I/O as memory stall */
1212 bio_clear_flag(bio, BIO_WORKINGSET);
Christoph Hellwig14eacf12019-04-11 08:23:29 +02001213 return bio->bi_vcnt ? 0 : ret;
Martin Wilck17d51b12018-07-25 23:15:09 +02001214}
Johannes Thumshirn29b2a3a2020-05-12 17:55:53 +09001215EXPORT_SYMBOL_GPL(bio_iov_iter_get_pages);
Kent Overstreet2cefe4d2016-10-31 11:59:24 -06001216
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001217static void submit_bio_wait_endio(struct bio *bio)
Kent Overstreet9e882242012-09-10 14:41:12 -07001218{
Christoph Hellwig65e53aa2017-10-25 17:55:57 +09001219 complete(bio->bi_private);
Kent Overstreet9e882242012-09-10 14:41:12 -07001220}
1221
1222/**
1223 * submit_bio_wait - submit a bio, and wait until it completes
Kent Overstreet9e882242012-09-10 14:41:12 -07001224 * @bio: The &struct bio which describes the I/O
1225 *
1226 * Simple wrapper around submit_bio(). Returns 0 on success, or the error from
1227 * bio_endio() on failure.
Jan Kara3d289d62017-08-02 10:25:21 +02001228 *
1229 * WARNING: Unlike to how submit_bio() is usually used, this function does not
1230 * result in bio reference to be consumed. The caller must drop the reference
1231 * on his own.
Kent Overstreet9e882242012-09-10 14:41:12 -07001232 */
Mike Christie4e49ea42016-06-05 14:31:41 -05001233int submit_bio_wait(struct bio *bio)
Kent Overstreet9e882242012-09-10 14:41:12 -07001234{
Christoph Hellwig309dca302021-01-24 11:02:34 +01001235 DECLARE_COMPLETION_ONSTACK_MAP(done,
1236 bio->bi_bdev->bd_disk->lockdep_map);
Ming Leide6a78b2020-03-18 11:43:36 +08001237 unsigned long hang_check;
Kent Overstreet9e882242012-09-10 14:41:12 -07001238
Christoph Hellwig65e53aa2017-10-25 17:55:57 +09001239 bio->bi_private = &done;
Kent Overstreet9e882242012-09-10 14:41:12 -07001240 bio->bi_end_io = submit_bio_wait_endio;
Jens Axboe1eff9d32016-08-05 15:35:16 -06001241 bio->bi_opf |= REQ_SYNC;
Mike Christie4e49ea42016-06-05 14:31:41 -05001242 submit_bio(bio);
Ming Leide6a78b2020-03-18 11:43:36 +08001243
1244 /* Prevent hang_check timer from firing at us during very long I/O */
1245 hang_check = sysctl_hung_task_timeout_secs;
1246 if (hang_check)
1247 while (!wait_for_completion_io_timeout(&done,
1248 hang_check * (HZ/2)))
1249 ;
1250 else
1251 wait_for_completion_io(&done);
Kent Overstreet9e882242012-09-10 14:41:12 -07001252
Christoph Hellwig65e53aa2017-10-25 17:55:57 +09001253 return blk_status_to_errno(bio->bi_status);
Kent Overstreet9e882242012-09-10 14:41:12 -07001254}
1255EXPORT_SYMBOL(submit_bio_wait);
1256
Kent Overstreet054bdf62012-09-28 13:17:55 -07001257/**
1258 * bio_advance - increment/complete a bio by some number of bytes
1259 * @bio: bio to advance
1260 * @bytes: number of bytes to complete
1261 *
1262 * This updates bi_sector, bi_size and bi_idx; if the number of bytes to
1263 * complete doesn't align with a bvec boundary, then bv_len and bv_offset will
1264 * be updated on the last bvec as well.
1265 *
1266 * @bio will then represent the remaining, uncompleted portion of the io.
1267 */
1268void bio_advance(struct bio *bio, unsigned bytes)
1269{
1270 if (bio_integrity(bio))
1271 bio_integrity_advance(bio, bytes);
1272
Satya Tangiralaa892c8d2020-05-14 00:37:18 +00001273 bio_crypt_advance(bio, bytes);
Kent Overstreet4550dd62013-08-07 14:26:21 -07001274 bio_advance_iter(bio, &bio->bi_iter, bytes);
Kent Overstreet054bdf62012-09-28 13:17:55 -07001275}
1276EXPORT_SYMBOL(bio_advance);
1277
Kent Overstreet45db54d2018-05-08 21:33:54 -04001278void bio_copy_data_iter(struct bio *dst, struct bvec_iter *dst_iter,
1279 struct bio *src, struct bvec_iter *src_iter)
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001280{
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001281 struct bio_vec src_bv, dst_bv;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001282 void *src_p, *dst_p;
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001283 unsigned bytes;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001284
Kent Overstreet45db54d2018-05-08 21:33:54 -04001285 while (src_iter->bi_size && dst_iter->bi_size) {
1286 src_bv = bio_iter_iovec(src, *src_iter);
1287 dst_bv = bio_iter_iovec(dst, *dst_iter);
1288
1289 bytes = min(src_bv.bv_len, dst_bv.bv_len);
1290
1291 src_p = kmap_atomic(src_bv.bv_page);
1292 dst_p = kmap_atomic(dst_bv.bv_page);
1293
1294 memcpy(dst_p + dst_bv.bv_offset,
1295 src_p + src_bv.bv_offset,
1296 bytes);
1297
1298 kunmap_atomic(dst_p);
1299 kunmap_atomic(src_p);
1300
Kent Overstreet6e6e8112018-05-08 21:33:55 -04001301 flush_dcache_page(dst_bv.bv_page);
1302
Pavel Begunkov22b56c22020-11-24 17:58:13 +00001303 bio_advance_iter_single(src, src_iter, bytes);
1304 bio_advance_iter_single(dst, dst_iter, bytes);
Kent Overstreet45db54d2018-05-08 21:33:54 -04001305 }
1306}
1307EXPORT_SYMBOL(bio_copy_data_iter);
1308
1309/**
1310 * bio_copy_data - copy contents of data buffers from one bio to another
1311 * @src: source bio
1312 * @dst: destination bio
1313 *
1314 * Stops when it reaches the end of either @src or @dst - that is, copies
1315 * min(src->bi_size, dst->bi_size) bytes (or the equivalent for lists of bios).
1316 */
1317void bio_copy_data(struct bio *dst, struct bio *src)
1318{
1319 struct bvec_iter src_iter = src->bi_iter;
1320 struct bvec_iter dst_iter = dst->bi_iter;
1321
1322 bio_copy_data_iter(dst, &dst_iter, src, &src_iter);
1323}
1324EXPORT_SYMBOL(bio_copy_data);
1325
Guoqing Jiang491221f2016-09-22 03:10:01 -04001326void bio_free_pages(struct bio *bio)
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001327{
1328 struct bio_vec *bvec;
Ming Lei6dc4f102019-02-15 19:13:19 +08001329 struct bvec_iter_all iter_all;
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001330
Christoph Hellwig2b070cf2019-04-25 09:03:00 +02001331 bio_for_each_segment_all(bvec, bio, iter_all)
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001332 __free_page(bvec->bv_page);
1333}
Guoqing Jiang491221f2016-09-22 03:10:01 -04001334EXPORT_SYMBOL(bio_free_pages);
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001335
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336/*
1337 * bio_set_pages_dirty() and bio_check_pages_dirty() are support functions
1338 * for performing direct-IO in BIOs.
1339 *
1340 * The problem is that we cannot run set_page_dirty() from interrupt context
1341 * because the required locks are not interrupt-safe. So what we can do is to
1342 * mark the pages dirty _before_ performing IO. And in interrupt context,
1343 * check that the pages are still dirty. If so, fine. If not, redirty them
1344 * in process context.
1345 *
1346 * We special-case compound pages here: normally this means reads into hugetlb
1347 * pages. The logic in here doesn't really work right for compound pages
1348 * because the VM does not uniformly chase down the head page in all cases.
1349 * But dirtiness of compound pages is pretty meaningless anyway: the VM doesn't
1350 * handle them at all. So we skip compound pages here at an early stage.
1351 *
1352 * Note that this code is very hard to test under normal circumstances because
1353 * direct-io pins the pages with get_user_pages(). This makes
1354 * is_page_cache_freeable return false, and the VM will not clean the pages.
Artem Bityutskiy0d5c3eb2012-07-25 18:12:08 +03001355 * But other code (eg, flusher threads) could clean the pages if they are mapped
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 * pagecache.
1357 *
1358 * Simply disabling the call to bio_set_pages_dirty() is a good way to test the
1359 * deferred bio dirtying paths.
1360 */
1361
1362/*
1363 * bio_set_pages_dirty() will mark all the bio's pages as dirty.
1364 */
1365void bio_set_pages_dirty(struct bio *bio)
1366{
Kent Overstreetcb34e052012-09-05 15:22:02 -07001367 struct bio_vec *bvec;
Ming Lei6dc4f102019-02-15 19:13:19 +08001368 struct bvec_iter_all iter_all;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369
Christoph Hellwig2b070cf2019-04-25 09:03:00 +02001370 bio_for_each_segment_all(bvec, bio, iter_all) {
Christoph Hellwig3bb50982018-07-24 14:04:13 +02001371 if (!PageCompound(bvec->bv_page))
1372 set_page_dirty_lock(bvec->bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 }
1374}
1375
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376/*
1377 * bio_check_pages_dirty() will check that all the BIO's pages are still dirty.
1378 * If they are, then fine. If, however, some pages are clean then they must
1379 * have been written out during the direct-IO read. So we take another ref on
Christoph Hellwig24d54932018-07-24 14:04:12 +02001380 * the BIO and re-dirty the pages in process context.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381 *
1382 * It is expected that bio_check_pages_dirty() will wholly own the BIO from
Kirill A. Shutemovea1754a2016-04-01 15:29:48 +03001383 * here on. It will run one put_page() against each page and will run one
1384 * bio_put() against the BIO.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385 */
1386
David Howells65f27f32006-11-22 14:55:48 +00001387static void bio_dirty_fn(struct work_struct *work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001388
David Howells65f27f32006-11-22 14:55:48 +00001389static DECLARE_WORK(bio_dirty_work, bio_dirty_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001390static DEFINE_SPINLOCK(bio_dirty_lock);
1391static struct bio *bio_dirty_list;
1392
1393/*
1394 * This runs in process context
1395 */
David Howells65f27f32006-11-22 14:55:48 +00001396static void bio_dirty_fn(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397{
Christoph Hellwig24d54932018-07-24 14:04:12 +02001398 struct bio *bio, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399
Christoph Hellwig24d54932018-07-24 14:04:12 +02001400 spin_lock_irq(&bio_dirty_lock);
1401 next = bio_dirty_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402 bio_dirty_list = NULL;
Christoph Hellwig24d54932018-07-24 14:04:12 +02001403 spin_unlock_irq(&bio_dirty_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404
Christoph Hellwig24d54932018-07-24 14:04:12 +02001405 while ((bio = next) != NULL) {
1406 next = bio->bi_private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001407
Christoph Hellwigd241a952019-06-26 15:49:21 +02001408 bio_release_pages(bio, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001409 bio_put(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001410 }
1411}
1412
1413void bio_check_pages_dirty(struct bio *bio)
1414{
Kent Overstreetcb34e052012-09-05 15:22:02 -07001415 struct bio_vec *bvec;
Christoph Hellwig24d54932018-07-24 14:04:12 +02001416 unsigned long flags;
Ming Lei6dc4f102019-02-15 19:13:19 +08001417 struct bvec_iter_all iter_all;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001418
Christoph Hellwig2b070cf2019-04-25 09:03:00 +02001419 bio_for_each_segment_all(bvec, bio, iter_all) {
Christoph Hellwig24d54932018-07-24 14:04:12 +02001420 if (!PageDirty(bvec->bv_page) && !PageCompound(bvec->bv_page))
1421 goto defer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422 }
1423
Christoph Hellwigd241a952019-06-26 15:49:21 +02001424 bio_release_pages(bio, false);
Christoph Hellwig24d54932018-07-24 14:04:12 +02001425 bio_put(bio);
1426 return;
1427defer:
1428 spin_lock_irqsave(&bio_dirty_lock, flags);
1429 bio->bi_private = bio_dirty_list;
1430 bio_dirty_list = bio;
1431 spin_unlock_irqrestore(&bio_dirty_lock, flags);
1432 schedule_work(&bio_dirty_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001433}
1434
Jens Axboec4cf5262015-04-17 16:15:18 -06001435static inline bool bio_remaining_done(struct bio *bio)
1436{
1437 /*
1438 * If we're not chaining, then ->__bi_remaining is always 1 and
1439 * we always end io on the first invocation.
1440 */
1441 if (!bio_flagged(bio, BIO_CHAIN))
1442 return true;
1443
1444 BUG_ON(atomic_read(&bio->__bi_remaining) <= 0);
1445
Mike Snitzer326e1db2015-05-22 09:14:03 -04001446 if (atomic_dec_and_test(&bio->__bi_remaining)) {
Jens Axboeb7c44ed2015-07-24 12:37:59 -06001447 bio_clear_flag(bio, BIO_CHAIN);
Jens Axboec4cf5262015-04-17 16:15:18 -06001448 return true;
Mike Snitzer326e1db2015-05-22 09:14:03 -04001449 }
Jens Axboec4cf5262015-04-17 16:15:18 -06001450
1451 return false;
1452}
1453
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454/**
1455 * bio_endio - end I/O on a bio
1456 * @bio: bio
Linus Torvalds1da177e2005-04-16 15:20:36 -07001457 *
1458 * Description:
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001459 * bio_endio() will end I/O on the whole bio. bio_endio() is the preferred
1460 * way to end I/O on a bio. No one should call bi_end_io() directly on a
1461 * bio unless they own it and thus know that it has an end_io function.
NeilBrownfbbaf702017-04-07 09:40:52 -06001462 *
1463 * bio_endio() can be called several times on a bio that has been chained
1464 * using bio_chain(). The ->bi_end_io() function will only be called the
Edward Hsieh60b6a7e2021-06-24 20:30:30 +08001465 * last time.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466 **/
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001467void bio_endio(struct bio *bio)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001468{
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001469again:
Christoph Hellwig2b885512016-03-11 17:34:53 +01001470 if (!bio_remaining_done(bio))
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001471 return;
Christoph Hellwig7c20f112017-07-03 16:58:43 -06001472 if (!bio_integrity_endio(bio))
1473 return;
Kent Overstreet196d38bc2013-11-23 18:34:15 -08001474
Christoph Hellwig309dca302021-01-24 11:02:34 +01001475 if (bio->bi_bdev)
1476 rq_qos_done_bio(bio->bi_bdev->bd_disk->queue, bio);
Josef Bacik67b42d02018-07-03 11:15:00 -04001477
Edward Hsieh60b6a7e2021-06-24 20:30:30 +08001478 if (bio->bi_bdev && bio_flagged(bio, BIO_TRACE_COMPLETION)) {
1479 trace_block_bio_complete(bio->bi_bdev->bd_disk->queue, bio);
1480 bio_clear_flag(bio, BIO_TRACE_COMPLETION);
1481 }
1482
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001483 /*
1484 * Need to have a real endio function for chained bios, otherwise
1485 * various corner cases will break (like stacking block devices that
1486 * save/restore bi_end_io) - however, we want to avoid unbounded
1487 * recursion and blowing the stack. Tail call optimization would
1488 * handle this, but compiling with frame pointers also disables
1489 * gcc's sibling call optimization.
1490 */
1491 if (bio->bi_end_io == bio_chain_endio) {
1492 bio = __bio_chain_endio(bio);
1493 goto again;
Kent Overstreet196d38bc2013-11-23 18:34:15 -08001494 }
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001495
Shaohua Li9e234ee2017-03-27 10:51:41 -07001496 blk_throtl_bio_endio(bio);
Shaohua Lib222dd22017-07-10 11:40:17 -07001497 /* release cgroup info */
1498 bio_uninit(bio);
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001499 if (bio->bi_end_io)
1500 bio->bi_end_io(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001501}
H Hartley Sweetena112a712009-09-26 16:19:21 +02001502EXPORT_SYMBOL(bio_endio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503
Kent Overstreet196d38bc2013-11-23 18:34:15 -08001504/**
Kent Overstreet20d01892013-11-23 18:21:01 -08001505 * bio_split - split a bio
1506 * @bio: bio to split
1507 * @sectors: number of sectors to split from the front of @bio
1508 * @gfp: gfp mask
1509 * @bs: bio set to allocate from
1510 *
1511 * Allocates and returns a new bio which represents @sectors from the start of
1512 * @bio, and updates @bio to represent the remaining sectors.
1513 *
Martin K. Petersenf3f5da62015-07-22 07:57:12 -04001514 * Unless this is a discard request the newly allocated bio will point
Bart Van Asschedad77582019-08-01 15:50:41 -07001515 * to @bio's bi_io_vec. It is the caller's responsibility to ensure that
1516 * neither @bio nor @bs are freed before the split bio.
Kent Overstreet20d01892013-11-23 18:21:01 -08001517 */
1518struct bio *bio_split(struct bio *bio, int sectors,
1519 gfp_t gfp, struct bio_set *bs)
1520{
Mikulas Patockaf341a4d2017-11-22 13:18:05 -05001521 struct bio *split;
Kent Overstreet20d01892013-11-23 18:21:01 -08001522
1523 BUG_ON(sectors <= 0);
1524 BUG_ON(sectors >= bio_sectors(bio));
1525
Keith Busch0512a752020-05-12 17:55:47 +09001526 /* Zone append commands cannot be split */
1527 if (WARN_ON_ONCE(bio_op(bio) == REQ_OP_ZONE_APPEND))
1528 return NULL;
1529
Christoph Hellwigf9d03f92016-12-08 15:20:32 -07001530 split = bio_clone_fast(bio, gfp, bs);
Kent Overstreet20d01892013-11-23 18:21:01 -08001531 if (!split)
1532 return NULL;
1533
1534 split->bi_iter.bi_size = sectors << 9;
1535
1536 if (bio_integrity(split))
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -07001537 bio_integrity_trim(split);
Kent Overstreet20d01892013-11-23 18:21:01 -08001538
1539 bio_advance(bio, split->bi_iter.bi_size);
1540
NeilBrownfbbaf702017-04-07 09:40:52 -06001541 if (bio_flagged(bio, BIO_TRACE_COMPLETION))
Goldwyn Rodrigues20d59022018-01-23 09:10:19 -07001542 bio_set_flag(split, BIO_TRACE_COMPLETION);
NeilBrownfbbaf702017-04-07 09:40:52 -06001543
Kent Overstreet20d01892013-11-23 18:21:01 -08001544 return split;
1545}
1546EXPORT_SYMBOL(bio_split);
1547
Martin K. Petersenad3316b2008-10-01 22:42:53 -04001548/**
Kent Overstreet6678d832013-08-07 11:14:32 -07001549 * bio_trim - trim a bio
1550 * @bio: bio to trim
1551 * @offset: number of sectors to trim from the front of @bio
1552 * @size: size we want to trim @bio to, in sectors
1553 */
1554void bio_trim(struct bio *bio, int offset, int size)
1555{
1556 /* 'bio' is a cloned bio which we need to trim to match
1557 * the given offset and size.
Kent Overstreet6678d832013-08-07 11:14:32 -07001558 */
Kent Overstreet6678d832013-08-07 11:14:32 -07001559
1560 size <<= 9;
Kent Overstreet4f024f32013-10-11 15:44:27 -07001561 if (offset == 0 && size == bio->bi_iter.bi_size)
Kent Overstreet6678d832013-08-07 11:14:32 -07001562 return;
1563
Kent Overstreet6678d832013-08-07 11:14:32 -07001564 bio_advance(bio, offset << 9);
Kent Overstreet4f024f32013-10-11 15:44:27 -07001565 bio->bi_iter.bi_size = size;
Dmitry Monakhov376a78a2017-06-29 11:31:08 -07001566
1567 if (bio_integrity(bio))
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -07001568 bio_integrity_trim(bio);
Dmitry Monakhov376a78a2017-06-29 11:31:08 -07001569
Kent Overstreet6678d832013-08-07 11:14:32 -07001570}
1571EXPORT_SYMBOL_GPL(bio_trim);
1572
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573/*
1574 * create memory pools for biovec's in a bio_set.
1575 * use the global biovec slabs created for general use.
1576 */
Kent Overstreet8aa6ba22018-05-08 21:33:50 -04001577int biovec_init_pool(mempool_t *pool, int pool_entries)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578{
Christoph Hellwig7a800a22021-02-02 18:19:29 +01001579 struct biovec_slab *bp = bvec_slabs + ARRAY_SIZE(bvec_slabs) - 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580
Kent Overstreet8aa6ba22018-05-08 21:33:50 -04001581 return mempool_init_slab_pool(pool, pool_entries, bp->slab);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001582}
1583
Kent Overstreet917a38c2018-05-08 21:33:51 -04001584/*
1585 * bioset_exit - exit a bioset initialized with bioset_init()
1586 *
1587 * May be called on a zeroed but uninitialized bioset (i.e. allocated with
1588 * kzalloc()).
1589 */
1590void bioset_exit(struct bio_set *bs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591{
Jens Axboebe4d2342021-03-08 11:37:47 -07001592 bio_alloc_cache_destroy(bs);
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -07001593 if (bs->rescue_workqueue)
1594 destroy_workqueue(bs->rescue_workqueue);
Kent Overstreet917a38c2018-05-08 21:33:51 -04001595 bs->rescue_workqueue = NULL;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -07001596
Kent Overstreet8aa6ba22018-05-08 21:33:50 -04001597 mempool_exit(&bs->bio_pool);
1598 mempool_exit(&bs->bvec_pool);
Kent Overstreet9f060e22012-10-12 15:29:33 -07001599
Martin K. Petersen7878cba2009-06-26 15:37:49 +02001600 bioset_integrity_free(bs);
Kent Overstreet917a38c2018-05-08 21:33:51 -04001601 if (bs->bio_slab)
1602 bio_put_slab(bs);
1603 bs->bio_slab = NULL;
1604}
1605EXPORT_SYMBOL(bioset_exit);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001606
NeilBrown011067b2017-06-18 14:38:57 +10001607/**
Kent Overstreet917a38c2018-05-08 21:33:51 -04001608 * bioset_init - Initialize a bio_set
Kent Overstreetdad08522018-05-20 18:25:58 -04001609 * @bs: pool to initialize
Kent Overstreet917a38c2018-05-08 21:33:51 -04001610 * @pool_size: Number of bio and bio_vecs to cache in the mempool
1611 * @front_pad: Number of bytes to allocate in front of the returned bio
1612 * @flags: Flags to modify behavior, currently %BIOSET_NEED_BVECS
1613 * and %BIOSET_NEED_RESCUER
1614 *
Kent Overstreetdad08522018-05-20 18:25:58 -04001615 * Description:
1616 * Set up a bio_set to be used with @bio_alloc_bioset. Allows the caller
1617 * to ask for a number of bytes to be allocated in front of the bio.
1618 * Front pad allocation is useful for embedding the bio inside
1619 * another structure, to avoid allocating extra data to go with the bio.
1620 * Note that the bio must be embedded at the END of that structure always,
1621 * or things will break badly.
1622 * If %BIOSET_NEED_BVECS is set in @flags, a separate pool will be allocated
1623 * for allocating iovecs. This pool is not needed e.g. for bio_clone_fast().
1624 * If %BIOSET_NEED_RESCUER is set, a workqueue is created which can be used to
1625 * dispatch queued requests when the mempool runs out of space.
1626 *
Kent Overstreet917a38c2018-05-08 21:33:51 -04001627 */
1628int bioset_init(struct bio_set *bs,
1629 unsigned int pool_size,
1630 unsigned int front_pad,
1631 int flags)
1632{
Kent Overstreet917a38c2018-05-08 21:33:51 -04001633 bs->front_pad = front_pad;
Ming Lei9f180e32021-01-11 11:05:54 +08001634 if (flags & BIOSET_NEED_BVECS)
1635 bs->back_pad = BIO_INLINE_VECS * sizeof(struct bio_vec);
1636 else
1637 bs->back_pad = 0;
Kent Overstreet917a38c2018-05-08 21:33:51 -04001638
1639 spin_lock_init(&bs->rescue_lock);
1640 bio_list_init(&bs->rescue_list);
1641 INIT_WORK(&bs->rescue_work, bio_alloc_rescue);
1642
Ming Lei49d1ec82021-01-11 11:05:52 +08001643 bs->bio_slab = bio_find_or_create_slab(bs);
Kent Overstreet917a38c2018-05-08 21:33:51 -04001644 if (!bs->bio_slab)
1645 return -ENOMEM;
1646
1647 if (mempool_init_slab_pool(&bs->bio_pool, pool_size, bs->bio_slab))
1648 goto bad;
1649
1650 if ((flags & BIOSET_NEED_BVECS) &&
1651 biovec_init_pool(&bs->bvec_pool, pool_size))
1652 goto bad;
1653
Jens Axboebe4d2342021-03-08 11:37:47 -07001654 if (flags & BIOSET_NEED_RESCUER) {
1655 bs->rescue_workqueue = alloc_workqueue("bioset",
1656 WQ_MEM_RECLAIM, 0);
1657 if (!bs->rescue_workqueue)
1658 goto bad;
1659 }
1660 if (flags & BIOSET_PERCPU_CACHE) {
1661 bs->cache = alloc_percpu(struct bio_alloc_cache);
1662 if (!bs->cache)
1663 goto bad;
1664 cpuhp_state_add_instance_nocalls(CPUHP_BIO_DEAD, &bs->cpuhp_dead);
1665 }
Kent Overstreet917a38c2018-05-08 21:33:51 -04001666
1667 return 0;
1668bad:
1669 bioset_exit(bs);
1670 return -ENOMEM;
1671}
1672EXPORT_SYMBOL(bioset_init);
1673
Jens Axboe28e89fd92018-06-07 14:42:05 -06001674/*
1675 * Initialize and setup a new bio_set, based on the settings from
1676 * another bio_set.
1677 */
1678int bioset_init_from_src(struct bio_set *bs, struct bio_set *src)
1679{
1680 int flags;
1681
1682 flags = 0;
1683 if (src->bvec_pool.min_nr)
1684 flags |= BIOSET_NEED_BVECS;
1685 if (src->rescue_workqueue)
1686 flags |= BIOSET_NEED_RESCUER;
1687
1688 return bioset_init(bs, src->bio_pool.min_nr, src->front_pad, flags);
1689}
1690EXPORT_SYMBOL(bioset_init_from_src);
1691
Jens Axboebe4d2342021-03-08 11:37:47 -07001692/**
1693 * bio_alloc_kiocb - Allocate a bio from bio_set based on kiocb
1694 * @kiocb: kiocb describing the IO
Jens Axboe3d5b3fb2021-08-13 07:53:09 -06001695 * @nr_iovecs: number of iovecs to pre-allocate
Jens Axboebe4d2342021-03-08 11:37:47 -07001696 * @bs: bio_set to allocate from
1697 *
1698 * Description:
1699 * Like @bio_alloc_bioset, but pass in the kiocb. The kiocb is only
1700 * used to check if we should dip into the per-cpu bio_set allocation
Jens Axboe3d5b3fb2021-08-13 07:53:09 -06001701 * cache. The allocation uses GFP_KERNEL internally. On return, the
1702 * bio is marked BIO_PERCPU_CACHEABLE, and the final put of the bio
1703 * MUST be done from process context, not hard/soft IRQ.
Jens Axboebe4d2342021-03-08 11:37:47 -07001704 *
1705 */
1706struct bio *bio_alloc_kiocb(struct kiocb *kiocb, unsigned short nr_vecs,
1707 struct bio_set *bs)
1708{
1709 struct bio_alloc_cache *cache;
1710 struct bio *bio;
1711
1712 if (!(kiocb->ki_flags & IOCB_ALLOC_CACHE) || nr_vecs > BIO_INLINE_VECS)
1713 return bio_alloc_bioset(GFP_KERNEL, nr_vecs, bs);
1714
1715 cache = per_cpu_ptr(bs->cache, get_cpu());
1716 bio = bio_list_pop(&cache->free_list);
1717 if (bio) {
1718 cache->nr--;
1719 put_cpu();
1720 bio_init(bio, nr_vecs ? bio->bi_inline_vecs : NULL, nr_vecs);
1721 bio->bi_pool = bs;
1722 bio_set_flag(bio, BIO_PERCPU_CACHE);
1723 return bio;
1724 }
1725 put_cpu();
1726 bio = bio_alloc_bioset(GFP_KERNEL, nr_vecs, bs);
1727 bio_set_flag(bio, BIO_PERCPU_CACHE);
1728 return bio;
1729}
1730EXPORT_SYMBOL_GPL(bio_alloc_kiocb);
1731
Christoph Hellwigde76fd82021-02-02 18:19:23 +01001732static int __init init_bio(void)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733{
1734 int i;
1735
Martin K. Petersen7878cba2009-06-26 15:37:49 +02001736 bio_integrity_init();
Christoph Hellwigde76fd82021-02-02 18:19:23 +01001737
1738 for (i = 0; i < ARRAY_SIZE(bvec_slabs); i++) {
Jens Axboea7fcd372008-12-05 16:10:29 +01001739 struct biovec_slab *bvs = bvec_slabs + i;
1740
Christoph Hellwigde76fd82021-02-02 18:19:23 +01001741 bvs->slab = kmem_cache_create(bvs->name,
1742 bvs->nr_vecs * sizeof(struct bio_vec), 0,
1743 SLAB_HWCACHE_ALIGN | SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001744 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745
Jens Axboebe4d2342021-03-08 11:37:47 -07001746 cpuhp_setup_state_multi(CPUHP_BIO_DEAD, "block/bio:dead", NULL,
1747 bio_cpu_dead);
1748
Kent Overstreetf4f81542018-05-08 21:33:52 -04001749 if (bioset_init(&fs_bio_set, BIO_POOL_SIZE, 0, BIOSET_NEED_BVECS))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750 panic("bio: can't allocate bios\n");
1751
Kent Overstreetf4f81542018-05-08 21:33:52 -04001752 if (bioset_integrity_create(&fs_bio_set, BIO_POOL_SIZE))
Martin K. Petersena91a2782011-03-17 11:11:05 +01001753 panic("bio: can't create integrity pool\n");
1754
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755 return 0;
1756}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001757subsys_initcall(init_bio);