compat_ioctl: block: handle Persistent Reservations
[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>
1da177e4 20
55782138 21#include <trace/events/block.h>
9e234eea 22#include "blk.h"
67b42d0b 23#include "blk-rq-qos.h"
0bfc2455 24
392ddc32
JA
25/*
26 * Test patch to inline a certain number of bi_io_vec's inside the bio
27 * itself, to shrink a bio data allocation from two mempool calls to one
28 */
29#define BIO_INLINE_VECS 4
30
1da177e4
LT
31/*
32 * if you change this list, also change bvec_alloc or things will
33 * break badly! cannot be bigger than what you can fit into an
34 * unsigned short
35 */
bd5c4fac 36#define BV(x, n) { .nr_vecs = x, .name = "biovec-"#n }
ed996a52 37static struct biovec_slab bvec_slabs[BVEC_POOL_NR] __read_mostly = {
bd5c4fac 38 BV(1, 1), BV(4, 4), BV(16, 16), BV(64, 64), BV(128, 128), BV(BIO_MAX_PAGES, max),
1da177e4
LT
39};
40#undef BV
41
1da177e4
LT
42/*
43 * fs_bio_set is the bio_set containing bio and iovec memory pools used by
44 * IO code that does not need private memory pools.
45 */
f4f8154a 46struct bio_set fs_bio_set;
3f86a82a 47EXPORT_SYMBOL(fs_bio_set);
1da177e4 48
bb799ca0
JA
49/*
50 * Our slab pool management
51 */
52struct bio_slab {
53 struct kmem_cache *slab;
54 unsigned int slab_ref;
55 unsigned int slab_size;
56 char name[8];
57};
58static DEFINE_MUTEX(bio_slab_lock);
59static struct bio_slab *bio_slabs;
60static unsigned int bio_slab_nr, bio_slab_max;
61
62static struct kmem_cache *bio_find_or_create_slab(unsigned int extra_size)
63{
64 unsigned int sz = sizeof(struct bio) + extra_size;
65 struct kmem_cache *slab = NULL;
389d7b26 66 struct bio_slab *bslab, *new_bio_slabs;
386bc35a 67 unsigned int new_bio_slab_max;
bb799ca0
JA
68 unsigned int i, entry = -1;
69
70 mutex_lock(&bio_slab_lock);
71
72 i = 0;
73 while (i < bio_slab_nr) {
f06f135d 74 bslab = &bio_slabs[i];
bb799ca0
JA
75
76 if (!bslab->slab && entry == -1)
77 entry = i;
78 else if (bslab->slab_size == sz) {
79 slab = bslab->slab;
80 bslab->slab_ref++;
81 break;
82 }
83 i++;
84 }
85
86 if (slab)
87 goto out_unlock;
88
89 if (bio_slab_nr == bio_slab_max && entry == -1) {
386bc35a 90 new_bio_slab_max = bio_slab_max << 1;
389d7b26 91 new_bio_slabs = krealloc(bio_slabs,
386bc35a 92 new_bio_slab_max * sizeof(struct bio_slab),
389d7b26
AK
93 GFP_KERNEL);
94 if (!new_bio_slabs)
bb799ca0 95 goto out_unlock;
386bc35a 96 bio_slab_max = new_bio_slab_max;
389d7b26 97 bio_slabs = new_bio_slabs;
bb799ca0
JA
98 }
99 if (entry == -1)
100 entry = bio_slab_nr++;
101
102 bslab = &bio_slabs[entry];
103
104 snprintf(bslab->name, sizeof(bslab->name), "bio-%d", entry);
6a241483
MP
105 slab = kmem_cache_create(bslab->name, sz, ARCH_KMALLOC_MINALIGN,
106 SLAB_HWCACHE_ALIGN, NULL);
bb799ca0
JA
107 if (!slab)
108 goto out_unlock;
109
bb799ca0
JA
110 bslab->slab = slab;
111 bslab->slab_ref = 1;
112 bslab->slab_size = sz;
113out_unlock:
114 mutex_unlock(&bio_slab_lock);
115 return slab;
116}
117
118static void bio_put_slab(struct bio_set *bs)
119{
120 struct bio_slab *bslab = NULL;
121 unsigned int i;
122
123 mutex_lock(&bio_slab_lock);
124
125 for (i = 0; i < bio_slab_nr; i++) {
126 if (bs->bio_slab == bio_slabs[i].slab) {
127 bslab = &bio_slabs[i];
128 break;
129 }
130 }
131
132 if (WARN(!bslab, KERN_ERR "bio: unable to find slab!\n"))
133 goto out;
134
135 WARN_ON(!bslab->slab_ref);
136
137 if (--bslab->slab_ref)
138 goto out;
139
140 kmem_cache_destroy(bslab->slab);
141 bslab->slab = NULL;
142
143out:
144 mutex_unlock(&bio_slab_lock);
145}
146
7ba1ba12
MP
147unsigned int bvec_nr_vecs(unsigned short idx)
148{
d6c02a9b 149 return bvec_slabs[--idx].nr_vecs;
7ba1ba12
MP
150}
151
9f060e22 152void bvec_free(mempool_t *pool, struct bio_vec *bv, unsigned int idx)
bb799ca0 153{
ed996a52
CH
154 if (!idx)
155 return;
156 idx--;
157
158 BIO_BUG_ON(idx >= BVEC_POOL_NR);
bb799ca0 159
ed996a52 160 if (idx == BVEC_POOL_MAX) {
9f060e22 161 mempool_free(bv, pool);
ed996a52 162 } else {
bb799ca0
JA
163 struct biovec_slab *bvs = bvec_slabs + idx;
164
165 kmem_cache_free(bvs->slab, bv);
166 }
167}
168
9f060e22
KO
169struct bio_vec *bvec_alloc(gfp_t gfp_mask, int nr, unsigned long *idx,
170 mempool_t *pool)
1da177e4
LT
171{
172 struct bio_vec *bvl;
1da177e4 173
7ff9345f
JA
174 /*
175 * see comment near bvec_array define!
176 */
177 switch (nr) {
178 case 1:
179 *idx = 0;
180 break;
181 case 2 ... 4:
182 *idx = 1;
183 break;
184 case 5 ... 16:
185 *idx = 2;
186 break;
187 case 17 ... 64:
188 *idx = 3;
189 break;
190 case 65 ... 128:
191 *idx = 4;
192 break;
193 case 129 ... BIO_MAX_PAGES:
194 *idx = 5;
195 break;
196 default:
197 return NULL;
198 }
199
200 /*
201 * idx now points to the pool we want to allocate from. only the
202 * 1-vec entry pool is mempool backed.
203 */
ed996a52 204 if (*idx == BVEC_POOL_MAX) {
7ff9345f 205fallback:
9f060e22 206 bvl = mempool_alloc(pool, gfp_mask);
7ff9345f
JA
207 } else {
208 struct biovec_slab *bvs = bvec_slabs + *idx;
d0164adc 209 gfp_t __gfp_mask = gfp_mask & ~(__GFP_DIRECT_RECLAIM | __GFP_IO);
7ff9345f 210
0a0d96b0 211 /*
7ff9345f
JA
212 * Make this allocation restricted and don't dump info on
213 * allocation failures, since we'll fallback to the mempool
214 * in case of failure.
0a0d96b0 215 */
7ff9345f 216 __gfp_mask |= __GFP_NOMEMALLOC | __GFP_NORETRY | __GFP_NOWARN;
1da177e4 217
0a0d96b0 218 /*
d0164adc 219 * Try a slab allocation. If this fails and __GFP_DIRECT_RECLAIM
7ff9345f 220 * is set, retry with the 1-entry mempool
0a0d96b0 221 */
7ff9345f 222 bvl = kmem_cache_alloc(bvs->slab, __gfp_mask);
d0164adc 223 if (unlikely(!bvl && (gfp_mask & __GFP_DIRECT_RECLAIM))) {
ed996a52 224 *idx = BVEC_POOL_MAX;
7ff9345f
JA
225 goto fallback;
226 }
227 }
228
ed996a52 229 (*idx)++;
1da177e4
LT
230 return bvl;
231}
232
9ae3b3f5 233void bio_uninit(struct bio *bio)
1da177e4 234{
6f70fb66 235 bio_disassociate_blkg(bio);
ece841ab
JT
236
237 if (bio_integrity(bio))
238 bio_integrity_free(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
RD
321 * @bio: the target bio
322 * @parent: the @bio's parent 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
353 generic_make_request(bio);
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 *
df2cb6da
KO
411 * Note that when running under generic_make_request() (i.e. any block
412 * driver), bios are not submitted until after you return - see the code in
413 * generic_make_request() that converts recursion into iteration, to prevent
414 * stack overflows.
415 *
416 * This would normally mean allocating multiple bios under
417 * generic_make_request() would be susceptible to deadlocks, but we have
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
423 * generic_make_request() should be avoided - instead, use bio_set's front_pad
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
443 p = kmalloc(sizeof(struct bio) +
444 nr_iovecs * sizeof(struct bio_vec),
445 gfp_mask);
446 front_pad = 0;
447 inline_vecs = nr_iovecs;
448 } else {
d8f429e1 449 /* should not use nobvec bioset for nr_iovecs > 0 */
8aa6ba2f
KO
450 if (WARN_ON_ONCE(!mempool_initialized(&bs->bvec_pool) &&
451 nr_iovecs > 0))
d8f429e1 452 return NULL;
df2cb6da
KO
453 /*
454 * generic_make_request() converts recursion to iteration; this
455 * means if we're running beneath it, any bios we allocate and
456 * submit will not be submitted (and thus freed) until after we
457 * return.
458 *
459 * This exposes us to a potential deadlock if we allocate
460 * multiple bios from the same bio_set() while running
461 * underneath generic_make_request(). If we were to allocate
462 * multiple bios (say a stacking block driver that was splitting
463 * bios), we would deadlock if we exhausted the mempool's
464 * reserve.
465 *
466 * We solve this, and guarantee forward progress, with a rescuer
467 * workqueue per bio_set. If we go to allocate and there are
468 * bios on current->bio_list, we first try the allocation
d0164adc
MG
469 * without __GFP_DIRECT_RECLAIM; if that fails, we punt those
470 * bios we would be blocking to the rescuer workqueue before
471 * we retry with the original gfp_flags.
df2cb6da
KO
472 */
473
f5fe1b51
N
474 if (current->bio_list &&
475 (!bio_list_empty(&current->bio_list[0]) ||
47e0fb46
N
476 !bio_list_empty(&current->bio_list[1])) &&
477 bs->rescue_workqueue)
d0164adc 478 gfp_mask &= ~__GFP_DIRECT_RECLAIM;
df2cb6da 479
8aa6ba2f 480 p = mempool_alloc(&bs->bio_pool, gfp_mask);
df2cb6da
KO
481 if (!p && gfp_mask != saved_gfp) {
482 punt_bios_to_rescuer(bs);
483 gfp_mask = saved_gfp;
8aa6ba2f 484 p = mempool_alloc(&bs->bio_pool, gfp_mask);
df2cb6da
KO
485 }
486
3f86a82a
KO
487 front_pad = bs->front_pad;
488 inline_vecs = BIO_INLINE_VECS;
489 }
490
451a9ebf
TH
491 if (unlikely(!p))
492 return NULL;
1da177e4 493
3f86a82a 494 bio = p + front_pad;
3a83f467 495 bio_init(bio, NULL, 0);
34053979 496
3f86a82a 497 if (nr_iovecs > inline_vecs) {
ed996a52
CH
498 unsigned long idx = 0;
499
8aa6ba2f 500 bvl = bvec_alloc(gfp_mask, nr_iovecs, &idx, &bs->bvec_pool);
df2cb6da
KO
501 if (!bvl && gfp_mask != saved_gfp) {
502 punt_bios_to_rescuer(bs);
503 gfp_mask = saved_gfp;
8aa6ba2f 504 bvl = bvec_alloc(gfp_mask, nr_iovecs, &idx, &bs->bvec_pool);
df2cb6da
KO
505 }
506
34053979
IM
507 if (unlikely(!bvl))
508 goto err_free;
a38352e0 509
ed996a52 510 bio->bi_flags |= idx << BVEC_POOL_OFFSET;
3f86a82a
KO
511 } else if (nr_iovecs) {
512 bvl = bio->bi_inline_vecs;
1da177e4 513 }
3f86a82a
KO
514
515 bio->bi_pool = bs;
34053979 516 bio->bi_max_vecs = nr_iovecs;
34053979 517 bio->bi_io_vec = bvl;
1da177e4 518 return bio;
34053979
IM
519
520err_free:
8aa6ba2f 521 mempool_free(p, &bs->bio_pool);
34053979 522 return NULL;
1da177e4 523}
a112a71d 524EXPORT_SYMBOL(bio_alloc_bioset);
1da177e4 525
38a72dac 526void zero_fill_bio_iter(struct bio *bio, struct bvec_iter start)
1da177e4
LT
527{
528 unsigned long flags;
7988613b
KO
529 struct bio_vec bv;
530 struct bvec_iter iter;
1da177e4 531
38a72dac 532 __bio_for_each_segment(bv, bio, iter, start) {
7988613b
KO
533 char *data = bvec_kmap_irq(&bv, &flags);
534 memset(data, 0, bv.bv_len);
535 flush_dcache_page(bv.bv_page);
1da177e4
LT
536 bvec_kunmap_irq(data, &flags);
537 }
538}
38a72dac 539EXPORT_SYMBOL(zero_fill_bio_iter);
1da177e4
LT
540
541/**
542 * bio_put - release a reference to a bio
543 * @bio: bio to release reference to
544 *
545 * Description:
546 * Put a reference to a &struct bio, either one you have gotten with
9b10f6a9 547 * bio_alloc, bio_get or bio_clone_*. The last put of a bio will free it.
1da177e4
LT
548 **/
549void bio_put(struct bio *bio)
550{
dac56212 551 if (!bio_flagged(bio, BIO_REFFED))
4254bba1 552 bio_free(bio);
dac56212
JA
553 else {
554 BIO_BUG_ON(!atomic_read(&bio->__bi_cnt));
555
556 /*
557 * last put frees it
558 */
559 if (atomic_dec_and_test(&bio->__bi_cnt))
560 bio_free(bio);
561 }
1da177e4 562}
a112a71d 563EXPORT_SYMBOL(bio_put);
1da177e4 564
59d276fe
KO
565/**
566 * __bio_clone_fast - clone a bio that shares the original bio's biovec
567 * @bio: destination bio
568 * @bio_src: bio to clone
569 *
570 * Clone a &bio. Caller will own the returned bio, but not
571 * the actual data it points to. Reference count of returned
572 * bio will be one.
573 *
574 * Caller must ensure that @bio_src is not freed before @bio.
575 */
576void __bio_clone_fast(struct bio *bio, struct bio *bio_src)
577{
ed996a52 578 BUG_ON(bio->bi_pool && BVEC_POOL_IDX(bio));
59d276fe
KO
579
580 /*
74d46992 581 * most users will be overriding ->bi_disk with a new target,
59d276fe
KO
582 * so we don't set nor calculate new physical/hw segment counts here
583 */
74d46992 584 bio->bi_disk = bio_src->bi_disk;
62530ed8 585 bio->bi_partno = bio_src->bi_partno;
b7c44ed9 586 bio_set_flag(bio, BIO_CLONED);
111be883
SL
587 if (bio_flagged(bio_src, BIO_THROTTLED))
588 bio_set_flag(bio, BIO_THROTTLED);
1eff9d32 589 bio->bi_opf = bio_src->bi_opf;
ca474b73 590 bio->bi_ioprio = bio_src->bi_ioprio;
cb6934f8 591 bio->bi_write_hint = bio_src->bi_write_hint;
59d276fe
KO
592 bio->bi_iter = bio_src->bi_iter;
593 bio->bi_io_vec = bio_src->bi_io_vec;
20bd723e 594
db6638d7 595 bio_clone_blkg_association(bio, bio_src);
e439bedf 596 blkcg_bio_issue_init(bio);
59d276fe
KO
597}
598EXPORT_SYMBOL(__bio_clone_fast);
599
600/**
601 * bio_clone_fast - clone a bio that shares the original bio's biovec
602 * @bio: bio to clone
603 * @gfp_mask: allocation priority
604 * @bs: bio_set to allocate from
605 *
606 * Like __bio_clone_fast, only also allocates the returned bio
607 */
608struct bio *bio_clone_fast(struct bio *bio, gfp_t gfp_mask, struct bio_set *bs)
609{
610 struct bio *b;
611
612 b = bio_alloc_bioset(gfp_mask, 0, bs);
613 if (!b)
614 return NULL;
615
616 __bio_clone_fast(b, bio);
617
618 if (bio_integrity(bio)) {
619 int ret;
620
621 ret = bio_integrity_clone(b, bio, gfp_mask);
622
623 if (ret < 0) {
624 bio_put(b);
625 return NULL;
626 }
627 }
628
629 return b;
630}
631EXPORT_SYMBOL(bio_clone_fast);
632
5919482e
ML
633static inline bool page_is_mergeable(const struct bio_vec *bv,
634 struct page *page, unsigned int len, unsigned int off,
ff896738 635 bool *same_page)
5919482e
ML
636{
637 phys_addr_t vec_end_addr = page_to_phys(bv->bv_page) +
638 bv->bv_offset + bv->bv_len - 1;
639 phys_addr_t page_addr = page_to_phys(page);
640
641 if (vec_end_addr + 1 != page_addr + off)
642 return false;
643 if (xen_domain() && !xen_biovec_phys_mergeable(bv, page))
644 return false;
52d52d1c 645
ff896738
CH
646 *same_page = ((vec_end_addr & PAGE_MASK) == page_addr);
647 if (!*same_page && pfn_to_page(PFN_DOWN(vec_end_addr)) + 1 != page)
648 return false;
5919482e
ML
649 return true;
650}
651
384209cd
CH
652static bool bio_try_merge_pc_page(struct request_queue *q, struct bio *bio,
653 struct page *page, unsigned len, unsigned offset,
654 bool *same_page)
489fbbcb 655{
384209cd 656 struct bio_vec *bv = &bio->bi_io_vec[bio->bi_vcnt - 1];
489fbbcb
ML
657 unsigned long mask = queue_segment_boundary(q);
658 phys_addr_t addr1 = page_to_phys(bv->bv_page) + bv->bv_offset;
659 phys_addr_t addr2 = page_to_phys(page) + offset + len - 1;
660
661 if ((addr1 | mask) != (addr2 | mask))
662 return false;
489fbbcb
ML
663 if (bv->bv_len + len > queue_max_segment_size(q))
664 return false;
384209cd 665 return __bio_try_merge_page(bio, page, len, offset, same_page);
489fbbcb
ML
666}
667
1da177e4 668/**
19047087 669 * __bio_add_pc_page - attempt to add page to passthrough bio
c66a14d0
KO
670 * @q: the target queue
671 * @bio: destination bio
672 * @page: page to add
673 * @len: vec entry length
674 * @offset: vec entry offset
d1916c86 675 * @same_page: return if the merge happen inside the same page
1da177e4 676 *
c66a14d0
KO
677 * Attempt to add a page to the bio_vec maplist. This can fail for a
678 * number of reasons, such as the bio being full or target block device
679 * limitations. The target block device must allow bio's up to PAGE_SIZE,
680 * so it is always possible to add a single page to an empty bio.
681 *
5a8ce240 682 * This should only be used by passthrough bios.
1da177e4 683 */
4713839d 684static int __bio_add_pc_page(struct request_queue *q, struct bio *bio,
19047087 685 struct page *page, unsigned int len, unsigned int offset,
d1916c86 686 bool *same_page)
1da177e4 687{
1da177e4
LT
688 struct bio_vec *bvec;
689
690 /*
691 * cloned bio must not modify vec list
692 */
693 if (unlikely(bio_flagged(bio, BIO_CLONED)))
694 return 0;
695
c66a14d0 696 if (((bio->bi_iter.bi_size + len) >> 9) > queue_max_hw_sectors(q))
1da177e4
LT
697 return 0;
698
80cfd548 699 if (bio->bi_vcnt > 0) {
d1916c86 700 if (bio_try_merge_pc_page(q, bio, page, len, offset, same_page))
384209cd 701 return len;
320ea869
CH
702
703 /*
704 * If the queue doesn't support SG gaps and adding this segment
705 * would create a gap, disallow it.
706 */
384209cd 707 bvec = &bio->bi_io_vec[bio->bi_vcnt - 1];
320ea869
CH
708 if (bvec_gap_to_prev(q, bvec, offset))
709 return 0;
80cfd548
JA
710 }
711
79d08f89 712 if (bio_full(bio, len))
1da177e4
LT
713 return 0;
714
14ccb66b 715 if (bio->bi_vcnt >= queue_max_segments(q))
489fbbcb
ML
716 return 0;
717
fcbf6a08
ML
718 bvec = &bio->bi_io_vec[bio->bi_vcnt];
719 bvec->bv_page = page;
720 bvec->bv_len = len;
721 bvec->bv_offset = offset;
722 bio->bi_vcnt++;
dcdca753 723 bio->bi_iter.bi_size += len;
1da177e4
LT
724 return len;
725}
19047087
ML
726
727int bio_add_pc_page(struct request_queue *q, struct bio *bio,
728 struct page *page, unsigned int len, unsigned int offset)
729{
d1916c86
CH
730 bool same_page = false;
731 return __bio_add_pc_page(q, bio, page, len, offset, &same_page);
19047087 732}
a112a71d 733EXPORT_SYMBOL(bio_add_pc_page);
6e68af66 734
1da177e4 735/**
0aa69fd3
CH
736 * __bio_try_merge_page - try appending data to an existing bvec.
737 * @bio: destination bio
551879a4 738 * @page: start page to add
0aa69fd3 739 * @len: length of the data to add
551879a4 740 * @off: offset of the data relative to @page
ff896738 741 * @same_page: return if the segment has been merged inside the same page
1da177e4 742 *
0aa69fd3
CH
743 * Try to add the data at @page + @off to the last bvec of @bio. This is a
744 * a useful optimisation for file systems with a block size smaller than the
745 * page size.
746 *
551879a4
ML
747 * Warn if (@len, @off) crosses pages in case that @same_page is true.
748 *
0aa69fd3 749 * Return %true on success or %false on failure.
1da177e4 750 */
0aa69fd3 751bool __bio_try_merge_page(struct bio *bio, struct page *page,
ff896738 752 unsigned int len, unsigned int off, bool *same_page)
1da177e4 753{
c66a14d0 754 if (WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED)))
0aa69fd3 755 return false;
762380ad 756
cc90bc68 757 if (bio->bi_vcnt > 0) {
0aa69fd3 758 struct bio_vec *bv = &bio->bi_io_vec[bio->bi_vcnt - 1];
5919482e
ML
759
760 if (page_is_mergeable(bv, page, len, off, same_page)) {
cc90bc68
AG
761 if (bio->bi_iter.bi_size > UINT_MAX - len)
762 return false;
5919482e
ML
763 bv->bv_len += len;
764 bio->bi_iter.bi_size += len;
765 return true;
766 }
c66a14d0 767 }
0aa69fd3
CH
768 return false;
769}
770EXPORT_SYMBOL_GPL(__bio_try_merge_page);
c66a14d0 771
0aa69fd3 772/**
551879a4 773 * __bio_add_page - add page(s) to a bio in a new segment
0aa69fd3 774 * @bio: destination bio
551879a4
ML
775 * @page: start page to add
776 * @len: length of the data to add, may cross pages
777 * @off: offset of the data relative to @page, may cross pages
0aa69fd3
CH
778 *
779 * Add the data at @page + @off to @bio as a new bvec. The caller must ensure
780 * that @bio has space for another bvec.
781 */
782void __bio_add_page(struct bio *bio, struct page *page,
783 unsigned int len, unsigned int off)
784{
785 struct bio_vec *bv = &bio->bi_io_vec[bio->bi_vcnt];
c66a14d0 786
0aa69fd3 787 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
79d08f89 788 WARN_ON_ONCE(bio_full(bio, len));
0aa69fd3
CH
789
790 bv->bv_page = page;
791 bv->bv_offset = off;
792 bv->bv_len = len;
c66a14d0 793
c66a14d0 794 bio->bi_iter.bi_size += len;
0aa69fd3 795 bio->bi_vcnt++;
b8e24a93
JW
796
797 if (!bio_flagged(bio, BIO_WORKINGSET) && unlikely(PageWorkingset(page)))
798 bio_set_flag(bio, BIO_WORKINGSET);
0aa69fd3
CH
799}
800EXPORT_SYMBOL_GPL(__bio_add_page);
801
802/**
551879a4 803 * bio_add_page - attempt to add page(s) to bio
0aa69fd3 804 * @bio: destination bio
551879a4
ML
805 * @page: start page to add
806 * @len: vec entry length, may cross pages
807 * @offset: vec entry offset relative to @page, may cross pages
0aa69fd3 808 *
551879a4 809 * Attempt to add page(s) to the bio_vec maplist. This will only fail
0aa69fd3
CH
810 * if either bio->bi_vcnt == bio->bi_max_vecs or it's a cloned bio.
811 */
812int bio_add_page(struct bio *bio, struct page *page,
813 unsigned int len, unsigned int offset)
814{
ff896738
CH
815 bool same_page = false;
816
817 if (!__bio_try_merge_page(bio, page, len, offset, &same_page)) {
79d08f89 818 if (bio_full(bio, len))
0aa69fd3
CH
819 return 0;
820 __bio_add_page(bio, page, len, offset);
821 }
c66a14d0 822 return len;
1da177e4 823}
a112a71d 824EXPORT_SYMBOL(bio_add_page);
1da177e4 825
d241a95f 826void bio_release_pages(struct bio *bio, bool mark_dirty)
7321ecbf
CH
827{
828 struct bvec_iter_all iter_all;
829 struct bio_vec *bvec;
7321ecbf 830
b2d0d991
CH
831 if (bio_flagged(bio, BIO_NO_PAGE_REF))
832 return;
833
d241a95f
CH
834 bio_for_each_segment_all(bvec, bio, iter_all) {
835 if (mark_dirty && !PageCompound(bvec->bv_page))
836 set_page_dirty_lock(bvec->bv_page);
7321ecbf 837 put_page(bvec->bv_page);
d241a95f 838 }
7321ecbf
CH
839}
840
6d0c48ae
JA
841static int __bio_iov_bvec_add_pages(struct bio *bio, struct iov_iter *iter)
842{
843 const struct bio_vec *bv = iter->bvec;
844 unsigned int len;
845 size_t size;
846
847 if (WARN_ON_ONCE(iter->iov_offset > bv->bv_len))
848 return -EINVAL;
849
850 len = min_t(size_t, bv->bv_len - iter->iov_offset, iter->count);
851 size = bio_add_page(bio, bv->bv_page, len,
852 bv->bv_offset + iter->iov_offset);
a10584c3
CH
853 if (unlikely(size != len))
854 return -EINVAL;
a10584c3
CH
855 iov_iter_advance(iter, size);
856 return 0;
6d0c48ae
JA
857}
858
576ed913
CH
859#define PAGE_PTRS_PER_BVEC (sizeof(struct bio_vec) / sizeof(struct page *))
860
2cefe4db 861/**
17d51b10 862 * __bio_iov_iter_get_pages - pin user or kernel pages and add them to a bio
2cefe4db
KO
863 * @bio: bio to add pages to
864 * @iter: iov iterator describing the region to be mapped
865 *
17d51b10 866 * Pins pages from *iter and appends them to @bio's bvec array. The
2cefe4db 867 * pages will have to be released using put_page() when done.
17d51b10
MW
868 * For multi-segment *iter, this function only adds pages from the
869 * the next non-empty segment of the iov iterator.
2cefe4db 870 */
17d51b10 871static int __bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter)
2cefe4db 872{
576ed913
CH
873 unsigned short nr_pages = bio->bi_max_vecs - bio->bi_vcnt;
874 unsigned short entries_left = bio->bi_max_vecs - bio->bi_vcnt;
2cefe4db
KO
875 struct bio_vec *bv = bio->bi_io_vec + bio->bi_vcnt;
876 struct page **pages = (struct page **)bv;
45691804 877 bool same_page = false;
576ed913
CH
878 ssize_t size, left;
879 unsigned len, i;
b403ea24 880 size_t offset;
576ed913
CH
881
882 /*
883 * Move page array up in the allocated memory for the bio vecs as far as
884 * possible so that we can start filling biovecs from the beginning
885 * without overwriting the temporary page array.
886 */
887 BUILD_BUG_ON(PAGE_PTRS_PER_BVEC < 2);
888 pages += entries_left * (PAGE_PTRS_PER_BVEC - 1);
2cefe4db
KO
889
890 size = iov_iter_get_pages(iter, pages, LONG_MAX, nr_pages, &offset);
891 if (unlikely(size <= 0))
892 return size ? size : -EFAULT;
2cefe4db 893
576ed913
CH
894 for (left = size, i = 0; left > 0; left -= len, i++) {
895 struct page *page = pages[i];
2cefe4db 896
576ed913 897 len = min_t(size_t, PAGE_SIZE - offset, left);
45691804
CH
898
899 if (__bio_try_merge_page(bio, page, len, offset, &same_page)) {
900 if (same_page)
901 put_page(page);
902 } else {
79d08f89 903 if (WARN_ON_ONCE(bio_full(bio, len)))
45691804
CH
904 return -EINVAL;
905 __bio_add_page(bio, page, len, offset);
906 }
576ed913 907 offset = 0;
2cefe4db
KO
908 }
909
2cefe4db
KO
910 iov_iter_advance(iter, size);
911 return 0;
912}
17d51b10
MW
913
914/**
6d0c48ae 915 * bio_iov_iter_get_pages - add user or kernel pages to a bio
17d51b10 916 * @bio: bio to add pages to
6d0c48ae
JA
917 * @iter: iov iterator describing the region to be added
918 *
919 * This takes either an iterator pointing to user memory, or one pointing to
920 * kernel pages (BVEC iterator). If we're adding user pages, we pin them and
921 * map them into the kernel. On IO completion, the caller should put those
399254aa
JA
922 * pages. If we're adding kernel pages, and the caller told us it's safe to
923 * do so, we just have to add the pages to the bio directly. We don't grab an
924 * extra reference to those pages (the user should already have that), and we
925 * don't put the page on IO completion. The caller needs to check if the bio is
926 * flagged BIO_NO_PAGE_REF on IO completion. If it isn't, then pages should be
927 * released.
17d51b10 928 *
17d51b10 929 * The function tries, but does not guarantee, to pin as many pages as
6d0c48ae
JA
930 * fit into the bio, or are requested in *iter, whatever is smaller. If
931 * MM encounters an error pinning the requested pages, it stops. Error
932 * is returned only if 0 pages could be pinned.
17d51b10
MW
933 */
934int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter)
935{
6d0c48ae 936 const bool is_bvec = iov_iter_is_bvec(iter);
14eacf12
CH
937 int ret;
938
939 if (WARN_ON_ONCE(bio->bi_vcnt))
940 return -EINVAL;
17d51b10
MW
941
942 do {
6d0c48ae
JA
943 if (is_bvec)
944 ret = __bio_iov_bvec_add_pages(bio, iter);
945 else
946 ret = __bio_iov_iter_get_pages(bio, iter);
79d08f89 947 } while (!ret && iov_iter_count(iter) && !bio_full(bio, 0));
17d51b10 948
b6207430 949 if (is_bvec)
7321ecbf 950 bio_set_flag(bio, BIO_NO_PAGE_REF);
14eacf12 951 return bio->bi_vcnt ? 0 : ret;
17d51b10 952}
2cefe4db 953
4246a0b6 954static void submit_bio_wait_endio(struct bio *bio)
9e882242 955{
65e53aab 956 complete(bio->bi_private);
9e882242
KO
957}
958
959/**
960 * submit_bio_wait - submit a bio, and wait until it completes
9e882242
KO
961 * @bio: The &struct bio which describes the I/O
962 *
963 * Simple wrapper around submit_bio(). Returns 0 on success, or the error from
964 * bio_endio() on failure.
3d289d68
JK
965 *
966 * WARNING: Unlike to how submit_bio() is usually used, this function does not
967 * result in bio reference to be consumed. The caller must drop the reference
968 * on his own.
9e882242 969 */
4e49ea4a 970int submit_bio_wait(struct bio *bio)
9e882242 971{
e319e1fb 972 DECLARE_COMPLETION_ONSTACK_MAP(done, bio->bi_disk->lockdep_map);
9e882242 973
65e53aab 974 bio->bi_private = &done;
9e882242 975 bio->bi_end_io = submit_bio_wait_endio;
1eff9d32 976 bio->bi_opf |= REQ_SYNC;
4e49ea4a 977 submit_bio(bio);
65e53aab 978 wait_for_completion_io(&done);
9e882242 979
65e53aab 980 return blk_status_to_errno(bio->bi_status);
9e882242
KO
981}
982EXPORT_SYMBOL(submit_bio_wait);
983
054bdf64
KO
984/**
985 * bio_advance - increment/complete a bio by some number of bytes
986 * @bio: bio to advance
987 * @bytes: number of bytes to complete
988 *
989 * This updates bi_sector, bi_size and bi_idx; if the number of bytes to
990 * complete doesn't align with a bvec boundary, then bv_len and bv_offset will
991 * be updated on the last bvec as well.
992 *
993 * @bio will then represent the remaining, uncompleted portion of the io.
994 */
995void bio_advance(struct bio *bio, unsigned bytes)
996{
997 if (bio_integrity(bio))
998 bio_integrity_advance(bio, bytes);
999
4550dd6c 1000 bio_advance_iter(bio, &bio->bi_iter, bytes);
054bdf64
KO
1001}
1002EXPORT_SYMBOL(bio_advance);
1003
45db54d5
KO
1004void bio_copy_data_iter(struct bio *dst, struct bvec_iter *dst_iter,
1005 struct bio *src, struct bvec_iter *src_iter)
16ac3d63 1006{
1cb9dda4 1007 struct bio_vec src_bv, dst_bv;
16ac3d63 1008 void *src_p, *dst_p;
1cb9dda4 1009 unsigned bytes;
16ac3d63 1010
45db54d5
KO
1011 while (src_iter->bi_size && dst_iter->bi_size) {
1012 src_bv = bio_iter_iovec(src, *src_iter);
1013 dst_bv = bio_iter_iovec(dst, *dst_iter);
1cb9dda4
KO
1014
1015 bytes = min(src_bv.bv_len, dst_bv.bv_len);
16ac3d63 1016
1cb9dda4
KO
1017 src_p = kmap_atomic(src_bv.bv_page);
1018 dst_p = kmap_atomic(dst_bv.bv_page);
16ac3d63 1019
1cb9dda4
KO
1020 memcpy(dst_p + dst_bv.bv_offset,
1021 src_p + src_bv.bv_offset,
16ac3d63
KO
1022 bytes);
1023
1024 kunmap_atomic(dst_p);
1025 kunmap_atomic(src_p);
1026
6e6e811d
KO
1027 flush_dcache_page(dst_bv.bv_page);
1028
45db54d5
KO
1029 bio_advance_iter(src, src_iter, bytes);
1030 bio_advance_iter(dst, dst_iter, bytes);
16ac3d63
KO
1031 }
1032}
38a72dac
KO
1033EXPORT_SYMBOL(bio_copy_data_iter);
1034
1035/**
45db54d5
KO
1036 * bio_copy_data - copy contents of data buffers from one bio to another
1037 * @src: source bio
1038 * @dst: destination bio
38a72dac
KO
1039 *
1040 * Stops when it reaches the end of either @src or @dst - that is, copies
1041 * min(src->bi_size, dst->bi_size) bytes (or the equivalent for lists of bios).
1042 */
1043void bio_copy_data(struct bio *dst, struct bio *src)
1044{
45db54d5
KO
1045 struct bvec_iter src_iter = src->bi_iter;
1046 struct bvec_iter dst_iter = dst->bi_iter;
1047
1048 bio_copy_data_iter(dst, &dst_iter, src, &src_iter);
38a72dac 1049}
16ac3d63
KO
1050EXPORT_SYMBOL(bio_copy_data);
1051
45db54d5
KO
1052/**
1053 * bio_list_copy_data - copy contents of data buffers from one chain of bios to
1054 * another
1055 * @src: source bio list
1056 * @dst: destination bio list
1057 *
1058 * Stops when it reaches the end of either the @src list or @dst list - that is,
1059 * copies min(src->bi_size, dst->bi_size) bytes (or the equivalent for lists of
1060 * bios).
1061 */
1062void bio_list_copy_data(struct bio *dst, struct bio *src)
1063{
1064 struct bvec_iter src_iter = src->bi_iter;
1065 struct bvec_iter dst_iter = dst->bi_iter;
1066
1067 while (1) {
1068 if (!src_iter.bi_size) {
1069 src = src->bi_next;
1070 if (!src)
1071 break;
1072
1073 src_iter = src->bi_iter;
1074 }
1075
1076 if (!dst_iter.bi_size) {
1077 dst = dst->bi_next;
1078 if (!dst)
1079 break;
1080
1081 dst_iter = dst->bi_iter;
1082 }
1083
1084 bio_copy_data_iter(dst, &dst_iter, src, &src_iter);
1085 }
1086}
1087EXPORT_SYMBOL(bio_list_copy_data);
1088
1da177e4 1089struct bio_map_data {
152e283f 1090 int is_our_pages;
26e49cfc
KO
1091 struct iov_iter iter;
1092 struct iovec iov[];
1da177e4
LT
1093};
1094
0e5b935d 1095static struct bio_map_data *bio_alloc_map_data(struct iov_iter *data,
76029ff3 1096 gfp_t gfp_mask)
1da177e4 1097{
0e5b935d
AV
1098 struct bio_map_data *bmd;
1099 if (data->nr_segs > UIO_MAXIOV)
f3f63c1c 1100 return NULL;
1da177e4 1101
f1f8f292 1102 bmd = kmalloc(struct_size(bmd, iov, data->nr_segs), gfp_mask);
0e5b935d
AV
1103 if (!bmd)
1104 return NULL;
1105 memcpy(bmd->iov, data->iov, sizeof(struct iovec) * data->nr_segs);
1106 bmd->iter = *data;
1107 bmd->iter.iov = bmd->iov;
1108 return bmd;
1da177e4
LT
1109}
1110
9124d3fe
DP
1111/**
1112 * bio_copy_from_iter - copy all pages from iov_iter to bio
1113 * @bio: The &struct bio which describes the I/O as destination
1114 * @iter: iov_iter as source
1115 *
1116 * Copy all pages from iov_iter to bio.
1117 * Returns 0 on success, or error on failure.
1118 */
98a09d61 1119static int bio_copy_from_iter(struct bio *bio, struct iov_iter *iter)
c5dec1c3 1120{
c5dec1c3 1121 struct bio_vec *bvec;
6dc4f100 1122 struct bvec_iter_all iter_all;
c5dec1c3 1123
2b070cfe 1124 bio_for_each_segment_all(bvec, bio, iter_all) {
9124d3fe 1125 ssize_t ret;
c5dec1c3 1126
9124d3fe
DP
1127 ret = copy_page_from_iter(bvec->bv_page,
1128 bvec->bv_offset,
1129 bvec->bv_len,
98a09d61 1130 iter);
9124d3fe 1131
98a09d61 1132 if (!iov_iter_count(iter))
9124d3fe
DP
1133 break;
1134
1135 if (ret < bvec->bv_len)
1136 return -EFAULT;
c5dec1c3
FT
1137 }
1138
9124d3fe
DP
1139 return 0;
1140}
1141
1142/**
1143 * bio_copy_to_iter - copy all pages from bio to iov_iter
1144 * @bio: The &struct bio which describes the I/O as source
1145 * @iter: iov_iter as destination
1146 *
1147 * Copy all pages from bio to iov_iter.
1148 * Returns 0 on success, or error on failure.
1149 */
1150static int bio_copy_to_iter(struct bio *bio, struct iov_iter iter)
1151{
9124d3fe 1152 struct bio_vec *bvec;
6dc4f100 1153 struct bvec_iter_all iter_all;
9124d3fe 1154
2b070cfe 1155 bio_for_each_segment_all(bvec, bio, iter_all) {
9124d3fe
DP
1156 ssize_t ret;
1157
1158 ret = copy_page_to_iter(bvec->bv_page,
1159 bvec->bv_offset,
1160 bvec->bv_len,
1161 &iter);
1162
1163 if (!iov_iter_count(&iter))
1164 break;
1165
1166 if (ret < bvec->bv_len)
1167 return -EFAULT;
1168 }
1169
1170 return 0;
c5dec1c3
FT
1171}
1172
491221f8 1173void bio_free_pages(struct bio *bio)
1dfa0f68
CH
1174{
1175 struct bio_vec *bvec;
6dc4f100 1176 struct bvec_iter_all iter_all;
1dfa0f68 1177
2b070cfe 1178 bio_for_each_segment_all(bvec, bio, iter_all)
1dfa0f68
CH
1179 __free_page(bvec->bv_page);
1180}
491221f8 1181EXPORT_SYMBOL(bio_free_pages);
1dfa0f68 1182
1da177e4
LT
1183/**
1184 * bio_uncopy_user - finish previously mapped bio
1185 * @bio: bio being terminated
1186 *
ddad8dd0 1187 * Free pages allocated from bio_copy_user_iov() and write back data
1da177e4
LT
1188 * to user space in case of a read.
1189 */
1190int bio_uncopy_user(struct bio *bio)
1191{
1192 struct bio_map_data *bmd = bio->bi_private;
1dfa0f68 1193 int ret = 0;
1da177e4 1194
35dc2483
RD
1195 if (!bio_flagged(bio, BIO_NULL_MAPPED)) {
1196 /*
1197 * if we're in a workqueue, the request is orphaned, so
2d99b55d
HR
1198 * don't copy into a random user address space, just free
1199 * and return -EINTR so user space doesn't expect any data.
35dc2483 1200 */
2d99b55d
HR
1201 if (!current->mm)
1202 ret = -EINTR;
1203 else if (bio_data_dir(bio) == READ)
9124d3fe 1204 ret = bio_copy_to_iter(bio, bmd->iter);
1dfa0f68
CH
1205 if (bmd->is_our_pages)
1206 bio_free_pages(bio);
35dc2483 1207 }
c8db4448 1208 kfree(bmd);
1da177e4
LT
1209 bio_put(bio);
1210 return ret;
1211}
1212
1213/**
c5dec1c3 1214 * bio_copy_user_iov - copy user data to bio
26e49cfc
KO
1215 * @q: destination block queue
1216 * @map_data: pointer to the rq_map_data holding pages (if necessary)
1217 * @iter: iovec iterator
1218 * @gfp_mask: memory allocation flags
1da177e4
LT
1219 *
1220 * Prepares and returns a bio for indirect user io, bouncing data
1221 * to/from kernel pages as necessary. Must be paired with
1222 * call bio_uncopy_user() on io completion.
1223 */
152e283f
FT
1224struct bio *bio_copy_user_iov(struct request_queue *q,
1225 struct rq_map_data *map_data,
e81cef5d 1226 struct iov_iter *iter,
26e49cfc 1227 gfp_t gfp_mask)
1da177e4 1228{
1da177e4 1229 struct bio_map_data *bmd;
1da177e4
LT
1230 struct page *page;
1231 struct bio *bio;
d16d44eb
AV
1232 int i = 0, ret;
1233 int nr_pages;
26e49cfc 1234 unsigned int len = iter->count;
bd5cecea 1235 unsigned int offset = map_data ? offset_in_page(map_data->offset) : 0;
1da177e4 1236
0e5b935d 1237 bmd = bio_alloc_map_data(iter, gfp_mask);
1da177e4
LT
1238 if (!bmd)
1239 return ERR_PTR(-ENOMEM);
1240
26e49cfc
KO
1241 /*
1242 * We need to do a deep copy of the iov_iter including the iovecs.
1243 * The caller provided iov might point to an on-stack or otherwise
1244 * shortlived one.
1245 */
1246 bmd->is_our_pages = map_data ? 0 : 1;
26e49cfc 1247
d16d44eb
AV
1248 nr_pages = DIV_ROUND_UP(offset + len, PAGE_SIZE);
1249 if (nr_pages > BIO_MAX_PAGES)
1250 nr_pages = BIO_MAX_PAGES;
26e49cfc 1251
1da177e4 1252 ret = -ENOMEM;
a9e9dc24 1253 bio = bio_kmalloc(gfp_mask, nr_pages);
1da177e4
LT
1254 if (!bio)
1255 goto out_bmd;
1256
1da177e4 1257 ret = 0;
56c451f4
FT
1258
1259 if (map_data) {
e623ddb4 1260 nr_pages = 1 << map_data->page_order;
56c451f4
FT
1261 i = map_data->offset / PAGE_SIZE;
1262 }
1da177e4 1263 while (len) {
e623ddb4 1264 unsigned int bytes = PAGE_SIZE;
1da177e4 1265
56c451f4
FT
1266 bytes -= offset;
1267
1da177e4
LT
1268 if (bytes > len)
1269 bytes = len;
1270
152e283f 1271 if (map_data) {
e623ddb4 1272 if (i == map_data->nr_entries * nr_pages) {
152e283f
FT
1273 ret = -ENOMEM;
1274 break;
1275 }
e623ddb4
FT
1276
1277 page = map_data->pages[i / nr_pages];
1278 page += (i % nr_pages);
1279
1280 i++;
1281 } else {
152e283f 1282 page = alloc_page(q->bounce_gfp | gfp_mask);
e623ddb4
FT
1283 if (!page) {
1284 ret = -ENOMEM;
1285 break;
1286 }
1da177e4
LT
1287 }
1288
a3761c3c
JG
1289 if (bio_add_pc_page(q, bio, page, bytes, offset) < bytes) {
1290 if (!map_data)
1291 __free_page(page);
1da177e4 1292 break;
a3761c3c 1293 }
1da177e4
LT
1294
1295 len -= bytes;
56c451f4 1296 offset = 0;
1da177e4
LT
1297 }
1298
1299 if (ret)
1300 goto cleanup;
1301
2884d0be
AV
1302 if (map_data)
1303 map_data->offset += bio->bi_iter.bi_size;
1304
1da177e4
LT
1305 /*
1306 * success
1307 */
00e23707 1308 if ((iov_iter_rw(iter) == WRITE && (!map_data || !map_data->null_mapped)) ||
ecb554a8 1309 (map_data && map_data->from_user)) {
98a09d61 1310 ret = bio_copy_from_iter(bio, iter);
c5dec1c3
FT
1311 if (ret)
1312 goto cleanup;
98a09d61 1313 } else {
f55adad6
KB
1314 if (bmd->is_our_pages)
1315 zero_fill_bio(bio);
98a09d61 1316 iov_iter_advance(iter, bio->bi_iter.bi_size);
1da177e4
LT
1317 }
1318
26e49cfc 1319 bio->bi_private = bmd;
2884d0be
AV
1320 if (map_data && map_data->null_mapped)
1321 bio_set_flag(bio, BIO_NULL_MAPPED);
1da177e4
LT
1322 return bio;
1323cleanup:
152e283f 1324 if (!map_data)
1dfa0f68 1325 bio_free_pages(bio);
1da177e4
LT
1326 bio_put(bio);
1327out_bmd:
c8db4448 1328 kfree(bmd);
1da177e4
LT
1329 return ERR_PTR(ret);
1330}
1331
37f19e57
CH
1332/**
1333 * bio_map_user_iov - map user iovec into bio
1334 * @q: the struct request_queue for the bio
1335 * @iter: iovec iterator
1336 * @gfp_mask: memory allocation flags
1337 *
1338 * Map the user space address into a bio suitable for io to a block
1339 * device. Returns an error pointer in case of error.
1340 */
1341struct bio *bio_map_user_iov(struct request_queue *q,
e81cef5d 1342 struct iov_iter *iter,
37f19e57 1343 gfp_t gfp_mask)
1da177e4 1344{
26e49cfc 1345 int j;
1da177e4 1346 struct bio *bio;
076098e5 1347 int ret;
1da177e4 1348
b282cc76 1349 if (!iov_iter_count(iter))
1da177e4
LT
1350 return ERR_PTR(-EINVAL);
1351
b282cc76 1352 bio = bio_kmalloc(gfp_mask, iov_iter_npages(iter, BIO_MAX_PAGES));
1da177e4
LT
1353 if (!bio)
1354 return ERR_PTR(-ENOMEM);
1355
0a0f1513 1356 while (iov_iter_count(iter)) {
629e42bc 1357 struct page **pages;
076098e5
AV
1358 ssize_t bytes;
1359 size_t offs, added = 0;
1360 int npages;
1da177e4 1361
0a0f1513 1362 bytes = iov_iter_get_pages_alloc(iter, &pages, LONG_MAX, &offs);
076098e5
AV
1363 if (unlikely(bytes <= 0)) {
1364 ret = bytes ? bytes : -EFAULT;
f1970baf 1365 goto out_unmap;
99172157 1366 }
f1970baf 1367
076098e5 1368 npages = DIV_ROUND_UP(offs + bytes, PAGE_SIZE);
f1970baf 1369
98f0bc99
AV
1370 if (unlikely(offs & queue_dma_alignment(q))) {
1371 ret = -EINVAL;
1372 j = 0;
1373 } else {
1374 for (j = 0; j < npages; j++) {
1375 struct page *page = pages[j];
1376 unsigned int n = PAGE_SIZE - offs;
d1916c86 1377 bool same_page = false;
f1970baf 1378
98f0bc99
AV
1379 if (n > bytes)
1380 n = bytes;
95d78c28 1381
19047087 1382 if (!__bio_add_pc_page(q, bio, page, n, offs,
d1916c86
CH
1383 &same_page)) {
1384 if (same_page)
1385 put_page(page);
98f0bc99 1386 break;
d1916c86 1387 }
1da177e4 1388
98f0bc99
AV
1389 added += n;
1390 bytes -= n;
1391 offs = 0;
1392 }
0a0f1513 1393 iov_iter_advance(iter, added);
f1970baf 1394 }
1da177e4 1395 /*
f1970baf 1396 * release the pages we didn't map into the bio, if any
1da177e4 1397 */
629e42bc 1398 while (j < npages)
09cbfeaf 1399 put_page(pages[j++]);
629e42bc 1400 kvfree(pages);
e2e115d1
AV
1401 /* couldn't stuff something into bio? */
1402 if (bytes)
1403 break;
1da177e4
LT
1404 }
1405
b7c44ed9 1406 bio_set_flag(bio, BIO_USER_MAPPED);
37f19e57
CH
1407
1408 /*
5fad1b64 1409 * subtle -- if bio_map_user_iov() ended up bouncing a bio,
37f19e57
CH
1410 * it would normally disappear when its bi_end_io is run.
1411 * however, we need it for the unmap, so grab an extra
1412 * reference to it
1413 */
1414 bio_get(bio);
1da177e4 1415 return bio;
f1970baf
JB
1416
1417 out_unmap:
506e0798 1418 bio_release_pages(bio, false);
1da177e4
LT
1419 bio_put(bio);
1420 return ERR_PTR(ret);
1421}
1422
1da177e4
LT
1423/**
1424 * bio_unmap_user - unmap a bio
1425 * @bio: the bio being unmapped
1426 *
5fad1b64
BVA
1427 * Unmap a bio previously mapped by bio_map_user_iov(). Must be called from
1428 * process context.
1da177e4
LT
1429 *
1430 * bio_unmap_user() may sleep.
1431 */
1432void bio_unmap_user(struct bio *bio)
1433{
163cc2d3
CH
1434 bio_release_pages(bio, bio_data_dir(bio) == READ);
1435 bio_put(bio);
1da177e4
LT
1436 bio_put(bio);
1437}
1438
b4c5875d
DLM
1439static void bio_invalidate_vmalloc_pages(struct bio *bio)
1440{
1441#ifdef ARCH_HAS_FLUSH_KERNEL_DCACHE_PAGE
1442 if (bio->bi_private && !op_is_write(bio_op(bio))) {
1443 unsigned long i, len = 0;
1444
1445 for (i = 0; i < bio->bi_vcnt; i++)
1446 len += bio->bi_io_vec[i].bv_len;
1447 invalidate_kernel_vmap_range(bio->bi_private, len);
1448 }
1449#endif
1450}
1451
4246a0b6 1452static void bio_map_kern_endio(struct bio *bio)
b823825e 1453{
b4c5875d 1454 bio_invalidate_vmalloc_pages(bio);
b823825e 1455 bio_put(bio);
b823825e
JA
1456}
1457
75c72b83
CH
1458/**
1459 * bio_map_kern - map kernel address into bio
1460 * @q: the struct request_queue for the bio
1461 * @data: pointer to buffer to map
1462 * @len: length in bytes
1463 * @gfp_mask: allocation flags for bio allocation
1464 *
1465 * Map the kernel address into a bio suitable for io to a block
1466 * device. Returns an error pointer in case of error.
1467 */
1468struct bio *bio_map_kern(struct request_queue *q, void *data, unsigned int len,
1469 gfp_t gfp_mask)
df46b9a4
MC
1470{
1471 unsigned long kaddr = (unsigned long)data;
1472 unsigned long end = (kaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1473 unsigned long start = kaddr >> PAGE_SHIFT;
1474 const int nr_pages = end - start;
b4c5875d
DLM
1475 bool is_vmalloc = is_vmalloc_addr(data);
1476 struct page *page;
df46b9a4
MC
1477 int offset, i;
1478 struct bio *bio;
1479
a9e9dc24 1480 bio = bio_kmalloc(gfp_mask, nr_pages);
df46b9a4
MC
1481 if (!bio)
1482 return ERR_PTR(-ENOMEM);
1483
b4c5875d
DLM
1484 if (is_vmalloc) {
1485 flush_kernel_vmap_range(data, len);
1486 bio->bi_private = data;
1487 }
1488
df46b9a4
MC
1489 offset = offset_in_page(kaddr);
1490 for (i = 0; i < nr_pages; i++) {
1491 unsigned int bytes = PAGE_SIZE - offset;
1492
1493 if (len <= 0)
1494 break;
1495
1496 if (bytes > len)
1497 bytes = len;
1498
b4c5875d
DLM
1499 if (!is_vmalloc)
1500 page = virt_to_page(data);
1501 else
1502 page = vmalloc_to_page(data);
1503 if (bio_add_pc_page(q, bio, page, bytes,
75c72b83
CH
1504 offset) < bytes) {
1505 /* we don't support partial mappings */
1506 bio_put(bio);
1507 return ERR_PTR(-EINVAL);
1508 }
df46b9a4
MC
1509
1510 data += bytes;
1511 len -= bytes;
1512 offset = 0;
1513 }
1514
b823825e 1515 bio->bi_end_io = bio_map_kern_endio;
df46b9a4
MC
1516 return bio;
1517}
df46b9a4 1518
4246a0b6 1519static void bio_copy_kern_endio(struct bio *bio)
68154e90 1520{
1dfa0f68
CH
1521 bio_free_pages(bio);
1522 bio_put(bio);
1523}
1524
4246a0b6 1525static void bio_copy_kern_endio_read(struct bio *bio)
1dfa0f68 1526{
42d2683a 1527 char *p = bio->bi_private;
1dfa0f68 1528 struct bio_vec *bvec;
6dc4f100 1529 struct bvec_iter_all iter_all;
68154e90 1530
2b070cfe 1531 bio_for_each_segment_all(bvec, bio, iter_all) {
1dfa0f68 1532 memcpy(p, page_address(bvec->bv_page), bvec->bv_len);
c8db4448 1533 p += bvec->bv_len;
68154e90
FT
1534 }
1535
4246a0b6 1536 bio_copy_kern_endio(bio);
68154e90
FT
1537}
1538
1539/**
1540 * bio_copy_kern - copy kernel address into bio
1541 * @q: the struct request_queue for the bio
1542 * @data: pointer to buffer to copy
1543 * @len: length in bytes
1544 * @gfp_mask: allocation flags for bio and page allocation
ffee0259 1545 * @reading: data direction is READ
68154e90
FT
1546 *
1547 * copy the kernel address into a bio suitable for io to a block
1548 * device. Returns an error pointer in case of error.
1549 */
1550struct bio *bio_copy_kern(struct request_queue *q, void *data, unsigned int len,
1551 gfp_t gfp_mask, int reading)
1552{
42d2683a
CH
1553 unsigned long kaddr = (unsigned long)data;
1554 unsigned long end = (kaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1555 unsigned long start = kaddr >> PAGE_SHIFT;
42d2683a
CH
1556 struct bio *bio;
1557 void *p = data;
1dfa0f68 1558 int nr_pages = 0;
68154e90 1559
42d2683a
CH
1560 /*
1561 * Overflow, abort
1562 */
1563 if (end < start)
1564 return ERR_PTR(-EINVAL);
68154e90 1565
42d2683a
CH
1566 nr_pages = end - start;
1567 bio = bio_kmalloc(gfp_mask, nr_pages);
1568 if (!bio)
1569 return ERR_PTR(-ENOMEM);
68154e90 1570
42d2683a
CH
1571 while (len) {
1572 struct page *page;
1573 unsigned int bytes = PAGE_SIZE;
68154e90 1574
42d2683a
CH
1575 if (bytes > len)
1576 bytes = len;
1577
1578 page = alloc_page(q->bounce_gfp | gfp_mask);
1579 if (!page)
1580 goto cleanup;
1581
1582 if (!reading)
1583 memcpy(page_address(page), p, bytes);
1584
1585 if (bio_add_pc_page(q, bio, page, bytes, 0) < bytes)
1586 break;
1587
1588 len -= bytes;
1589 p += bytes;
68154e90
FT
1590 }
1591
1dfa0f68
CH
1592 if (reading) {
1593 bio->bi_end_io = bio_copy_kern_endio_read;
1594 bio->bi_private = data;
1595 } else {
1596 bio->bi_end_io = bio_copy_kern_endio;
1dfa0f68 1597 }
76029ff3 1598
68154e90 1599 return bio;
42d2683a
CH
1600
1601cleanup:
1dfa0f68 1602 bio_free_pages(bio);
42d2683a
CH
1603 bio_put(bio);
1604 return ERR_PTR(-ENOMEM);
68154e90
FT
1605}
1606
1da177e4
LT
1607/*
1608 * bio_set_pages_dirty() and bio_check_pages_dirty() are support functions
1609 * for performing direct-IO in BIOs.
1610 *
1611 * The problem is that we cannot run set_page_dirty() from interrupt context
1612 * because the required locks are not interrupt-safe. So what we can do is to
1613 * mark the pages dirty _before_ performing IO. And in interrupt context,
1614 * check that the pages are still dirty. If so, fine. If not, redirty them
1615 * in process context.
1616 *
1617 * We special-case compound pages here: normally this means reads into hugetlb
1618 * pages. The logic in here doesn't really work right for compound pages
1619 * because the VM does not uniformly chase down the head page in all cases.
1620 * But dirtiness of compound pages is pretty meaningless anyway: the VM doesn't
1621 * handle them at all. So we skip compound pages here at an early stage.
1622 *
1623 * Note that this code is very hard to test under normal circumstances because
1624 * direct-io pins the pages with get_user_pages(). This makes
1625 * is_page_cache_freeable return false, and the VM will not clean the pages.
0d5c3eba 1626 * But other code (eg, flusher threads) could clean the pages if they are mapped
1da177e4
LT
1627 * pagecache.
1628 *
1629 * Simply disabling the call to bio_set_pages_dirty() is a good way to test the
1630 * deferred bio dirtying paths.
1631 */
1632
1633/*
1634 * bio_set_pages_dirty() will mark all the bio's pages as dirty.
1635 */
1636void bio_set_pages_dirty(struct bio *bio)
1637{
cb34e057 1638 struct bio_vec *bvec;
6dc4f100 1639 struct bvec_iter_all iter_all;
1da177e4 1640
2b070cfe 1641 bio_for_each_segment_all(bvec, bio, iter_all) {
3bb50983
CH
1642 if (!PageCompound(bvec->bv_page))
1643 set_page_dirty_lock(bvec->bv_page);
1da177e4
LT
1644 }
1645}
1646
1da177e4
LT
1647/*
1648 * bio_check_pages_dirty() will check that all the BIO's pages are still dirty.
1649 * If they are, then fine. If, however, some pages are clean then they must
1650 * have been written out during the direct-IO read. So we take another ref on
24d5493f 1651 * the BIO and re-dirty the pages in process context.
1da177e4
LT
1652 *
1653 * It is expected that bio_check_pages_dirty() will wholly own the BIO from
ea1754a0
KS
1654 * here on. It will run one put_page() against each page and will run one
1655 * bio_put() against the BIO.
1da177e4
LT
1656 */
1657
65f27f38 1658static void bio_dirty_fn(struct work_struct *work);
1da177e4 1659
65f27f38 1660static DECLARE_WORK(bio_dirty_work, bio_dirty_fn);
1da177e4
LT
1661static DEFINE_SPINLOCK(bio_dirty_lock);
1662static struct bio *bio_dirty_list;
1663
1664/*
1665 * This runs in process context
1666 */
65f27f38 1667static void bio_dirty_fn(struct work_struct *work)
1da177e4 1668{
24d5493f 1669 struct bio *bio, *next;
1da177e4 1670
24d5493f
CH
1671 spin_lock_irq(&bio_dirty_lock);
1672 next = bio_dirty_list;
1da177e4 1673 bio_dirty_list = NULL;
24d5493f 1674 spin_unlock_irq(&bio_dirty_lock);
1da177e4 1675
24d5493f
CH
1676 while ((bio = next) != NULL) {
1677 next = bio->bi_private;
1da177e4 1678
d241a95f 1679 bio_release_pages(bio, true);
1da177e4 1680 bio_put(bio);
1da177e4
LT
1681 }
1682}
1683
1684void bio_check_pages_dirty(struct bio *bio)
1685{
cb34e057 1686 struct bio_vec *bvec;
24d5493f 1687 unsigned long flags;
6dc4f100 1688 struct bvec_iter_all iter_all;
1da177e4 1689
2b070cfe 1690 bio_for_each_segment_all(bvec, bio, iter_all) {
24d5493f
CH
1691 if (!PageDirty(bvec->bv_page) && !PageCompound(bvec->bv_page))
1692 goto defer;
1da177e4
LT
1693 }
1694
d241a95f 1695 bio_release_pages(bio, false);
24d5493f
CH
1696 bio_put(bio);
1697 return;
1698defer:
1699 spin_lock_irqsave(&bio_dirty_lock, flags);
1700 bio->bi_private = bio_dirty_list;
1701 bio_dirty_list = bio;
1702 spin_unlock_irqrestore(&bio_dirty_lock, flags);
1703 schedule_work(&bio_dirty_work);
1da177e4
LT
1704}
1705
5b18b5a7
MP
1706void update_io_ticks(struct hd_struct *part, unsigned long now)
1707{
1708 unsigned long stamp;
1709again:
1710 stamp = READ_ONCE(part->stamp);
1711 if (unlikely(stamp != now)) {
1712 if (likely(cmpxchg(&part->stamp, stamp, now) == stamp)) {
1713 __part_stat_add(part, io_ticks, 1);
1714 }
1715 }
1716 if (part->partno) {
1717 part = &part_to_disk(part)->part0;
1718 goto again;
1719 }
1720}
1da177e4 1721
ddcf35d3 1722void generic_start_io_acct(struct request_queue *q, int op,
d62e26b3 1723 unsigned long sectors, struct hd_struct *part)
394ffa50 1724{
ddcf35d3 1725 const int sgrp = op_stat_group(op);
394ffa50 1726
112f158f
MS
1727 part_stat_lock();
1728
5b18b5a7 1729 update_io_ticks(part, jiffies);
112f158f
MS
1730 part_stat_inc(part, ios[sgrp]);
1731 part_stat_add(part, sectors[sgrp], sectors);
ddcf35d3 1732 part_inc_in_flight(q, part, op_is_write(op));
394ffa50
GZ
1733
1734 part_stat_unlock();
1735}
1736EXPORT_SYMBOL(generic_start_io_acct);
1737
ddcf35d3 1738void generic_end_io_acct(struct request_queue *q, int req_op,
d62e26b3 1739 struct hd_struct *part, unsigned long start_time)
394ffa50 1740{
5b18b5a7
MP
1741 unsigned long now = jiffies;
1742 unsigned long duration = now - start_time;
ddcf35d3 1743 const int sgrp = op_stat_group(req_op);
394ffa50 1744
112f158f
MS
1745 part_stat_lock();
1746
5b18b5a7 1747 update_io_ticks(part, now);
112f158f 1748 part_stat_add(part, nsecs[sgrp], jiffies_to_nsecs(duration));
5b18b5a7 1749 part_stat_add(part, time_in_queue, duration);
ddcf35d3 1750 part_dec_in_flight(q, part, op_is_write(req_op));
394ffa50
GZ
1751
1752 part_stat_unlock();
1753}
1754EXPORT_SYMBOL(generic_end_io_acct);
1755
c4cf5261
JA
1756static inline bool bio_remaining_done(struct bio *bio)
1757{
1758 /*
1759 * If we're not chaining, then ->__bi_remaining is always 1 and
1760 * we always end io on the first invocation.
1761 */
1762 if (!bio_flagged(bio, BIO_CHAIN))
1763 return true;
1764
1765 BUG_ON(atomic_read(&bio->__bi_remaining) <= 0);
1766
326e1dbb 1767 if (atomic_dec_and_test(&bio->__bi_remaining)) {
b7c44ed9 1768 bio_clear_flag(bio, BIO_CHAIN);
c4cf5261 1769 return true;
326e1dbb 1770 }
c4cf5261
JA
1771
1772 return false;
1773}
1774
1da177e4
LT
1775/**
1776 * bio_endio - end I/O on a bio
1777 * @bio: bio
1da177e4
LT
1778 *
1779 * Description:
4246a0b6
CH
1780 * bio_endio() will end I/O on the whole bio. bio_endio() is the preferred
1781 * way to end I/O on a bio. No one should call bi_end_io() directly on a
1782 * bio unless they own it and thus know that it has an end_io function.
fbbaf700
N
1783 *
1784 * bio_endio() can be called several times on a bio that has been chained
1785 * using bio_chain(). The ->bi_end_io() function will only be called the
1786 * last time. At this point the BLK_TA_COMPLETE tracing event will be
1787 * generated if BIO_TRACE_COMPLETION is set.
1da177e4 1788 **/
4246a0b6 1789void bio_endio(struct bio *bio)
1da177e4 1790{
ba8c6967 1791again:
2b885517 1792 if (!bio_remaining_done(bio))
ba8c6967 1793 return;
7c20f116
CH
1794 if (!bio_integrity_endio(bio))
1795 return;
1da177e4 1796
67b42d0b
JB
1797 if (bio->bi_disk)
1798 rq_qos_done_bio(bio->bi_disk->queue, bio);
1799
ba8c6967
CH
1800 /*
1801 * Need to have a real endio function for chained bios, otherwise
1802 * various corner cases will break (like stacking block devices that
1803 * save/restore bi_end_io) - however, we want to avoid unbounded
1804 * recursion and blowing the stack. Tail call optimization would
1805 * handle this, but compiling with frame pointers also disables
1806 * gcc's sibling call optimization.
1807 */
1808 if (bio->bi_end_io == bio_chain_endio) {
1809 bio = __bio_chain_endio(bio);
1810 goto again;
196d38bc 1811 }
ba8c6967 1812
74d46992
CH
1813 if (bio->bi_disk && bio_flagged(bio, BIO_TRACE_COMPLETION)) {
1814 trace_block_bio_complete(bio->bi_disk->queue, bio,
a462b950 1815 blk_status_to_errno(bio->bi_status));
fbbaf700
N
1816 bio_clear_flag(bio, BIO_TRACE_COMPLETION);
1817 }
1818
9e234eea 1819 blk_throtl_bio_endio(bio);
b222dd2f
SL
1820 /* release cgroup info */
1821 bio_uninit(bio);
ba8c6967
CH
1822 if (bio->bi_end_io)
1823 bio->bi_end_io(bio);
1da177e4 1824}
a112a71d 1825EXPORT_SYMBOL(bio_endio);
1da177e4 1826
20d0189b
KO
1827/**
1828 * bio_split - split a bio
1829 * @bio: bio to split
1830 * @sectors: number of sectors to split from the front of @bio
1831 * @gfp: gfp mask
1832 * @bs: bio set to allocate from
1833 *
1834 * Allocates and returns a new bio which represents @sectors from the start of
1835 * @bio, and updates @bio to represent the remaining sectors.
1836 *
f3f5da62 1837 * Unless this is a discard request the newly allocated bio will point
dad77584
BVA
1838 * to @bio's bi_io_vec. It is the caller's responsibility to ensure that
1839 * neither @bio nor @bs are freed before the split bio.
20d0189b
KO
1840 */
1841struct bio *bio_split(struct bio *bio, int sectors,
1842 gfp_t gfp, struct bio_set *bs)
1843{
f341a4d3 1844 struct bio *split;
20d0189b
KO
1845
1846 BUG_ON(sectors <= 0);
1847 BUG_ON(sectors >= bio_sectors(bio));
1848
f9d03f96 1849 split = bio_clone_fast(bio, gfp, bs);
20d0189b
KO
1850 if (!split)
1851 return NULL;
1852
1853 split->bi_iter.bi_size = sectors << 9;
1854
1855 if (bio_integrity(split))
fbd08e76 1856 bio_integrity_trim(split);
20d0189b
KO
1857
1858 bio_advance(bio, split->bi_iter.bi_size);
1859
fbbaf700 1860 if (bio_flagged(bio, BIO_TRACE_COMPLETION))
20d59023 1861 bio_set_flag(split, BIO_TRACE_COMPLETION);
fbbaf700 1862
20d0189b
KO
1863 return split;
1864}
1865EXPORT_SYMBOL(bio_split);
1866
6678d83f
KO
1867/**
1868 * bio_trim - trim a bio
1869 * @bio: bio to trim
1870 * @offset: number of sectors to trim from the front of @bio
1871 * @size: size we want to trim @bio to, in sectors
1872 */
1873void bio_trim(struct bio *bio, int offset, int size)
1874{
1875 /* 'bio' is a cloned bio which we need to trim to match
1876 * the given offset and size.
6678d83f 1877 */
6678d83f
KO
1878
1879 size <<= 9;
4f024f37 1880 if (offset == 0 && size == bio->bi_iter.bi_size)
6678d83f
KO
1881 return;
1882
6678d83f 1883 bio_advance(bio, offset << 9);
4f024f37 1884 bio->bi_iter.bi_size = size;
376a78ab
DM
1885
1886 if (bio_integrity(bio))
fbd08e76 1887 bio_integrity_trim(bio);
376a78ab 1888
6678d83f
KO
1889}
1890EXPORT_SYMBOL_GPL(bio_trim);
1891
1da177e4
LT
1892/*
1893 * create memory pools for biovec's in a bio_set.
1894 * use the global biovec slabs created for general use.
1895 */
8aa6ba2f 1896int biovec_init_pool(mempool_t *pool, int pool_entries)
1da177e4 1897{
ed996a52 1898 struct biovec_slab *bp = bvec_slabs + BVEC_POOL_MAX;
1da177e4 1899
8aa6ba2f 1900 return mempool_init_slab_pool(pool, pool_entries, bp->slab);
1da177e4
LT
1901}
1902
917a38c7
KO
1903/*
1904 * bioset_exit - exit a bioset initialized with bioset_init()
1905 *
1906 * May be called on a zeroed but uninitialized bioset (i.e. allocated with
1907 * kzalloc()).
1908 */
1909void bioset_exit(struct bio_set *bs)
1da177e4 1910{
df2cb6da
KO
1911 if (bs->rescue_workqueue)
1912 destroy_workqueue(bs->rescue_workqueue);
917a38c7 1913 bs->rescue_workqueue = NULL;
df2cb6da 1914
8aa6ba2f
KO
1915 mempool_exit(&bs->bio_pool);
1916 mempool_exit(&bs->bvec_pool);
9f060e22 1917
7878cba9 1918 bioset_integrity_free(bs);
917a38c7
KO
1919 if (bs->bio_slab)
1920 bio_put_slab(bs);
1921 bs->bio_slab = NULL;
1922}
1923EXPORT_SYMBOL(bioset_exit);
1da177e4 1924
917a38c7
KO
1925/**
1926 * bioset_init - Initialize a bio_set
dad08527 1927 * @bs: pool to initialize
917a38c7
KO
1928 * @pool_size: Number of bio and bio_vecs to cache in the mempool
1929 * @front_pad: Number of bytes to allocate in front of the returned bio
1930 * @flags: Flags to modify behavior, currently %BIOSET_NEED_BVECS
1931 * and %BIOSET_NEED_RESCUER
1932 *
dad08527
KO
1933 * Description:
1934 * Set up a bio_set to be used with @bio_alloc_bioset. Allows the caller
1935 * to ask for a number of bytes to be allocated in front of the bio.
1936 * Front pad allocation is useful for embedding the bio inside
1937 * another structure, to avoid allocating extra data to go with the bio.
1938 * Note that the bio must be embedded at the END of that structure always,
1939 * or things will break badly.
1940 * If %BIOSET_NEED_BVECS is set in @flags, a separate pool will be allocated
1941 * for allocating iovecs. This pool is not needed e.g. for bio_clone_fast().
1942 * If %BIOSET_NEED_RESCUER is set, a workqueue is created which can be used to
1943 * dispatch queued requests when the mempool runs out of space.
1944 *
917a38c7
KO
1945 */
1946int bioset_init(struct bio_set *bs,
1947 unsigned int pool_size,
1948 unsigned int front_pad,
1949 int flags)
1950{
1951 unsigned int back_pad = BIO_INLINE_VECS * sizeof(struct bio_vec);
1952
1953 bs->front_pad = front_pad;
1954
1955 spin_lock_init(&bs->rescue_lock);
1956 bio_list_init(&bs->rescue_list);
1957 INIT_WORK(&bs->rescue_work, bio_alloc_rescue);
1958
1959 bs->bio_slab = bio_find_or_create_slab(front_pad + back_pad);
1960 if (!bs->bio_slab)
1961 return -ENOMEM;
1962
1963 if (mempool_init_slab_pool(&bs->bio_pool, pool_size, bs->bio_slab))
1964 goto bad;
1965
1966 if ((flags & BIOSET_NEED_BVECS) &&
1967 biovec_init_pool(&bs->bvec_pool, pool_size))
1968 goto bad;
1969
1970 if (!(flags & BIOSET_NEED_RESCUER))
1971 return 0;
1972
1973 bs->rescue_workqueue = alloc_workqueue("bioset", WQ_MEM_RECLAIM, 0);
1974 if (!bs->rescue_workqueue)
1975 goto bad;
1976
1977 return 0;
1978bad:
1979 bioset_exit(bs);
1980 return -ENOMEM;
1981}
1982EXPORT_SYMBOL(bioset_init);
1983
28e89fd9
JA
1984/*
1985 * Initialize and setup a new bio_set, based on the settings from
1986 * another bio_set.
1987 */
1988int bioset_init_from_src(struct bio_set *bs, struct bio_set *src)
1989{
1990 int flags;
1991
1992 flags = 0;
1993 if (src->bvec_pool.min_nr)
1994 flags |= BIOSET_NEED_BVECS;
1995 if (src->rescue_workqueue)
1996 flags |= BIOSET_NEED_RESCUER;
1997
1998 return bioset_init(bs, src->bio_pool.min_nr, src->front_pad, flags);
1999}
2000EXPORT_SYMBOL(bioset_init_from_src);
2001
852c788f 2002#ifdef CONFIG_BLK_CGROUP
1d933cf0 2003
74b7c02a 2004/**
2268c0fe 2005 * bio_disassociate_blkg - puts back the blkg reference if associated
74b7c02a 2006 * @bio: target bio
74b7c02a 2007 *
2268c0fe 2008 * Helper to disassociate the blkg from @bio if a blkg is associated.
74b7c02a 2009 */
2268c0fe 2010void bio_disassociate_blkg(struct bio *bio)
74b7c02a 2011{
2268c0fe
DZ
2012 if (bio->bi_blkg) {
2013 blkg_put(bio->bi_blkg);
2014 bio->bi_blkg = NULL;
2015 }
74b7c02a 2016}
892ad71f 2017EXPORT_SYMBOL_GPL(bio_disassociate_blkg);
74b7c02a 2018
a7b39b4e 2019/**
2268c0fe 2020 * __bio_associate_blkg - associate a bio with the a blkg
a7b39b4e 2021 * @bio: target bio
b5f2954d 2022 * @blkg: the blkg to associate
b5f2954d 2023 *
beea9da0
DZ
2024 * This tries to associate @bio with the specified @blkg. Association failure
2025 * is handled by walking up the blkg tree. Therefore, the blkg associated can
2026 * be anything between @blkg and the root_blkg. This situation only happens
2027 * when a cgroup is dying and then the remaining bios will spill to the closest
2028 * alive blkg.
a7b39b4e 2029 *
beea9da0
DZ
2030 * A reference will be taken on the @blkg and will be released when @bio is
2031 * freed.
a7b39b4e 2032 */
2268c0fe 2033static void __bio_associate_blkg(struct bio *bio, struct blkcg_gq *blkg)
a7b39b4e 2034{
2268c0fe
DZ
2035 bio_disassociate_blkg(bio);
2036
7754f669 2037 bio->bi_blkg = blkg_tryget_closest(blkg);
a7b39b4e
DZF
2038}
2039
d459d853 2040/**
fd42df30 2041 * bio_associate_blkg_from_css - associate a bio with a specified css
d459d853 2042 * @bio: target bio
fd42df30 2043 * @css: target css
d459d853 2044 *
fd42df30 2045 * Associate @bio with the blkg found by combining the css's blkg and the
fc5a828b
DZ
2046 * request_queue of the @bio. This falls back to the queue's root_blkg if
2047 * the association fails with the css.
d459d853 2048 */
fd42df30
DZ
2049void bio_associate_blkg_from_css(struct bio *bio,
2050 struct cgroup_subsys_state *css)
d459d853 2051{
fc5a828b
DZ
2052 struct request_queue *q = bio->bi_disk->queue;
2053 struct blkcg_gq *blkg;
2054
2055 rcu_read_lock();
2056
2057 if (!css || !css->parent)
2058 blkg = q->root_blkg;
2059 else
2060 blkg = blkg_lookup_create(css_to_blkcg(css), q);
2061
2062 __bio_associate_blkg(bio, blkg);
2063
2064 rcu_read_unlock();
d459d853 2065}
fd42df30 2066EXPORT_SYMBOL_GPL(bio_associate_blkg_from_css);
d459d853 2067
6a7f6d86 2068#ifdef CONFIG_MEMCG
852c788f 2069/**
6a7f6d86 2070 * bio_associate_blkg_from_page - associate a bio with the page's blkg
852c788f 2071 * @bio: target bio
6a7f6d86
DZ
2072 * @page: the page to lookup the blkcg from
2073 *
2074 * Associate @bio with the blkg from @page's owning memcg and the respective
fc5a828b
DZ
2075 * request_queue. If cgroup_e_css returns %NULL, fall back to the queue's
2076 * root_blkg.
852c788f 2077 */
6a7f6d86 2078void bio_associate_blkg_from_page(struct bio *bio, struct page *page)
852c788f 2079{
6a7f6d86
DZ
2080 struct cgroup_subsys_state *css;
2081
6a7f6d86
DZ
2082 if (!page->mem_cgroup)
2083 return;
2084
fc5a828b
DZ
2085 rcu_read_lock();
2086
2087 css = cgroup_e_css(page->mem_cgroup->css.cgroup, &io_cgrp_subsys);
2088 bio_associate_blkg_from_css(bio, css);
2089
2090 rcu_read_unlock();
6a7f6d86
DZ
2091}
2092#endif /* CONFIG_MEMCG */
2093
2268c0fe
DZ
2094/**
2095 * bio_associate_blkg - associate a bio with a blkg
2096 * @bio: target bio
2097 *
2098 * Associate @bio with the blkg found from the bio's css and request_queue.
2099 * If one is not found, bio_lookup_blkg() creates the blkg. If a blkg is
2100 * already associated, the css is reused and association redone as the
2101 * request_queue may have changed.
2102 */
2103void bio_associate_blkg(struct bio *bio)
2104{
fc5a828b 2105 struct cgroup_subsys_state *css;
2268c0fe
DZ
2106
2107 rcu_read_lock();
2108
db6638d7 2109 if (bio->bi_blkg)
fc5a828b 2110 css = &bio_blkcg(bio)->css;
db6638d7 2111 else
fc5a828b 2112 css = blkcg_css();
2268c0fe 2113
fc5a828b 2114 bio_associate_blkg_from_css(bio, css);
2268c0fe
DZ
2115
2116 rcu_read_unlock();
852c788f 2117}
5cdf2e3f 2118EXPORT_SYMBOL_GPL(bio_associate_blkg);
852c788f 2119
20bd723e 2120/**
db6638d7 2121 * bio_clone_blkg_association - clone blkg association from src to dst bio
20bd723e
PV
2122 * @dst: destination bio
2123 * @src: source bio
2124 */
db6638d7 2125void bio_clone_blkg_association(struct bio *dst, struct bio *src)
20bd723e 2126{
6ab21879
DZ
2127 rcu_read_lock();
2128
fc5a828b 2129 if (src->bi_blkg)
2268c0fe 2130 __bio_associate_blkg(dst, src->bi_blkg);
6ab21879
DZ
2131
2132 rcu_read_unlock();
20bd723e 2133}
db6638d7 2134EXPORT_SYMBOL_GPL(bio_clone_blkg_association);
852c788f
TH
2135#endif /* CONFIG_BLK_CGROUP */
2136
1da177e4
LT
2137static void __init biovec_init_slabs(void)
2138{
2139 int i;
2140
ed996a52 2141 for (i = 0; i < BVEC_POOL_NR; i++) {
1da177e4
LT
2142 int size;
2143 struct biovec_slab *bvs = bvec_slabs + i;
2144
a7fcd37c
JA
2145 if (bvs->nr_vecs <= BIO_INLINE_VECS) {
2146 bvs->slab = NULL;
2147 continue;
2148 }
a7fcd37c 2149
1da177e4
LT
2150 size = bvs->nr_vecs * sizeof(struct bio_vec);
2151 bvs->slab = kmem_cache_create(bvs->name, size, 0,
20c2df83 2152 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
1da177e4
LT
2153 }
2154}
2155
2156static int __init init_bio(void)
2157{
bb799ca0
JA
2158 bio_slab_max = 2;
2159 bio_slab_nr = 0;
6396bb22
KC
2160 bio_slabs = kcalloc(bio_slab_max, sizeof(struct bio_slab),
2161 GFP_KERNEL);
2b24e6f6
JT
2162
2163 BUILD_BUG_ON(BIO_FLAG_LAST > BVEC_POOL_OFFSET);
2164
bb799ca0
JA
2165 if (!bio_slabs)
2166 panic("bio: can't allocate bios\n");
1da177e4 2167
7878cba9 2168 bio_integrity_init();
1da177e4
LT
2169 biovec_init_slabs();
2170
f4f8154a 2171 if (bioset_init(&fs_bio_set, BIO_POOL_SIZE, 0, BIOSET_NEED_BVECS))
1da177e4
LT
2172 panic("bio: can't allocate bios\n");
2173
f4f8154a 2174 if (bioset_integrity_create(&fs_bio_set, BIO_POOL_SIZE))
a91a2785
MP
2175 panic("bio: can't create integrity pool\n");
2176
1da177e4
LT
2177 return 0;
2178}
1da177e4 2179subsys_initcall(init_bio);