18c16567dSChristoph Hellwig // SPDX-License-Identifier: GPL-2.0 2f9c78b2bSJens Axboe /* 3f9c78b2bSJens Axboe * Copyright (C) 2001 Jens Axboe <axboe@kernel.dk> 4f9c78b2bSJens Axboe */ 5f9c78b2bSJens Axboe #include <linux/mm.h> 6f9c78b2bSJens Axboe #include <linux/swap.h> 7f9c78b2bSJens Axboe #include <linux/bio.h> 8f9c78b2bSJens Axboe #include <linux/blkdev.h> 9f9c78b2bSJens Axboe #include <linux/uio.h> 10f9c78b2bSJens Axboe #include <linux/iocontext.h> 11f9c78b2bSJens Axboe #include <linux/slab.h> 12f9c78b2bSJens Axboe #include <linux/init.h> 13f9c78b2bSJens Axboe #include <linux/kernel.h> 14f9c78b2bSJens Axboe #include <linux/export.h> 15f9c78b2bSJens Axboe #include <linux/mempool.h> 16f9c78b2bSJens Axboe #include <linux/workqueue.h> 17f9c78b2bSJens Axboe #include <linux/cgroup.h> 1808e18eabSJosef Bacik #include <linux/blk-cgroup.h> 19b4c5875dSDamien Le Moal #include <linux/highmem.h> 20de6a78b6SMing Lei #include <linux/sched/sysctl.h> 21a892c8d5SSatya Tangirala #include <linux/blk-crypto.h> 2249d1ec85SMing Lei #include <linux/xarray.h> 23f9c78b2bSJens Axboe 24f9c78b2bSJens Axboe #include <trace/events/block.h> 259e234eeaSShaohua Li #include "blk.h" 2667b42d0bSJosef Bacik #include "blk-rq-qos.h" 27f9c78b2bSJens Axboe 28be4d234dSJens Axboe struct bio_alloc_cache { 29be4d234dSJens Axboe struct bio_list free_list; 30be4d234dSJens Axboe unsigned int nr; 31be4d234dSJens Axboe }; 32be4d234dSJens Axboe 33de76fd89SChristoph Hellwig static struct biovec_slab { 346ac0b715SChristoph Hellwig int nr_vecs; 356ac0b715SChristoph Hellwig char *name; 366ac0b715SChristoph Hellwig struct kmem_cache *slab; 37de76fd89SChristoph Hellwig } bvec_slabs[] __read_mostly = { 38de76fd89SChristoph Hellwig { .nr_vecs = 16, .name = "biovec-16" }, 39de76fd89SChristoph Hellwig { .nr_vecs = 64, .name = "biovec-64" }, 40de76fd89SChristoph Hellwig { .nr_vecs = 128, .name = "biovec-128" }, 41a8affc03SChristoph Hellwig { .nr_vecs = BIO_MAX_VECS, .name = "biovec-max" }, 42f9c78b2bSJens Axboe }; 436ac0b715SChristoph Hellwig 447a800a20SChristoph Hellwig static struct biovec_slab *biovec_slab(unsigned short nr_vecs) 457a800a20SChristoph Hellwig { 467a800a20SChristoph Hellwig switch (nr_vecs) { 477a800a20SChristoph Hellwig /* smaller bios use inline vecs */ 487a800a20SChristoph Hellwig case 5 ... 16: 497a800a20SChristoph Hellwig return &bvec_slabs[0]; 507a800a20SChristoph Hellwig case 17 ... 64: 517a800a20SChristoph Hellwig return &bvec_slabs[1]; 527a800a20SChristoph Hellwig case 65 ... 128: 537a800a20SChristoph Hellwig return &bvec_slabs[2]; 54a8affc03SChristoph Hellwig case 129 ... BIO_MAX_VECS: 557a800a20SChristoph Hellwig return &bvec_slabs[3]; 567a800a20SChristoph Hellwig default: 577a800a20SChristoph Hellwig BUG(); 587a800a20SChristoph Hellwig return NULL; 597a800a20SChristoph Hellwig } 607a800a20SChristoph Hellwig } 61f9c78b2bSJens Axboe 62f9c78b2bSJens Axboe /* 63f9c78b2bSJens Axboe * fs_bio_set is the bio_set containing bio and iovec memory pools used by 64f9c78b2bSJens Axboe * IO code that does not need private memory pools. 65f9c78b2bSJens Axboe */ 66f4f8154aSKent Overstreet struct bio_set fs_bio_set; 67f9c78b2bSJens Axboe EXPORT_SYMBOL(fs_bio_set); 68f9c78b2bSJens Axboe 69f9c78b2bSJens Axboe /* 70f9c78b2bSJens Axboe * Our slab pool management 71f9c78b2bSJens Axboe */ 72f9c78b2bSJens Axboe struct bio_slab { 73f9c78b2bSJens Axboe struct kmem_cache *slab; 74f9c78b2bSJens Axboe unsigned int slab_ref; 75f9c78b2bSJens Axboe unsigned int slab_size; 76f9c78b2bSJens Axboe char name[8]; 77f9c78b2bSJens Axboe }; 78f9c78b2bSJens Axboe static DEFINE_MUTEX(bio_slab_lock); 7949d1ec85SMing Lei static DEFINE_XARRAY(bio_slabs); 80f9c78b2bSJens Axboe 8149d1ec85SMing Lei static struct bio_slab *create_bio_slab(unsigned int size) 82f9c78b2bSJens Axboe { 8349d1ec85SMing Lei struct bio_slab *bslab = kzalloc(sizeof(*bslab), GFP_KERNEL); 8449d1ec85SMing Lei 8549d1ec85SMing Lei if (!bslab) 8649d1ec85SMing Lei return NULL; 8749d1ec85SMing Lei 8849d1ec85SMing Lei snprintf(bslab->name, sizeof(bslab->name), "bio-%d", size); 8949d1ec85SMing Lei bslab->slab = kmem_cache_create(bslab->name, size, 901a7e76e4SChristoph Hellwig ARCH_KMALLOC_MINALIGN, 911a7e76e4SChristoph Hellwig SLAB_HWCACHE_ALIGN | SLAB_TYPESAFE_BY_RCU, NULL); 9249d1ec85SMing Lei if (!bslab->slab) 9349d1ec85SMing Lei goto fail_alloc_slab; 9449d1ec85SMing Lei 9549d1ec85SMing Lei bslab->slab_ref = 1; 9649d1ec85SMing Lei bslab->slab_size = size; 9749d1ec85SMing Lei 9849d1ec85SMing Lei if (!xa_err(xa_store(&bio_slabs, size, bslab, GFP_KERNEL))) 9949d1ec85SMing Lei return bslab; 10049d1ec85SMing Lei 10149d1ec85SMing Lei kmem_cache_destroy(bslab->slab); 10249d1ec85SMing Lei 10349d1ec85SMing Lei fail_alloc_slab: 10449d1ec85SMing Lei kfree(bslab); 10549d1ec85SMing Lei return NULL; 10649d1ec85SMing Lei } 10749d1ec85SMing Lei 10849d1ec85SMing Lei static inline unsigned int bs_bio_slab_size(struct bio_set *bs) 10949d1ec85SMing Lei { 1109f180e31SMing Lei return bs->front_pad + sizeof(struct bio) + bs->back_pad; 11149d1ec85SMing Lei } 11249d1ec85SMing Lei 11349d1ec85SMing Lei static struct kmem_cache *bio_find_or_create_slab(struct bio_set *bs) 11449d1ec85SMing Lei { 11549d1ec85SMing Lei unsigned int size = bs_bio_slab_size(bs); 11649d1ec85SMing Lei struct bio_slab *bslab; 117f9c78b2bSJens Axboe 118f9c78b2bSJens Axboe mutex_lock(&bio_slab_lock); 11949d1ec85SMing Lei bslab = xa_load(&bio_slabs, size); 12049d1ec85SMing Lei if (bslab) 121f9c78b2bSJens Axboe bslab->slab_ref++; 12249d1ec85SMing Lei else 12349d1ec85SMing Lei bslab = create_bio_slab(size); 124f9c78b2bSJens Axboe mutex_unlock(&bio_slab_lock); 12549d1ec85SMing Lei 12649d1ec85SMing Lei if (bslab) 12749d1ec85SMing Lei return bslab->slab; 12849d1ec85SMing Lei return NULL; 129f9c78b2bSJens Axboe } 130f9c78b2bSJens Axboe 131f9c78b2bSJens Axboe static void bio_put_slab(struct bio_set *bs) 132f9c78b2bSJens Axboe { 133f9c78b2bSJens Axboe struct bio_slab *bslab = NULL; 13449d1ec85SMing Lei unsigned int slab_size = bs_bio_slab_size(bs); 135f9c78b2bSJens Axboe 136f9c78b2bSJens Axboe mutex_lock(&bio_slab_lock); 137f9c78b2bSJens Axboe 13849d1ec85SMing Lei bslab = xa_load(&bio_slabs, slab_size); 139f9c78b2bSJens Axboe if (WARN(!bslab, KERN_ERR "bio: unable to find slab!\n")) 140f9c78b2bSJens Axboe goto out; 141f9c78b2bSJens Axboe 14249d1ec85SMing Lei WARN_ON_ONCE(bslab->slab != bs->bio_slab); 14349d1ec85SMing Lei 144f9c78b2bSJens Axboe WARN_ON(!bslab->slab_ref); 145f9c78b2bSJens Axboe 146f9c78b2bSJens Axboe if (--bslab->slab_ref) 147f9c78b2bSJens Axboe goto out; 148f9c78b2bSJens Axboe 14949d1ec85SMing Lei xa_erase(&bio_slabs, slab_size); 15049d1ec85SMing Lei 151f9c78b2bSJens Axboe kmem_cache_destroy(bslab->slab); 15249d1ec85SMing Lei kfree(bslab); 153f9c78b2bSJens Axboe 154f9c78b2bSJens Axboe out: 155f9c78b2bSJens Axboe mutex_unlock(&bio_slab_lock); 156f9c78b2bSJens Axboe } 157f9c78b2bSJens Axboe 1587a800a20SChristoph Hellwig void bvec_free(mempool_t *pool, struct bio_vec *bv, unsigned short nr_vecs) 159f9c78b2bSJens Axboe { 1609e8c0d0dSChristoph Hellwig BUG_ON(nr_vecs > BIO_MAX_VECS); 161f9c78b2bSJens Axboe 162a8affc03SChristoph Hellwig if (nr_vecs == BIO_MAX_VECS) 163f9c78b2bSJens Axboe mempool_free(bv, pool); 1647a800a20SChristoph Hellwig else if (nr_vecs > BIO_INLINE_VECS) 1657a800a20SChristoph Hellwig kmem_cache_free(biovec_slab(nr_vecs)->slab, bv); 166f9c78b2bSJens Axboe } 167f9c78b2bSJens Axboe 168f2c3eb9bSChristoph Hellwig /* 169f2c3eb9bSChristoph Hellwig * Make the first allocation restricted and don't dump info on allocation 170f2c3eb9bSChristoph Hellwig * failures, since we'll fall back to the mempool in case of failure. 171f2c3eb9bSChristoph Hellwig */ 172f2c3eb9bSChristoph Hellwig static inline gfp_t bvec_alloc_gfp(gfp_t gfp) 173f9c78b2bSJens Axboe { 174f2c3eb9bSChristoph Hellwig return (gfp & ~(__GFP_DIRECT_RECLAIM | __GFP_IO)) | 175f2c3eb9bSChristoph Hellwig __GFP_NOMEMALLOC | __GFP_NORETRY | __GFP_NOWARN; 176f2c3eb9bSChristoph Hellwig } 177f2c3eb9bSChristoph Hellwig 1787a800a20SChristoph Hellwig struct bio_vec *bvec_alloc(mempool_t *pool, unsigned short *nr_vecs, 1797a800a20SChristoph Hellwig gfp_t gfp_mask) 180f9c78b2bSJens Axboe { 1817a800a20SChristoph Hellwig struct biovec_slab *bvs = biovec_slab(*nr_vecs); 1827a800a20SChristoph Hellwig 1837a800a20SChristoph Hellwig if (WARN_ON_ONCE(!bvs)) 184f9c78b2bSJens Axboe return NULL; 1857a800a20SChristoph Hellwig 1867a800a20SChristoph Hellwig /* 1877a800a20SChristoph Hellwig * Upgrade the nr_vecs request to take full advantage of the allocation. 1887a800a20SChristoph Hellwig * We also rely on this in the bvec_free path. 1897a800a20SChristoph Hellwig */ 1907a800a20SChristoph Hellwig *nr_vecs = bvs->nr_vecs; 191f9c78b2bSJens Axboe 192f9c78b2bSJens Axboe /* 193f007a3d6SChristoph Hellwig * Try a slab allocation first for all smaller allocations. If that 194f007a3d6SChristoph Hellwig * fails and __GFP_DIRECT_RECLAIM is set retry with the mempool. 195a8affc03SChristoph Hellwig * The mempool is sized to handle up to BIO_MAX_VECS entries. 196f9c78b2bSJens Axboe */ 197a8affc03SChristoph Hellwig if (*nr_vecs < BIO_MAX_VECS) { 198f9c78b2bSJens Axboe struct bio_vec *bvl; 199f9c78b2bSJens Axboe 200f2c3eb9bSChristoph Hellwig bvl = kmem_cache_alloc(bvs->slab, bvec_alloc_gfp(gfp_mask)); 2017a800a20SChristoph Hellwig if (likely(bvl) || !(gfp_mask & __GFP_DIRECT_RECLAIM)) 202f9c78b2bSJens Axboe return bvl; 203a8affc03SChristoph Hellwig *nr_vecs = BIO_MAX_VECS; 204f9c78b2bSJens Axboe } 205f9c78b2bSJens Axboe 206f007a3d6SChristoph Hellwig return mempool_alloc(pool, gfp_mask); 207f9c78b2bSJens Axboe } 208f9c78b2bSJens Axboe 2099ae3b3f5SJens Axboe void bio_uninit(struct bio *bio) 210f9c78b2bSJens Axboe { 211db9819c7SChristoph Hellwig #ifdef CONFIG_BLK_CGROUP 212db9819c7SChristoph Hellwig if (bio->bi_blkg) { 213db9819c7SChristoph Hellwig blkg_put(bio->bi_blkg); 214db9819c7SChristoph Hellwig bio->bi_blkg = NULL; 215db9819c7SChristoph Hellwig } 216db9819c7SChristoph Hellwig #endif 217ece841abSJustin Tee if (bio_integrity(bio)) 218ece841abSJustin Tee bio_integrity_free(bio); 219a892c8d5SSatya Tangirala 220a892c8d5SSatya Tangirala bio_crypt_free_ctx(bio); 221f9c78b2bSJens Axboe } 2229ae3b3f5SJens Axboe EXPORT_SYMBOL(bio_uninit); 223f9c78b2bSJens Axboe 224f9c78b2bSJens Axboe static void bio_free(struct bio *bio) 225f9c78b2bSJens Axboe { 226f9c78b2bSJens Axboe struct bio_set *bs = bio->bi_pool; 227f9c78b2bSJens Axboe void *p; 228f9c78b2bSJens Axboe 2299ae3b3f5SJens Axboe bio_uninit(bio); 230f9c78b2bSJens Axboe 231f9c78b2bSJens Axboe if (bs) { 2327a800a20SChristoph Hellwig bvec_free(&bs->bvec_pool, bio->bi_io_vec, bio->bi_max_vecs); 233f9c78b2bSJens Axboe 234f9c78b2bSJens Axboe /* 235f9c78b2bSJens Axboe * If we have front padding, adjust the bio pointer before freeing 236f9c78b2bSJens Axboe */ 237f9c78b2bSJens Axboe p = bio; 238f9c78b2bSJens Axboe p -= bs->front_pad; 239f9c78b2bSJens Axboe 2408aa6ba2fSKent Overstreet mempool_free(p, &bs->bio_pool); 241f9c78b2bSJens Axboe } else { 242f9c78b2bSJens Axboe /* Bio was allocated by bio_kmalloc() */ 243f9c78b2bSJens Axboe kfree(bio); 244f9c78b2bSJens Axboe } 245f9c78b2bSJens Axboe } 246f9c78b2bSJens Axboe 2479ae3b3f5SJens Axboe /* 2489ae3b3f5SJens Axboe * Users of this function have their own bio allocation. Subsequently, 2499ae3b3f5SJens Axboe * they must remember to pair any call to bio_init() with bio_uninit() 2509ae3b3f5SJens Axboe * when IO has completed, or when the bio is released. 2519ae3b3f5SJens Axboe */ 2523a83f467SMing Lei void bio_init(struct bio *bio, struct bio_vec *table, 2533a83f467SMing Lei unsigned short max_vecs) 254f9c78b2bSJens Axboe { 255da521626SJens Axboe bio->bi_next = NULL; 256da521626SJens Axboe bio->bi_bdev = NULL; 257da521626SJens Axboe bio->bi_opf = 0; 258da521626SJens Axboe bio->bi_flags = 0; 259da521626SJens Axboe bio->bi_ioprio = 0; 260da521626SJens Axboe bio->bi_write_hint = 0; 261da521626SJens Axboe bio->bi_status = 0; 262da521626SJens Axboe bio->bi_iter.bi_sector = 0; 263da521626SJens Axboe bio->bi_iter.bi_size = 0; 264da521626SJens Axboe bio->bi_iter.bi_idx = 0; 265da521626SJens Axboe bio->bi_iter.bi_bvec_done = 0; 266da521626SJens Axboe bio->bi_end_io = NULL; 267da521626SJens Axboe bio->bi_private = NULL; 268da521626SJens Axboe #ifdef CONFIG_BLK_CGROUP 269da521626SJens Axboe bio->bi_blkg = NULL; 270da521626SJens Axboe bio->bi_issue.value = 0; 271da521626SJens Axboe #ifdef CONFIG_BLK_CGROUP_IOCOST 272da521626SJens Axboe bio->bi_iocost_cost = 0; 273da521626SJens Axboe #endif 274da521626SJens Axboe #endif 275da521626SJens Axboe #ifdef CONFIG_BLK_INLINE_ENCRYPTION 276da521626SJens Axboe bio->bi_crypt_context = NULL; 277da521626SJens Axboe #endif 278da521626SJens Axboe #ifdef CONFIG_BLK_DEV_INTEGRITY 279da521626SJens Axboe bio->bi_integrity = NULL; 280da521626SJens Axboe #endif 281da521626SJens Axboe bio->bi_vcnt = 0; 282da521626SJens Axboe 283c4cf5261SJens Axboe atomic_set(&bio->__bi_remaining, 1); 284dac56212SJens Axboe atomic_set(&bio->__bi_cnt, 1); 2853e08773cSChristoph Hellwig bio->bi_cookie = BLK_QC_T_NONE; 2863a83f467SMing Lei 2873a83f467SMing Lei bio->bi_max_vecs = max_vecs; 288da521626SJens Axboe bio->bi_io_vec = table; 289da521626SJens Axboe bio->bi_pool = NULL; 290f9c78b2bSJens Axboe } 291f9c78b2bSJens Axboe EXPORT_SYMBOL(bio_init); 292f9c78b2bSJens Axboe 293f9c78b2bSJens Axboe /** 294f9c78b2bSJens Axboe * bio_reset - reinitialize a bio 295f9c78b2bSJens Axboe * @bio: bio to reset 296f9c78b2bSJens Axboe * 297f9c78b2bSJens Axboe * Description: 298f9c78b2bSJens Axboe * After calling bio_reset(), @bio will be in the same state as a freshly 299f9c78b2bSJens Axboe * allocated bio returned bio bio_alloc_bioset() - the only fields that are 300f9c78b2bSJens Axboe * preserved are the ones that are initialized by bio_alloc_bioset(). See 301f9c78b2bSJens Axboe * comment in struct bio. 302f9c78b2bSJens Axboe */ 303f9c78b2bSJens Axboe void bio_reset(struct bio *bio) 304f9c78b2bSJens Axboe { 3059ae3b3f5SJens Axboe bio_uninit(bio); 306f9c78b2bSJens Axboe memset(bio, 0, BIO_RESET_BYTES); 307c4cf5261SJens Axboe atomic_set(&bio->__bi_remaining, 1); 308f9c78b2bSJens Axboe } 309f9c78b2bSJens Axboe EXPORT_SYMBOL(bio_reset); 310f9c78b2bSJens Axboe 31138f8baaeSChristoph Hellwig static struct bio *__bio_chain_endio(struct bio *bio) 312f9c78b2bSJens Axboe { 3134246a0b6SChristoph Hellwig struct bio *parent = bio->bi_private; 3144246a0b6SChristoph Hellwig 3153edf5346SYufen Yu if (bio->bi_status && !parent->bi_status) 3164e4cbee9SChristoph Hellwig parent->bi_status = bio->bi_status; 317f9c78b2bSJens Axboe bio_put(bio); 31838f8baaeSChristoph Hellwig return parent; 31938f8baaeSChristoph Hellwig } 32038f8baaeSChristoph Hellwig 32138f8baaeSChristoph Hellwig static void bio_chain_endio(struct bio *bio) 32238f8baaeSChristoph Hellwig { 32338f8baaeSChristoph Hellwig bio_endio(__bio_chain_endio(bio)); 324f9c78b2bSJens Axboe } 325f9c78b2bSJens Axboe 326f9c78b2bSJens Axboe /** 327f9c78b2bSJens Axboe * bio_chain - chain bio completions 328f9c78b2bSJens Axboe * @bio: the target bio 3295b874af6SMauro Carvalho Chehab * @parent: the parent bio of @bio 330f9c78b2bSJens Axboe * 331f9c78b2bSJens Axboe * The caller won't have a bi_end_io called when @bio completes - instead, 332f9c78b2bSJens Axboe * @parent's bi_end_io won't be called until both @parent and @bio have 333f9c78b2bSJens Axboe * completed; the chained bio will also be freed when it completes. 334f9c78b2bSJens Axboe * 335f9c78b2bSJens Axboe * The caller must not set bi_private or bi_end_io in @bio. 336f9c78b2bSJens Axboe */ 337f9c78b2bSJens Axboe void bio_chain(struct bio *bio, struct bio *parent) 338f9c78b2bSJens Axboe { 339f9c78b2bSJens Axboe BUG_ON(bio->bi_private || bio->bi_end_io); 340f9c78b2bSJens Axboe 341f9c78b2bSJens Axboe bio->bi_private = parent; 342f9c78b2bSJens Axboe bio->bi_end_io = bio_chain_endio; 343c4cf5261SJens Axboe bio_inc_remaining(parent); 344f9c78b2bSJens Axboe } 345f9c78b2bSJens Axboe EXPORT_SYMBOL(bio_chain); 346f9c78b2bSJens Axboe 347f9c78b2bSJens Axboe static void bio_alloc_rescue(struct work_struct *work) 348f9c78b2bSJens Axboe { 349f9c78b2bSJens Axboe struct bio_set *bs = container_of(work, struct bio_set, rescue_work); 350f9c78b2bSJens Axboe struct bio *bio; 351f9c78b2bSJens Axboe 352f9c78b2bSJens Axboe while (1) { 353f9c78b2bSJens Axboe spin_lock(&bs->rescue_lock); 354f9c78b2bSJens Axboe bio = bio_list_pop(&bs->rescue_list); 355f9c78b2bSJens Axboe spin_unlock(&bs->rescue_lock); 356f9c78b2bSJens Axboe 357f9c78b2bSJens Axboe if (!bio) 358f9c78b2bSJens Axboe break; 359f9c78b2bSJens Axboe 360ed00aabdSChristoph Hellwig submit_bio_noacct(bio); 361f9c78b2bSJens Axboe } 362f9c78b2bSJens Axboe } 363f9c78b2bSJens Axboe 364f9c78b2bSJens Axboe static void punt_bios_to_rescuer(struct bio_set *bs) 365f9c78b2bSJens Axboe { 366f9c78b2bSJens Axboe struct bio_list punt, nopunt; 367f9c78b2bSJens Axboe struct bio *bio; 368f9c78b2bSJens Axboe 36947e0fb46SNeilBrown if (WARN_ON_ONCE(!bs->rescue_workqueue)) 37047e0fb46SNeilBrown return; 371f9c78b2bSJens Axboe /* 372f9c78b2bSJens Axboe * In order to guarantee forward progress we must punt only bios that 373f9c78b2bSJens Axboe * were allocated from this bio_set; otherwise, if there was a bio on 374f9c78b2bSJens Axboe * there for a stacking driver higher up in the stack, processing it 375f9c78b2bSJens Axboe * could require allocating bios from this bio_set, and doing that from 376f9c78b2bSJens Axboe * our own rescuer would be bad. 377f9c78b2bSJens Axboe * 378f9c78b2bSJens Axboe * Since bio lists are singly linked, pop them all instead of trying to 379f9c78b2bSJens Axboe * remove from the middle of the list: 380f9c78b2bSJens Axboe */ 381f9c78b2bSJens Axboe 382f9c78b2bSJens Axboe bio_list_init(&punt); 383f9c78b2bSJens Axboe bio_list_init(&nopunt); 384f9c78b2bSJens Axboe 385f5fe1b51SNeilBrown while ((bio = bio_list_pop(¤t->bio_list[0]))) 386f9c78b2bSJens Axboe bio_list_add(bio->bi_pool == bs ? &punt : &nopunt, bio); 387f5fe1b51SNeilBrown current->bio_list[0] = nopunt; 388f9c78b2bSJens Axboe 389f5fe1b51SNeilBrown bio_list_init(&nopunt); 390f5fe1b51SNeilBrown while ((bio = bio_list_pop(¤t->bio_list[1]))) 391f5fe1b51SNeilBrown bio_list_add(bio->bi_pool == bs ? &punt : &nopunt, bio); 392f5fe1b51SNeilBrown current->bio_list[1] = nopunt; 393f9c78b2bSJens Axboe 394f9c78b2bSJens Axboe spin_lock(&bs->rescue_lock); 395f9c78b2bSJens Axboe bio_list_merge(&bs->rescue_list, &punt); 396f9c78b2bSJens Axboe spin_unlock(&bs->rescue_lock); 397f9c78b2bSJens Axboe 398f9c78b2bSJens Axboe queue_work(bs->rescue_workqueue, &bs->rescue_work); 399f9c78b2bSJens Axboe } 400f9c78b2bSJens Axboe 401f9c78b2bSJens Axboe /** 402f9c78b2bSJens Axboe * bio_alloc_bioset - allocate a bio for I/O 403519c8e9fSRandy Dunlap * @gfp_mask: the GFP_* mask given to the slab allocator 404f9c78b2bSJens Axboe * @nr_iovecs: number of iovecs to pre-allocate 405f9c78b2bSJens Axboe * @bs: the bio_set to allocate from. 406f9c78b2bSJens Axboe * 4073175199aSChristoph Hellwig * Allocate a bio from the mempools in @bs. 408f9c78b2bSJens Axboe * 4093175199aSChristoph Hellwig * If %__GFP_DIRECT_RECLAIM is set then bio_alloc will always be able to 4103175199aSChristoph Hellwig * allocate a bio. This is due to the mempool guarantees. To make this work, 4113175199aSChristoph Hellwig * callers must never allocate more than 1 bio at a time from the general pool. 4123175199aSChristoph Hellwig * Callers that need to allocate more than 1 bio must always submit the 4133175199aSChristoph Hellwig * previously allocated bio for IO before attempting to allocate a new one. 4143175199aSChristoph Hellwig * Failure to do so can cause deadlocks under memory pressure. 415f9c78b2bSJens Axboe * 4163175199aSChristoph Hellwig * Note that when running under submit_bio_noacct() (i.e. any block driver), 4173175199aSChristoph Hellwig * bios are not submitted until after you return - see the code in 418ed00aabdSChristoph Hellwig * submit_bio_noacct() that converts recursion into iteration, to prevent 419f9c78b2bSJens Axboe * stack overflows. 420f9c78b2bSJens Axboe * 4213175199aSChristoph Hellwig * This would normally mean allocating multiple bios under submit_bio_noacct() 4223175199aSChristoph Hellwig * would be susceptible to deadlocks, but we have 423f9c78b2bSJens Axboe * deadlock avoidance code that resubmits any blocked bios from a rescuer 424f9c78b2bSJens Axboe * thread. 425f9c78b2bSJens Axboe * 426f9c78b2bSJens Axboe * However, we do not guarantee forward progress for allocations from other 427f9c78b2bSJens Axboe * mempools. Doing multiple allocations from the same mempool under 428ed00aabdSChristoph Hellwig * submit_bio_noacct() should be avoided - instead, use bio_set's front_pad 429f9c78b2bSJens Axboe * for per bio allocations. 430f9c78b2bSJens Axboe * 4313175199aSChristoph Hellwig * Returns: Pointer to new bio on success, NULL on failure. 432f9c78b2bSJens Axboe */ 4330f2e6ab8SChristoph Hellwig struct bio *bio_alloc_bioset(gfp_t gfp_mask, unsigned short nr_iovecs, 4347a88fa19SDan Carpenter struct bio_set *bs) 435f9c78b2bSJens Axboe { 436f9c78b2bSJens Axboe gfp_t saved_gfp = gfp_mask; 437f9c78b2bSJens Axboe struct bio *bio; 438f9c78b2bSJens Axboe void *p; 439f9c78b2bSJens Axboe 4403175199aSChristoph Hellwig /* should not use nobvec bioset for nr_iovecs > 0 */ 4413175199aSChristoph Hellwig if (WARN_ON_ONCE(!mempool_initialized(&bs->bvec_pool) && nr_iovecs > 0)) 442f9c78b2bSJens Axboe return NULL; 443f9c78b2bSJens Axboe 444f9c78b2bSJens Axboe /* 4453175199aSChristoph Hellwig * submit_bio_noacct() converts recursion to iteration; this means if 4463175199aSChristoph Hellwig * we're running beneath it, any bios we allocate and submit will not be 4473175199aSChristoph Hellwig * submitted (and thus freed) until after we return. 448f9c78b2bSJens Axboe * 4493175199aSChristoph Hellwig * This exposes us to a potential deadlock if we allocate multiple bios 4503175199aSChristoph Hellwig * from the same bio_set() while running underneath submit_bio_noacct(). 4513175199aSChristoph Hellwig * If we were to allocate multiple bios (say a stacking block driver 4523175199aSChristoph Hellwig * that was splitting bios), we would deadlock if we exhausted the 4533175199aSChristoph Hellwig * mempool's reserve. 454f9c78b2bSJens Axboe * 455f9c78b2bSJens Axboe * We solve this, and guarantee forward progress, with a rescuer 4563175199aSChristoph Hellwig * workqueue per bio_set. If we go to allocate and there are bios on 4573175199aSChristoph Hellwig * current->bio_list, we first try the allocation without 4583175199aSChristoph Hellwig * __GFP_DIRECT_RECLAIM; if that fails, we punt those bios we would be 4593175199aSChristoph Hellwig * blocking to the rescuer workqueue before we retry with the original 4603175199aSChristoph Hellwig * gfp_flags. 461f9c78b2bSJens Axboe */ 462f5fe1b51SNeilBrown if (current->bio_list && 463f5fe1b51SNeilBrown (!bio_list_empty(¤t->bio_list[0]) || 46447e0fb46SNeilBrown !bio_list_empty(¤t->bio_list[1])) && 46547e0fb46SNeilBrown bs->rescue_workqueue) 466d0164adcSMel Gorman gfp_mask &= ~__GFP_DIRECT_RECLAIM; 467f9c78b2bSJens Axboe 4688aa6ba2fSKent Overstreet p = mempool_alloc(&bs->bio_pool, gfp_mask); 469f9c78b2bSJens Axboe if (!p && gfp_mask != saved_gfp) { 470f9c78b2bSJens Axboe punt_bios_to_rescuer(bs); 471f9c78b2bSJens Axboe gfp_mask = saved_gfp; 4728aa6ba2fSKent Overstreet p = mempool_alloc(&bs->bio_pool, gfp_mask); 473f9c78b2bSJens Axboe } 474f9c78b2bSJens Axboe if (unlikely(!p)) 475f9c78b2bSJens Axboe return NULL; 476f9c78b2bSJens Axboe 4773175199aSChristoph Hellwig bio = p + bs->front_pad; 4783175199aSChristoph Hellwig if (nr_iovecs > BIO_INLINE_VECS) { 4793175199aSChristoph Hellwig struct bio_vec *bvl = NULL; 480f9c78b2bSJens Axboe 4817a800a20SChristoph Hellwig bvl = bvec_alloc(&bs->bvec_pool, &nr_iovecs, gfp_mask); 482f9c78b2bSJens Axboe if (!bvl && gfp_mask != saved_gfp) { 483f9c78b2bSJens Axboe punt_bios_to_rescuer(bs); 484f9c78b2bSJens Axboe gfp_mask = saved_gfp; 4857a800a20SChristoph Hellwig bvl = bvec_alloc(&bs->bvec_pool, &nr_iovecs, gfp_mask); 486f9c78b2bSJens Axboe } 487f9c78b2bSJens Axboe if (unlikely(!bvl)) 488f9c78b2bSJens Axboe goto err_free; 489f9c78b2bSJens Axboe 4907a800a20SChristoph Hellwig bio_init(bio, bvl, nr_iovecs); 491f9c78b2bSJens Axboe } else if (nr_iovecs) { 4923175199aSChristoph Hellwig bio_init(bio, bio->bi_inline_vecs, BIO_INLINE_VECS); 4933175199aSChristoph Hellwig } else { 4943175199aSChristoph Hellwig bio_init(bio, NULL, 0); 495f9c78b2bSJens Axboe } 496f9c78b2bSJens Axboe 497f9c78b2bSJens Axboe bio->bi_pool = bs; 498f9c78b2bSJens Axboe return bio; 499f9c78b2bSJens Axboe 500f9c78b2bSJens Axboe err_free: 5018aa6ba2fSKent Overstreet mempool_free(p, &bs->bio_pool); 502f9c78b2bSJens Axboe return NULL; 503f9c78b2bSJens Axboe } 504f9c78b2bSJens Axboe EXPORT_SYMBOL(bio_alloc_bioset); 505f9c78b2bSJens Axboe 5063175199aSChristoph Hellwig /** 5073175199aSChristoph Hellwig * bio_kmalloc - kmalloc a bio for I/O 5083175199aSChristoph Hellwig * @gfp_mask: the GFP_* mask given to the slab allocator 5093175199aSChristoph Hellwig * @nr_iovecs: number of iovecs to pre-allocate 5103175199aSChristoph Hellwig * 5113175199aSChristoph Hellwig * Use kmalloc to allocate and initialize a bio. 5123175199aSChristoph Hellwig * 5133175199aSChristoph Hellwig * Returns: Pointer to new bio on success, NULL on failure. 5143175199aSChristoph Hellwig */ 5150f2e6ab8SChristoph Hellwig struct bio *bio_kmalloc(gfp_t gfp_mask, unsigned short nr_iovecs) 5163175199aSChristoph Hellwig { 5173175199aSChristoph Hellwig struct bio *bio; 5183175199aSChristoph Hellwig 5193175199aSChristoph Hellwig if (nr_iovecs > UIO_MAXIOV) 5203175199aSChristoph Hellwig return NULL; 5213175199aSChristoph Hellwig 5223175199aSChristoph Hellwig bio = kmalloc(struct_size(bio, bi_inline_vecs, nr_iovecs), gfp_mask); 5233175199aSChristoph Hellwig if (unlikely(!bio)) 5243175199aSChristoph Hellwig return NULL; 5253175199aSChristoph Hellwig bio_init(bio, nr_iovecs ? bio->bi_inline_vecs : NULL, nr_iovecs); 5263175199aSChristoph Hellwig bio->bi_pool = NULL; 5273175199aSChristoph Hellwig return bio; 5283175199aSChristoph Hellwig } 5293175199aSChristoph Hellwig EXPORT_SYMBOL(bio_kmalloc); 5303175199aSChristoph Hellwig 5316f822e1bSChristoph Hellwig void zero_fill_bio(struct bio *bio) 532f9c78b2bSJens Axboe { 533f9c78b2bSJens Axboe struct bio_vec bv; 534f9c78b2bSJens Axboe struct bvec_iter iter; 535f9c78b2bSJens Axboe 536ab6c340eSChristoph Hellwig bio_for_each_segment(bv, bio, iter) 537ab6c340eSChristoph Hellwig memzero_bvec(&bv); 538f9c78b2bSJens Axboe } 5396f822e1bSChristoph Hellwig EXPORT_SYMBOL(zero_fill_bio); 540f9c78b2bSJens Axboe 54183c9c547SMing Lei /** 54283c9c547SMing Lei * bio_truncate - truncate the bio to small size of @new_size 54383c9c547SMing Lei * @bio: the bio to be truncated 54483c9c547SMing Lei * @new_size: new size for truncating the bio 54583c9c547SMing Lei * 54683c9c547SMing Lei * Description: 54783c9c547SMing Lei * Truncate the bio to new size of @new_size. If bio_op(bio) is 54883c9c547SMing Lei * REQ_OP_READ, zero the truncated part. This function should only 54983c9c547SMing Lei * be used for handling corner cases, such as bio eod. 55083c9c547SMing Lei */ 5514f7ab09aSChristoph Hellwig static void bio_truncate(struct bio *bio, unsigned new_size) 55285a8ce62SMing Lei { 55385a8ce62SMing Lei struct bio_vec bv; 55485a8ce62SMing Lei struct bvec_iter iter; 55585a8ce62SMing Lei unsigned int done = 0; 55685a8ce62SMing Lei bool truncated = false; 55785a8ce62SMing Lei 55885a8ce62SMing Lei if (new_size >= bio->bi_iter.bi_size) 55985a8ce62SMing Lei return; 56085a8ce62SMing Lei 56183c9c547SMing Lei if (bio_op(bio) != REQ_OP_READ) 56285a8ce62SMing Lei goto exit; 56385a8ce62SMing Lei 56485a8ce62SMing Lei bio_for_each_segment(bv, bio, iter) { 56585a8ce62SMing Lei if (done + bv.bv_len > new_size) { 56685a8ce62SMing Lei unsigned offset; 56785a8ce62SMing Lei 56885a8ce62SMing Lei if (!truncated) 56985a8ce62SMing Lei offset = new_size - done; 57085a8ce62SMing Lei else 57185a8ce62SMing Lei offset = 0; 57285a8ce62SMing Lei zero_user(bv.bv_page, offset, bv.bv_len - offset); 57385a8ce62SMing Lei truncated = true; 57485a8ce62SMing Lei } 57585a8ce62SMing Lei done += bv.bv_len; 57685a8ce62SMing Lei } 57785a8ce62SMing Lei 57885a8ce62SMing Lei exit: 57985a8ce62SMing Lei /* 58085a8ce62SMing Lei * Don't touch bvec table here and make it really immutable, since 58185a8ce62SMing Lei * fs bio user has to retrieve all pages via bio_for_each_segment_all 58285a8ce62SMing Lei * in its .end_bio() callback. 58385a8ce62SMing Lei * 58485a8ce62SMing Lei * It is enough to truncate bio by updating .bi_size since we can make 58585a8ce62SMing Lei * correct bvec with the updated .bi_size for drivers. 58685a8ce62SMing Lei */ 58785a8ce62SMing Lei bio->bi_iter.bi_size = new_size; 58885a8ce62SMing Lei } 58985a8ce62SMing Lei 590f9c78b2bSJens Axboe /** 59129125ed6SChristoph Hellwig * guard_bio_eod - truncate a BIO to fit the block device 59229125ed6SChristoph Hellwig * @bio: bio to truncate 59329125ed6SChristoph Hellwig * 59429125ed6SChristoph Hellwig * This allows us to do IO even on the odd last sectors of a device, even if the 59529125ed6SChristoph Hellwig * block size is some multiple of the physical sector size. 59629125ed6SChristoph Hellwig * 59729125ed6SChristoph Hellwig * We'll just truncate the bio to the size of the device, and clear the end of 59829125ed6SChristoph Hellwig * the buffer head manually. Truly out-of-range accesses will turn into actual 59929125ed6SChristoph Hellwig * I/O errors, this only handles the "we need to be able to do I/O at the final 60029125ed6SChristoph Hellwig * sector" case. 60129125ed6SChristoph Hellwig */ 60229125ed6SChristoph Hellwig void guard_bio_eod(struct bio *bio) 60329125ed6SChristoph Hellwig { 604309dca30SChristoph Hellwig sector_t maxsector = bdev_nr_sectors(bio->bi_bdev); 60529125ed6SChristoph Hellwig 60629125ed6SChristoph Hellwig if (!maxsector) 60729125ed6SChristoph Hellwig return; 60829125ed6SChristoph Hellwig 60929125ed6SChristoph Hellwig /* 61029125ed6SChristoph Hellwig * If the *whole* IO is past the end of the device, 61129125ed6SChristoph Hellwig * let it through, and the IO layer will turn it into 61229125ed6SChristoph Hellwig * an EIO. 61329125ed6SChristoph Hellwig */ 61429125ed6SChristoph Hellwig if (unlikely(bio->bi_iter.bi_sector >= maxsector)) 61529125ed6SChristoph Hellwig return; 61629125ed6SChristoph Hellwig 61729125ed6SChristoph Hellwig maxsector -= bio->bi_iter.bi_sector; 61829125ed6SChristoph Hellwig if (likely((bio->bi_iter.bi_size >> 9) <= maxsector)) 61929125ed6SChristoph Hellwig return; 62029125ed6SChristoph Hellwig 62129125ed6SChristoph Hellwig bio_truncate(bio, maxsector << 9); 62229125ed6SChristoph Hellwig } 62329125ed6SChristoph Hellwig 624be4d234dSJens Axboe #define ALLOC_CACHE_MAX 512 625be4d234dSJens Axboe #define ALLOC_CACHE_SLACK 64 626be4d234dSJens Axboe 627be4d234dSJens Axboe static void bio_alloc_cache_prune(struct bio_alloc_cache *cache, 628be4d234dSJens Axboe unsigned int nr) 629be4d234dSJens Axboe { 630be4d234dSJens Axboe unsigned int i = 0; 631be4d234dSJens Axboe struct bio *bio; 632be4d234dSJens Axboe 633be4d234dSJens Axboe while ((bio = bio_list_pop(&cache->free_list)) != NULL) { 634be4d234dSJens Axboe cache->nr--; 635be4d234dSJens Axboe bio_free(bio); 636be4d234dSJens Axboe if (++i == nr) 637be4d234dSJens Axboe break; 638be4d234dSJens Axboe } 639be4d234dSJens Axboe } 640be4d234dSJens Axboe 641be4d234dSJens Axboe static int bio_cpu_dead(unsigned int cpu, struct hlist_node *node) 642be4d234dSJens Axboe { 643be4d234dSJens Axboe struct bio_set *bs; 644be4d234dSJens Axboe 645be4d234dSJens Axboe bs = hlist_entry_safe(node, struct bio_set, cpuhp_dead); 646be4d234dSJens Axboe if (bs->cache) { 647be4d234dSJens Axboe struct bio_alloc_cache *cache = per_cpu_ptr(bs->cache, cpu); 648be4d234dSJens Axboe 649be4d234dSJens Axboe bio_alloc_cache_prune(cache, -1U); 650be4d234dSJens Axboe } 651be4d234dSJens Axboe return 0; 652be4d234dSJens Axboe } 653be4d234dSJens Axboe 654be4d234dSJens Axboe static void bio_alloc_cache_destroy(struct bio_set *bs) 655be4d234dSJens Axboe { 656be4d234dSJens Axboe int cpu; 657be4d234dSJens Axboe 658be4d234dSJens Axboe if (!bs->cache) 659be4d234dSJens Axboe return; 660be4d234dSJens Axboe 661be4d234dSJens Axboe cpuhp_state_remove_instance_nocalls(CPUHP_BIO_DEAD, &bs->cpuhp_dead); 662be4d234dSJens Axboe for_each_possible_cpu(cpu) { 663be4d234dSJens Axboe struct bio_alloc_cache *cache; 664be4d234dSJens Axboe 665be4d234dSJens Axboe cache = per_cpu_ptr(bs->cache, cpu); 666be4d234dSJens Axboe bio_alloc_cache_prune(cache, -1U); 667be4d234dSJens Axboe } 668be4d234dSJens Axboe free_percpu(bs->cache); 669be4d234dSJens Axboe } 670be4d234dSJens Axboe 67129125ed6SChristoph Hellwig /** 672f9c78b2bSJens Axboe * bio_put - release a reference to a bio 673f9c78b2bSJens Axboe * @bio: bio to release reference to 674f9c78b2bSJens Axboe * 675f9c78b2bSJens Axboe * Description: 676f9c78b2bSJens Axboe * Put a reference to a &struct bio, either one you have gotten with 6779b10f6a9SNeilBrown * bio_alloc, bio_get or bio_clone_*. The last put of a bio will free it. 678f9c78b2bSJens Axboe **/ 679f9c78b2bSJens Axboe void bio_put(struct bio *bio) 680f9c78b2bSJens Axboe { 681be4d234dSJens Axboe if (unlikely(bio_flagged(bio, BIO_REFFED))) { 6829e8c0d0dSChristoph Hellwig BUG_ON(!atomic_read(&bio->__bi_cnt)); 683be4d234dSJens Axboe if (!atomic_dec_and_test(&bio->__bi_cnt)) 684be4d234dSJens Axboe return; 685be4d234dSJens Axboe } 686f9c78b2bSJens Axboe 687be4d234dSJens Axboe if (bio_flagged(bio, BIO_PERCPU_CACHE)) { 688be4d234dSJens Axboe struct bio_alloc_cache *cache; 689be4d234dSJens Axboe 690be4d234dSJens Axboe bio_uninit(bio); 691be4d234dSJens Axboe cache = per_cpu_ptr(bio->bi_pool->cache, get_cpu()); 692be4d234dSJens Axboe bio_list_add_head(&cache->free_list, bio); 693be4d234dSJens Axboe if (++cache->nr > ALLOC_CACHE_MAX + ALLOC_CACHE_SLACK) 694be4d234dSJens Axboe bio_alloc_cache_prune(cache, ALLOC_CACHE_SLACK); 695be4d234dSJens Axboe put_cpu(); 696be4d234dSJens Axboe } else { 697f9c78b2bSJens Axboe bio_free(bio); 698f9c78b2bSJens Axboe } 699dac56212SJens Axboe } 700f9c78b2bSJens Axboe EXPORT_SYMBOL(bio_put); 701f9c78b2bSJens Axboe 702f9c78b2bSJens Axboe /** 703f9c78b2bSJens Axboe * __bio_clone_fast - clone a bio that shares the original bio's biovec 704f9c78b2bSJens Axboe * @bio: destination bio 705f9c78b2bSJens Axboe * @bio_src: bio to clone 706f9c78b2bSJens Axboe * 707f9c78b2bSJens Axboe * Clone a &bio. Caller will own the returned bio, but not 708f9c78b2bSJens Axboe * the actual data it points to. Reference count of returned 709f9c78b2bSJens Axboe * bio will be one. 710f9c78b2bSJens Axboe * 711f9c78b2bSJens Axboe * Caller must ensure that @bio_src is not freed before @bio. 712f9c78b2bSJens Axboe */ 713f9c78b2bSJens Axboe void __bio_clone_fast(struct bio *bio, struct bio *bio_src) 714f9c78b2bSJens Axboe { 7157a800a20SChristoph Hellwig WARN_ON_ONCE(bio->bi_pool && bio->bi_max_vecs); 716f9c78b2bSJens Axboe 717f9c78b2bSJens Axboe /* 718309dca30SChristoph Hellwig * most users will be overriding ->bi_bdev with a new target, 719f9c78b2bSJens Axboe * so we don't set nor calculate new physical/hw segment counts here 720f9c78b2bSJens Axboe */ 721309dca30SChristoph Hellwig bio->bi_bdev = bio_src->bi_bdev; 722b7c44ed9SJens Axboe bio_set_flag(bio, BIO_CLONED); 723111be883SShaohua Li if (bio_flagged(bio_src, BIO_THROTTLED)) 724111be883SShaohua Li bio_set_flag(bio, BIO_THROTTLED); 72546bbf653SChristoph Hellwig if (bio_flagged(bio_src, BIO_REMAPPED)) 72646bbf653SChristoph Hellwig bio_set_flag(bio, BIO_REMAPPED); 7271eff9d32SJens Axboe bio->bi_opf = bio_src->bi_opf; 728ca474b73SHannes Reinecke bio->bi_ioprio = bio_src->bi_ioprio; 729cb6934f8SJens Axboe bio->bi_write_hint = bio_src->bi_write_hint; 730f9c78b2bSJens Axboe bio->bi_iter = bio_src->bi_iter; 731f9c78b2bSJens Axboe bio->bi_io_vec = bio_src->bi_io_vec; 73220bd723eSPaolo Valente 733db6638d7SDennis Zhou bio_clone_blkg_association(bio, bio_src); 734e439bedfSDennis Zhou blkcg_bio_issue_init(bio); 735f9c78b2bSJens Axboe } 736f9c78b2bSJens Axboe EXPORT_SYMBOL(__bio_clone_fast); 737f9c78b2bSJens Axboe 738f9c78b2bSJens Axboe /** 739f9c78b2bSJens Axboe * bio_clone_fast - clone a bio that shares the original bio's biovec 740f9c78b2bSJens Axboe * @bio: bio to clone 741f9c78b2bSJens Axboe * @gfp_mask: allocation priority 742f9c78b2bSJens Axboe * @bs: bio_set to allocate from 743f9c78b2bSJens Axboe * 744f9c78b2bSJens Axboe * Like __bio_clone_fast, only also allocates the returned bio 745f9c78b2bSJens Axboe */ 746f9c78b2bSJens Axboe struct bio *bio_clone_fast(struct bio *bio, gfp_t gfp_mask, struct bio_set *bs) 747f9c78b2bSJens Axboe { 748f9c78b2bSJens Axboe struct bio *b; 749f9c78b2bSJens Axboe 750f9c78b2bSJens Axboe b = bio_alloc_bioset(gfp_mask, 0, bs); 751f9c78b2bSJens Axboe if (!b) 752f9c78b2bSJens Axboe return NULL; 753f9c78b2bSJens Axboe 754f9c78b2bSJens Axboe __bio_clone_fast(b, bio); 755f9c78b2bSJens Axboe 75607560151SEric Biggers if (bio_crypt_clone(b, bio, gfp_mask) < 0) 75707560151SEric Biggers goto err_put; 758a892c8d5SSatya Tangirala 75907560151SEric Biggers if (bio_integrity(bio) && 76007560151SEric Biggers bio_integrity_clone(b, bio, gfp_mask) < 0) 76107560151SEric Biggers goto err_put; 762f9c78b2bSJens Axboe 763f9c78b2bSJens Axboe return b; 76407560151SEric Biggers 76507560151SEric Biggers err_put: 76607560151SEric Biggers bio_put(b); 76707560151SEric Biggers return NULL; 768f9c78b2bSJens Axboe } 769f9c78b2bSJens Axboe EXPORT_SYMBOL(bio_clone_fast); 770f9c78b2bSJens Axboe 7715cbd28e3SChristoph Hellwig const char *bio_devname(struct bio *bio, char *buf) 7725cbd28e3SChristoph Hellwig { 773309dca30SChristoph Hellwig return bdevname(bio->bi_bdev, buf); 7745cbd28e3SChristoph Hellwig } 7755cbd28e3SChristoph Hellwig EXPORT_SYMBOL(bio_devname); 7765cbd28e3SChristoph Hellwig 7779a6083beSChristoph Hellwig /** 7789a6083beSChristoph Hellwig * bio_full - check if the bio is full 7799a6083beSChristoph Hellwig * @bio: bio to check 7809a6083beSChristoph Hellwig * @len: length of one segment to be added 7819a6083beSChristoph Hellwig * 7829a6083beSChristoph Hellwig * Return true if @bio is full and one segment with @len bytes can't be 7839a6083beSChristoph Hellwig * added to the bio, otherwise return false 7849a6083beSChristoph Hellwig */ 7859a6083beSChristoph Hellwig static inline bool bio_full(struct bio *bio, unsigned len) 7869a6083beSChristoph Hellwig { 7879a6083beSChristoph Hellwig if (bio->bi_vcnt >= bio->bi_max_vecs) 7889a6083beSChristoph Hellwig return true; 7899a6083beSChristoph Hellwig if (bio->bi_iter.bi_size > UINT_MAX - len) 7909a6083beSChristoph Hellwig return true; 7919a6083beSChristoph Hellwig return false; 7929a6083beSChristoph Hellwig } 7939a6083beSChristoph Hellwig 7945919482eSMing Lei static inline bool page_is_mergeable(const struct bio_vec *bv, 7955919482eSMing Lei struct page *page, unsigned int len, unsigned int off, 796ff896738SChristoph Hellwig bool *same_page) 7975919482eSMing Lei { 798d8166519SMatthew Wilcox (Oracle) size_t bv_end = bv->bv_offset + bv->bv_len; 799d8166519SMatthew Wilcox (Oracle) phys_addr_t vec_end_addr = page_to_phys(bv->bv_page) + bv_end - 1; 8005919482eSMing Lei phys_addr_t page_addr = page_to_phys(page); 8015919482eSMing Lei 8025919482eSMing Lei if (vec_end_addr + 1 != page_addr + off) 8035919482eSMing Lei return false; 8045919482eSMing Lei if (xen_domain() && !xen_biovec_phys_mergeable(bv, page)) 8055919482eSMing Lei return false; 80652d52d1cSChristoph Hellwig 807ff896738SChristoph Hellwig *same_page = ((vec_end_addr & PAGE_MASK) == page_addr); 808d8166519SMatthew Wilcox (Oracle) if (*same_page) 8095919482eSMing Lei return true; 810d8166519SMatthew Wilcox (Oracle) return (bv->bv_page + bv_end / PAGE_SIZE) == (page + off / PAGE_SIZE); 8115919482eSMing Lei } 8125919482eSMing Lei 8139774b391SChristoph Hellwig /** 8149774b391SChristoph Hellwig * __bio_try_merge_page - try appending data to an existing bvec. 8159774b391SChristoph Hellwig * @bio: destination bio 8169774b391SChristoph Hellwig * @page: start page to add 8179774b391SChristoph Hellwig * @len: length of the data to add 8189774b391SChristoph Hellwig * @off: offset of the data relative to @page 8199774b391SChristoph Hellwig * @same_page: return if the segment has been merged inside the same page 8209774b391SChristoph Hellwig * 8219774b391SChristoph Hellwig * Try to add the data at @page + @off to the last bvec of @bio. This is a 8229774b391SChristoph Hellwig * useful optimisation for file systems with a block size smaller than the 8239774b391SChristoph Hellwig * page size. 8249774b391SChristoph Hellwig * 8259774b391SChristoph Hellwig * Warn if (@len, @off) crosses pages in case that @same_page is true. 8269774b391SChristoph Hellwig * 8279774b391SChristoph Hellwig * Return %true on success or %false on failure. 8289774b391SChristoph Hellwig */ 8299774b391SChristoph Hellwig static bool __bio_try_merge_page(struct bio *bio, struct page *page, 8309774b391SChristoph Hellwig unsigned int len, unsigned int off, bool *same_page) 8319774b391SChristoph Hellwig { 8329774b391SChristoph Hellwig if (WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED))) 8339774b391SChristoph Hellwig return false; 8349774b391SChristoph Hellwig 8359774b391SChristoph Hellwig if (bio->bi_vcnt > 0) { 8369774b391SChristoph Hellwig struct bio_vec *bv = &bio->bi_io_vec[bio->bi_vcnt - 1]; 8379774b391SChristoph Hellwig 8389774b391SChristoph Hellwig if (page_is_mergeable(bv, page, len, off, same_page)) { 8399774b391SChristoph Hellwig if (bio->bi_iter.bi_size > UINT_MAX - len) { 8409774b391SChristoph Hellwig *same_page = false; 8419774b391SChristoph Hellwig return false; 8429774b391SChristoph Hellwig } 8439774b391SChristoph Hellwig bv->bv_len += len; 8449774b391SChristoph Hellwig bio->bi_iter.bi_size += len; 8459774b391SChristoph Hellwig return true; 8469774b391SChristoph Hellwig } 8479774b391SChristoph Hellwig } 8489774b391SChristoph Hellwig return false; 8499774b391SChristoph Hellwig } 8509774b391SChristoph Hellwig 851e4581105SChristoph Hellwig /* 852e4581105SChristoph Hellwig * Try to merge a page into a segment, while obeying the hardware segment 853e4581105SChristoph Hellwig * size limit. This is not for normal read/write bios, but for passthrough 854e4581105SChristoph Hellwig * or Zone Append operations that we can't split. 855e4581105SChristoph Hellwig */ 856e4581105SChristoph Hellwig static bool bio_try_merge_hw_seg(struct request_queue *q, struct bio *bio, 857e4581105SChristoph Hellwig struct page *page, unsigned len, 858e4581105SChristoph Hellwig unsigned offset, bool *same_page) 859489fbbcbSMing Lei { 860384209cdSChristoph Hellwig struct bio_vec *bv = &bio->bi_io_vec[bio->bi_vcnt - 1]; 861489fbbcbSMing Lei unsigned long mask = queue_segment_boundary(q); 862489fbbcbSMing Lei phys_addr_t addr1 = page_to_phys(bv->bv_page) + bv->bv_offset; 863489fbbcbSMing Lei phys_addr_t addr2 = page_to_phys(page) + offset + len - 1; 864489fbbcbSMing Lei 865489fbbcbSMing Lei if ((addr1 | mask) != (addr2 | mask)) 866489fbbcbSMing Lei return false; 867489fbbcbSMing Lei if (bv->bv_len + len > queue_max_segment_size(q)) 868489fbbcbSMing Lei return false; 869384209cdSChristoph Hellwig return __bio_try_merge_page(bio, page, len, offset, same_page); 870489fbbcbSMing Lei } 871489fbbcbSMing Lei 872f4595875SShaohua Li /** 873e4581105SChristoph Hellwig * bio_add_hw_page - attempt to add a page to a bio with hw constraints 874c66a14d0SKent Overstreet * @q: the target queue 875c66a14d0SKent Overstreet * @bio: destination bio 876c66a14d0SKent Overstreet * @page: page to add 877c66a14d0SKent Overstreet * @len: vec entry length 878c66a14d0SKent Overstreet * @offset: vec entry offset 879e4581105SChristoph Hellwig * @max_sectors: maximum number of sectors that can be added 880e4581105SChristoph Hellwig * @same_page: return if the segment has been merged inside the same page 881f9c78b2bSJens Axboe * 882e4581105SChristoph Hellwig * Add a page to a bio while respecting the hardware max_sectors, max_segment 883e4581105SChristoph Hellwig * and gap limitations. 884f9c78b2bSJens Axboe */ 885e4581105SChristoph Hellwig int bio_add_hw_page(struct request_queue *q, struct bio *bio, 88619047087SMing Lei struct page *page, unsigned int len, unsigned int offset, 887e4581105SChristoph Hellwig unsigned int max_sectors, bool *same_page) 888f9c78b2bSJens Axboe { 889f9c78b2bSJens Axboe struct bio_vec *bvec; 890f9c78b2bSJens Axboe 891e4581105SChristoph Hellwig if (WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED))) 892f9c78b2bSJens Axboe return 0; 893f9c78b2bSJens Axboe 894e4581105SChristoph Hellwig if (((bio->bi_iter.bi_size + len) >> 9) > max_sectors) 895f9c78b2bSJens Axboe return 0; 896f9c78b2bSJens Axboe 897f9c78b2bSJens Axboe if (bio->bi_vcnt > 0) { 898e4581105SChristoph Hellwig if (bio_try_merge_hw_seg(q, bio, page, len, offset, same_page)) 899384209cdSChristoph Hellwig return len; 900320ea869SChristoph Hellwig 901320ea869SChristoph Hellwig /* 902320ea869SChristoph Hellwig * If the queue doesn't support SG gaps and adding this segment 903320ea869SChristoph Hellwig * would create a gap, disallow it. 904320ea869SChristoph Hellwig */ 905384209cdSChristoph Hellwig bvec = &bio->bi_io_vec[bio->bi_vcnt - 1]; 906320ea869SChristoph Hellwig if (bvec_gap_to_prev(q, bvec, offset)) 907320ea869SChristoph Hellwig return 0; 908f9c78b2bSJens Axboe } 909f9c78b2bSJens Axboe 91079d08f89SMing Lei if (bio_full(bio, len)) 911f9c78b2bSJens Axboe return 0; 912f9c78b2bSJens Axboe 91314ccb66bSChristoph Hellwig if (bio->bi_vcnt >= queue_max_segments(q)) 914489fbbcbSMing Lei return 0; 915489fbbcbSMing Lei 916f9c78b2bSJens Axboe bvec = &bio->bi_io_vec[bio->bi_vcnt]; 917f9c78b2bSJens Axboe bvec->bv_page = page; 918f9c78b2bSJens Axboe bvec->bv_len = len; 919f9c78b2bSJens Axboe bvec->bv_offset = offset; 920fcbf6a08SMaurizio Lombardi bio->bi_vcnt++; 921dcdca753SChristoph Hellwig bio->bi_iter.bi_size += len; 922f9c78b2bSJens Axboe return len; 923f9c78b2bSJens Axboe } 92419047087SMing Lei 925e4581105SChristoph Hellwig /** 926e4581105SChristoph Hellwig * bio_add_pc_page - attempt to add page to passthrough bio 927e4581105SChristoph Hellwig * @q: the target queue 928e4581105SChristoph Hellwig * @bio: destination bio 929e4581105SChristoph Hellwig * @page: page to add 930e4581105SChristoph Hellwig * @len: vec entry length 931e4581105SChristoph Hellwig * @offset: vec entry offset 932e4581105SChristoph Hellwig * 933e4581105SChristoph Hellwig * Attempt to add a page to the bio_vec maplist. This can fail for a 934e4581105SChristoph Hellwig * number of reasons, such as the bio being full or target block device 935e4581105SChristoph Hellwig * limitations. The target block device must allow bio's up to PAGE_SIZE, 936e4581105SChristoph Hellwig * so it is always possible to add a single page to an empty bio. 937e4581105SChristoph Hellwig * 938e4581105SChristoph Hellwig * This should only be used by passthrough bios. 939e4581105SChristoph Hellwig */ 94019047087SMing Lei int bio_add_pc_page(struct request_queue *q, struct bio *bio, 94119047087SMing Lei struct page *page, unsigned int len, unsigned int offset) 94219047087SMing Lei { 943d1916c86SChristoph Hellwig bool same_page = false; 944e4581105SChristoph Hellwig return bio_add_hw_page(q, bio, page, len, offset, 945e4581105SChristoph Hellwig queue_max_hw_sectors(q), &same_page); 94619047087SMing Lei } 947f9c78b2bSJens Axboe EXPORT_SYMBOL(bio_add_pc_page); 948f9c78b2bSJens Axboe 949f9c78b2bSJens Axboe /** 950ae29333fSJohannes Thumshirn * bio_add_zone_append_page - attempt to add page to zone-append bio 951ae29333fSJohannes Thumshirn * @bio: destination bio 952ae29333fSJohannes Thumshirn * @page: page to add 953ae29333fSJohannes Thumshirn * @len: vec entry length 954ae29333fSJohannes Thumshirn * @offset: vec entry offset 955ae29333fSJohannes Thumshirn * 956ae29333fSJohannes Thumshirn * Attempt to add a page to the bio_vec maplist of a bio that will be submitted 957ae29333fSJohannes Thumshirn * for a zone-append request. This can fail for a number of reasons, such as the 958ae29333fSJohannes Thumshirn * bio being full or the target block device is not a zoned block device or 959ae29333fSJohannes Thumshirn * other limitations of the target block device. The target block device must 960ae29333fSJohannes Thumshirn * allow bio's up to PAGE_SIZE, so it is always possible to add a single page 961ae29333fSJohannes Thumshirn * to an empty bio. 962ae29333fSJohannes Thumshirn * 963ae29333fSJohannes Thumshirn * Returns: number of bytes added to the bio, or 0 in case of a failure. 964ae29333fSJohannes Thumshirn */ 965ae29333fSJohannes Thumshirn int bio_add_zone_append_page(struct bio *bio, struct page *page, 966ae29333fSJohannes Thumshirn unsigned int len, unsigned int offset) 967ae29333fSJohannes Thumshirn { 9683caee463SPavel Begunkov struct request_queue *q = bdev_get_queue(bio->bi_bdev); 969ae29333fSJohannes Thumshirn bool same_page = false; 970ae29333fSJohannes Thumshirn 971ae29333fSJohannes Thumshirn if (WARN_ON_ONCE(bio_op(bio) != REQ_OP_ZONE_APPEND)) 972ae29333fSJohannes Thumshirn return 0; 973ae29333fSJohannes Thumshirn 974ae29333fSJohannes Thumshirn if (WARN_ON_ONCE(!blk_queue_is_zoned(q))) 975ae29333fSJohannes Thumshirn return 0; 976ae29333fSJohannes Thumshirn 977ae29333fSJohannes Thumshirn return bio_add_hw_page(q, bio, page, len, offset, 978ae29333fSJohannes Thumshirn queue_max_zone_append_sectors(q), &same_page); 979ae29333fSJohannes Thumshirn } 980ae29333fSJohannes Thumshirn EXPORT_SYMBOL_GPL(bio_add_zone_append_page); 981ae29333fSJohannes Thumshirn 982ae29333fSJohannes Thumshirn /** 983551879a4SMing Lei * __bio_add_page - add page(s) to a bio in a new segment 9840aa69fd3SChristoph Hellwig * @bio: destination bio 985551879a4SMing Lei * @page: start page to add 986551879a4SMing Lei * @len: length of the data to add, may cross pages 987551879a4SMing Lei * @off: offset of the data relative to @page, may cross pages 9880aa69fd3SChristoph Hellwig * 9890aa69fd3SChristoph Hellwig * Add the data at @page + @off to @bio as a new bvec. The caller must ensure 9900aa69fd3SChristoph Hellwig * that @bio has space for another bvec. 9910aa69fd3SChristoph Hellwig */ 9920aa69fd3SChristoph Hellwig void __bio_add_page(struct bio *bio, struct page *page, 9930aa69fd3SChristoph Hellwig unsigned int len, unsigned int off) 9940aa69fd3SChristoph Hellwig { 9950aa69fd3SChristoph Hellwig struct bio_vec *bv = &bio->bi_io_vec[bio->bi_vcnt]; 9960aa69fd3SChristoph Hellwig 9970aa69fd3SChristoph Hellwig WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED)); 99879d08f89SMing Lei WARN_ON_ONCE(bio_full(bio, len)); 9990aa69fd3SChristoph Hellwig 10000aa69fd3SChristoph Hellwig bv->bv_page = page; 10010aa69fd3SChristoph Hellwig bv->bv_offset = off; 10020aa69fd3SChristoph Hellwig bv->bv_len = len; 10030aa69fd3SChristoph Hellwig 10040aa69fd3SChristoph Hellwig bio->bi_iter.bi_size += len; 10050aa69fd3SChristoph Hellwig bio->bi_vcnt++; 1006b8e24a93SJohannes Weiner 1007b8e24a93SJohannes Weiner if (!bio_flagged(bio, BIO_WORKINGSET) && unlikely(PageWorkingset(page))) 1008b8e24a93SJohannes Weiner bio_set_flag(bio, BIO_WORKINGSET); 10090aa69fd3SChristoph Hellwig } 10100aa69fd3SChristoph Hellwig EXPORT_SYMBOL_GPL(__bio_add_page); 10110aa69fd3SChristoph Hellwig 10120aa69fd3SChristoph Hellwig /** 1013551879a4SMing Lei * bio_add_page - attempt to add page(s) to bio 1014f9c78b2bSJens Axboe * @bio: destination bio 1015551879a4SMing Lei * @page: start page to add 1016551879a4SMing Lei * @len: vec entry length, may cross pages 1017551879a4SMing Lei * @offset: vec entry offset relative to @page, may cross pages 1018f9c78b2bSJens Axboe * 1019551879a4SMing Lei * Attempt to add page(s) to the bio_vec maplist. This will only fail 1020c66a14d0SKent Overstreet * if either bio->bi_vcnt == bio->bi_max_vecs or it's a cloned bio. 1021f9c78b2bSJens Axboe */ 1022c66a14d0SKent Overstreet int bio_add_page(struct bio *bio, struct page *page, 1023c66a14d0SKent Overstreet unsigned int len, unsigned int offset) 1024f9c78b2bSJens Axboe { 1025ff896738SChristoph Hellwig bool same_page = false; 1026ff896738SChristoph Hellwig 1027ff896738SChristoph Hellwig if (!__bio_try_merge_page(bio, page, len, offset, &same_page)) { 102879d08f89SMing Lei if (bio_full(bio, len)) 1029c66a14d0SKent Overstreet return 0; 10300aa69fd3SChristoph Hellwig __bio_add_page(bio, page, len, offset); 1031c66a14d0SKent Overstreet } 1032c66a14d0SKent Overstreet return len; 1033f9c78b2bSJens Axboe } 1034f9c78b2bSJens Axboe EXPORT_SYMBOL(bio_add_page); 1035f9c78b2bSJens Axboe 1036*85f5a74cSMatthew Wilcox (Oracle) /** 1037*85f5a74cSMatthew Wilcox (Oracle) * bio_add_folio - Attempt to add part of a folio to a bio. 1038*85f5a74cSMatthew Wilcox (Oracle) * @bio: BIO to add to. 1039*85f5a74cSMatthew Wilcox (Oracle) * @folio: Folio to add. 1040*85f5a74cSMatthew Wilcox (Oracle) * @len: How many bytes from the folio to add. 1041*85f5a74cSMatthew Wilcox (Oracle) * @off: First byte in this folio to add. 1042*85f5a74cSMatthew Wilcox (Oracle) * 1043*85f5a74cSMatthew Wilcox (Oracle) * Filesystems that use folios can call this function instead of calling 1044*85f5a74cSMatthew Wilcox (Oracle) * bio_add_page() for each page in the folio. If @off is bigger than 1045*85f5a74cSMatthew Wilcox (Oracle) * PAGE_SIZE, this function can create a bio_vec that starts in a page 1046*85f5a74cSMatthew Wilcox (Oracle) * after the bv_page. BIOs do not support folios that are 4GiB or larger. 1047*85f5a74cSMatthew Wilcox (Oracle) * 1048*85f5a74cSMatthew Wilcox (Oracle) * Return: Whether the addition was successful. 1049*85f5a74cSMatthew Wilcox (Oracle) */ 1050*85f5a74cSMatthew Wilcox (Oracle) bool bio_add_folio(struct bio *bio, struct folio *folio, size_t len, 1051*85f5a74cSMatthew Wilcox (Oracle) size_t off) 1052*85f5a74cSMatthew Wilcox (Oracle) { 1053*85f5a74cSMatthew Wilcox (Oracle) if (len > UINT_MAX || off > UINT_MAX) 1054*85f5a74cSMatthew Wilcox (Oracle) return 0; 1055*85f5a74cSMatthew Wilcox (Oracle) return bio_add_page(bio, &folio->page, len, off) > 0; 1056*85f5a74cSMatthew Wilcox (Oracle) } 1057*85f5a74cSMatthew Wilcox (Oracle) 1058c809084aSPavel Begunkov void __bio_release_pages(struct bio *bio, bool mark_dirty) 10597321ecbfSChristoph Hellwig { 10607321ecbfSChristoph Hellwig struct bvec_iter_all iter_all; 10617321ecbfSChristoph Hellwig struct bio_vec *bvec; 10627321ecbfSChristoph Hellwig 1063d241a95fSChristoph Hellwig bio_for_each_segment_all(bvec, bio, iter_all) { 1064d241a95fSChristoph Hellwig if (mark_dirty && !PageCompound(bvec->bv_page)) 1065d241a95fSChristoph Hellwig set_page_dirty_lock(bvec->bv_page); 10667321ecbfSChristoph Hellwig put_page(bvec->bv_page); 10677321ecbfSChristoph Hellwig } 1068d241a95fSChristoph Hellwig } 1069c809084aSPavel Begunkov EXPORT_SYMBOL_GPL(__bio_release_pages); 10707321ecbfSChristoph Hellwig 10711bb6b810SPavel Begunkov void bio_iov_bvec_set(struct bio *bio, struct iov_iter *iter) 10726d0c48aeSJens Axboe { 1073fa5fa8ecSPavel Begunkov size_t size = iov_iter_count(iter); 1074fa5fa8ecSPavel Begunkov 10757a800a20SChristoph Hellwig WARN_ON_ONCE(bio->bi_max_vecs); 10766d0c48aeSJens Axboe 1077fa5fa8ecSPavel Begunkov if (bio_op(bio) == REQ_OP_ZONE_APPEND) { 1078fa5fa8ecSPavel Begunkov struct request_queue *q = bdev_get_queue(bio->bi_bdev); 1079fa5fa8ecSPavel Begunkov size_t max_sectors = queue_max_zone_append_sectors(q); 1080fa5fa8ecSPavel Begunkov 1081fa5fa8ecSPavel Begunkov size = min(size, max_sectors << SECTOR_SHIFT); 1082fa5fa8ecSPavel Begunkov } 1083fa5fa8ecSPavel Begunkov 1084c42bca92SPavel Begunkov bio->bi_vcnt = iter->nr_segs; 1085c42bca92SPavel Begunkov bio->bi_io_vec = (struct bio_vec *)iter->bvec; 1086c42bca92SPavel Begunkov bio->bi_iter.bi_bvec_done = iter->iov_offset; 1087fa5fa8ecSPavel Begunkov bio->bi_iter.bi_size = size; 1088ed97ce5eSChristoph Hellwig bio_set_flag(bio, BIO_NO_PAGE_REF); 1089977be012SChristoph Hellwig bio_set_flag(bio, BIO_CLONED); 10907de55b7dSJohannes Thumshirn } 10916d0c48aeSJens Axboe 1092d9cf3bd5SPavel Begunkov static void bio_put_pages(struct page **pages, size_t size, size_t off) 1093d9cf3bd5SPavel Begunkov { 1094d9cf3bd5SPavel Begunkov size_t i, nr = DIV_ROUND_UP(size + (off & ~PAGE_MASK), PAGE_SIZE); 1095d9cf3bd5SPavel Begunkov 1096d9cf3bd5SPavel Begunkov for (i = 0; i < nr; i++) 1097d9cf3bd5SPavel Begunkov put_page(pages[i]); 1098d9cf3bd5SPavel Begunkov } 1099d9cf3bd5SPavel Begunkov 1100576ed913SChristoph Hellwig #define PAGE_PTRS_PER_BVEC (sizeof(struct bio_vec) / sizeof(struct page *)) 1101576ed913SChristoph Hellwig 11022cefe4dbSKent Overstreet /** 110317d51b10SMartin Wilck * __bio_iov_iter_get_pages - pin user or kernel pages and add them to a bio 11042cefe4dbSKent Overstreet * @bio: bio to add pages to 11052cefe4dbSKent Overstreet * @iter: iov iterator describing the region to be mapped 11062cefe4dbSKent Overstreet * 110717d51b10SMartin Wilck * Pins pages from *iter and appends them to @bio's bvec array. The 11082cefe4dbSKent Overstreet * pages will have to be released using put_page() when done. 110917d51b10SMartin Wilck * For multi-segment *iter, this function only adds pages from the 11103cf14889SRandy Dunlap * next non-empty segment of the iov iterator. 11112cefe4dbSKent Overstreet */ 111217d51b10SMartin Wilck static int __bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter) 11132cefe4dbSKent Overstreet { 1114576ed913SChristoph Hellwig unsigned short nr_pages = bio->bi_max_vecs - bio->bi_vcnt; 1115576ed913SChristoph Hellwig unsigned short entries_left = bio->bi_max_vecs - bio->bi_vcnt; 11162cefe4dbSKent Overstreet struct bio_vec *bv = bio->bi_io_vec + bio->bi_vcnt; 11172cefe4dbSKent Overstreet struct page **pages = (struct page **)bv; 111845691804SChristoph Hellwig bool same_page = false; 1119576ed913SChristoph Hellwig ssize_t size, left; 1120576ed913SChristoph Hellwig unsigned len, i; 1121b403ea24SMartin Wilck size_t offset; 1122576ed913SChristoph Hellwig 1123576ed913SChristoph Hellwig /* 1124576ed913SChristoph Hellwig * Move page array up in the allocated memory for the bio vecs as far as 1125576ed913SChristoph Hellwig * possible so that we can start filling biovecs from the beginning 1126576ed913SChristoph Hellwig * without overwriting the temporary page array. 1127576ed913SChristoph Hellwig */ 1128576ed913SChristoph Hellwig BUILD_BUG_ON(PAGE_PTRS_PER_BVEC < 2); 1129576ed913SChristoph Hellwig pages += entries_left * (PAGE_PTRS_PER_BVEC - 1); 11302cefe4dbSKent Overstreet 113135c820e7SJens Axboe size = iov_iter_get_pages(iter, pages, LONG_MAX, nr_pages, &offset); 11322cefe4dbSKent Overstreet if (unlikely(size <= 0)) 11332cefe4dbSKent Overstreet return size ? size : -EFAULT; 11342cefe4dbSKent Overstreet 1135576ed913SChristoph Hellwig for (left = size, i = 0; left > 0; left -= len, i++) { 1136576ed913SChristoph Hellwig struct page *page = pages[i]; 11372cefe4dbSKent Overstreet 1138576ed913SChristoph Hellwig len = min_t(size_t, PAGE_SIZE - offset, left); 113945691804SChristoph Hellwig 114045691804SChristoph Hellwig if (__bio_try_merge_page(bio, page, len, offset, &same_page)) { 114145691804SChristoph Hellwig if (same_page) 114245691804SChristoph Hellwig put_page(page); 114345691804SChristoph Hellwig } else { 1144d9cf3bd5SPavel Begunkov if (WARN_ON_ONCE(bio_full(bio, len))) { 1145d9cf3bd5SPavel Begunkov bio_put_pages(pages + i, left, offset); 1146576ed913SChristoph Hellwig return -EINVAL; 1147d9cf3bd5SPavel Begunkov } 114845691804SChristoph Hellwig __bio_add_page(bio, page, len, offset); 114945691804SChristoph Hellwig } 1150576ed913SChristoph Hellwig offset = 0; 11512cefe4dbSKent Overstreet } 11522cefe4dbSKent Overstreet 11532cefe4dbSKent Overstreet iov_iter_advance(iter, size); 11542cefe4dbSKent Overstreet return 0; 11552cefe4dbSKent Overstreet } 115617d51b10SMartin Wilck 11570512a75bSKeith Busch static int __bio_iov_append_get_pages(struct bio *bio, struct iov_iter *iter) 11580512a75bSKeith Busch { 11590512a75bSKeith Busch unsigned short nr_pages = bio->bi_max_vecs - bio->bi_vcnt; 11600512a75bSKeith Busch unsigned short entries_left = bio->bi_max_vecs - bio->bi_vcnt; 11613caee463SPavel Begunkov struct request_queue *q = bdev_get_queue(bio->bi_bdev); 11620512a75bSKeith Busch unsigned int max_append_sectors = queue_max_zone_append_sectors(q); 11630512a75bSKeith Busch struct bio_vec *bv = bio->bi_io_vec + bio->bi_vcnt; 11640512a75bSKeith Busch struct page **pages = (struct page **)bv; 11650512a75bSKeith Busch ssize_t size, left; 11660512a75bSKeith Busch unsigned len, i; 11670512a75bSKeith Busch size_t offset; 11684977d121SNaohiro Aota int ret = 0; 11690512a75bSKeith Busch 11700512a75bSKeith Busch if (WARN_ON_ONCE(!max_append_sectors)) 11710512a75bSKeith Busch return 0; 11720512a75bSKeith Busch 11730512a75bSKeith Busch /* 11740512a75bSKeith Busch * Move page array up in the allocated memory for the bio vecs as far as 11750512a75bSKeith Busch * possible so that we can start filling biovecs from the beginning 11760512a75bSKeith Busch * without overwriting the temporary page array. 11770512a75bSKeith Busch */ 11780512a75bSKeith Busch BUILD_BUG_ON(PAGE_PTRS_PER_BVEC < 2); 11790512a75bSKeith Busch pages += entries_left * (PAGE_PTRS_PER_BVEC - 1); 11800512a75bSKeith Busch 11810512a75bSKeith Busch size = iov_iter_get_pages(iter, pages, LONG_MAX, nr_pages, &offset); 11820512a75bSKeith Busch if (unlikely(size <= 0)) 11830512a75bSKeith Busch return size ? size : -EFAULT; 11840512a75bSKeith Busch 11850512a75bSKeith Busch for (left = size, i = 0; left > 0; left -= len, i++) { 11860512a75bSKeith Busch struct page *page = pages[i]; 11870512a75bSKeith Busch bool same_page = false; 11880512a75bSKeith Busch 11890512a75bSKeith Busch len = min_t(size_t, PAGE_SIZE - offset, left); 11900512a75bSKeith Busch if (bio_add_hw_page(q, bio, page, len, offset, 11914977d121SNaohiro Aota max_append_sectors, &same_page) != len) { 1192d9cf3bd5SPavel Begunkov bio_put_pages(pages + i, left, offset); 11934977d121SNaohiro Aota ret = -EINVAL; 11944977d121SNaohiro Aota break; 11954977d121SNaohiro Aota } 11960512a75bSKeith Busch if (same_page) 11970512a75bSKeith Busch put_page(page); 11980512a75bSKeith Busch offset = 0; 11990512a75bSKeith Busch } 12000512a75bSKeith Busch 12014977d121SNaohiro Aota iov_iter_advance(iter, size - left); 12024977d121SNaohiro Aota return ret; 12030512a75bSKeith Busch } 12040512a75bSKeith Busch 120517d51b10SMartin Wilck /** 12066d0c48aeSJens Axboe * bio_iov_iter_get_pages - add user or kernel pages to a bio 120717d51b10SMartin Wilck * @bio: bio to add pages to 12086d0c48aeSJens Axboe * @iter: iov iterator describing the region to be added 120917d51b10SMartin Wilck * 12106d0c48aeSJens Axboe * This takes either an iterator pointing to user memory, or one pointing to 12116d0c48aeSJens Axboe * kernel pages (BVEC iterator). If we're adding user pages, we pin them and 12126d0c48aeSJens Axboe * map them into the kernel. On IO completion, the caller should put those 1213c42bca92SPavel Begunkov * pages. For bvec based iterators bio_iov_iter_get_pages() uses the provided 1214c42bca92SPavel Begunkov * bvecs rather than copying them. Hence anyone issuing kiocb based IO needs 1215c42bca92SPavel Begunkov * to ensure the bvecs and pages stay referenced until the submitted I/O is 1216c42bca92SPavel Begunkov * completed by a call to ->ki_complete() or returns with an error other than 1217c42bca92SPavel Begunkov * -EIOCBQUEUED. The caller needs to check if the bio is flagged BIO_NO_PAGE_REF 1218c42bca92SPavel Begunkov * on IO completion. If it isn't, then pages should be released. 12196d0c48aeSJens Axboe * 122017d51b10SMartin Wilck * The function tries, but does not guarantee, to pin as many pages as 12215cd3ddc1SMauro Carvalho Chehab * fit into the bio, or are requested in @iter, whatever is smaller. If 12226d0c48aeSJens Axboe * MM encounters an error pinning the requested pages, it stops. Error 12236d0c48aeSJens Axboe * is returned only if 0 pages could be pinned. 12240cf41e5eSPavel Begunkov * 12250cf41e5eSPavel Begunkov * It's intended for direct IO, so doesn't do PSI tracking, the caller is 12260cf41e5eSPavel Begunkov * responsible for setting BIO_WORKINGSET if necessary. 122717d51b10SMartin Wilck */ 122817d51b10SMartin Wilck int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter) 122917d51b10SMartin Wilck { 1230c42bca92SPavel Begunkov int ret = 0; 123114eacf12SChristoph Hellwig 1232c42bca92SPavel Begunkov if (iov_iter_is_bvec(iter)) { 1233fa5fa8ecSPavel Begunkov bio_iov_bvec_set(bio, iter); 1234fa5fa8ecSPavel Begunkov iov_iter_advance(iter, bio->bi_iter.bi_size); 1235fa5fa8ecSPavel Begunkov return 0; 123686004515SChristoph Hellwig } 123717d51b10SMartin Wilck 123817d51b10SMartin Wilck do { 1239c42bca92SPavel Begunkov if (bio_op(bio) == REQ_OP_ZONE_APPEND) 12400512a75bSKeith Busch ret = __bio_iov_append_get_pages(bio, iter); 12416d0c48aeSJens Axboe else 12426d0c48aeSJens Axboe ret = __bio_iov_iter_get_pages(bio, iter); 124379d08f89SMing Lei } while (!ret && iov_iter_count(iter) && !bio_full(bio, 0)); 124417d51b10SMartin Wilck 12450cf41e5eSPavel Begunkov /* don't account direct I/O as memory stall */ 12460cf41e5eSPavel Begunkov bio_clear_flag(bio, BIO_WORKINGSET); 124714eacf12SChristoph Hellwig return bio->bi_vcnt ? 0 : ret; 124817d51b10SMartin Wilck } 124929b2a3aaSJohannes Thumshirn EXPORT_SYMBOL_GPL(bio_iov_iter_get_pages); 12502cefe4dbSKent Overstreet 12514246a0b6SChristoph Hellwig static void submit_bio_wait_endio(struct bio *bio) 1252f9c78b2bSJens Axboe { 125365e53aabSChristoph Hellwig complete(bio->bi_private); 1254f9c78b2bSJens Axboe } 1255f9c78b2bSJens Axboe 1256f9c78b2bSJens Axboe /** 1257f9c78b2bSJens Axboe * submit_bio_wait - submit a bio, and wait until it completes 1258f9c78b2bSJens Axboe * @bio: The &struct bio which describes the I/O 1259f9c78b2bSJens Axboe * 1260f9c78b2bSJens Axboe * Simple wrapper around submit_bio(). Returns 0 on success, or the error from 1261f9c78b2bSJens Axboe * bio_endio() on failure. 12623d289d68SJan Kara * 12633d289d68SJan Kara * WARNING: Unlike to how submit_bio() is usually used, this function does not 12643d289d68SJan Kara * result in bio reference to be consumed. The caller must drop the reference 12653d289d68SJan Kara * on his own. 1266f9c78b2bSJens Axboe */ 12674e49ea4aSMike Christie int submit_bio_wait(struct bio *bio) 1268f9c78b2bSJens Axboe { 1269309dca30SChristoph Hellwig DECLARE_COMPLETION_ONSTACK_MAP(done, 1270309dca30SChristoph Hellwig bio->bi_bdev->bd_disk->lockdep_map); 1271de6a78b6SMing Lei unsigned long hang_check; 1272f9c78b2bSJens Axboe 127365e53aabSChristoph Hellwig bio->bi_private = &done; 1274f9c78b2bSJens Axboe bio->bi_end_io = submit_bio_wait_endio; 12751eff9d32SJens Axboe bio->bi_opf |= REQ_SYNC; 12764e49ea4aSMike Christie submit_bio(bio); 1277de6a78b6SMing Lei 1278de6a78b6SMing Lei /* Prevent hang_check timer from firing at us during very long I/O */ 1279de6a78b6SMing Lei hang_check = sysctl_hung_task_timeout_secs; 1280de6a78b6SMing Lei if (hang_check) 1281de6a78b6SMing Lei while (!wait_for_completion_io_timeout(&done, 1282de6a78b6SMing Lei hang_check * (HZ/2))) 1283de6a78b6SMing Lei ; 1284de6a78b6SMing Lei else 128565e53aabSChristoph Hellwig wait_for_completion_io(&done); 1286f9c78b2bSJens Axboe 128765e53aabSChristoph Hellwig return blk_status_to_errno(bio->bi_status); 1288f9c78b2bSJens Axboe } 1289f9c78b2bSJens Axboe EXPORT_SYMBOL(submit_bio_wait); 1290f9c78b2bSJens Axboe 1291d4aa57a1SJens Axboe void __bio_advance(struct bio *bio, unsigned bytes) 1292f9c78b2bSJens Axboe { 1293f9c78b2bSJens Axboe if (bio_integrity(bio)) 1294f9c78b2bSJens Axboe bio_integrity_advance(bio, bytes); 1295f9c78b2bSJens Axboe 1296a892c8d5SSatya Tangirala bio_crypt_advance(bio, bytes); 1297f9c78b2bSJens Axboe bio_advance_iter(bio, &bio->bi_iter, bytes); 1298f9c78b2bSJens Axboe } 1299d4aa57a1SJens Axboe EXPORT_SYMBOL(__bio_advance); 1300f9c78b2bSJens Axboe 130145db54d5SKent Overstreet void bio_copy_data_iter(struct bio *dst, struct bvec_iter *dst_iter, 130245db54d5SKent Overstreet struct bio *src, struct bvec_iter *src_iter) 1303f9c78b2bSJens Axboe { 130445db54d5SKent Overstreet while (src_iter->bi_size && dst_iter->bi_size) { 1305f8b679a0SChristoph Hellwig struct bio_vec src_bv = bio_iter_iovec(src, *src_iter); 1306f8b679a0SChristoph Hellwig struct bio_vec dst_bv = bio_iter_iovec(dst, *dst_iter); 1307f8b679a0SChristoph Hellwig unsigned int bytes = min(src_bv.bv_len, dst_bv.bv_len); 1308f8b679a0SChristoph Hellwig void *src_buf; 130945db54d5SKent Overstreet 1310f8b679a0SChristoph Hellwig src_buf = bvec_kmap_local(&src_bv); 1311f8b679a0SChristoph Hellwig memcpy_to_bvec(&dst_bv, src_buf); 1312f8b679a0SChristoph Hellwig kunmap_local(src_buf); 13136e6e811dSKent Overstreet 131422b56c29SPavel Begunkov bio_advance_iter_single(src, src_iter, bytes); 131522b56c29SPavel Begunkov bio_advance_iter_single(dst, dst_iter, bytes); 131645db54d5SKent Overstreet } 131745db54d5SKent Overstreet } 131845db54d5SKent Overstreet EXPORT_SYMBOL(bio_copy_data_iter); 131945db54d5SKent Overstreet 132045db54d5SKent Overstreet /** 132145db54d5SKent Overstreet * bio_copy_data - copy contents of data buffers from one bio to another 132245db54d5SKent Overstreet * @src: source bio 132345db54d5SKent Overstreet * @dst: destination bio 132445db54d5SKent Overstreet * 132545db54d5SKent Overstreet * Stops when it reaches the end of either @src or @dst - that is, copies 132645db54d5SKent Overstreet * min(src->bi_size, dst->bi_size) bytes (or the equivalent for lists of bios). 132745db54d5SKent Overstreet */ 132845db54d5SKent Overstreet void bio_copy_data(struct bio *dst, struct bio *src) 132945db54d5SKent Overstreet { 133045db54d5SKent Overstreet struct bvec_iter src_iter = src->bi_iter; 133145db54d5SKent Overstreet struct bvec_iter dst_iter = dst->bi_iter; 133245db54d5SKent Overstreet 133345db54d5SKent Overstreet bio_copy_data_iter(dst, &dst_iter, src, &src_iter); 133445db54d5SKent Overstreet } 133545db54d5SKent Overstreet EXPORT_SYMBOL(bio_copy_data); 133645db54d5SKent Overstreet 1337491221f8SGuoqing Jiang void bio_free_pages(struct bio *bio) 13381dfa0f68SChristoph Hellwig { 13391dfa0f68SChristoph Hellwig struct bio_vec *bvec; 13406dc4f100SMing Lei struct bvec_iter_all iter_all; 13411dfa0f68SChristoph Hellwig 13422b070cfeSChristoph Hellwig bio_for_each_segment_all(bvec, bio, iter_all) 13431dfa0f68SChristoph Hellwig __free_page(bvec->bv_page); 13441dfa0f68SChristoph Hellwig } 1345491221f8SGuoqing Jiang EXPORT_SYMBOL(bio_free_pages); 13461dfa0f68SChristoph Hellwig 1347f9c78b2bSJens Axboe /* 1348f9c78b2bSJens Axboe * bio_set_pages_dirty() and bio_check_pages_dirty() are support functions 1349f9c78b2bSJens Axboe * for performing direct-IO in BIOs. 1350f9c78b2bSJens Axboe * 1351f9c78b2bSJens Axboe * The problem is that we cannot run set_page_dirty() from interrupt context 1352f9c78b2bSJens Axboe * because the required locks are not interrupt-safe. So what we can do is to 1353f9c78b2bSJens Axboe * mark the pages dirty _before_ performing IO. And in interrupt context, 1354f9c78b2bSJens Axboe * check that the pages are still dirty. If so, fine. If not, redirty them 1355f9c78b2bSJens Axboe * in process context. 1356f9c78b2bSJens Axboe * 1357f9c78b2bSJens Axboe * We special-case compound pages here: normally this means reads into hugetlb 1358f9c78b2bSJens Axboe * pages. The logic in here doesn't really work right for compound pages 1359f9c78b2bSJens Axboe * because the VM does not uniformly chase down the head page in all cases. 1360f9c78b2bSJens Axboe * But dirtiness of compound pages is pretty meaningless anyway: the VM doesn't 1361f9c78b2bSJens Axboe * handle them at all. So we skip compound pages here at an early stage. 1362f9c78b2bSJens Axboe * 1363f9c78b2bSJens Axboe * Note that this code is very hard to test under normal circumstances because 1364f9c78b2bSJens Axboe * direct-io pins the pages with get_user_pages(). This makes 1365f9c78b2bSJens Axboe * is_page_cache_freeable return false, and the VM will not clean the pages. 1366f9c78b2bSJens Axboe * But other code (eg, flusher threads) could clean the pages if they are mapped 1367f9c78b2bSJens Axboe * pagecache. 1368f9c78b2bSJens Axboe * 1369f9c78b2bSJens Axboe * Simply disabling the call to bio_set_pages_dirty() is a good way to test the 1370f9c78b2bSJens Axboe * deferred bio dirtying paths. 1371f9c78b2bSJens Axboe */ 1372f9c78b2bSJens Axboe 1373f9c78b2bSJens Axboe /* 1374f9c78b2bSJens Axboe * bio_set_pages_dirty() will mark all the bio's pages as dirty. 1375f9c78b2bSJens Axboe */ 1376f9c78b2bSJens Axboe void bio_set_pages_dirty(struct bio *bio) 1377f9c78b2bSJens Axboe { 1378f9c78b2bSJens Axboe struct bio_vec *bvec; 13796dc4f100SMing Lei struct bvec_iter_all iter_all; 1380f9c78b2bSJens Axboe 13812b070cfeSChristoph Hellwig bio_for_each_segment_all(bvec, bio, iter_all) { 13823bb50983SChristoph Hellwig if (!PageCompound(bvec->bv_page)) 13833bb50983SChristoph Hellwig set_page_dirty_lock(bvec->bv_page); 1384f9c78b2bSJens Axboe } 1385f9c78b2bSJens Axboe } 1386f9c78b2bSJens Axboe 1387f9c78b2bSJens Axboe /* 1388f9c78b2bSJens Axboe * bio_check_pages_dirty() will check that all the BIO's pages are still dirty. 1389f9c78b2bSJens Axboe * If they are, then fine. If, however, some pages are clean then they must 1390f9c78b2bSJens Axboe * have been written out during the direct-IO read. So we take another ref on 139124d5493fSChristoph Hellwig * the BIO and re-dirty the pages in process context. 1392f9c78b2bSJens Axboe * 1393f9c78b2bSJens Axboe * It is expected that bio_check_pages_dirty() will wholly own the BIO from 1394ea1754a0SKirill A. Shutemov * here on. It will run one put_page() against each page and will run one 1395ea1754a0SKirill A. Shutemov * bio_put() against the BIO. 1396f9c78b2bSJens Axboe */ 1397f9c78b2bSJens Axboe 1398f9c78b2bSJens Axboe static void bio_dirty_fn(struct work_struct *work); 1399f9c78b2bSJens Axboe 1400f9c78b2bSJens Axboe static DECLARE_WORK(bio_dirty_work, bio_dirty_fn); 1401f9c78b2bSJens Axboe static DEFINE_SPINLOCK(bio_dirty_lock); 1402f9c78b2bSJens Axboe static struct bio *bio_dirty_list; 1403f9c78b2bSJens Axboe 1404f9c78b2bSJens Axboe /* 1405f9c78b2bSJens Axboe * This runs in process context 1406f9c78b2bSJens Axboe */ 1407f9c78b2bSJens Axboe static void bio_dirty_fn(struct work_struct *work) 1408f9c78b2bSJens Axboe { 140924d5493fSChristoph Hellwig struct bio *bio, *next; 1410f9c78b2bSJens Axboe 141124d5493fSChristoph Hellwig spin_lock_irq(&bio_dirty_lock); 141224d5493fSChristoph Hellwig next = bio_dirty_list; 1413f9c78b2bSJens Axboe bio_dirty_list = NULL; 141424d5493fSChristoph Hellwig spin_unlock_irq(&bio_dirty_lock); 1415f9c78b2bSJens Axboe 141624d5493fSChristoph Hellwig while ((bio = next) != NULL) { 141724d5493fSChristoph Hellwig next = bio->bi_private; 1418f9c78b2bSJens Axboe 1419d241a95fSChristoph Hellwig bio_release_pages(bio, true); 1420f9c78b2bSJens Axboe bio_put(bio); 1421f9c78b2bSJens Axboe } 1422f9c78b2bSJens Axboe } 1423f9c78b2bSJens Axboe 1424f9c78b2bSJens Axboe void bio_check_pages_dirty(struct bio *bio) 1425f9c78b2bSJens Axboe { 1426f9c78b2bSJens Axboe struct bio_vec *bvec; 142724d5493fSChristoph Hellwig unsigned long flags; 14286dc4f100SMing Lei struct bvec_iter_all iter_all; 1429f9c78b2bSJens Axboe 14302b070cfeSChristoph Hellwig bio_for_each_segment_all(bvec, bio, iter_all) { 143124d5493fSChristoph Hellwig if (!PageDirty(bvec->bv_page) && !PageCompound(bvec->bv_page)) 143224d5493fSChristoph Hellwig goto defer; 1433f9c78b2bSJens Axboe } 1434f9c78b2bSJens Axboe 1435d241a95fSChristoph Hellwig bio_release_pages(bio, false); 143624d5493fSChristoph Hellwig bio_put(bio); 143724d5493fSChristoph Hellwig return; 143824d5493fSChristoph Hellwig defer: 1439f9c78b2bSJens Axboe spin_lock_irqsave(&bio_dirty_lock, flags); 1440f9c78b2bSJens Axboe bio->bi_private = bio_dirty_list; 1441f9c78b2bSJens Axboe bio_dirty_list = bio; 1442f9c78b2bSJens Axboe spin_unlock_irqrestore(&bio_dirty_lock, flags); 1443f9c78b2bSJens Axboe schedule_work(&bio_dirty_work); 1444f9c78b2bSJens Axboe } 1445f9c78b2bSJens Axboe 1446c4cf5261SJens Axboe static inline bool bio_remaining_done(struct bio *bio) 1447c4cf5261SJens Axboe { 1448c4cf5261SJens Axboe /* 1449c4cf5261SJens Axboe * If we're not chaining, then ->__bi_remaining is always 1 and 1450c4cf5261SJens Axboe * we always end io on the first invocation. 1451c4cf5261SJens Axboe */ 1452c4cf5261SJens Axboe if (!bio_flagged(bio, BIO_CHAIN)) 1453c4cf5261SJens Axboe return true; 1454c4cf5261SJens Axboe 1455c4cf5261SJens Axboe BUG_ON(atomic_read(&bio->__bi_remaining) <= 0); 1456c4cf5261SJens Axboe 1457326e1dbbSMike Snitzer if (atomic_dec_and_test(&bio->__bi_remaining)) { 1458b7c44ed9SJens Axboe bio_clear_flag(bio, BIO_CHAIN); 1459c4cf5261SJens Axboe return true; 1460326e1dbbSMike Snitzer } 1461c4cf5261SJens Axboe 1462c4cf5261SJens Axboe return false; 1463c4cf5261SJens Axboe } 1464c4cf5261SJens Axboe 1465f9c78b2bSJens Axboe /** 1466f9c78b2bSJens Axboe * bio_endio - end I/O on a bio 1467f9c78b2bSJens Axboe * @bio: bio 1468f9c78b2bSJens Axboe * 1469f9c78b2bSJens Axboe * Description: 14704246a0b6SChristoph Hellwig * bio_endio() will end I/O on the whole bio. bio_endio() is the preferred 14714246a0b6SChristoph Hellwig * way to end I/O on a bio. No one should call bi_end_io() directly on a 14724246a0b6SChristoph Hellwig * bio unless they own it and thus know that it has an end_io function. 1473fbbaf700SNeilBrown * 1474fbbaf700SNeilBrown * bio_endio() can be called several times on a bio that has been chained 1475fbbaf700SNeilBrown * using bio_chain(). The ->bi_end_io() function will only be called the 147660b6a7e6SEdward Hsieh * last time. 1477f9c78b2bSJens Axboe **/ 14784246a0b6SChristoph Hellwig void bio_endio(struct bio *bio) 1479f9c78b2bSJens Axboe { 1480ba8c6967SChristoph Hellwig again: 14812b885517SChristoph Hellwig if (!bio_remaining_done(bio)) 1482ba8c6967SChristoph Hellwig return; 14837c20f116SChristoph Hellwig if (!bio_integrity_endio(bio)) 14847c20f116SChristoph Hellwig return; 1485f9c78b2bSJens Axboe 1486a647a524SMing Lei if (bio->bi_bdev && bio_flagged(bio, BIO_TRACKED)) 14873caee463SPavel Begunkov rq_qos_done_bio(bdev_get_queue(bio->bi_bdev), bio); 148867b42d0bSJosef Bacik 148960b6a7e6SEdward Hsieh if (bio->bi_bdev && bio_flagged(bio, BIO_TRACE_COMPLETION)) { 14903caee463SPavel Begunkov trace_block_bio_complete(bdev_get_queue(bio->bi_bdev), bio); 149160b6a7e6SEdward Hsieh bio_clear_flag(bio, BIO_TRACE_COMPLETION); 149260b6a7e6SEdward Hsieh } 149360b6a7e6SEdward Hsieh 1494f9c78b2bSJens Axboe /* 1495ba8c6967SChristoph Hellwig * Need to have a real endio function for chained bios, otherwise 1496ba8c6967SChristoph Hellwig * various corner cases will break (like stacking block devices that 1497ba8c6967SChristoph Hellwig * save/restore bi_end_io) - however, we want to avoid unbounded 1498ba8c6967SChristoph Hellwig * recursion and blowing the stack. Tail call optimization would 1499ba8c6967SChristoph Hellwig * handle this, but compiling with frame pointers also disables 1500ba8c6967SChristoph Hellwig * gcc's sibling call optimization. 1501f9c78b2bSJens Axboe */ 1502f9c78b2bSJens Axboe if (bio->bi_end_io == bio_chain_endio) { 150338f8baaeSChristoph Hellwig bio = __bio_chain_endio(bio); 1504ba8c6967SChristoph Hellwig goto again; 1505ba8c6967SChristoph Hellwig } 1506ba8c6967SChristoph Hellwig 15079e234eeaSShaohua Li blk_throtl_bio_endio(bio); 1508b222dd2fSShaohua Li /* release cgroup info */ 1509b222dd2fSShaohua Li bio_uninit(bio); 1510f9c78b2bSJens Axboe if (bio->bi_end_io) 15114246a0b6SChristoph Hellwig bio->bi_end_io(bio); 1512f9c78b2bSJens Axboe } 1513f9c78b2bSJens Axboe EXPORT_SYMBOL(bio_endio); 1514f9c78b2bSJens Axboe 1515f9c78b2bSJens Axboe /** 1516f9c78b2bSJens Axboe * bio_split - split a bio 1517f9c78b2bSJens Axboe * @bio: bio to split 1518f9c78b2bSJens Axboe * @sectors: number of sectors to split from the front of @bio 1519f9c78b2bSJens Axboe * @gfp: gfp mask 1520f9c78b2bSJens Axboe * @bs: bio set to allocate from 1521f9c78b2bSJens Axboe * 1522f9c78b2bSJens Axboe * Allocates and returns a new bio which represents @sectors from the start of 1523f9c78b2bSJens Axboe * @bio, and updates @bio to represent the remaining sectors. 1524f9c78b2bSJens Axboe * 1525f3f5da62SMartin K. Petersen * Unless this is a discard request the newly allocated bio will point 1526dad77584SBart Van Assche * to @bio's bi_io_vec. It is the caller's responsibility to ensure that 1527dad77584SBart Van Assche * neither @bio nor @bs are freed before the split bio. 1528f9c78b2bSJens Axboe */ 1529f9c78b2bSJens Axboe struct bio *bio_split(struct bio *bio, int sectors, 1530f9c78b2bSJens Axboe gfp_t gfp, struct bio_set *bs) 1531f9c78b2bSJens Axboe { 1532f341a4d3SMikulas Patocka struct bio *split; 1533f9c78b2bSJens Axboe 1534f9c78b2bSJens Axboe BUG_ON(sectors <= 0); 1535f9c78b2bSJens Axboe BUG_ON(sectors >= bio_sectors(bio)); 1536f9c78b2bSJens Axboe 15370512a75bSKeith Busch /* Zone append commands cannot be split */ 15380512a75bSKeith Busch if (WARN_ON_ONCE(bio_op(bio) == REQ_OP_ZONE_APPEND)) 15390512a75bSKeith Busch return NULL; 15400512a75bSKeith Busch 1541f9c78b2bSJens Axboe split = bio_clone_fast(bio, gfp, bs); 1542f9c78b2bSJens Axboe if (!split) 1543f9c78b2bSJens Axboe return NULL; 1544f9c78b2bSJens Axboe 1545f9c78b2bSJens Axboe split->bi_iter.bi_size = sectors << 9; 1546f9c78b2bSJens Axboe 1547f9c78b2bSJens Axboe if (bio_integrity(split)) 1548fbd08e76SDmitry Monakhov bio_integrity_trim(split); 1549f9c78b2bSJens Axboe 1550f9c78b2bSJens Axboe bio_advance(bio, split->bi_iter.bi_size); 1551f9c78b2bSJens Axboe 1552fbbaf700SNeilBrown if (bio_flagged(bio, BIO_TRACE_COMPLETION)) 155320d59023SGoldwyn Rodrigues bio_set_flag(split, BIO_TRACE_COMPLETION); 1554fbbaf700SNeilBrown 1555f9c78b2bSJens Axboe return split; 1556f9c78b2bSJens Axboe } 1557f9c78b2bSJens Axboe EXPORT_SYMBOL(bio_split); 1558f9c78b2bSJens Axboe 1559f9c78b2bSJens Axboe /** 1560f9c78b2bSJens Axboe * bio_trim - trim a bio 1561f9c78b2bSJens Axboe * @bio: bio to trim 1562f9c78b2bSJens Axboe * @offset: number of sectors to trim from the front of @bio 1563f9c78b2bSJens Axboe * @size: size we want to trim @bio to, in sectors 1564e83502caSChaitanya Kulkarni * 1565e83502caSChaitanya Kulkarni * This function is typically used for bios that are cloned and submitted 1566e83502caSChaitanya Kulkarni * to the underlying device in parts. 1567f9c78b2bSJens Axboe */ 1568e83502caSChaitanya Kulkarni void bio_trim(struct bio *bio, sector_t offset, sector_t size) 1569f9c78b2bSJens Axboe { 1570e83502caSChaitanya Kulkarni if (WARN_ON_ONCE(offset > BIO_MAX_SECTORS || size > BIO_MAX_SECTORS || 1571e83502caSChaitanya Kulkarni offset + size > bio->bi_iter.bi_size)) 1572e83502caSChaitanya Kulkarni return; 1573f9c78b2bSJens Axboe 1574f9c78b2bSJens Axboe size <<= 9; 1575f9c78b2bSJens Axboe if (offset == 0 && size == bio->bi_iter.bi_size) 1576f9c78b2bSJens Axboe return; 1577f9c78b2bSJens Axboe 1578f9c78b2bSJens Axboe bio_advance(bio, offset << 9); 1579f9c78b2bSJens Axboe bio->bi_iter.bi_size = size; 1580376a78abSDmitry Monakhov 1581376a78abSDmitry Monakhov if (bio_integrity(bio)) 1582fbd08e76SDmitry Monakhov bio_integrity_trim(bio); 1583f9c78b2bSJens Axboe } 1584f9c78b2bSJens Axboe EXPORT_SYMBOL_GPL(bio_trim); 1585f9c78b2bSJens Axboe 1586f9c78b2bSJens Axboe /* 1587f9c78b2bSJens Axboe * create memory pools for biovec's in a bio_set. 1588f9c78b2bSJens Axboe * use the global biovec slabs created for general use. 1589f9c78b2bSJens Axboe */ 15908aa6ba2fSKent Overstreet int biovec_init_pool(mempool_t *pool, int pool_entries) 1591f9c78b2bSJens Axboe { 15927a800a20SChristoph Hellwig struct biovec_slab *bp = bvec_slabs + ARRAY_SIZE(bvec_slabs) - 1; 1593f9c78b2bSJens Axboe 15948aa6ba2fSKent Overstreet return mempool_init_slab_pool(pool, pool_entries, bp->slab); 1595f9c78b2bSJens Axboe } 1596f9c78b2bSJens Axboe 1597917a38c7SKent Overstreet /* 1598917a38c7SKent Overstreet * bioset_exit - exit a bioset initialized with bioset_init() 1599917a38c7SKent Overstreet * 1600917a38c7SKent Overstreet * May be called on a zeroed but uninitialized bioset (i.e. allocated with 1601917a38c7SKent Overstreet * kzalloc()). 1602917a38c7SKent Overstreet */ 1603917a38c7SKent Overstreet void bioset_exit(struct bio_set *bs) 1604f9c78b2bSJens Axboe { 1605be4d234dSJens Axboe bio_alloc_cache_destroy(bs); 1606f9c78b2bSJens Axboe if (bs->rescue_workqueue) 1607f9c78b2bSJens Axboe destroy_workqueue(bs->rescue_workqueue); 1608917a38c7SKent Overstreet bs->rescue_workqueue = NULL; 1609f9c78b2bSJens Axboe 16108aa6ba2fSKent Overstreet mempool_exit(&bs->bio_pool); 16118aa6ba2fSKent Overstreet mempool_exit(&bs->bvec_pool); 1612f9c78b2bSJens Axboe 1613f9c78b2bSJens Axboe bioset_integrity_free(bs); 1614917a38c7SKent Overstreet if (bs->bio_slab) 1615f9c78b2bSJens Axboe bio_put_slab(bs); 1616917a38c7SKent Overstreet bs->bio_slab = NULL; 1617917a38c7SKent Overstreet } 1618917a38c7SKent Overstreet EXPORT_SYMBOL(bioset_exit); 1619f9c78b2bSJens Axboe 1620011067b0SNeilBrown /** 1621917a38c7SKent Overstreet * bioset_init - Initialize a bio_set 1622dad08527SKent Overstreet * @bs: pool to initialize 1623917a38c7SKent Overstreet * @pool_size: Number of bio and bio_vecs to cache in the mempool 1624917a38c7SKent Overstreet * @front_pad: Number of bytes to allocate in front of the returned bio 1625917a38c7SKent Overstreet * @flags: Flags to modify behavior, currently %BIOSET_NEED_BVECS 1626917a38c7SKent Overstreet * and %BIOSET_NEED_RESCUER 1627917a38c7SKent Overstreet * 1628dad08527SKent Overstreet * Description: 1629dad08527SKent Overstreet * Set up a bio_set to be used with @bio_alloc_bioset. Allows the caller 1630dad08527SKent Overstreet * to ask for a number of bytes to be allocated in front of the bio. 1631dad08527SKent Overstreet * Front pad allocation is useful for embedding the bio inside 1632dad08527SKent Overstreet * another structure, to avoid allocating extra data to go with the bio. 1633dad08527SKent Overstreet * Note that the bio must be embedded at the END of that structure always, 1634dad08527SKent Overstreet * or things will break badly. 1635dad08527SKent Overstreet * If %BIOSET_NEED_BVECS is set in @flags, a separate pool will be allocated 1636dad08527SKent Overstreet * for allocating iovecs. This pool is not needed e.g. for bio_clone_fast(). 1637dad08527SKent Overstreet * If %BIOSET_NEED_RESCUER is set, a workqueue is created which can be used to 1638dad08527SKent Overstreet * dispatch queued requests when the mempool runs out of space. 1639dad08527SKent Overstreet * 1640917a38c7SKent Overstreet */ 1641917a38c7SKent Overstreet int bioset_init(struct bio_set *bs, 1642917a38c7SKent Overstreet unsigned int pool_size, 1643917a38c7SKent Overstreet unsigned int front_pad, 1644917a38c7SKent Overstreet int flags) 1645917a38c7SKent Overstreet { 1646917a38c7SKent Overstreet bs->front_pad = front_pad; 16479f180e31SMing Lei if (flags & BIOSET_NEED_BVECS) 16489f180e31SMing Lei bs->back_pad = BIO_INLINE_VECS * sizeof(struct bio_vec); 16499f180e31SMing Lei else 16509f180e31SMing Lei bs->back_pad = 0; 1651917a38c7SKent Overstreet 1652917a38c7SKent Overstreet spin_lock_init(&bs->rescue_lock); 1653917a38c7SKent Overstreet bio_list_init(&bs->rescue_list); 1654917a38c7SKent Overstreet INIT_WORK(&bs->rescue_work, bio_alloc_rescue); 1655917a38c7SKent Overstreet 165649d1ec85SMing Lei bs->bio_slab = bio_find_or_create_slab(bs); 1657917a38c7SKent Overstreet if (!bs->bio_slab) 1658917a38c7SKent Overstreet return -ENOMEM; 1659917a38c7SKent Overstreet 1660917a38c7SKent Overstreet if (mempool_init_slab_pool(&bs->bio_pool, pool_size, bs->bio_slab)) 1661917a38c7SKent Overstreet goto bad; 1662917a38c7SKent Overstreet 1663917a38c7SKent Overstreet if ((flags & BIOSET_NEED_BVECS) && 1664917a38c7SKent Overstreet biovec_init_pool(&bs->bvec_pool, pool_size)) 1665917a38c7SKent Overstreet goto bad; 1666917a38c7SKent Overstreet 1667be4d234dSJens Axboe if (flags & BIOSET_NEED_RESCUER) { 1668be4d234dSJens Axboe bs->rescue_workqueue = alloc_workqueue("bioset", 1669be4d234dSJens Axboe WQ_MEM_RECLAIM, 0); 1670917a38c7SKent Overstreet if (!bs->rescue_workqueue) 1671917a38c7SKent Overstreet goto bad; 1672be4d234dSJens Axboe } 1673be4d234dSJens Axboe if (flags & BIOSET_PERCPU_CACHE) { 1674be4d234dSJens Axboe bs->cache = alloc_percpu(struct bio_alloc_cache); 1675be4d234dSJens Axboe if (!bs->cache) 1676be4d234dSJens Axboe goto bad; 1677be4d234dSJens Axboe cpuhp_state_add_instance_nocalls(CPUHP_BIO_DEAD, &bs->cpuhp_dead); 1678be4d234dSJens Axboe } 1679917a38c7SKent Overstreet 1680917a38c7SKent Overstreet return 0; 1681917a38c7SKent Overstreet bad: 1682917a38c7SKent Overstreet bioset_exit(bs); 1683917a38c7SKent Overstreet return -ENOMEM; 1684917a38c7SKent Overstreet } 1685917a38c7SKent Overstreet EXPORT_SYMBOL(bioset_init); 1686917a38c7SKent Overstreet 168728e89fd9SJens Axboe /* 168828e89fd9SJens Axboe * Initialize and setup a new bio_set, based on the settings from 168928e89fd9SJens Axboe * another bio_set. 169028e89fd9SJens Axboe */ 169128e89fd9SJens Axboe int bioset_init_from_src(struct bio_set *bs, struct bio_set *src) 169228e89fd9SJens Axboe { 169328e89fd9SJens Axboe int flags; 169428e89fd9SJens Axboe 169528e89fd9SJens Axboe flags = 0; 169628e89fd9SJens Axboe if (src->bvec_pool.min_nr) 169728e89fd9SJens Axboe flags |= BIOSET_NEED_BVECS; 169828e89fd9SJens Axboe if (src->rescue_workqueue) 169928e89fd9SJens Axboe flags |= BIOSET_NEED_RESCUER; 170028e89fd9SJens Axboe 170128e89fd9SJens Axboe return bioset_init(bs, src->bio_pool.min_nr, src->front_pad, flags); 170228e89fd9SJens Axboe } 170328e89fd9SJens Axboe EXPORT_SYMBOL(bioset_init_from_src); 170428e89fd9SJens Axboe 1705be4d234dSJens Axboe /** 1706be4d234dSJens Axboe * bio_alloc_kiocb - Allocate a bio from bio_set based on kiocb 1707be4d234dSJens Axboe * @kiocb: kiocb describing the IO 17080ef47db1SJens Axboe * @nr_vecs: number of iovecs to pre-allocate 1709be4d234dSJens Axboe * @bs: bio_set to allocate from 1710be4d234dSJens Axboe * 1711be4d234dSJens Axboe * Description: 1712be4d234dSJens Axboe * Like @bio_alloc_bioset, but pass in the kiocb. The kiocb is only 1713be4d234dSJens Axboe * used to check if we should dip into the per-cpu bio_set allocation 17143d5b3fbeSJens Axboe * cache. The allocation uses GFP_KERNEL internally. On return, the 17153d5b3fbeSJens Axboe * bio is marked BIO_PERCPU_CACHEABLE, and the final put of the bio 17163d5b3fbeSJens Axboe * MUST be done from process context, not hard/soft IRQ. 1717be4d234dSJens Axboe * 1718be4d234dSJens Axboe */ 1719be4d234dSJens Axboe struct bio *bio_alloc_kiocb(struct kiocb *kiocb, unsigned short nr_vecs, 1720be4d234dSJens Axboe struct bio_set *bs) 1721be4d234dSJens Axboe { 1722be4d234dSJens Axboe struct bio_alloc_cache *cache; 1723be4d234dSJens Axboe struct bio *bio; 1724be4d234dSJens Axboe 1725be4d234dSJens Axboe if (!(kiocb->ki_flags & IOCB_ALLOC_CACHE) || nr_vecs > BIO_INLINE_VECS) 1726be4d234dSJens Axboe return bio_alloc_bioset(GFP_KERNEL, nr_vecs, bs); 1727be4d234dSJens Axboe 1728be4d234dSJens Axboe cache = per_cpu_ptr(bs->cache, get_cpu()); 1729be4d234dSJens Axboe bio = bio_list_pop(&cache->free_list); 1730be4d234dSJens Axboe if (bio) { 1731be4d234dSJens Axboe cache->nr--; 1732be4d234dSJens Axboe put_cpu(); 1733be4d234dSJens Axboe bio_init(bio, nr_vecs ? bio->bi_inline_vecs : NULL, nr_vecs); 1734be4d234dSJens Axboe bio->bi_pool = bs; 1735be4d234dSJens Axboe bio_set_flag(bio, BIO_PERCPU_CACHE); 1736be4d234dSJens Axboe return bio; 1737be4d234dSJens Axboe } 1738be4d234dSJens Axboe put_cpu(); 1739be4d234dSJens Axboe bio = bio_alloc_bioset(GFP_KERNEL, nr_vecs, bs); 1740be4d234dSJens Axboe bio_set_flag(bio, BIO_PERCPU_CACHE); 1741be4d234dSJens Axboe return bio; 1742be4d234dSJens Axboe } 1743be4d234dSJens Axboe EXPORT_SYMBOL_GPL(bio_alloc_kiocb); 1744be4d234dSJens Axboe 1745de76fd89SChristoph Hellwig static int __init init_bio(void) 1746f9c78b2bSJens Axboe { 1747f9c78b2bSJens Axboe int i; 1748f9c78b2bSJens Axboe 1749f9c78b2bSJens Axboe bio_integrity_init(); 1750de76fd89SChristoph Hellwig 1751de76fd89SChristoph Hellwig for (i = 0; i < ARRAY_SIZE(bvec_slabs); i++) { 1752f9c78b2bSJens Axboe struct biovec_slab *bvs = bvec_slabs + i; 1753f9c78b2bSJens Axboe 1754de76fd89SChristoph Hellwig bvs->slab = kmem_cache_create(bvs->name, 1755de76fd89SChristoph Hellwig bvs->nr_vecs * sizeof(struct bio_vec), 0, 1756f9c78b2bSJens Axboe SLAB_HWCACHE_ALIGN | SLAB_PANIC, NULL); 1757f9c78b2bSJens Axboe } 1758f9c78b2bSJens Axboe 1759be4d234dSJens Axboe cpuhp_setup_state_multi(CPUHP_BIO_DEAD, "block/bio:dead", NULL, 1760be4d234dSJens Axboe bio_cpu_dead); 1761be4d234dSJens Axboe 1762f4f8154aSKent Overstreet if (bioset_init(&fs_bio_set, BIO_POOL_SIZE, 0, BIOSET_NEED_BVECS)) 1763f9c78b2bSJens Axboe panic("bio: can't allocate bios\n"); 1764f9c78b2bSJens Axboe 1765f4f8154aSKent Overstreet if (bioset_integrity_create(&fs_bio_set, BIO_POOL_SIZE)) 1766f9c78b2bSJens Axboe panic("bio: can't create integrity pool\n"); 1767f9c78b2bSJens Axboe 1768f9c78b2bSJens Axboe return 0; 1769f9c78b2bSJens Axboe } 1770f9c78b2bSJens Axboe subsys_initcall(init_bio); 1771