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