1 // SPDX-License-Identifier: GPL-2.0 2 /* 3 * Copyright (C) 2001 Jens Axboe <axboe@kernel.dk> 4 */ 5 #include <linux/mm.h> 6 #include <linux/swap.h> 7 #include <linux/bio-integrity.h> 8 #include <linux/blkdev.h> 9 #include <linux/uio.h> 10 #include <linux/iocontext.h> 11 #include <linux/slab.h> 12 #include <linux/init.h> 13 #include <linux/kernel.h> 14 #include <linux/export.h> 15 #include <linux/mempool.h> 16 #include <linux/workqueue.h> 17 #include <linux/cgroup.h> 18 #include <linux/highmem.h> 19 #include <linux/blk-crypto.h> 20 #include <linux/xarray.h> 21 22 #include <trace/events/block.h> 23 #include "blk.h" 24 #include "blk-rq-qos.h" 25 #include "blk-cgroup.h" 26 27 #define ALLOC_CACHE_THRESHOLD 16 28 #define ALLOC_CACHE_MAX 256 29 30 struct bio_alloc_cache { 31 struct bio *free_list; 32 struct bio *free_list_irq; 33 unsigned int nr; 34 unsigned int nr_irq; 35 }; 36 37 static struct biovec_slab { 38 int nr_vecs; 39 char *name; 40 struct kmem_cache *slab; 41 } bvec_slabs[] __read_mostly = { 42 { .nr_vecs = 16, .name = "biovec-16" }, 43 { .nr_vecs = 64, .name = "biovec-64" }, 44 { .nr_vecs = 128, .name = "biovec-128" }, 45 { .nr_vecs = BIO_MAX_VECS, .name = "biovec-max" }, 46 }; 47 48 static struct biovec_slab *biovec_slab(unsigned short nr_vecs) 49 { 50 switch (nr_vecs) { 51 /* smaller bios use inline vecs */ 52 case 5 ... 16: 53 return &bvec_slabs[0]; 54 case 17 ... 64: 55 return &bvec_slabs[1]; 56 case 65 ... 128: 57 return &bvec_slabs[2]; 58 case 129 ... BIO_MAX_VECS: 59 return &bvec_slabs[3]; 60 default: 61 BUG(); 62 return NULL; 63 } 64 } 65 66 /* 67 * fs_bio_set is the bio_set containing bio and iovec memory pools used by 68 * IO code that does not need private memory pools. 69 */ 70 struct bio_set fs_bio_set; 71 EXPORT_SYMBOL(fs_bio_set); 72 73 /* 74 * Our slab pool management 75 */ 76 struct bio_slab { 77 struct kmem_cache *slab; 78 unsigned int slab_ref; 79 unsigned int slab_size; 80 char name[12]; 81 }; 82 static DEFINE_MUTEX(bio_slab_lock); 83 static DEFINE_XARRAY(bio_slabs); 84 85 static struct bio_slab *create_bio_slab(unsigned int size) 86 { 87 struct bio_slab *bslab = kzalloc(sizeof(*bslab), GFP_KERNEL); 88 89 if (!bslab) 90 return NULL; 91 92 snprintf(bslab->name, sizeof(bslab->name), "bio-%d", size); 93 bslab->slab = kmem_cache_create(bslab->name, size, 94 ARCH_KMALLOC_MINALIGN, 95 SLAB_HWCACHE_ALIGN | SLAB_TYPESAFE_BY_RCU, NULL); 96 if (!bslab->slab) 97 goto fail_alloc_slab; 98 99 bslab->slab_ref = 1; 100 bslab->slab_size = size; 101 102 if (!xa_err(xa_store(&bio_slabs, size, bslab, GFP_KERNEL))) 103 return bslab; 104 105 kmem_cache_destroy(bslab->slab); 106 107 fail_alloc_slab: 108 kfree(bslab); 109 return NULL; 110 } 111 112 static inline unsigned int bs_bio_slab_size(struct bio_set *bs) 113 { 114 return bs->front_pad + sizeof(struct bio) + bs->back_pad; 115 } 116 117 static struct kmem_cache *bio_find_or_create_slab(struct bio_set *bs) 118 { 119 unsigned int size = bs_bio_slab_size(bs); 120 struct bio_slab *bslab; 121 122 mutex_lock(&bio_slab_lock); 123 bslab = xa_load(&bio_slabs, size); 124 if (bslab) 125 bslab->slab_ref++; 126 else 127 bslab = create_bio_slab(size); 128 mutex_unlock(&bio_slab_lock); 129 130 if (bslab) 131 return bslab->slab; 132 return NULL; 133 } 134 135 static void bio_put_slab(struct bio_set *bs) 136 { 137 struct bio_slab *bslab = NULL; 138 unsigned int slab_size = bs_bio_slab_size(bs); 139 140 mutex_lock(&bio_slab_lock); 141 142 bslab = xa_load(&bio_slabs, slab_size); 143 if (WARN(!bslab, KERN_ERR "bio: unable to find slab!\n")) 144 goto out; 145 146 WARN_ON_ONCE(bslab->slab != bs->bio_slab); 147 148 WARN_ON(!bslab->slab_ref); 149 150 if (--bslab->slab_ref) 151 goto out; 152 153 xa_erase(&bio_slabs, slab_size); 154 155 kmem_cache_destroy(bslab->slab); 156 kfree(bslab); 157 158 out: 159 mutex_unlock(&bio_slab_lock); 160 } 161 162 void bvec_free(mempool_t *pool, struct bio_vec *bv, unsigned short nr_vecs) 163 { 164 BUG_ON(nr_vecs > BIO_MAX_VECS); 165 166 if (nr_vecs == BIO_MAX_VECS) 167 mempool_free(bv, pool); 168 else if (nr_vecs > BIO_INLINE_VECS) 169 kmem_cache_free(biovec_slab(nr_vecs)->slab, bv); 170 } 171 172 /* 173 * Make the first allocation restricted and don't dump info on allocation 174 * failures, since we'll fall back to the mempool in case of failure. 175 */ 176 static inline gfp_t bvec_alloc_gfp(gfp_t gfp) 177 { 178 return (gfp & ~(__GFP_DIRECT_RECLAIM | __GFP_IO)) | 179 __GFP_NOMEMALLOC | __GFP_NORETRY | __GFP_NOWARN; 180 } 181 182 struct bio_vec *bvec_alloc(mempool_t *pool, unsigned short *nr_vecs, 183 gfp_t gfp_mask) 184 { 185 struct biovec_slab *bvs = biovec_slab(*nr_vecs); 186 187 if (WARN_ON_ONCE(!bvs)) 188 return NULL; 189 190 /* 191 * Upgrade the nr_vecs request to take full advantage of the allocation. 192 * We also rely on this in the bvec_free path. 193 */ 194 *nr_vecs = bvs->nr_vecs; 195 196 /* 197 * Try a slab allocation first for all smaller allocations. If that 198 * fails and __GFP_DIRECT_RECLAIM is set retry with the mempool. 199 * The mempool is sized to handle up to BIO_MAX_VECS entries. 200 */ 201 if (*nr_vecs < BIO_MAX_VECS) { 202 struct bio_vec *bvl; 203 204 bvl = kmem_cache_alloc(bvs->slab, bvec_alloc_gfp(gfp_mask)); 205 if (likely(bvl) || !(gfp_mask & __GFP_DIRECT_RECLAIM)) 206 return bvl; 207 *nr_vecs = BIO_MAX_VECS; 208 } 209 210 return mempool_alloc(pool, gfp_mask); 211 } 212 213 void bio_uninit(struct bio *bio) 214 { 215 #ifdef CONFIG_BLK_CGROUP 216 if (bio->bi_blkg) { 217 blkg_put(bio->bi_blkg); 218 bio->bi_blkg = NULL; 219 } 220 #endif 221 if (bio_integrity(bio)) 222 bio_integrity_free(bio); 223 224 bio_crypt_free_ctx(bio); 225 } 226 EXPORT_SYMBOL(bio_uninit); 227 228 static void bio_free(struct bio *bio) 229 { 230 struct bio_set *bs = bio->bi_pool; 231 void *p = bio; 232 233 WARN_ON_ONCE(!bs); 234 235 bio_uninit(bio); 236 bvec_free(&bs->bvec_pool, bio->bi_io_vec, bio->bi_max_vecs); 237 mempool_free(p - bs->front_pad, &bs->bio_pool); 238 } 239 240 /* 241 * Users of this function have their own bio allocation. Subsequently, 242 * they must remember to pair any call to bio_init() with bio_uninit() 243 * when IO has completed, or when the bio is released. 244 */ 245 void bio_init(struct bio *bio, struct block_device *bdev, struct bio_vec *table, 246 unsigned short max_vecs, blk_opf_t opf) 247 { 248 bio->bi_next = NULL; 249 bio->bi_bdev = bdev; 250 bio->bi_opf = opf; 251 bio->bi_flags = 0; 252 bio->bi_ioprio = 0; 253 bio->bi_write_hint = 0; 254 bio->bi_write_stream = 0; 255 bio->bi_status = 0; 256 bio->bi_bvec_gap_bit = 0; 257 bio->bi_iter.bi_sector = 0; 258 bio->bi_iter.bi_size = 0; 259 bio->bi_iter.bi_idx = 0; 260 bio->bi_iter.bi_bvec_done = 0; 261 bio->bi_end_io = NULL; 262 bio->bi_private = NULL; 263 #ifdef CONFIG_BLK_CGROUP 264 bio->bi_blkg = NULL; 265 bio->issue_time_ns = 0; 266 if (bdev) 267 bio_associate_blkg(bio); 268 #ifdef CONFIG_BLK_CGROUP_IOCOST 269 bio->bi_iocost_cost = 0; 270 #endif 271 #endif 272 #ifdef CONFIG_BLK_INLINE_ENCRYPTION 273 bio->bi_crypt_context = NULL; 274 #endif 275 #ifdef CONFIG_BLK_DEV_INTEGRITY 276 bio->bi_integrity = NULL; 277 #endif 278 bio->bi_vcnt = 0; 279 280 atomic_set(&bio->__bi_remaining, 1); 281 atomic_set(&bio->__bi_cnt, 1); 282 bio->bi_cookie = BLK_QC_T_NONE; 283 284 bio->bi_max_vecs = max_vecs; 285 bio->bi_io_vec = table; 286 bio->bi_pool = NULL; 287 } 288 EXPORT_SYMBOL(bio_init); 289 290 /** 291 * bio_reset - reinitialize a bio 292 * @bio: bio to reset 293 * @bdev: block device to use the bio for 294 * @opf: operation and flags for bio 295 * 296 * Description: 297 * After calling bio_reset(), @bio will be in the same state as a freshly 298 * allocated bio returned bio bio_alloc_bioset() - the only fields that are 299 * preserved are the ones that are initialized by bio_alloc_bioset(). See 300 * comment in struct bio. 301 */ 302 void bio_reset(struct bio *bio, struct block_device *bdev, blk_opf_t opf) 303 { 304 struct bio_vec *bv = bio->bi_io_vec; 305 306 bio_uninit(bio); 307 memset(bio, 0, BIO_RESET_BYTES); 308 atomic_set(&bio->__bi_remaining, 1); 309 bio->bi_io_vec = bv; 310 bio->bi_bdev = bdev; 311 if (bio->bi_bdev) 312 bio_associate_blkg(bio); 313 bio->bi_opf = opf; 314 } 315 EXPORT_SYMBOL(bio_reset); 316 317 static struct bio *__bio_chain_endio(struct bio *bio) 318 { 319 struct bio *parent = bio->bi_private; 320 321 if (bio->bi_status && !parent->bi_status) 322 parent->bi_status = bio->bi_status; 323 bio_put(bio); 324 return parent; 325 } 326 327 /* 328 * This function should only be used as a flag and must never be called. 329 * If execution reaches here, it indicates a serious programming error. 330 */ 331 static void bio_chain_endio(struct bio *bio) 332 { 333 BUG(); 334 } 335 336 /** 337 * bio_chain - chain bio completions 338 * @bio: the target bio 339 * @parent: the parent bio of @bio 340 * 341 * The caller won't have a bi_end_io called when @bio completes - instead, 342 * @parent's bi_end_io won't be called until both @parent and @bio have 343 * completed; the chained bio will also be freed when it completes. 344 * 345 * The caller must not set bi_private or bi_end_io in @bio. 346 */ 347 void bio_chain(struct bio *bio, struct bio *parent) 348 { 349 BUG_ON(bio->bi_private || bio->bi_end_io); 350 351 bio->bi_private = parent; 352 bio->bi_end_io = bio_chain_endio; 353 bio_inc_remaining(parent); 354 } 355 EXPORT_SYMBOL(bio_chain); 356 357 /** 358 * bio_chain_and_submit - submit a bio after chaining it to another one 359 * @prev: bio to chain and submit 360 * @new: bio to chain to 361 * 362 * If @prev is non-NULL, chain it to @new and submit it. 363 * 364 * Return: @new. 365 */ 366 struct bio *bio_chain_and_submit(struct bio *prev, struct bio *new) 367 { 368 if (prev) { 369 bio_chain(prev, new); 370 submit_bio(prev); 371 } 372 return new; 373 } 374 375 struct bio *blk_next_bio(struct bio *bio, struct block_device *bdev, 376 unsigned int nr_pages, blk_opf_t opf, gfp_t gfp) 377 { 378 return bio_chain_and_submit(bio, bio_alloc(bdev, nr_pages, opf, gfp)); 379 } 380 EXPORT_SYMBOL_GPL(blk_next_bio); 381 382 static void bio_alloc_rescue(struct work_struct *work) 383 { 384 struct bio_set *bs = container_of(work, struct bio_set, rescue_work); 385 struct bio *bio; 386 387 while (1) { 388 spin_lock(&bs->rescue_lock); 389 bio = bio_list_pop(&bs->rescue_list); 390 spin_unlock(&bs->rescue_lock); 391 392 if (!bio) 393 break; 394 395 submit_bio_noacct(bio); 396 } 397 } 398 399 static void punt_bios_to_rescuer(struct bio_set *bs) 400 { 401 struct bio_list punt, nopunt; 402 struct bio *bio; 403 404 if (WARN_ON_ONCE(!bs->rescue_workqueue)) 405 return; 406 /* 407 * In order to guarantee forward progress we must punt only bios that 408 * were allocated from this bio_set; otherwise, if there was a bio on 409 * there for a stacking driver higher up in the stack, processing it 410 * could require allocating bios from this bio_set, and doing that from 411 * our own rescuer would be bad. 412 * 413 * Since bio lists are singly linked, pop them all instead of trying to 414 * remove from the middle of the list: 415 */ 416 417 bio_list_init(&punt); 418 bio_list_init(&nopunt); 419 420 while ((bio = bio_list_pop(¤t->bio_list[0]))) 421 bio_list_add(bio->bi_pool == bs ? &punt : &nopunt, bio); 422 current->bio_list[0] = nopunt; 423 424 bio_list_init(&nopunt); 425 while ((bio = bio_list_pop(¤t->bio_list[1]))) 426 bio_list_add(bio->bi_pool == bs ? &punt : &nopunt, bio); 427 current->bio_list[1] = nopunt; 428 429 spin_lock(&bs->rescue_lock); 430 bio_list_merge(&bs->rescue_list, &punt); 431 spin_unlock(&bs->rescue_lock); 432 433 queue_work(bs->rescue_workqueue, &bs->rescue_work); 434 } 435 436 static void bio_alloc_irq_cache_splice(struct bio_alloc_cache *cache) 437 { 438 unsigned long flags; 439 440 /* cache->free_list must be empty */ 441 if (WARN_ON_ONCE(cache->free_list)) 442 return; 443 444 local_irq_save(flags); 445 cache->free_list = cache->free_list_irq; 446 cache->free_list_irq = NULL; 447 cache->nr += cache->nr_irq; 448 cache->nr_irq = 0; 449 local_irq_restore(flags); 450 } 451 452 static struct bio *bio_alloc_percpu_cache(struct block_device *bdev, 453 unsigned short nr_vecs, blk_opf_t opf, gfp_t gfp, 454 struct bio_set *bs) 455 { 456 struct bio_alloc_cache *cache; 457 struct bio *bio; 458 459 cache = per_cpu_ptr(bs->cache, get_cpu()); 460 if (!cache->free_list) { 461 if (READ_ONCE(cache->nr_irq) >= ALLOC_CACHE_THRESHOLD) 462 bio_alloc_irq_cache_splice(cache); 463 if (!cache->free_list) { 464 put_cpu(); 465 return NULL; 466 } 467 } 468 bio = cache->free_list; 469 cache->free_list = bio->bi_next; 470 cache->nr--; 471 put_cpu(); 472 473 if (nr_vecs) 474 bio_init_inline(bio, bdev, nr_vecs, opf); 475 else 476 bio_init(bio, bdev, NULL, nr_vecs, opf); 477 bio->bi_pool = bs; 478 return bio; 479 } 480 481 /** 482 * bio_alloc_bioset - allocate a bio for I/O 483 * @bdev: block device to allocate the bio for (can be %NULL) 484 * @nr_vecs: number of bvecs to pre-allocate 485 * @opf: operation and flags for bio 486 * @gfp_mask: the GFP_* mask given to the slab allocator 487 * @bs: the bio_set to allocate from. 488 * 489 * Allocate a bio from the mempools in @bs. 490 * 491 * If %__GFP_DIRECT_RECLAIM is set then bio_alloc will always be able to 492 * allocate a bio. This is due to the mempool guarantees. To make this work, 493 * callers must never allocate more than 1 bio at a time from the general pool. 494 * Callers that need to allocate more than 1 bio must always submit the 495 * previously allocated bio for IO before attempting to allocate a new one. 496 * Failure to do so can cause deadlocks under memory pressure. 497 * 498 * Note that when running under submit_bio_noacct() (i.e. any block driver), 499 * bios are not submitted until after you return - see the code in 500 * submit_bio_noacct() that converts recursion into iteration, to prevent 501 * stack overflows. 502 * 503 * This would normally mean allocating multiple bios under submit_bio_noacct() 504 * would be susceptible to deadlocks, but we have 505 * deadlock avoidance code that resubmits any blocked bios from a rescuer 506 * thread. 507 * 508 * However, we do not guarantee forward progress for allocations from other 509 * mempools. Doing multiple allocations from the same mempool under 510 * submit_bio_noacct() should be avoided - instead, use bio_set's front_pad 511 * for per bio allocations. 512 * 513 * Returns: Pointer to new bio on success, NULL on failure. 514 */ 515 struct bio *bio_alloc_bioset(struct block_device *bdev, unsigned short nr_vecs, 516 blk_opf_t opf, gfp_t gfp_mask, 517 struct bio_set *bs) 518 { 519 gfp_t saved_gfp = gfp_mask; 520 struct bio *bio; 521 void *p; 522 523 /* should not use nobvec bioset for nr_vecs > 0 */ 524 if (WARN_ON_ONCE(!mempool_initialized(&bs->bvec_pool) && nr_vecs > 0)) 525 return NULL; 526 527 if (bs->cache && nr_vecs <= BIO_INLINE_VECS) { 528 opf |= REQ_ALLOC_CACHE; 529 bio = bio_alloc_percpu_cache(bdev, nr_vecs, opf, 530 gfp_mask, bs); 531 if (bio) 532 return bio; 533 /* 534 * No cached bio available, bio returned below marked with 535 * REQ_ALLOC_CACHE to participate in per-cpu alloc cache. 536 */ 537 } else 538 opf &= ~REQ_ALLOC_CACHE; 539 540 /* 541 * submit_bio_noacct() converts recursion to iteration; this means if 542 * we're running beneath it, any bios we allocate and submit will not be 543 * submitted (and thus freed) until after we return. 544 * 545 * This exposes us to a potential deadlock if we allocate multiple bios 546 * from the same bio_set() while running underneath submit_bio_noacct(). 547 * If we were to allocate multiple bios (say a stacking block driver 548 * that was splitting bios), we would deadlock if we exhausted the 549 * mempool's reserve. 550 * 551 * We solve this, and guarantee forward progress, with a rescuer 552 * workqueue per bio_set. If we go to allocate and there are bios on 553 * current->bio_list, we first try the allocation without 554 * __GFP_DIRECT_RECLAIM; if that fails, we punt those bios we would be 555 * blocking to the rescuer workqueue before we retry with the original 556 * gfp_flags. 557 */ 558 if (current->bio_list && 559 (!bio_list_empty(¤t->bio_list[0]) || 560 !bio_list_empty(¤t->bio_list[1])) && 561 bs->rescue_workqueue) 562 gfp_mask &= ~__GFP_DIRECT_RECLAIM; 563 564 p = mempool_alloc(&bs->bio_pool, gfp_mask); 565 if (!p && gfp_mask != saved_gfp) { 566 punt_bios_to_rescuer(bs); 567 gfp_mask = saved_gfp; 568 p = mempool_alloc(&bs->bio_pool, gfp_mask); 569 } 570 if (unlikely(!p)) 571 return NULL; 572 if (!mempool_is_saturated(&bs->bio_pool)) 573 opf &= ~REQ_ALLOC_CACHE; 574 575 bio = p + bs->front_pad; 576 if (nr_vecs > BIO_INLINE_VECS) { 577 struct bio_vec *bvl = NULL; 578 579 bvl = bvec_alloc(&bs->bvec_pool, &nr_vecs, gfp_mask); 580 if (!bvl && gfp_mask != saved_gfp) { 581 punt_bios_to_rescuer(bs); 582 gfp_mask = saved_gfp; 583 bvl = bvec_alloc(&bs->bvec_pool, &nr_vecs, gfp_mask); 584 } 585 if (unlikely(!bvl)) 586 goto err_free; 587 588 bio_init(bio, bdev, bvl, nr_vecs, opf); 589 } else if (nr_vecs) { 590 bio_init_inline(bio, bdev, BIO_INLINE_VECS, opf); 591 } else { 592 bio_init(bio, bdev, NULL, 0, opf); 593 } 594 595 bio->bi_pool = bs; 596 return bio; 597 598 err_free: 599 mempool_free(p, &bs->bio_pool); 600 return NULL; 601 } 602 EXPORT_SYMBOL(bio_alloc_bioset); 603 604 /** 605 * bio_kmalloc - kmalloc a bio 606 * @nr_vecs: number of bio_vecs to allocate 607 * @gfp_mask: the GFP_* mask given to the slab allocator 608 * 609 * Use kmalloc to allocate a bio (including bvecs). The bio must be initialized 610 * using bio_init() before use. To free a bio returned from this function use 611 * kfree() after calling bio_uninit(). A bio returned from this function can 612 * be reused by calling bio_uninit() before calling bio_init() again. 613 * 614 * Note that unlike bio_alloc() or bio_alloc_bioset() allocations from this 615 * function are not backed by a mempool can fail. Do not use this function 616 * for allocations in the file system I/O path. 617 * 618 * Returns: Pointer to new bio on success, NULL on failure. 619 */ 620 struct bio *bio_kmalloc(unsigned short nr_vecs, gfp_t gfp_mask) 621 { 622 struct bio *bio; 623 624 if (nr_vecs > BIO_MAX_INLINE_VECS) 625 return NULL; 626 return kmalloc(sizeof(*bio) + nr_vecs * sizeof(struct bio_vec), 627 gfp_mask); 628 } 629 EXPORT_SYMBOL(bio_kmalloc); 630 631 void zero_fill_bio_iter(struct bio *bio, struct bvec_iter start) 632 { 633 struct bio_vec bv; 634 struct bvec_iter iter; 635 636 __bio_for_each_segment(bv, bio, iter, start) 637 memzero_bvec(&bv); 638 } 639 EXPORT_SYMBOL(zero_fill_bio_iter); 640 641 /** 642 * bio_truncate - truncate the bio to small size of @new_size 643 * @bio: the bio to be truncated 644 * @new_size: new size for truncating the bio 645 * 646 * Description: 647 * Truncate the bio to new size of @new_size. If bio_op(bio) is 648 * REQ_OP_READ, zero the truncated part. This function should only 649 * be used for handling corner cases, such as bio eod. 650 */ 651 static void bio_truncate(struct bio *bio, unsigned new_size) 652 { 653 struct bio_vec bv; 654 struct bvec_iter iter; 655 unsigned int done = 0; 656 bool truncated = false; 657 658 if (new_size >= bio->bi_iter.bi_size) 659 return; 660 661 if (bio_op(bio) != REQ_OP_READ) 662 goto exit; 663 664 bio_for_each_segment(bv, bio, iter) { 665 if (done + bv.bv_len > new_size) { 666 size_t offset; 667 668 if (!truncated) 669 offset = new_size - done; 670 else 671 offset = 0; 672 memzero_page(bv.bv_page, bv.bv_offset + offset, 673 bv.bv_len - offset); 674 truncated = true; 675 } 676 done += bv.bv_len; 677 } 678 679 exit: 680 /* 681 * Don't touch bvec table here and make it really immutable, since 682 * fs bio user has to retrieve all pages via bio_for_each_segment_all 683 * in its .end_bio() callback. 684 * 685 * It is enough to truncate bio by updating .bi_size since we can make 686 * correct bvec with the updated .bi_size for drivers. 687 */ 688 bio->bi_iter.bi_size = new_size; 689 } 690 691 /** 692 * guard_bio_eod - truncate a BIO to fit the block device 693 * @bio: bio to truncate 694 * 695 * This allows us to do IO even on the odd last sectors of a device, even if the 696 * block size is some multiple of the physical sector size. 697 * 698 * We'll just truncate the bio to the size of the device, and clear the end of 699 * the buffer head manually. Truly out-of-range accesses will turn into actual 700 * I/O errors, this only handles the "we need to be able to do I/O at the final 701 * sector" case. 702 */ 703 void guard_bio_eod(struct bio *bio) 704 { 705 sector_t maxsector = bdev_nr_sectors(bio->bi_bdev); 706 707 if (!maxsector) 708 return; 709 710 /* 711 * If the *whole* IO is past the end of the device, 712 * let it through, and the IO layer will turn it into 713 * an EIO. 714 */ 715 if (unlikely(bio->bi_iter.bi_sector >= maxsector)) 716 return; 717 718 maxsector -= bio->bi_iter.bi_sector; 719 if (likely((bio->bi_iter.bi_size >> 9) <= maxsector)) 720 return; 721 722 bio_truncate(bio, maxsector << 9); 723 } 724 725 static int __bio_alloc_cache_prune(struct bio_alloc_cache *cache, 726 unsigned int nr) 727 { 728 unsigned int i = 0; 729 struct bio *bio; 730 731 while ((bio = cache->free_list) != NULL) { 732 cache->free_list = bio->bi_next; 733 cache->nr--; 734 bio_free(bio); 735 if (++i == nr) 736 break; 737 } 738 return i; 739 } 740 741 static void bio_alloc_cache_prune(struct bio_alloc_cache *cache, 742 unsigned int nr) 743 { 744 nr -= __bio_alloc_cache_prune(cache, nr); 745 if (!READ_ONCE(cache->free_list)) { 746 bio_alloc_irq_cache_splice(cache); 747 __bio_alloc_cache_prune(cache, nr); 748 } 749 } 750 751 static int bio_cpu_dead(unsigned int cpu, struct hlist_node *node) 752 { 753 struct bio_set *bs; 754 755 bs = hlist_entry_safe(node, struct bio_set, cpuhp_dead); 756 if (bs->cache) { 757 struct bio_alloc_cache *cache = per_cpu_ptr(bs->cache, cpu); 758 759 bio_alloc_cache_prune(cache, -1U); 760 } 761 return 0; 762 } 763 764 static void bio_alloc_cache_destroy(struct bio_set *bs) 765 { 766 int cpu; 767 768 if (!bs->cache) 769 return; 770 771 cpuhp_state_remove_instance_nocalls(CPUHP_BIO_DEAD, &bs->cpuhp_dead); 772 for_each_possible_cpu(cpu) { 773 struct bio_alloc_cache *cache; 774 775 cache = per_cpu_ptr(bs->cache, cpu); 776 bio_alloc_cache_prune(cache, -1U); 777 } 778 free_percpu(bs->cache); 779 bs->cache = NULL; 780 } 781 782 static inline void bio_put_percpu_cache(struct bio *bio) 783 { 784 struct bio_alloc_cache *cache; 785 786 cache = per_cpu_ptr(bio->bi_pool->cache, get_cpu()); 787 if (READ_ONCE(cache->nr_irq) + cache->nr > ALLOC_CACHE_MAX) 788 goto out_free; 789 790 if (in_task()) { 791 bio_uninit(bio); 792 bio->bi_next = cache->free_list; 793 /* Not necessary but helps not to iopoll already freed bios */ 794 bio->bi_bdev = NULL; 795 cache->free_list = bio; 796 cache->nr++; 797 } else if (in_hardirq()) { 798 lockdep_assert_irqs_disabled(); 799 800 bio_uninit(bio); 801 bio->bi_next = cache->free_list_irq; 802 cache->free_list_irq = bio; 803 cache->nr_irq++; 804 } else { 805 goto out_free; 806 } 807 put_cpu(); 808 return; 809 out_free: 810 put_cpu(); 811 bio_free(bio); 812 } 813 814 /** 815 * bio_put - release a reference to a bio 816 * @bio: bio to release reference to 817 * 818 * Description: 819 * Put a reference to a &struct bio, either one you have gotten with 820 * bio_alloc, bio_get or bio_clone_*. The last put of a bio will free it. 821 **/ 822 void bio_put(struct bio *bio) 823 { 824 if (unlikely(bio_flagged(bio, BIO_REFFED))) { 825 BUG_ON(!atomic_read(&bio->__bi_cnt)); 826 if (!atomic_dec_and_test(&bio->__bi_cnt)) 827 return; 828 } 829 if (bio->bi_opf & REQ_ALLOC_CACHE) 830 bio_put_percpu_cache(bio); 831 else 832 bio_free(bio); 833 } 834 EXPORT_SYMBOL(bio_put); 835 836 static int __bio_clone(struct bio *bio, struct bio *bio_src, gfp_t gfp) 837 { 838 bio_set_flag(bio, BIO_CLONED); 839 bio->bi_ioprio = bio_src->bi_ioprio; 840 bio->bi_write_hint = bio_src->bi_write_hint; 841 bio->bi_write_stream = bio_src->bi_write_stream; 842 bio->bi_iter = bio_src->bi_iter; 843 844 if (bio->bi_bdev) { 845 if (bio->bi_bdev == bio_src->bi_bdev && 846 bio_flagged(bio_src, BIO_REMAPPED)) 847 bio_set_flag(bio, BIO_REMAPPED); 848 bio_clone_blkg_association(bio, bio_src); 849 } 850 851 if (bio_crypt_clone(bio, bio_src, gfp) < 0) 852 return -ENOMEM; 853 if (bio_integrity(bio_src) && 854 bio_integrity_clone(bio, bio_src, gfp) < 0) 855 return -ENOMEM; 856 return 0; 857 } 858 859 /** 860 * bio_alloc_clone - clone a bio that shares the original bio's biovec 861 * @bdev: block_device to clone onto 862 * @bio_src: bio to clone from 863 * @gfp: allocation priority 864 * @bs: bio_set to allocate from 865 * 866 * Allocate a new bio that is a clone of @bio_src. The caller owns the returned 867 * bio, but not the actual data it points to. 868 * 869 * The caller must ensure that the return bio is not freed before @bio_src. 870 */ 871 struct bio *bio_alloc_clone(struct block_device *bdev, struct bio *bio_src, 872 gfp_t gfp, struct bio_set *bs) 873 { 874 struct bio *bio; 875 876 bio = bio_alloc_bioset(bdev, 0, bio_src->bi_opf, gfp, bs); 877 if (!bio) 878 return NULL; 879 880 if (__bio_clone(bio, bio_src, gfp) < 0) { 881 bio_put(bio); 882 return NULL; 883 } 884 bio->bi_io_vec = bio_src->bi_io_vec; 885 886 return bio; 887 } 888 EXPORT_SYMBOL(bio_alloc_clone); 889 890 /** 891 * bio_init_clone - clone a bio that shares the original bio's biovec 892 * @bdev: block_device to clone onto 893 * @bio: bio to clone into 894 * @bio_src: bio to clone from 895 * @gfp: allocation priority 896 * 897 * Initialize a new bio in caller provided memory that is a clone of @bio_src. 898 * The caller owns the returned bio, but not the actual data it points to. 899 * 900 * The caller must ensure that @bio_src is not freed before @bio. 901 */ 902 int bio_init_clone(struct block_device *bdev, struct bio *bio, 903 struct bio *bio_src, gfp_t gfp) 904 { 905 int ret; 906 907 bio_init(bio, bdev, bio_src->bi_io_vec, 0, bio_src->bi_opf); 908 ret = __bio_clone(bio, bio_src, gfp); 909 if (ret) 910 bio_uninit(bio); 911 return ret; 912 } 913 EXPORT_SYMBOL(bio_init_clone); 914 915 /** 916 * bio_full - check if the bio is full 917 * @bio: bio to check 918 * @len: length of one segment to be added 919 * 920 * Return true if @bio is full and one segment with @len bytes can't be 921 * added to the bio, otherwise return false 922 */ 923 static inline bool bio_full(struct bio *bio, unsigned len) 924 { 925 if (bio->bi_vcnt >= bio->bi_max_vecs) 926 return true; 927 if (bio->bi_iter.bi_size > UINT_MAX - len) 928 return true; 929 return false; 930 } 931 932 static bool bvec_try_merge_page(struct bio_vec *bv, struct page *page, 933 unsigned int len, unsigned int off) 934 { 935 size_t bv_end = bv->bv_offset + bv->bv_len; 936 phys_addr_t vec_end_addr = page_to_phys(bv->bv_page) + bv_end - 1; 937 phys_addr_t page_addr = page_to_phys(page); 938 939 if (vec_end_addr + 1 != page_addr + off) 940 return false; 941 if (xen_domain() && !xen_biovec_phys_mergeable(bv, page)) 942 return false; 943 944 if ((vec_end_addr & PAGE_MASK) != ((page_addr + off) & PAGE_MASK)) { 945 if (IS_ENABLED(CONFIG_KMSAN)) 946 return false; 947 if (bv->bv_page + bv_end / PAGE_SIZE != page + off / PAGE_SIZE) 948 return false; 949 } 950 951 bv->bv_len += len; 952 return true; 953 } 954 955 /* 956 * Try to merge a page into a segment, while obeying the hardware segment 957 * size limit. 958 * 959 * This is kept around for the integrity metadata, which is still tries 960 * to build the initial bio to the hardware limit and doesn't have proper 961 * helpers to split. Hopefully this will go away soon. 962 */ 963 bool bvec_try_merge_hw_page(struct request_queue *q, struct bio_vec *bv, 964 struct page *page, unsigned len, unsigned offset) 965 { 966 unsigned long mask = queue_segment_boundary(q); 967 phys_addr_t addr1 = bvec_phys(bv); 968 phys_addr_t addr2 = page_to_phys(page) + offset + len - 1; 969 970 if ((addr1 | mask) != (addr2 | mask)) 971 return false; 972 if (len > queue_max_segment_size(q) - bv->bv_len) 973 return false; 974 return bvec_try_merge_page(bv, page, len, offset); 975 } 976 977 /** 978 * __bio_add_page - add page(s) to a bio in a new segment 979 * @bio: destination bio 980 * @page: start page to add 981 * @len: length of the data to add, may cross pages 982 * @off: offset of the data relative to @page, may cross pages 983 * 984 * Add the data at @page + @off to @bio as a new bvec. The caller must ensure 985 * that @bio has space for another bvec. 986 */ 987 void __bio_add_page(struct bio *bio, struct page *page, 988 unsigned int len, unsigned int off) 989 { 990 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED)); 991 WARN_ON_ONCE(bio_full(bio, len)); 992 993 if (is_pci_p2pdma_page(page)) 994 bio->bi_opf |= REQ_NOMERGE; 995 996 bvec_set_page(&bio->bi_io_vec[bio->bi_vcnt], page, len, off); 997 bio->bi_iter.bi_size += len; 998 bio->bi_vcnt++; 999 } 1000 EXPORT_SYMBOL_GPL(__bio_add_page); 1001 1002 /** 1003 * bio_add_virt_nofail - add data in the direct kernel mapping to a bio 1004 * @bio: destination bio 1005 * @vaddr: data to add 1006 * @len: length of the data to add, may cross pages 1007 * 1008 * Add the data at @vaddr to @bio. The caller must have ensure a segment 1009 * is available for the added data. No merging into an existing segment 1010 * will be performed. 1011 */ 1012 void bio_add_virt_nofail(struct bio *bio, void *vaddr, unsigned len) 1013 { 1014 __bio_add_page(bio, virt_to_page(vaddr), len, offset_in_page(vaddr)); 1015 } 1016 EXPORT_SYMBOL_GPL(bio_add_virt_nofail); 1017 1018 /** 1019 * bio_add_page - attempt to add page(s) to bio 1020 * @bio: destination bio 1021 * @page: start page to add 1022 * @len: vec entry length, may cross pages 1023 * @offset: vec entry offset relative to @page, may cross pages 1024 * 1025 * Attempt to add page(s) to the bio_vec maplist. This will only fail 1026 * if either bio->bi_vcnt == bio->bi_max_vecs or it's a cloned bio. 1027 */ 1028 int bio_add_page(struct bio *bio, struct page *page, 1029 unsigned int len, unsigned int offset) 1030 { 1031 if (WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED))) 1032 return 0; 1033 if (bio->bi_iter.bi_size > UINT_MAX - len) 1034 return 0; 1035 1036 if (bio->bi_vcnt > 0) { 1037 struct bio_vec *bv = &bio->bi_io_vec[bio->bi_vcnt - 1]; 1038 1039 if (!zone_device_pages_have_same_pgmap(bv->bv_page, page)) 1040 return 0; 1041 1042 if (bvec_try_merge_page(bv, page, len, offset)) { 1043 bio->bi_iter.bi_size += len; 1044 return len; 1045 } 1046 } 1047 1048 if (bio->bi_vcnt >= bio->bi_max_vecs) 1049 return 0; 1050 __bio_add_page(bio, page, len, offset); 1051 return len; 1052 } 1053 EXPORT_SYMBOL(bio_add_page); 1054 1055 void bio_add_folio_nofail(struct bio *bio, struct folio *folio, size_t len, 1056 size_t off) 1057 { 1058 unsigned long nr = off / PAGE_SIZE; 1059 1060 WARN_ON_ONCE(len > UINT_MAX); 1061 __bio_add_page(bio, folio_page(folio, nr), len, off % PAGE_SIZE); 1062 } 1063 EXPORT_SYMBOL_GPL(bio_add_folio_nofail); 1064 1065 /** 1066 * bio_add_folio - Attempt to add part of a folio to a bio. 1067 * @bio: BIO to add to. 1068 * @folio: Folio to add. 1069 * @len: How many bytes from the folio to add. 1070 * @off: First byte in this folio to add. 1071 * 1072 * Filesystems that use folios can call this function instead of calling 1073 * bio_add_page() for each page in the folio. If @off is bigger than 1074 * PAGE_SIZE, this function can create a bio_vec that starts in a page 1075 * after the bv_page. BIOs do not support folios that are 4GiB or larger. 1076 * 1077 * Return: Whether the addition was successful. 1078 */ 1079 bool bio_add_folio(struct bio *bio, struct folio *folio, size_t len, 1080 size_t off) 1081 { 1082 unsigned long nr = off / PAGE_SIZE; 1083 1084 if (len > UINT_MAX) 1085 return false; 1086 return bio_add_page(bio, folio_page(folio, nr), len, off % PAGE_SIZE) > 0; 1087 } 1088 EXPORT_SYMBOL(bio_add_folio); 1089 1090 /** 1091 * bio_add_vmalloc_chunk - add a vmalloc chunk to a bio 1092 * @bio: destination bio 1093 * @vaddr: vmalloc address to add 1094 * @len: total length in bytes of the data to add 1095 * 1096 * Add data starting at @vaddr to @bio and return how many bytes were added. 1097 * This may be less than the amount originally asked. Returns 0 if no data 1098 * could be added to @bio. 1099 * 1100 * This helper calls flush_kernel_vmap_range() for the range added. For reads 1101 * the caller still needs to manually call invalidate_kernel_vmap_range() in 1102 * the completion handler. 1103 */ 1104 unsigned int bio_add_vmalloc_chunk(struct bio *bio, void *vaddr, unsigned len) 1105 { 1106 unsigned int offset = offset_in_page(vaddr); 1107 1108 len = min(len, PAGE_SIZE - offset); 1109 if (bio_add_page(bio, vmalloc_to_page(vaddr), len, offset) < len) 1110 return 0; 1111 if (op_is_write(bio_op(bio))) 1112 flush_kernel_vmap_range(vaddr, len); 1113 return len; 1114 } 1115 EXPORT_SYMBOL_GPL(bio_add_vmalloc_chunk); 1116 1117 /** 1118 * bio_add_vmalloc - add a vmalloc region to a bio 1119 * @bio: destination bio 1120 * @vaddr: vmalloc address to add 1121 * @len: total length in bytes of the data to add 1122 * 1123 * Add data starting at @vaddr to @bio. Return %true on success or %false if 1124 * @bio does not have enough space for the payload. 1125 * 1126 * This helper calls flush_kernel_vmap_range() for the range added. For reads 1127 * the caller still needs to manually call invalidate_kernel_vmap_range() in 1128 * the completion handler. 1129 */ 1130 bool bio_add_vmalloc(struct bio *bio, void *vaddr, unsigned int len) 1131 { 1132 do { 1133 unsigned int added = bio_add_vmalloc_chunk(bio, vaddr, len); 1134 1135 if (!added) 1136 return false; 1137 vaddr += added; 1138 len -= added; 1139 } while (len); 1140 1141 return true; 1142 } 1143 EXPORT_SYMBOL_GPL(bio_add_vmalloc); 1144 1145 void __bio_release_pages(struct bio *bio, bool mark_dirty) 1146 { 1147 struct folio_iter fi; 1148 1149 bio_for_each_folio_all(fi, bio) { 1150 size_t nr_pages; 1151 1152 if (mark_dirty) { 1153 folio_lock(fi.folio); 1154 folio_mark_dirty(fi.folio); 1155 folio_unlock(fi.folio); 1156 } 1157 nr_pages = (fi.offset + fi.length - 1) / PAGE_SIZE - 1158 fi.offset / PAGE_SIZE + 1; 1159 unpin_user_folio(fi.folio, nr_pages); 1160 } 1161 } 1162 EXPORT_SYMBOL_GPL(__bio_release_pages); 1163 1164 void bio_iov_bvec_set(struct bio *bio, const struct iov_iter *iter) 1165 { 1166 WARN_ON_ONCE(bio->bi_max_vecs); 1167 1168 bio->bi_io_vec = (struct bio_vec *)iter->bvec; 1169 bio->bi_iter.bi_idx = 0; 1170 bio->bi_iter.bi_bvec_done = iter->iov_offset; 1171 bio->bi_iter.bi_size = iov_iter_count(iter); 1172 bio_set_flag(bio, BIO_CLONED); 1173 } 1174 1175 static unsigned int get_contig_folio_len(unsigned int *num_pages, 1176 struct page **pages, unsigned int i, 1177 struct folio *folio, size_t left, 1178 size_t offset) 1179 { 1180 size_t bytes = left; 1181 size_t contig_sz = min_t(size_t, PAGE_SIZE - offset, bytes); 1182 unsigned int j; 1183 1184 /* 1185 * We might COW a single page in the middle of 1186 * a large folio, so we have to check that all 1187 * pages belong to the same folio. 1188 */ 1189 bytes -= contig_sz; 1190 for (j = i + 1; j < i + *num_pages; j++) { 1191 size_t next = min_t(size_t, PAGE_SIZE, bytes); 1192 1193 if (page_folio(pages[j]) != folio || 1194 pages[j] != pages[j - 1] + 1) { 1195 break; 1196 } 1197 contig_sz += next; 1198 bytes -= next; 1199 } 1200 *num_pages = j - i; 1201 1202 return contig_sz; 1203 } 1204 1205 #define PAGE_PTRS_PER_BVEC (sizeof(struct bio_vec) / sizeof(struct page *)) 1206 1207 /** 1208 * __bio_iov_iter_get_pages - pin user or kernel pages and add them to a bio 1209 * @bio: bio to add pages to 1210 * @iter: iov iterator describing the region to be mapped 1211 * 1212 * Extracts pages from *iter and appends them to @bio's bvec array. The pages 1213 * will have to be cleaned up in the way indicated by the BIO_PAGE_PINNED flag. 1214 * For a multi-segment *iter, this function only adds pages from the next 1215 * non-empty segment of the iov iterator. 1216 */ 1217 static int __bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter) 1218 { 1219 iov_iter_extraction_t extraction_flags = 0; 1220 unsigned short nr_pages = bio->bi_max_vecs - bio->bi_vcnt; 1221 unsigned short entries_left = bio->bi_max_vecs - bio->bi_vcnt; 1222 struct bio_vec *bv = bio->bi_io_vec + bio->bi_vcnt; 1223 struct page **pages = (struct page **)bv; 1224 ssize_t size; 1225 unsigned int num_pages, i = 0; 1226 size_t offset, folio_offset, left, len; 1227 int ret = 0; 1228 1229 /* 1230 * Move page array up in the allocated memory for the bio vecs as far as 1231 * possible so that we can start filling biovecs from the beginning 1232 * without overwriting the temporary page array. 1233 */ 1234 BUILD_BUG_ON(PAGE_PTRS_PER_BVEC < 2); 1235 pages += entries_left * (PAGE_PTRS_PER_BVEC - 1); 1236 1237 if (bio->bi_bdev && blk_queue_pci_p2pdma(bio->bi_bdev->bd_disk->queue)) 1238 extraction_flags |= ITER_ALLOW_P2PDMA; 1239 1240 size = iov_iter_extract_pages(iter, &pages, 1241 UINT_MAX - bio->bi_iter.bi_size, 1242 nr_pages, extraction_flags, &offset); 1243 if (unlikely(size <= 0)) 1244 return size ? size : -EFAULT; 1245 1246 nr_pages = DIV_ROUND_UP(offset + size, PAGE_SIZE); 1247 for (left = size, i = 0; left > 0; left -= len, i += num_pages) { 1248 struct page *page = pages[i]; 1249 struct folio *folio = page_folio(page); 1250 unsigned int old_vcnt = bio->bi_vcnt; 1251 1252 folio_offset = ((size_t)folio_page_idx(folio, page) << 1253 PAGE_SHIFT) + offset; 1254 1255 len = min(folio_size(folio) - folio_offset, left); 1256 1257 num_pages = DIV_ROUND_UP(offset + len, PAGE_SIZE); 1258 1259 if (num_pages > 1) 1260 len = get_contig_folio_len(&num_pages, pages, i, 1261 folio, left, offset); 1262 1263 if (!bio_add_folio(bio, folio, len, folio_offset)) { 1264 WARN_ON_ONCE(1); 1265 ret = -EINVAL; 1266 goto out; 1267 } 1268 1269 if (bio_flagged(bio, BIO_PAGE_PINNED)) { 1270 /* 1271 * We're adding another fragment of a page that already 1272 * was part of the last segment. Undo our pin as the 1273 * page was pinned when an earlier fragment of it was 1274 * added to the bio and __bio_release_pages expects a 1275 * single pin per page. 1276 */ 1277 if (offset && bio->bi_vcnt == old_vcnt) 1278 unpin_user_folio(folio, 1); 1279 } 1280 offset = 0; 1281 } 1282 1283 iov_iter_revert(iter, left); 1284 out: 1285 while (i < nr_pages) 1286 bio_release_page(bio, pages[i++]); 1287 1288 return ret; 1289 } 1290 1291 /* 1292 * Aligns the bio size to the len_align_mask, releasing excessive bio vecs that 1293 * __bio_iov_iter_get_pages may have inserted, and reverts the trimmed length 1294 * for the next iteration. 1295 */ 1296 static int bio_iov_iter_align_down(struct bio *bio, struct iov_iter *iter, 1297 unsigned len_align_mask) 1298 { 1299 size_t nbytes = bio->bi_iter.bi_size & len_align_mask; 1300 1301 if (!nbytes) 1302 return 0; 1303 1304 iov_iter_revert(iter, nbytes); 1305 bio->bi_iter.bi_size -= nbytes; 1306 do { 1307 struct bio_vec *bv = &bio->bi_io_vec[bio->bi_vcnt - 1]; 1308 1309 if (nbytes < bv->bv_len) { 1310 bv->bv_len -= nbytes; 1311 break; 1312 } 1313 1314 bio_release_page(bio, bv->bv_page); 1315 bio->bi_vcnt--; 1316 nbytes -= bv->bv_len; 1317 } while (nbytes); 1318 1319 if (!bio->bi_vcnt) 1320 return -EFAULT; 1321 return 0; 1322 } 1323 1324 /** 1325 * bio_iov_iter_get_pages - add user or kernel pages to a bio 1326 * @bio: bio to add pages to 1327 * @iter: iov iterator describing the region to be added 1328 * @len_align_mask: the mask to align the total size to, 0 for any length 1329 * 1330 * This takes either an iterator pointing to user memory, or one pointing to 1331 * kernel pages (BVEC iterator). If we're adding user pages, we pin them and 1332 * map them into the kernel. On IO completion, the caller should put those 1333 * pages. For bvec based iterators bio_iov_iter_get_pages() uses the provided 1334 * bvecs rather than copying them. Hence anyone issuing kiocb based IO needs 1335 * to ensure the bvecs and pages stay referenced until the submitted I/O is 1336 * completed by a call to ->ki_complete() or returns with an error other than 1337 * -EIOCBQUEUED. The caller needs to check if the bio is flagged BIO_NO_PAGE_REF 1338 * on IO completion. If it isn't, then pages should be released. 1339 * 1340 * The function tries, but does not guarantee, to pin as many pages as 1341 * fit into the bio, or are requested in @iter, whatever is smaller. If 1342 * MM encounters an error pinning the requested pages, it stops. Error 1343 * is returned only if 0 pages could be pinned. 1344 */ 1345 int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter, 1346 unsigned len_align_mask) 1347 { 1348 int ret = 0; 1349 1350 if (WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED))) 1351 return -EIO; 1352 1353 if (iov_iter_is_bvec(iter)) { 1354 bio_iov_bvec_set(bio, iter); 1355 iov_iter_advance(iter, bio->bi_iter.bi_size); 1356 return 0; 1357 } 1358 1359 if (iov_iter_extract_will_pin(iter)) 1360 bio_set_flag(bio, BIO_PAGE_PINNED); 1361 do { 1362 ret = __bio_iov_iter_get_pages(bio, iter); 1363 } while (!ret && iov_iter_count(iter) && !bio_full(bio, 0)); 1364 1365 if (bio->bi_vcnt) 1366 return bio_iov_iter_align_down(bio, iter, len_align_mask); 1367 return ret; 1368 } 1369 1370 static void submit_bio_wait_endio(struct bio *bio) 1371 { 1372 complete(bio->bi_private); 1373 } 1374 1375 /** 1376 * submit_bio_wait - submit a bio, and wait until it completes 1377 * @bio: The &struct bio which describes the I/O 1378 * 1379 * Simple wrapper around submit_bio(). Returns 0 on success, or the error from 1380 * bio_endio() on failure. 1381 * 1382 * WARNING: Unlike to how submit_bio() is usually used, this function does not 1383 * result in bio reference to be consumed. The caller must drop the reference 1384 * on his own. 1385 */ 1386 int submit_bio_wait(struct bio *bio) 1387 { 1388 DECLARE_COMPLETION_ONSTACK_MAP(done, 1389 bio->bi_bdev->bd_disk->lockdep_map); 1390 1391 bio->bi_private = &done; 1392 bio->bi_end_io = submit_bio_wait_endio; 1393 bio->bi_opf |= REQ_SYNC; 1394 submit_bio(bio); 1395 blk_wait_io(&done); 1396 1397 return blk_status_to_errno(bio->bi_status); 1398 } 1399 EXPORT_SYMBOL(submit_bio_wait); 1400 1401 /** 1402 * bdev_rw_virt - synchronously read into / write from kernel mapping 1403 * @bdev: block device to access 1404 * @sector: sector to access 1405 * @data: data to read/write 1406 * @len: length in byte to read/write 1407 * @op: operation (e.g. REQ_OP_READ/REQ_OP_WRITE) 1408 * 1409 * Performs synchronous I/O to @bdev for @data/@len. @data must be in 1410 * the kernel direct mapping and not a vmalloc address. 1411 */ 1412 int bdev_rw_virt(struct block_device *bdev, sector_t sector, void *data, 1413 size_t len, enum req_op op) 1414 { 1415 struct bio_vec bv; 1416 struct bio bio; 1417 int error; 1418 1419 if (WARN_ON_ONCE(is_vmalloc_addr(data))) 1420 return -EIO; 1421 1422 bio_init(&bio, bdev, &bv, 1, op); 1423 bio.bi_iter.bi_sector = sector; 1424 bio_add_virt_nofail(&bio, data, len); 1425 error = submit_bio_wait(&bio); 1426 bio_uninit(&bio); 1427 return error; 1428 } 1429 EXPORT_SYMBOL_GPL(bdev_rw_virt); 1430 1431 static void bio_wait_end_io(struct bio *bio) 1432 { 1433 complete(bio->bi_private); 1434 bio_put(bio); 1435 } 1436 1437 /* 1438 * bio_await_chain - ends @bio and waits for every chained bio to complete 1439 */ 1440 void bio_await_chain(struct bio *bio) 1441 { 1442 DECLARE_COMPLETION_ONSTACK_MAP(done, 1443 bio->bi_bdev->bd_disk->lockdep_map); 1444 1445 bio->bi_private = &done; 1446 bio->bi_end_io = bio_wait_end_io; 1447 bio_endio(bio); 1448 blk_wait_io(&done); 1449 } 1450 1451 void __bio_advance(struct bio *bio, unsigned bytes) 1452 { 1453 if (bio_integrity(bio)) 1454 bio_integrity_advance(bio, bytes); 1455 1456 bio_crypt_advance(bio, bytes); 1457 bio_advance_iter(bio, &bio->bi_iter, bytes); 1458 } 1459 EXPORT_SYMBOL(__bio_advance); 1460 1461 void bio_copy_data_iter(struct bio *dst, struct bvec_iter *dst_iter, 1462 struct bio *src, struct bvec_iter *src_iter) 1463 { 1464 while (src_iter->bi_size && dst_iter->bi_size) { 1465 struct bio_vec src_bv = bio_iter_iovec(src, *src_iter); 1466 struct bio_vec dst_bv = bio_iter_iovec(dst, *dst_iter); 1467 unsigned int bytes = min(src_bv.bv_len, dst_bv.bv_len); 1468 void *src_buf = bvec_kmap_local(&src_bv); 1469 void *dst_buf = bvec_kmap_local(&dst_bv); 1470 1471 memcpy(dst_buf, src_buf, bytes); 1472 1473 kunmap_local(dst_buf); 1474 kunmap_local(src_buf); 1475 1476 bio_advance_iter_single(src, src_iter, bytes); 1477 bio_advance_iter_single(dst, dst_iter, bytes); 1478 } 1479 } 1480 EXPORT_SYMBOL(bio_copy_data_iter); 1481 1482 /** 1483 * bio_copy_data - copy contents of data buffers from one bio to another 1484 * @src: source bio 1485 * @dst: destination bio 1486 * 1487 * Stops when it reaches the end of either @src or @dst - that is, copies 1488 * min(src->bi_size, dst->bi_size) bytes (or the equivalent for lists of bios). 1489 */ 1490 void bio_copy_data(struct bio *dst, struct bio *src) 1491 { 1492 struct bvec_iter src_iter = src->bi_iter; 1493 struct bvec_iter dst_iter = dst->bi_iter; 1494 1495 bio_copy_data_iter(dst, &dst_iter, src, &src_iter); 1496 } 1497 EXPORT_SYMBOL(bio_copy_data); 1498 1499 void bio_free_pages(struct bio *bio) 1500 { 1501 struct bio_vec *bvec; 1502 struct bvec_iter_all iter_all; 1503 1504 bio_for_each_segment_all(bvec, bio, iter_all) 1505 __free_page(bvec->bv_page); 1506 } 1507 EXPORT_SYMBOL(bio_free_pages); 1508 1509 /* 1510 * bio_set_pages_dirty() and bio_check_pages_dirty() are support functions 1511 * for performing direct-IO in BIOs. 1512 * 1513 * The problem is that we cannot run folio_mark_dirty() from interrupt context 1514 * because the required locks are not interrupt-safe. So what we can do is to 1515 * mark the pages dirty _before_ performing IO. And in interrupt context, 1516 * check that the pages are still dirty. If so, fine. If not, redirty them 1517 * in process context. 1518 * 1519 * Note that this code is very hard to test under normal circumstances because 1520 * direct-io pins the pages with get_user_pages(). This makes 1521 * is_page_cache_freeable return false, and the VM will not clean the pages. 1522 * But other code (eg, flusher threads) could clean the pages if they are mapped 1523 * pagecache. 1524 * 1525 * Simply disabling the call to bio_set_pages_dirty() is a good way to test the 1526 * deferred bio dirtying paths. 1527 */ 1528 1529 /* 1530 * bio_set_pages_dirty() will mark all the bio's pages as dirty. 1531 */ 1532 void bio_set_pages_dirty(struct bio *bio) 1533 { 1534 struct folio_iter fi; 1535 1536 bio_for_each_folio_all(fi, bio) { 1537 folio_lock(fi.folio); 1538 folio_mark_dirty(fi.folio); 1539 folio_unlock(fi.folio); 1540 } 1541 } 1542 EXPORT_SYMBOL_GPL(bio_set_pages_dirty); 1543 1544 /* 1545 * bio_check_pages_dirty() will check that all the BIO's pages are still dirty. 1546 * If they are, then fine. If, however, some pages are clean then they must 1547 * have been written out during the direct-IO read. So we take another ref on 1548 * the BIO and re-dirty the pages in process context. 1549 * 1550 * It is expected that bio_check_pages_dirty() will wholly own the BIO from 1551 * here on. It will unpin each page and will run one bio_put() against the 1552 * BIO. 1553 */ 1554 1555 static void bio_dirty_fn(struct work_struct *work); 1556 1557 static DECLARE_WORK(bio_dirty_work, bio_dirty_fn); 1558 static DEFINE_SPINLOCK(bio_dirty_lock); 1559 static struct bio *bio_dirty_list; 1560 1561 /* 1562 * This runs in process context 1563 */ 1564 static void bio_dirty_fn(struct work_struct *work) 1565 { 1566 struct bio *bio, *next; 1567 1568 spin_lock_irq(&bio_dirty_lock); 1569 next = bio_dirty_list; 1570 bio_dirty_list = NULL; 1571 spin_unlock_irq(&bio_dirty_lock); 1572 1573 while ((bio = next) != NULL) { 1574 next = bio->bi_private; 1575 1576 bio_release_pages(bio, true); 1577 bio_put(bio); 1578 } 1579 } 1580 1581 void bio_check_pages_dirty(struct bio *bio) 1582 { 1583 struct folio_iter fi; 1584 unsigned long flags; 1585 1586 bio_for_each_folio_all(fi, bio) { 1587 if (!folio_test_dirty(fi.folio)) 1588 goto defer; 1589 } 1590 1591 bio_release_pages(bio, false); 1592 bio_put(bio); 1593 return; 1594 defer: 1595 spin_lock_irqsave(&bio_dirty_lock, flags); 1596 bio->bi_private = bio_dirty_list; 1597 bio_dirty_list = bio; 1598 spin_unlock_irqrestore(&bio_dirty_lock, flags); 1599 schedule_work(&bio_dirty_work); 1600 } 1601 EXPORT_SYMBOL_GPL(bio_check_pages_dirty); 1602 1603 static inline bool bio_remaining_done(struct bio *bio) 1604 { 1605 /* 1606 * If we're not chaining, then ->__bi_remaining is always 1 and 1607 * we always end io on the first invocation. 1608 */ 1609 if (!bio_flagged(bio, BIO_CHAIN)) 1610 return true; 1611 1612 BUG_ON(atomic_read(&bio->__bi_remaining) <= 0); 1613 1614 if (atomic_dec_and_test(&bio->__bi_remaining)) { 1615 bio_clear_flag(bio, BIO_CHAIN); 1616 return true; 1617 } 1618 1619 return false; 1620 } 1621 1622 /** 1623 * bio_endio - end I/O on a bio 1624 * @bio: bio 1625 * 1626 * Description: 1627 * bio_endio() will end I/O on the whole bio. bio_endio() is the preferred 1628 * way to end I/O on a bio. No one should call bi_end_io() directly on a 1629 * bio unless they own it and thus know that it has an end_io function. 1630 * 1631 * bio_endio() can be called several times on a bio that has been chained 1632 * using bio_chain(). The ->bi_end_io() function will only be called the 1633 * last time. 1634 **/ 1635 void bio_endio(struct bio *bio) 1636 { 1637 again: 1638 if (!bio_remaining_done(bio)) 1639 return; 1640 if (!bio_integrity_endio(bio)) 1641 return; 1642 1643 blk_zone_bio_endio(bio); 1644 1645 rq_qos_done_bio(bio); 1646 1647 if (bio->bi_bdev && bio_flagged(bio, BIO_TRACE_COMPLETION)) { 1648 trace_block_bio_complete(bdev_get_queue(bio->bi_bdev), bio); 1649 bio_clear_flag(bio, BIO_TRACE_COMPLETION); 1650 } 1651 1652 /* 1653 * Need to have a real endio function for chained bios, otherwise 1654 * various corner cases will break (like stacking block devices that 1655 * save/restore bi_end_io) - however, we want to avoid unbounded 1656 * recursion and blowing the stack. Tail call optimization would 1657 * handle this, but compiling with frame pointers also disables 1658 * gcc's sibling call optimization. 1659 */ 1660 if (bio->bi_end_io == bio_chain_endio) { 1661 bio = __bio_chain_endio(bio); 1662 goto again; 1663 } 1664 1665 #ifdef CONFIG_BLK_CGROUP 1666 /* 1667 * Release cgroup info. We shouldn't have to do this here, but quite 1668 * a few callers of bio_init fail to call bio_uninit, so we cover up 1669 * for that here at least for now. 1670 */ 1671 if (bio->bi_blkg) { 1672 blkg_put(bio->bi_blkg); 1673 bio->bi_blkg = NULL; 1674 } 1675 #endif 1676 1677 if (bio->bi_end_io) 1678 bio->bi_end_io(bio); 1679 } 1680 EXPORT_SYMBOL(bio_endio); 1681 1682 /** 1683 * bio_split - split a bio 1684 * @bio: bio to split 1685 * @sectors: number of sectors to split from the front of @bio 1686 * @gfp: gfp mask 1687 * @bs: bio set to allocate from 1688 * 1689 * Allocates and returns a new bio which represents @sectors from the start of 1690 * @bio, and updates @bio to represent the remaining sectors. 1691 * 1692 * Unless this is a discard request the newly allocated bio will point 1693 * to @bio's bi_io_vec. It is the caller's responsibility to ensure that 1694 * neither @bio nor @bs are freed before the split bio. 1695 */ 1696 struct bio *bio_split(struct bio *bio, int sectors, 1697 gfp_t gfp, struct bio_set *bs) 1698 { 1699 struct bio *split; 1700 1701 if (WARN_ON_ONCE(sectors <= 0)) 1702 return ERR_PTR(-EINVAL); 1703 if (WARN_ON_ONCE(sectors >= bio_sectors(bio))) 1704 return ERR_PTR(-EINVAL); 1705 1706 /* Zone append commands cannot be split */ 1707 if (WARN_ON_ONCE(bio_op(bio) == REQ_OP_ZONE_APPEND)) 1708 return ERR_PTR(-EINVAL); 1709 1710 /* atomic writes cannot be split */ 1711 if (bio->bi_opf & REQ_ATOMIC) 1712 return ERR_PTR(-EINVAL); 1713 1714 split = bio_alloc_clone(bio->bi_bdev, bio, gfp, bs); 1715 if (!split) 1716 return ERR_PTR(-ENOMEM); 1717 1718 split->bi_iter.bi_size = sectors << 9; 1719 1720 if (bio_integrity(split)) 1721 bio_integrity_trim(split); 1722 1723 bio_advance(bio, split->bi_iter.bi_size); 1724 1725 if (bio_flagged(bio, BIO_TRACE_COMPLETION)) 1726 bio_set_flag(split, BIO_TRACE_COMPLETION); 1727 1728 return split; 1729 } 1730 EXPORT_SYMBOL(bio_split); 1731 1732 /** 1733 * bio_trim - trim a bio 1734 * @bio: bio to trim 1735 * @offset: number of sectors to trim from the front of @bio 1736 * @size: size we want to trim @bio to, in sectors 1737 * 1738 * This function is typically used for bios that are cloned and submitted 1739 * to the underlying device in parts. 1740 */ 1741 void bio_trim(struct bio *bio, sector_t offset, sector_t size) 1742 { 1743 /* We should never trim an atomic write */ 1744 if (WARN_ON_ONCE(bio->bi_opf & REQ_ATOMIC && size)) 1745 return; 1746 1747 if (WARN_ON_ONCE(offset > BIO_MAX_SECTORS || size > BIO_MAX_SECTORS || 1748 offset + size > bio_sectors(bio))) 1749 return; 1750 1751 size <<= 9; 1752 if (offset == 0 && size == bio->bi_iter.bi_size) 1753 return; 1754 1755 bio_advance(bio, offset << 9); 1756 bio->bi_iter.bi_size = size; 1757 1758 if (bio_integrity(bio)) 1759 bio_integrity_trim(bio); 1760 } 1761 EXPORT_SYMBOL_GPL(bio_trim); 1762 1763 /* 1764 * create memory pools for biovec's in a bio_set. 1765 * use the global biovec slabs created for general use. 1766 */ 1767 int biovec_init_pool(mempool_t *pool, int pool_entries) 1768 { 1769 struct biovec_slab *bp = bvec_slabs + ARRAY_SIZE(bvec_slabs) - 1; 1770 1771 return mempool_init_slab_pool(pool, pool_entries, bp->slab); 1772 } 1773 1774 /* 1775 * bioset_exit - exit a bioset initialized with bioset_init() 1776 * 1777 * May be called on a zeroed but uninitialized bioset (i.e. allocated with 1778 * kzalloc()). 1779 */ 1780 void bioset_exit(struct bio_set *bs) 1781 { 1782 bio_alloc_cache_destroy(bs); 1783 if (bs->rescue_workqueue) 1784 destroy_workqueue(bs->rescue_workqueue); 1785 bs->rescue_workqueue = NULL; 1786 1787 mempool_exit(&bs->bio_pool); 1788 mempool_exit(&bs->bvec_pool); 1789 1790 if (bs->bio_slab) 1791 bio_put_slab(bs); 1792 bs->bio_slab = NULL; 1793 } 1794 EXPORT_SYMBOL(bioset_exit); 1795 1796 /** 1797 * bioset_init - Initialize a bio_set 1798 * @bs: pool to initialize 1799 * @pool_size: Number of bio and bio_vecs to cache in the mempool 1800 * @front_pad: Number of bytes to allocate in front of the returned bio 1801 * @flags: Flags to modify behavior, currently %BIOSET_NEED_BVECS 1802 * and %BIOSET_NEED_RESCUER 1803 * 1804 * Description: 1805 * Set up a bio_set to be used with @bio_alloc_bioset. Allows the caller 1806 * to ask for a number of bytes to be allocated in front of the bio. 1807 * Front pad allocation is useful for embedding the bio inside 1808 * another structure, to avoid allocating extra data to go with the bio. 1809 * Note that the bio must be embedded at the END of that structure always, 1810 * or things will break badly. 1811 * If %BIOSET_NEED_BVECS is set in @flags, a separate pool will be allocated 1812 * for allocating iovecs. This pool is not needed e.g. for bio_init_clone(). 1813 * If %BIOSET_NEED_RESCUER is set, a workqueue is created which can be used 1814 * to dispatch queued requests when the mempool runs out of space. 1815 * 1816 */ 1817 int bioset_init(struct bio_set *bs, 1818 unsigned int pool_size, 1819 unsigned int front_pad, 1820 int flags) 1821 { 1822 bs->front_pad = front_pad; 1823 if (flags & BIOSET_NEED_BVECS) 1824 bs->back_pad = BIO_INLINE_VECS * sizeof(struct bio_vec); 1825 else 1826 bs->back_pad = 0; 1827 1828 spin_lock_init(&bs->rescue_lock); 1829 bio_list_init(&bs->rescue_list); 1830 INIT_WORK(&bs->rescue_work, bio_alloc_rescue); 1831 1832 bs->bio_slab = bio_find_or_create_slab(bs); 1833 if (!bs->bio_slab) 1834 return -ENOMEM; 1835 1836 if (mempool_init_slab_pool(&bs->bio_pool, pool_size, bs->bio_slab)) 1837 goto bad; 1838 1839 if ((flags & BIOSET_NEED_BVECS) && 1840 biovec_init_pool(&bs->bvec_pool, pool_size)) 1841 goto bad; 1842 1843 if (flags & BIOSET_NEED_RESCUER) { 1844 bs->rescue_workqueue = alloc_workqueue("bioset", 1845 WQ_MEM_RECLAIM, 0); 1846 if (!bs->rescue_workqueue) 1847 goto bad; 1848 } 1849 if (flags & BIOSET_PERCPU_CACHE) { 1850 bs->cache = alloc_percpu(struct bio_alloc_cache); 1851 if (!bs->cache) 1852 goto bad; 1853 cpuhp_state_add_instance_nocalls(CPUHP_BIO_DEAD, &bs->cpuhp_dead); 1854 } 1855 1856 return 0; 1857 bad: 1858 bioset_exit(bs); 1859 return -ENOMEM; 1860 } 1861 EXPORT_SYMBOL(bioset_init); 1862 1863 static int __init init_bio(void) 1864 { 1865 int i; 1866 1867 BUILD_BUG_ON(BIO_FLAG_LAST > 8 * sizeof_field(struct bio, bi_flags)); 1868 1869 for (i = 0; i < ARRAY_SIZE(bvec_slabs); i++) { 1870 struct biovec_slab *bvs = bvec_slabs + i; 1871 1872 bvs->slab = kmem_cache_create(bvs->name, 1873 bvs->nr_vecs * sizeof(struct bio_vec), 0, 1874 SLAB_HWCACHE_ALIGN | SLAB_PANIC, NULL); 1875 } 1876 1877 cpuhp_setup_state_multi(CPUHP_BIO_DEAD, "block/bio:dead", NULL, 1878 bio_cpu_dead); 1879 1880 if (bioset_init(&fs_bio_set, BIO_POOL_SIZE, 0, 1881 BIOSET_NEED_BVECS | BIOSET_PERCPU_CACHE)) 1882 panic("bio: can't allocate bios\n"); 1883 1884 return 0; 1885 } 1886 subsys_initcall(init_bio); 1887