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