blob: 11e6aac35092db56d0e31f4967e8fe708b5bc9b4 [file] [log] [blame]
Christoph Hellwig8c165672019-04-30 14:42:39 -04001// SPDX-License-Identifier: GPL-2.0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
Jens Axboe0fe23472006-09-04 15:41:16 +02003 * Copyright (C) 2001 Jens Axboe <axboe@kernel.dk>
Linus Torvalds1da177e2005-04-16 15:20:36 -07004 */
5#include <linux/mm.h>
6#include <linux/swap.h>
7#include <linux/bio.h>
8#include <linux/blkdev.h>
Kent Overstreeta27bb332013-05-07 16:19:08 -07009#include <linux/uio.h>
Tejun Heo852c7882012-03-05 13:15:27 -080010#include <linux/iocontext.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <linux/slab.h>
12#include <linux/init.h>
13#include <linux/kernel.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050014#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/mempool.h>
16#include <linux/workqueue.h>
Tejun Heo852c7882012-03-05 13:15:27 -080017#include <linux/cgroup.h>
Josef Bacik08e18ea2018-07-03 11:14:50 -040018#include <linux/blk-cgroup.h>
Damien Le Moalb4c58752019-07-01 14:09:15 +090019#include <linux/highmem.h>
Ming Leide6a78b2020-03-18 11:43:36 +080020#include <linux/sched/sysctl.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021
Li Zefan55782132009-06-09 13:43:05 +080022#include <trace/events/block.h>
Shaohua Li9e234ee2017-03-27 10:51:41 -070023#include "blk.h"
Josef Bacik67b42d02018-07-03 11:15:00 -040024#include "blk-rq-qos.h"
Ingo Molnar0bfc2452008-11-26 11:59:56 +010025
Jens Axboe392ddc32008-12-23 12:42:54 +010026/*
27 * Test patch to inline a certain number of bi_io_vec's inside the bio
28 * itself, to shrink a bio data allocation from two mempool calls to one
29 */
30#define BIO_INLINE_VECS 4
31
Linus Torvalds1da177e2005-04-16 15:20:36 -070032/*
33 * if you change this list, also change bvec_alloc or things will
34 * break badly! cannot be bigger than what you can fit into an
35 * unsigned short
36 */
Mikulas Patockabd5c4fa2018-03-21 12:49:29 -040037#define BV(x, n) { .nr_vecs = x, .name = "biovec-"#n }
Christoph Hellwiged996a52016-07-19 11:28:42 +020038static struct biovec_slab bvec_slabs[BVEC_POOL_NR] __read_mostly = {
Mikulas Patockabd5c4fa2018-03-21 12:49:29 -040039 BV(1, 1), BV(4, 4), BV(16, 16), BV(64, 64), BV(128, 128), BV(BIO_MAX_PAGES, max),
Linus Torvalds1da177e2005-04-16 15:20:36 -070040};
41#undef BV
42
43/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070044 * fs_bio_set is the bio_set containing bio and iovec memory pools used by
45 * IO code that does not need private memory pools.
46 */
Kent Overstreetf4f81542018-05-08 21:33:52 -040047struct bio_set fs_bio_set;
Kent Overstreet3f86a822012-09-06 15:35:01 -070048EXPORT_SYMBOL(fs_bio_set);
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Jens Axboebb799ca2008-12-10 15:35:05 +010050/*
51 * Our slab pool management
52 */
53struct bio_slab {
54 struct kmem_cache *slab;
55 unsigned int slab_ref;
56 unsigned int slab_size;
57 char name[8];
58};
59static DEFINE_MUTEX(bio_slab_lock);
60static struct bio_slab *bio_slabs;
61static unsigned int bio_slab_nr, bio_slab_max;
62
63static struct kmem_cache *bio_find_or_create_slab(unsigned int extra_size)
64{
65 unsigned int sz = sizeof(struct bio) + extra_size;
66 struct kmem_cache *slab = NULL;
Alexey Khoroshilov389d7b22012-08-09 15:19:25 +020067 struct bio_slab *bslab, *new_bio_slabs;
Anna Leuschner386bc352012-10-22 21:53:36 +020068 unsigned int new_bio_slab_max;
Jens Axboebb799ca2008-12-10 15:35:05 +010069 unsigned int i, entry = -1;
70
71 mutex_lock(&bio_slab_lock);
72
73 i = 0;
74 while (i < bio_slab_nr) {
Thiago Farinaf06f1352010-01-19 14:07:09 +010075 bslab = &bio_slabs[i];
Jens Axboebb799ca2008-12-10 15:35:05 +010076
77 if (!bslab->slab && entry == -1)
78 entry = i;
79 else if (bslab->slab_size == sz) {
80 slab = bslab->slab;
81 bslab->slab_ref++;
82 break;
83 }
84 i++;
85 }
86
87 if (slab)
88 goto out_unlock;
89
90 if (bio_slab_nr == bio_slab_max && entry == -1) {
Anna Leuschner386bc352012-10-22 21:53:36 +020091 new_bio_slab_max = bio_slab_max << 1;
Alexey Khoroshilov389d7b22012-08-09 15:19:25 +020092 new_bio_slabs = krealloc(bio_slabs,
Anna Leuschner386bc352012-10-22 21:53:36 +020093 new_bio_slab_max * sizeof(struct bio_slab),
Alexey Khoroshilov389d7b22012-08-09 15:19:25 +020094 GFP_KERNEL);
95 if (!new_bio_slabs)
Jens Axboebb799ca2008-12-10 15:35:05 +010096 goto out_unlock;
Anna Leuschner386bc352012-10-22 21:53:36 +020097 bio_slab_max = new_bio_slab_max;
Alexey Khoroshilov389d7b22012-08-09 15:19:25 +020098 bio_slabs = new_bio_slabs;
Jens Axboebb799ca2008-12-10 15:35:05 +010099 }
100 if (entry == -1)
101 entry = bio_slab_nr++;
102
103 bslab = &bio_slabs[entry];
104
105 snprintf(bslab->name, sizeof(bslab->name), "bio-%d", entry);
Mikulas Patocka6a241482014-03-28 15:51:55 -0400106 slab = kmem_cache_create(bslab->name, sz, ARCH_KMALLOC_MINALIGN,
107 SLAB_HWCACHE_ALIGN, NULL);
Jens Axboebb799ca2008-12-10 15:35:05 +0100108 if (!slab)
109 goto out_unlock;
110
Jens Axboebb799ca2008-12-10 15:35:05 +0100111 bslab->slab = slab;
112 bslab->slab_ref = 1;
113 bslab->slab_size = sz;
114out_unlock:
115 mutex_unlock(&bio_slab_lock);
116 return slab;
117}
118
119static void bio_put_slab(struct bio_set *bs)
120{
121 struct bio_slab *bslab = NULL;
122 unsigned int i;
123
124 mutex_lock(&bio_slab_lock);
125
126 for (i = 0; i < bio_slab_nr; i++) {
127 if (bs->bio_slab == bio_slabs[i].slab) {
128 bslab = &bio_slabs[i];
129 break;
130 }
131 }
132
133 if (WARN(!bslab, KERN_ERR "bio: unable to find slab!\n"))
134 goto out;
135
136 WARN_ON(!bslab->slab_ref);
137
138 if (--bslab->slab_ref)
139 goto out;
140
141 kmem_cache_destroy(bslab->slab);
142 bslab->slab = NULL;
143
144out:
145 mutex_unlock(&bio_slab_lock);
146}
147
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200148unsigned int bvec_nr_vecs(unsigned short idx)
149{
Greg Edwardsd6c02a92018-08-08 13:27:53 -0600150 return bvec_slabs[--idx].nr_vecs;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200151}
152
Kent Overstreet9f060e22012-10-12 15:29:33 -0700153void bvec_free(mempool_t *pool, struct bio_vec *bv, unsigned int idx)
Jens Axboebb799ca2008-12-10 15:35:05 +0100154{
Christoph Hellwiged996a52016-07-19 11:28:42 +0200155 if (!idx)
156 return;
157 idx--;
Jens Axboebb799ca2008-12-10 15:35:05 +0100158
Christoph Hellwiged996a52016-07-19 11:28:42 +0200159 BIO_BUG_ON(idx >= BVEC_POOL_NR);
160
161 if (idx == BVEC_POOL_MAX) {
Kent Overstreet9f060e22012-10-12 15:29:33 -0700162 mempool_free(bv, pool);
Christoph Hellwiged996a52016-07-19 11:28:42 +0200163 } else {
Jens Axboebb799ca2008-12-10 15:35:05 +0100164 struct biovec_slab *bvs = bvec_slabs + idx;
165
166 kmem_cache_free(bvs->slab, bv);
167 }
168}
169
Kent Overstreet9f060e22012-10-12 15:29:33 -0700170struct bio_vec *bvec_alloc(gfp_t gfp_mask, int nr, unsigned long *idx,
171 mempool_t *pool)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700172{
173 struct bio_vec *bvl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174
175 /*
Jens Axboe7ff93452008-12-11 11:53:43 +0100176 * see comment near bvec_array define!
177 */
178 switch (nr) {
179 case 1:
180 *idx = 0;
181 break;
182 case 2 ... 4:
183 *idx = 1;
184 break;
185 case 5 ... 16:
186 *idx = 2;
187 break;
188 case 17 ... 64:
189 *idx = 3;
190 break;
191 case 65 ... 128:
192 *idx = 4;
193 break;
194 case 129 ... BIO_MAX_PAGES:
195 *idx = 5;
196 break;
197 default:
198 return NULL;
199 }
200
201 /*
202 * idx now points to the pool we want to allocate from. only the
203 * 1-vec entry pool is mempool backed.
204 */
Christoph Hellwiged996a52016-07-19 11:28:42 +0200205 if (*idx == BVEC_POOL_MAX) {
Jens Axboe7ff93452008-12-11 11:53:43 +0100206fallback:
Kent Overstreet9f060e22012-10-12 15:29:33 -0700207 bvl = mempool_alloc(pool, gfp_mask);
Jens Axboe7ff93452008-12-11 11:53:43 +0100208 } else {
209 struct biovec_slab *bvs = bvec_slabs + *idx;
Mel Gormand0164ad2015-11-06 16:28:21 -0800210 gfp_t __gfp_mask = gfp_mask & ~(__GFP_DIRECT_RECLAIM | __GFP_IO);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211
Jens Axboe0a0d96b2008-09-11 13:17:37 +0200212 /*
Jens Axboe7ff93452008-12-11 11:53:43 +0100213 * Make this allocation restricted and don't dump info on
214 * allocation failures, since we'll fallback to the mempool
215 * in case of failure.
Jens Axboe0a0d96b2008-09-11 13:17:37 +0200216 */
Jens Axboe7ff93452008-12-11 11:53:43 +0100217 __gfp_mask |= __GFP_NOMEMALLOC | __GFP_NORETRY | __GFP_NOWARN;
218
219 /*
Mel Gormand0164ad2015-11-06 16:28:21 -0800220 * Try a slab allocation. If this fails and __GFP_DIRECT_RECLAIM
Jens Axboe7ff93452008-12-11 11:53:43 +0100221 * is set, retry with the 1-entry mempool
222 */
223 bvl = kmem_cache_alloc(bvs->slab, __gfp_mask);
Mel Gormand0164ad2015-11-06 16:28:21 -0800224 if (unlikely(!bvl && (gfp_mask & __GFP_DIRECT_RECLAIM))) {
Christoph Hellwiged996a52016-07-19 11:28:42 +0200225 *idx = BVEC_POOL_MAX;
Jens Axboe7ff93452008-12-11 11:53:43 +0100226 goto fallback;
227 }
228 }
229
Christoph Hellwiged996a52016-07-19 11:28:42 +0200230 (*idx)++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 return bvl;
232}
233
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600234void bio_uninit(struct bio *bio)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235{
Dennis Zhou6f70fb62018-12-05 12:10:37 -0500236 bio_disassociate_blkg(bio);
Justin Teeece841a2019-12-05 10:09:01 +0800237
238 if (bio_integrity(bio))
239 bio_integrity_free(bio);
Kent Overstreet4254bba2012-09-06 15:35:00 -0700240}
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600241EXPORT_SYMBOL(bio_uninit);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200242
Kent Overstreet4254bba2012-09-06 15:35:00 -0700243static void bio_free(struct bio *bio)
244{
245 struct bio_set *bs = bio->bi_pool;
246 void *p;
247
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600248 bio_uninit(bio);
Kent Overstreet4254bba2012-09-06 15:35:00 -0700249
250 if (bs) {
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400251 bvec_free(&bs->bvec_pool, bio->bi_io_vec, BVEC_POOL_IDX(bio));
Kent Overstreet4254bba2012-09-06 15:35:00 -0700252
253 /*
254 * If we have front padding, adjust the bio pointer before freeing
255 */
256 p = bio;
Jens Axboebb799ca2008-12-10 15:35:05 +0100257 p -= bs->front_pad;
258
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400259 mempool_free(p, &bs->bio_pool);
Kent Overstreet4254bba2012-09-06 15:35:00 -0700260 } else {
261 /* Bio was allocated by bio_kmalloc() */
262 kfree(bio);
263 }
Peter Osterlund36763472005-09-06 15:16:42 -0700264}
265
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600266/*
267 * Users of this function have their own bio allocation. Subsequently,
268 * they must remember to pair any call to bio_init() with bio_uninit()
269 * when IO has completed, or when the bio is released.
270 */
Ming Lei3a83f462016-11-22 08:57:21 -0700271void bio_init(struct bio *bio, struct bio_vec *table,
272 unsigned short max_vecs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273{
Jens Axboe2b94de52007-07-18 13:14:03 +0200274 memset(bio, 0, sizeof(*bio));
Jens Axboec4cf5262015-04-17 16:15:18 -0600275 atomic_set(&bio->__bi_remaining, 1);
Jens Axboedac56212015-04-17 16:23:59 -0600276 atomic_set(&bio->__bi_cnt, 1);
Ming Lei3a83f462016-11-22 08:57:21 -0700277
278 bio->bi_io_vec = table;
279 bio->bi_max_vecs = max_vecs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200281EXPORT_SYMBOL(bio_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282
283/**
Kent Overstreetf44b48c2012-09-06 15:34:58 -0700284 * bio_reset - reinitialize a bio
285 * @bio: bio to reset
286 *
287 * Description:
288 * After calling bio_reset(), @bio will be in the same state as a freshly
289 * allocated bio returned bio bio_alloc_bioset() - the only fields that are
290 * preserved are the ones that are initialized by bio_alloc_bioset(). See
291 * comment in struct bio.
292 */
293void bio_reset(struct bio *bio)
294{
295 unsigned long flags = bio->bi_flags & (~0UL << BIO_RESET_BITS);
296
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600297 bio_uninit(bio);
Kent Overstreetf44b48c2012-09-06 15:34:58 -0700298
299 memset(bio, 0, BIO_RESET_BYTES);
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200300 bio->bi_flags = flags;
Jens Axboec4cf5262015-04-17 16:15:18 -0600301 atomic_set(&bio->__bi_remaining, 1);
Kent Overstreetf44b48c2012-09-06 15:34:58 -0700302}
303EXPORT_SYMBOL(bio_reset);
304
Christoph Hellwig38f8baa2016-03-11 17:34:51 +0100305static struct bio *__bio_chain_endio(struct bio *bio)
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800306{
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200307 struct bio *parent = bio->bi_private;
308
Christoph Hellwig4e4cbee2017-06-03 09:38:06 +0200309 if (!parent->bi_status)
310 parent->bi_status = bio->bi_status;
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800311 bio_put(bio);
Christoph Hellwig38f8baa2016-03-11 17:34:51 +0100312 return parent;
313}
314
315static void bio_chain_endio(struct bio *bio)
316{
317 bio_endio(__bio_chain_endio(bio));
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800318}
319
320/**
321 * bio_chain - chain bio completions
Randy Dunlap1051a902014-04-20 16:03:31 -0700322 * @bio: the target bio
323 * @parent: the @bio's parent bio
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800324 *
325 * The caller won't have a bi_end_io called when @bio completes - instead,
326 * @parent's bi_end_io won't be called until both @parent and @bio have
327 * completed; the chained bio will also be freed when it completes.
328 *
329 * The caller must not set bi_private or bi_end_io in @bio.
330 */
331void bio_chain(struct bio *bio, struct bio *parent)
332{
333 BUG_ON(bio->bi_private || bio->bi_end_io);
334
335 bio->bi_private = parent;
336 bio->bi_end_io = bio_chain_endio;
Jens Axboec4cf5262015-04-17 16:15:18 -0600337 bio_inc_remaining(parent);
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800338}
339EXPORT_SYMBOL(bio_chain);
340
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700341static void bio_alloc_rescue(struct work_struct *work)
342{
343 struct bio_set *bs = container_of(work, struct bio_set, rescue_work);
344 struct bio *bio;
345
346 while (1) {
347 spin_lock(&bs->rescue_lock);
348 bio = bio_list_pop(&bs->rescue_list);
349 spin_unlock(&bs->rescue_lock);
350
351 if (!bio)
352 break;
353
354 generic_make_request(bio);
355 }
356}
357
358static void punt_bios_to_rescuer(struct bio_set *bs)
359{
360 struct bio_list punt, nopunt;
361 struct bio *bio;
362
NeilBrown47e0fb42017-06-18 14:38:57 +1000363 if (WARN_ON_ONCE(!bs->rescue_workqueue))
364 return;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700365 /*
366 * In order to guarantee forward progress we must punt only bios that
367 * were allocated from this bio_set; otherwise, if there was a bio on
368 * there for a stacking driver higher up in the stack, processing it
369 * could require allocating bios from this bio_set, and doing that from
370 * our own rescuer would be bad.
371 *
372 * Since bio lists are singly linked, pop them all instead of trying to
373 * remove from the middle of the list:
374 */
375
376 bio_list_init(&punt);
377 bio_list_init(&nopunt);
378
NeilBrownf5fe1b52017-03-10 17:00:47 +1100379 while ((bio = bio_list_pop(&current->bio_list[0])))
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700380 bio_list_add(bio->bi_pool == bs ? &punt : &nopunt, bio);
NeilBrownf5fe1b52017-03-10 17:00:47 +1100381 current->bio_list[0] = nopunt;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700382
NeilBrownf5fe1b52017-03-10 17:00:47 +1100383 bio_list_init(&nopunt);
384 while ((bio = bio_list_pop(&current->bio_list[1])))
385 bio_list_add(bio->bi_pool == bs ? &punt : &nopunt, bio);
386 current->bio_list[1] = nopunt;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700387
388 spin_lock(&bs->rescue_lock);
389 bio_list_merge(&bs->rescue_list, &punt);
390 spin_unlock(&bs->rescue_lock);
391
392 queue_work(bs->rescue_workqueue, &bs->rescue_work);
393}
394
Kent Overstreetf44b48c2012-09-06 15:34:58 -0700395/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396 * bio_alloc_bioset - allocate a bio for I/O
Randy Dunlap519c8e92017-10-16 11:01:00 -0700397 * @gfp_mask: the GFP_* mask given to the slab allocator
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398 * @nr_iovecs: number of iovecs to pre-allocate
Jaak Ristiojadb18efa2010-01-15 12:05:07 +0200399 * @bs: the bio_set to allocate from.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 *
401 * Description:
Kent Overstreet3f86a822012-09-06 15:35:01 -0700402 * If @bs is NULL, uses kmalloc() to allocate the bio; else the allocation is
403 * backed by the @bs's mempool.
404 *
Mel Gormand0164ad2015-11-06 16:28:21 -0800405 * When @bs is not NULL, if %__GFP_DIRECT_RECLAIM is set then bio_alloc will
406 * always be able to allocate a bio. This is due to the mempool guarantees.
407 * To make this work, callers must never allocate more than 1 bio at a time
408 * from this pool. Callers that need to allocate more than 1 bio must always
409 * submit the previously allocated bio for IO before attempting to allocate
410 * a new one. Failure to do so can cause deadlocks under memory pressure.
Kent Overstreet3f86a822012-09-06 15:35:01 -0700411 *
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700412 * Note that when running under generic_make_request() (i.e. any block
413 * driver), bios are not submitted until after you return - see the code in
414 * generic_make_request() that converts recursion into iteration, to prevent
415 * stack overflows.
416 *
417 * This would normally mean allocating multiple bios under
418 * generic_make_request() would be susceptible to deadlocks, but we have
419 * deadlock avoidance code that resubmits any blocked bios from a rescuer
420 * thread.
421 *
422 * However, we do not guarantee forward progress for allocations from other
423 * mempools. Doing multiple allocations from the same mempool under
424 * generic_make_request() should be avoided - instead, use bio_set's front_pad
425 * for per bio allocations.
426 *
Kent Overstreet3f86a822012-09-06 15:35:01 -0700427 * RETURNS:
428 * Pointer to new bio on success, NULL on failure.
429 */
Dan Carpenter7a88fa12017-03-23 13:24:55 +0300430struct bio *bio_alloc_bioset(gfp_t gfp_mask, unsigned int nr_iovecs,
431 struct bio_set *bs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432{
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700433 gfp_t saved_gfp = gfp_mask;
Kent Overstreet3f86a822012-09-06 15:35:01 -0700434 unsigned front_pad;
435 unsigned inline_vecs;
Ingo Molnar34053972009-02-21 11:16:36 +0100436 struct bio_vec *bvl = NULL;
Tejun Heo451a9eb2009-04-15 19:50:51 +0200437 struct bio *bio;
438 void *p;
Jens Axboe0a0d96b2008-09-11 13:17:37 +0200439
Kent Overstreet3f86a822012-09-06 15:35:01 -0700440 if (!bs) {
441 if (nr_iovecs > UIO_MAXIOV)
442 return NULL;
443
444 p = kmalloc(sizeof(struct bio) +
445 nr_iovecs * sizeof(struct bio_vec),
446 gfp_mask);
447 front_pad = 0;
448 inline_vecs = nr_iovecs;
449 } else {
Junichi Nomurad8f429e2014-10-03 17:27:12 -0400450 /* should not use nobvec bioset for nr_iovecs > 0 */
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400451 if (WARN_ON_ONCE(!mempool_initialized(&bs->bvec_pool) &&
452 nr_iovecs > 0))
Junichi Nomurad8f429e2014-10-03 17:27:12 -0400453 return NULL;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700454 /*
455 * generic_make_request() converts recursion to iteration; this
456 * means if we're running beneath it, any bios we allocate and
457 * submit will not be submitted (and thus freed) until after we
458 * return.
459 *
460 * This exposes us to a potential deadlock if we allocate
461 * multiple bios from the same bio_set() while running
462 * underneath generic_make_request(). If we were to allocate
463 * multiple bios (say a stacking block driver that was splitting
464 * bios), we would deadlock if we exhausted the mempool's
465 * reserve.
466 *
467 * We solve this, and guarantee forward progress, with a rescuer
468 * workqueue per bio_set. If we go to allocate and there are
469 * bios on current->bio_list, we first try the allocation
Mel Gormand0164ad2015-11-06 16:28:21 -0800470 * without __GFP_DIRECT_RECLAIM; if that fails, we punt those
471 * bios we would be blocking to the rescuer workqueue before
472 * we retry with the original gfp_flags.
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700473 */
474
NeilBrownf5fe1b52017-03-10 17:00:47 +1100475 if (current->bio_list &&
476 (!bio_list_empty(&current->bio_list[0]) ||
NeilBrown47e0fb42017-06-18 14:38:57 +1000477 !bio_list_empty(&current->bio_list[1])) &&
478 bs->rescue_workqueue)
Mel Gormand0164ad2015-11-06 16:28:21 -0800479 gfp_mask &= ~__GFP_DIRECT_RECLAIM;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700480
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400481 p = mempool_alloc(&bs->bio_pool, gfp_mask);
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700482 if (!p && gfp_mask != saved_gfp) {
483 punt_bios_to_rescuer(bs);
484 gfp_mask = saved_gfp;
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400485 p = mempool_alloc(&bs->bio_pool, gfp_mask);
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700486 }
487
Kent Overstreet3f86a822012-09-06 15:35:01 -0700488 front_pad = bs->front_pad;
489 inline_vecs = BIO_INLINE_VECS;
490 }
491
Tejun Heo451a9eb2009-04-15 19:50:51 +0200492 if (unlikely(!p))
493 return NULL;
Ingo Molnar34053972009-02-21 11:16:36 +0100494
Kent Overstreet3f86a822012-09-06 15:35:01 -0700495 bio = p + front_pad;
Ming Lei3a83f462016-11-22 08:57:21 -0700496 bio_init(bio, NULL, 0);
Ingo Molnar34053972009-02-21 11:16:36 +0100497
Kent Overstreet3f86a822012-09-06 15:35:01 -0700498 if (nr_iovecs > inline_vecs) {
Christoph Hellwiged996a52016-07-19 11:28:42 +0200499 unsigned long idx = 0;
500
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400501 bvl = bvec_alloc(gfp_mask, nr_iovecs, &idx, &bs->bvec_pool);
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700502 if (!bvl && gfp_mask != saved_gfp) {
503 punt_bios_to_rescuer(bs);
504 gfp_mask = saved_gfp;
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400505 bvl = bvec_alloc(gfp_mask, nr_iovecs, &idx, &bs->bvec_pool);
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700506 }
507
Ingo Molnar34053972009-02-21 11:16:36 +0100508 if (unlikely(!bvl))
509 goto err_free;
Kent Overstreeta38352e2012-05-25 13:03:11 -0700510
Christoph Hellwiged996a52016-07-19 11:28:42 +0200511 bio->bi_flags |= idx << BVEC_POOL_OFFSET;
Kent Overstreet3f86a822012-09-06 15:35:01 -0700512 } else if (nr_iovecs) {
513 bvl = bio->bi_inline_vecs;
Ingo Molnar34053972009-02-21 11:16:36 +0100514 }
Kent Overstreet3f86a822012-09-06 15:35:01 -0700515
516 bio->bi_pool = bs;
Ingo Molnar34053972009-02-21 11:16:36 +0100517 bio->bi_max_vecs = nr_iovecs;
Ingo Molnar34053972009-02-21 11:16:36 +0100518 bio->bi_io_vec = bvl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 return bio;
Ingo Molnar34053972009-02-21 11:16:36 +0100520
521err_free:
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400522 mempool_free(p, &bs->bio_pool);
Ingo Molnar34053972009-02-21 11:16:36 +0100523 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200525EXPORT_SYMBOL(bio_alloc_bioset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526
Kent Overstreet38a72da2018-05-08 21:33:53 -0400527void zero_fill_bio_iter(struct bio *bio, struct bvec_iter start)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528{
529 unsigned long flags;
Kent Overstreet79886132013-11-23 17:19:00 -0800530 struct bio_vec bv;
531 struct bvec_iter iter;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532
Kent Overstreet38a72da2018-05-08 21:33:53 -0400533 __bio_for_each_segment(bv, bio, iter, start) {
Kent Overstreet79886132013-11-23 17:19:00 -0800534 char *data = bvec_kmap_irq(&bv, &flags);
535 memset(data, 0, bv.bv_len);
536 flush_dcache_page(bv.bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537 bvec_kunmap_irq(data, &flags);
538 }
539}
Kent Overstreet38a72da2018-05-08 21:33:53 -0400540EXPORT_SYMBOL(zero_fill_bio_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541
Ming Lei83c9c542020-01-05 09:41:14 +0800542/**
543 * bio_truncate - truncate the bio to small size of @new_size
544 * @bio: the bio to be truncated
545 * @new_size: new size for truncating the bio
546 *
547 * Description:
548 * Truncate the bio to new size of @new_size. If bio_op(bio) is
549 * REQ_OP_READ, zero the truncated part. This function should only
550 * be used for handling corner cases, such as bio eod.
551 */
Ming Lei85a8ce62019-12-28 07:05:48 +0800552void bio_truncate(struct bio *bio, unsigned new_size)
553{
554 struct bio_vec bv;
555 struct bvec_iter iter;
556 unsigned int done = 0;
557 bool truncated = false;
558
559 if (new_size >= bio->bi_iter.bi_size)
560 return;
561
Ming Lei83c9c542020-01-05 09:41:14 +0800562 if (bio_op(bio) != REQ_OP_READ)
Ming Lei85a8ce62019-12-28 07:05:48 +0800563 goto exit;
564
565 bio_for_each_segment(bv, bio, iter) {
566 if (done + bv.bv_len > new_size) {
567 unsigned offset;
568
569 if (!truncated)
570 offset = new_size - done;
571 else
572 offset = 0;
573 zero_user(bv.bv_page, offset, bv.bv_len - offset);
574 truncated = true;
575 }
576 done += bv.bv_len;
577 }
578
579 exit:
580 /*
581 * Don't touch bvec table here and make it really immutable, since
582 * fs bio user has to retrieve all pages via bio_for_each_segment_all
583 * in its .end_bio() callback.
584 *
585 * It is enough to truncate bio by updating .bi_size since we can make
586 * correct bvec with the updated .bi_size for drivers.
587 */
588 bio->bi_iter.bi_size = new_size;
589}
590
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591/**
Christoph Hellwig29125ed2020-03-25 16:48:40 +0100592 * guard_bio_eod - truncate a BIO to fit the block device
593 * @bio: bio to truncate
594 *
595 * This allows us to do IO even on the odd last sectors of a device, even if the
596 * block size is some multiple of the physical sector size.
597 *
598 * We'll just truncate the bio to the size of the device, and clear the end of
599 * the buffer head manually. Truly out-of-range accesses will turn into actual
600 * I/O errors, this only handles the "we need to be able to do I/O at the final
601 * sector" case.
602 */
603void guard_bio_eod(struct bio *bio)
604{
605 sector_t maxsector;
606 struct hd_struct *part;
607
608 rcu_read_lock();
609 part = __disk_get_part(bio->bi_disk, bio->bi_partno);
610 if (part)
611 maxsector = part_nr_sects_read(part);
612 else
613 maxsector = get_capacity(bio->bi_disk);
614 rcu_read_unlock();
615
616 if (!maxsector)
617 return;
618
619 /*
620 * If the *whole* IO is past the end of the device,
621 * let it through, and the IO layer will turn it into
622 * an EIO.
623 */
624 if (unlikely(bio->bi_iter.bi_sector >= maxsector))
625 return;
626
627 maxsector -= bio->bi_iter.bi_sector;
628 if (likely((bio->bi_iter.bi_size >> 9) <= maxsector))
629 return;
630
631 bio_truncate(bio, maxsector << 9);
632}
633
634/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700635 * bio_put - release a reference to a bio
636 * @bio: bio to release reference to
637 *
638 * Description:
639 * Put a reference to a &struct bio, either one you have gotten with
NeilBrown9b10f6a2017-06-18 14:38:59 +1000640 * bio_alloc, bio_get or bio_clone_*. The last put of a bio will free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 **/
642void bio_put(struct bio *bio)
643{
Jens Axboedac56212015-04-17 16:23:59 -0600644 if (!bio_flagged(bio, BIO_REFFED))
Kent Overstreet4254bba2012-09-06 15:35:00 -0700645 bio_free(bio);
Jens Axboedac56212015-04-17 16:23:59 -0600646 else {
647 BIO_BUG_ON(!atomic_read(&bio->__bi_cnt));
648
649 /*
650 * last put frees it
651 */
652 if (atomic_dec_and_test(&bio->__bi_cnt))
653 bio_free(bio);
654 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200656EXPORT_SYMBOL(bio_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658/**
Kent Overstreet59d276f2013-11-23 18:19:27 -0800659 * __bio_clone_fast - clone a bio that shares the original bio's biovec
660 * @bio: destination bio
661 * @bio_src: bio to clone
662 *
663 * Clone a &bio. Caller will own the returned bio, but not
664 * the actual data it points to. Reference count of returned
665 * bio will be one.
666 *
667 * Caller must ensure that @bio_src is not freed before @bio.
668 */
669void __bio_clone_fast(struct bio *bio, struct bio *bio_src)
670{
Christoph Hellwiged996a52016-07-19 11:28:42 +0200671 BUG_ON(bio->bi_pool && BVEC_POOL_IDX(bio));
Kent Overstreet59d276f2013-11-23 18:19:27 -0800672
673 /*
Christoph Hellwig74d46992017-08-23 19:10:32 +0200674 * most users will be overriding ->bi_disk with a new target,
Kent Overstreet59d276f2013-11-23 18:19:27 -0800675 * so we don't set nor calculate new physical/hw segment counts here
676 */
Christoph Hellwig74d46992017-08-23 19:10:32 +0200677 bio->bi_disk = bio_src->bi_disk;
Michael Lyle62530ed2017-11-16 23:47:25 -0800678 bio->bi_partno = bio_src->bi_partno;
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600679 bio_set_flag(bio, BIO_CLONED);
Shaohua Li111be882017-12-20 11:10:17 -0700680 if (bio_flagged(bio_src, BIO_THROTTLED))
681 bio_set_flag(bio, BIO_THROTTLED);
Jens Axboe1eff9d32016-08-05 15:35:16 -0600682 bio->bi_opf = bio_src->bi_opf;
Hannes Reineckeca474b72018-11-12 10:35:25 -0700683 bio->bi_ioprio = bio_src->bi_ioprio;
Jens Axboecb6934f2017-06-27 09:22:02 -0600684 bio->bi_write_hint = bio_src->bi_write_hint;
Kent Overstreet59d276f2013-11-23 18:19:27 -0800685 bio->bi_iter = bio_src->bi_iter;
686 bio->bi_io_vec = bio_src->bi_io_vec;
Paolo Valente20bd7232016-07-27 07:22:05 +0200687
Dennis Zhoudb6638d2018-12-05 12:10:35 -0500688 bio_clone_blkg_association(bio, bio_src);
Dennis Zhoue439bed2018-12-05 12:10:32 -0500689 blkcg_bio_issue_init(bio);
Kent Overstreet59d276f2013-11-23 18:19:27 -0800690}
691EXPORT_SYMBOL(__bio_clone_fast);
692
693/**
694 * bio_clone_fast - clone a bio that shares the original bio's biovec
695 * @bio: bio to clone
696 * @gfp_mask: allocation priority
697 * @bs: bio_set to allocate from
698 *
699 * Like __bio_clone_fast, only also allocates the returned bio
700 */
701struct bio *bio_clone_fast(struct bio *bio, gfp_t gfp_mask, struct bio_set *bs)
702{
703 struct bio *b;
704
705 b = bio_alloc_bioset(gfp_mask, 0, bs);
706 if (!b)
707 return NULL;
708
709 __bio_clone_fast(b, bio);
710
711 if (bio_integrity(bio)) {
712 int ret;
713
714 ret = bio_integrity_clone(b, bio, gfp_mask);
715
716 if (ret < 0) {
717 bio_put(b);
718 return NULL;
719 }
720 }
721
722 return b;
723}
724EXPORT_SYMBOL(bio_clone_fast);
725
Christoph Hellwig5cbd28e2020-03-24 08:25:12 +0100726const char *bio_devname(struct bio *bio, char *buf)
727{
728 return disk_name(bio->bi_disk, bio->bi_partno, buf);
729}
730EXPORT_SYMBOL(bio_devname);
731
Ming Lei59194822019-03-17 18:01:07 +0800732static inline bool page_is_mergeable(const struct bio_vec *bv,
733 struct page *page, unsigned int len, unsigned int off,
Christoph Hellwigff896732019-06-17 11:14:11 +0200734 bool *same_page)
Ming Lei59194822019-03-17 18:01:07 +0800735{
736 phys_addr_t vec_end_addr = page_to_phys(bv->bv_page) +
737 bv->bv_offset + bv->bv_len - 1;
738 phys_addr_t page_addr = page_to_phys(page);
739
740 if (vec_end_addr + 1 != page_addr + off)
741 return false;
742 if (xen_domain() && !xen_biovec_phys_mergeable(bv, page))
743 return false;
Christoph Hellwig52d52d12019-04-11 08:23:31 +0200744
Christoph Hellwigff896732019-06-17 11:14:11 +0200745 *same_page = ((vec_end_addr & PAGE_MASK) == page_addr);
746 if (!*same_page && pfn_to_page(PFN_DOWN(vec_end_addr)) + 1 != page)
747 return false;
Ming Lei59194822019-03-17 18:01:07 +0800748 return true;
749}
750
Christoph Hellwig384209c2019-08-12 17:39:57 +0200751static bool bio_try_merge_pc_page(struct request_queue *q, struct bio *bio,
752 struct page *page, unsigned len, unsigned offset,
753 bool *same_page)
Ming Lei489fbbc2019-03-29 15:08:00 +0800754{
Christoph Hellwig384209c2019-08-12 17:39:57 +0200755 struct bio_vec *bv = &bio->bi_io_vec[bio->bi_vcnt - 1];
Ming Lei489fbbc2019-03-29 15:08:00 +0800756 unsigned long mask = queue_segment_boundary(q);
757 phys_addr_t addr1 = page_to_phys(bv->bv_page) + bv->bv_offset;
758 phys_addr_t addr2 = page_to_phys(page) + offset + len - 1;
759
760 if ((addr1 | mask) != (addr2 | mask))
761 return false;
Ming Lei489fbbc2019-03-29 15:08:00 +0800762 if (bv->bv_len + len > queue_max_segment_size(q))
763 return false;
Christoph Hellwig384209c2019-08-12 17:39:57 +0200764 return __bio_try_merge_page(bio, page, len, offset, same_page);
Ming Lei489fbbc2019-03-29 15:08:00 +0800765}
766
Shaohua Lif4595872017-03-24 10:34:43 -0700767/**
Ming Lei19047082019-03-17 18:01:08 +0800768 * __bio_add_pc_page - attempt to add page to passthrough bio
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800769 * @q: the target queue
770 * @bio: destination bio
771 * @page: page to add
772 * @len: vec entry length
773 * @offset: vec entry offset
Christoph Hellwigd1916c82019-08-12 17:39:58 +0200774 * @same_page: return if the merge happen inside the same page
Linus Torvalds1da177e2005-04-16 15:20:36 -0700775 *
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800776 * Attempt to add a page to the bio_vec maplist. This can fail for a
777 * number of reasons, such as the bio being full or target block device
778 * limitations. The target block device must allow bio's up to PAGE_SIZE,
779 * so it is always possible to add a single page to an empty bio.
780 *
Ming Lei5a8ce242019-03-17 18:01:06 +0800781 * This should only be used by passthrough bios.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 */
Christoph Hellwig47138392019-04-25 09:04:33 +0200783static int __bio_add_pc_page(struct request_queue *q, struct bio *bio,
Ming Lei19047082019-03-17 18:01:08 +0800784 struct page *page, unsigned int len, unsigned int offset,
Christoph Hellwigd1916c82019-08-12 17:39:58 +0200785 bool *same_page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700786{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700787 struct bio_vec *bvec;
788
789 /*
790 * cloned bio must not modify vec list
791 */
792 if (unlikely(bio_flagged(bio, BIO_CLONED)))
793 return 0;
794
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800795 if (((bio->bi_iter.bi_size + len) >> 9) > queue_max_hw_sectors(q))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796 return 0;
797
Jens Axboe80cfd542006-01-06 09:43:28 +0100798 if (bio->bi_vcnt > 0) {
Christoph Hellwigd1916c82019-08-12 17:39:58 +0200799 if (bio_try_merge_pc_page(q, bio, page, len, offset, same_page))
Christoph Hellwig384209c2019-08-12 17:39:57 +0200800 return len;
Christoph Hellwig320ea862019-08-12 17:39:56 +0200801
802 /*
803 * If the queue doesn't support SG gaps and adding this segment
804 * would create a gap, disallow it.
805 */
Christoph Hellwig384209c2019-08-12 17:39:57 +0200806 bvec = &bio->bi_io_vec[bio->bi_vcnt - 1];
Christoph Hellwig320ea862019-08-12 17:39:56 +0200807 if (bvec_gap_to_prev(q, bvec, offset))
808 return 0;
Jens Axboe80cfd542006-01-06 09:43:28 +0100809 }
810
Ming Lei79d08f82019-07-01 15:14:46 +0800811 if (bio_full(bio, len))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812 return 0;
813
Christoph Hellwig14ccb662019-06-06 12:29:01 +0200814 if (bio->bi_vcnt >= queue_max_segments(q))
Ming Lei489fbbc2019-03-29 15:08:00 +0800815 return 0;
816
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817 bvec = &bio->bi_io_vec[bio->bi_vcnt];
818 bvec->bv_page = page;
819 bvec->bv_len = len;
820 bvec->bv_offset = offset;
Maurizio Lombardifcbf6a02014-12-10 14:16:53 -0800821 bio->bi_vcnt++;
Christoph Hellwigdcdca752019-04-25 09:04:35 +0200822 bio->bi_iter.bi_size += len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823 return len;
824}
Ming Lei19047082019-03-17 18:01:08 +0800825
826int bio_add_pc_page(struct request_queue *q, struct bio *bio,
827 struct page *page, unsigned int len, unsigned int offset)
828{
Christoph Hellwigd1916c82019-08-12 17:39:58 +0200829 bool same_page = false;
830 return __bio_add_pc_page(q, bio, page, len, offset, &same_page);
Ming Lei19047082019-03-17 18:01:08 +0800831}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200832EXPORT_SYMBOL(bio_add_pc_page);
Mike Christie6e68af62005-11-11 05:30:27 -0600833
834/**
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700835 * __bio_try_merge_page - try appending data to an existing bvec.
836 * @bio: destination bio
Ming Lei551879a2019-04-23 10:51:04 +0800837 * @page: start page to add
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700838 * @len: length of the data to add
Ming Lei551879a2019-04-23 10:51:04 +0800839 * @off: offset of the data relative to @page
Christoph Hellwigff896732019-06-17 11:14:11 +0200840 * @same_page: return if the segment has been merged inside the same page
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700841 *
842 * Try to add the data at @page + @off to the last bvec of @bio. This is a
843 * a useful optimisation for file systems with a block size smaller than the
844 * page size.
845 *
Ming Lei551879a2019-04-23 10:51:04 +0800846 * Warn if (@len, @off) crosses pages in case that @same_page is true.
847 *
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700848 * Return %true on success or %false on failure.
849 */
850bool __bio_try_merge_page(struct bio *bio, struct page *page,
Christoph Hellwigff896732019-06-17 11:14:11 +0200851 unsigned int len, unsigned int off, bool *same_page)
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700852{
853 if (WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED)))
854 return false;
855
Andreas Gruenbachercc90bc62019-12-09 20:11:14 +0100856 if (bio->bi_vcnt > 0) {
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700857 struct bio_vec *bv = &bio->bi_io_vec[bio->bi_vcnt - 1];
858
Ming Lei59194822019-03-17 18:01:07 +0800859 if (page_is_mergeable(bv, page, len, off, same_page)) {
Andreas Gruenbachercc90bc62019-12-09 20:11:14 +0100860 if (bio->bi_iter.bi_size > UINT_MAX - len)
861 return false;
Ming Lei59194822019-03-17 18:01:07 +0800862 bv->bv_len += len;
863 bio->bi_iter.bi_size += len;
864 return true;
865 }
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700866 }
867 return false;
868}
869EXPORT_SYMBOL_GPL(__bio_try_merge_page);
870
871/**
Ming Lei551879a2019-04-23 10:51:04 +0800872 * __bio_add_page - add page(s) to a bio in a new segment
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700873 * @bio: destination bio
Ming Lei551879a2019-04-23 10:51:04 +0800874 * @page: start page to add
875 * @len: length of the data to add, may cross pages
876 * @off: offset of the data relative to @page, may cross pages
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700877 *
878 * Add the data at @page + @off to @bio as a new bvec. The caller must ensure
879 * that @bio has space for another bvec.
880 */
881void __bio_add_page(struct bio *bio, struct page *page,
882 unsigned int len, unsigned int off)
883{
884 struct bio_vec *bv = &bio->bi_io_vec[bio->bi_vcnt];
885
886 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
Ming Lei79d08f82019-07-01 15:14:46 +0800887 WARN_ON_ONCE(bio_full(bio, len));
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700888
889 bv->bv_page = page;
890 bv->bv_offset = off;
891 bv->bv_len = len;
892
893 bio->bi_iter.bi_size += len;
894 bio->bi_vcnt++;
Johannes Weinerb8e24a92019-08-08 15:03:00 -0400895
896 if (!bio_flagged(bio, BIO_WORKINGSET) && unlikely(PageWorkingset(page)))
897 bio_set_flag(bio, BIO_WORKINGSET);
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700898}
899EXPORT_SYMBOL_GPL(__bio_add_page);
900
901/**
Ming Lei551879a2019-04-23 10:51:04 +0800902 * bio_add_page - attempt to add page(s) to bio
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903 * @bio: destination bio
Ming Lei551879a2019-04-23 10:51:04 +0800904 * @page: start page to add
905 * @len: vec entry length, may cross pages
906 * @offset: vec entry offset relative to @page, may cross pages
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907 *
Ming Lei551879a2019-04-23 10:51:04 +0800908 * Attempt to add page(s) to the bio_vec maplist. This will only fail
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800909 * if either bio->bi_vcnt == bio->bi_max_vecs or it's a cloned bio.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910 */
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800911int bio_add_page(struct bio *bio, struct page *page,
912 unsigned int len, unsigned int offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913{
Christoph Hellwigff896732019-06-17 11:14:11 +0200914 bool same_page = false;
915
916 if (!__bio_try_merge_page(bio, page, len, offset, &same_page)) {
Ming Lei79d08f82019-07-01 15:14:46 +0800917 if (bio_full(bio, len))
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700918 return 0;
919 __bio_add_page(bio, page, len, offset);
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800920 }
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800921 return len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200923EXPORT_SYMBOL(bio_add_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924
Christoph Hellwigd241a952019-06-26 15:49:21 +0200925void bio_release_pages(struct bio *bio, bool mark_dirty)
Christoph Hellwig7321ecb2019-04-11 08:23:30 +0200926{
927 struct bvec_iter_all iter_all;
928 struct bio_vec *bvec;
Christoph Hellwig7321ecb2019-04-11 08:23:30 +0200929
Christoph Hellwigb2d0d992019-06-26 15:49:20 +0200930 if (bio_flagged(bio, BIO_NO_PAGE_REF))
931 return;
932
Christoph Hellwigd241a952019-06-26 15:49:21 +0200933 bio_for_each_segment_all(bvec, bio, iter_all) {
934 if (mark_dirty && !PageCompound(bvec->bv_page))
935 set_page_dirty_lock(bvec->bv_page);
Christoph Hellwig7321ecb2019-04-11 08:23:30 +0200936 put_page(bvec->bv_page);
Christoph Hellwigd241a952019-06-26 15:49:21 +0200937 }
Christoph Hellwig7321ecb2019-04-11 08:23:30 +0200938}
939
Jens Axboe6d0c48a2018-11-30 08:47:03 -0700940static int __bio_iov_bvec_add_pages(struct bio *bio, struct iov_iter *iter)
941{
942 const struct bio_vec *bv = iter->bvec;
943 unsigned int len;
944 size_t size;
945
946 if (WARN_ON_ONCE(iter->iov_offset > bv->bv_len))
947 return -EINVAL;
948
949 len = min_t(size_t, bv->bv_len - iter->iov_offset, iter->count);
950 size = bio_add_page(bio, bv->bv_page, len,
951 bv->bv_offset + iter->iov_offset);
Christoph Hellwiga10584c2019-04-11 08:23:28 +0200952 if (unlikely(size != len))
953 return -EINVAL;
Christoph Hellwiga10584c2019-04-11 08:23:28 +0200954 iov_iter_advance(iter, size);
955 return 0;
Jens Axboe6d0c48a2018-11-30 08:47:03 -0700956}
957
Christoph Hellwig576ed912018-09-20 08:28:21 +0200958#define PAGE_PTRS_PER_BVEC (sizeof(struct bio_vec) / sizeof(struct page *))
959
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600960/**
Martin Wilck17d51b12018-07-25 23:15:09 +0200961 * __bio_iov_iter_get_pages - pin user or kernel pages and add them to a bio
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600962 * @bio: bio to add pages to
963 * @iter: iov iterator describing the region to be mapped
964 *
Martin Wilck17d51b12018-07-25 23:15:09 +0200965 * Pins pages from *iter and appends them to @bio's bvec array. The
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600966 * pages will have to be released using put_page() when done.
Martin Wilck17d51b12018-07-25 23:15:09 +0200967 * For multi-segment *iter, this function only adds pages from the
968 * the next non-empty segment of the iov iterator.
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600969 */
Martin Wilck17d51b12018-07-25 23:15:09 +0200970static int __bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter)
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600971{
Christoph Hellwig576ed912018-09-20 08:28:21 +0200972 unsigned short nr_pages = bio->bi_max_vecs - bio->bi_vcnt;
973 unsigned short entries_left = bio->bi_max_vecs - bio->bi_vcnt;
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600974 struct bio_vec *bv = bio->bi_io_vec + bio->bi_vcnt;
975 struct page **pages = (struct page **)bv;
Christoph Hellwig45691802019-06-17 11:14:12 +0200976 bool same_page = false;
Christoph Hellwig576ed912018-09-20 08:28:21 +0200977 ssize_t size, left;
978 unsigned len, i;
Martin Wilckb403ea22018-07-25 23:15:07 +0200979 size_t offset;
Christoph Hellwig576ed912018-09-20 08:28:21 +0200980
981 /*
982 * Move page array up in the allocated memory for the bio vecs as far as
983 * possible so that we can start filling biovecs from the beginning
984 * without overwriting the temporary page array.
985 */
986 BUILD_BUG_ON(PAGE_PTRS_PER_BVEC < 2);
987 pages += entries_left * (PAGE_PTRS_PER_BVEC - 1);
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600988
989 size = iov_iter_get_pages(iter, pages, LONG_MAX, nr_pages, &offset);
990 if (unlikely(size <= 0))
991 return size ? size : -EFAULT;
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600992
Christoph Hellwig576ed912018-09-20 08:28:21 +0200993 for (left = size, i = 0; left > 0; left -= len, i++) {
994 struct page *page = pages[i];
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600995
Christoph Hellwig576ed912018-09-20 08:28:21 +0200996 len = min_t(size_t, PAGE_SIZE - offset, left);
Christoph Hellwig45691802019-06-17 11:14:12 +0200997
998 if (__bio_try_merge_page(bio, page, len, offset, &same_page)) {
999 if (same_page)
1000 put_page(page);
1001 } else {
Ming Lei79d08f82019-07-01 15:14:46 +08001002 if (WARN_ON_ONCE(bio_full(bio, len)))
Christoph Hellwig45691802019-06-17 11:14:12 +02001003 return -EINVAL;
1004 __bio_add_page(bio, page, len, offset);
1005 }
Christoph Hellwig576ed912018-09-20 08:28:21 +02001006 offset = 0;
Kent Overstreet2cefe4d2016-10-31 11:59:24 -06001007 }
1008
Kent Overstreet2cefe4d2016-10-31 11:59:24 -06001009 iov_iter_advance(iter, size);
1010 return 0;
1011}
Martin Wilck17d51b12018-07-25 23:15:09 +02001012
1013/**
Jens Axboe6d0c48a2018-11-30 08:47:03 -07001014 * bio_iov_iter_get_pages - add user or kernel pages to a bio
Martin Wilck17d51b12018-07-25 23:15:09 +02001015 * @bio: bio to add pages to
Jens Axboe6d0c48a2018-11-30 08:47:03 -07001016 * @iter: iov iterator describing the region to be added
Martin Wilck17d51b12018-07-25 23:15:09 +02001017 *
Jens Axboe6d0c48a2018-11-30 08:47:03 -07001018 * This takes either an iterator pointing to user memory, or one pointing to
1019 * kernel pages (BVEC iterator). If we're adding user pages, we pin them and
1020 * map them into the kernel. On IO completion, the caller should put those
Jens Axboe399254a2019-02-27 13:13:23 -07001021 * pages. If we're adding kernel pages, and the caller told us it's safe to
1022 * do so, we just have to add the pages to the bio directly. We don't grab an
1023 * extra reference to those pages (the user should already have that), and we
1024 * don't put the page on IO completion. The caller needs to check if the bio is
1025 * flagged BIO_NO_PAGE_REF on IO completion. If it isn't, then pages should be
1026 * released.
Jens Axboe6d0c48a2018-11-30 08:47:03 -07001027 *
Martin Wilck17d51b12018-07-25 23:15:09 +02001028 * The function tries, but does not guarantee, to pin as many pages as
Jens Axboe6d0c48a2018-11-30 08:47:03 -07001029 * fit into the bio, or are requested in *iter, whatever is smaller. If
1030 * MM encounters an error pinning the requested pages, it stops. Error
1031 * is returned only if 0 pages could be pinned.
Martin Wilck17d51b12018-07-25 23:15:09 +02001032 */
1033int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter)
1034{
Jens Axboe6d0c48a2018-11-30 08:47:03 -07001035 const bool is_bvec = iov_iter_is_bvec(iter);
Christoph Hellwig14eacf12019-04-11 08:23:29 +02001036 int ret;
1037
1038 if (WARN_ON_ONCE(bio->bi_vcnt))
1039 return -EINVAL;
Martin Wilck17d51b12018-07-25 23:15:09 +02001040
1041 do {
Jens Axboe6d0c48a2018-11-30 08:47:03 -07001042 if (is_bvec)
1043 ret = __bio_iov_bvec_add_pages(bio, iter);
1044 else
1045 ret = __bio_iov_iter_get_pages(bio, iter);
Ming Lei79d08f82019-07-01 15:14:46 +08001046 } while (!ret && iov_iter_count(iter) && !bio_full(bio, 0));
Martin Wilck17d51b12018-07-25 23:15:09 +02001047
Christoph Hellwigb6207432019-06-26 15:49:28 +02001048 if (is_bvec)
Christoph Hellwig7321ecb2019-04-11 08:23:30 +02001049 bio_set_flag(bio, BIO_NO_PAGE_REF);
Christoph Hellwig14eacf12019-04-11 08:23:29 +02001050 return bio->bi_vcnt ? 0 : ret;
Martin Wilck17d51b12018-07-25 23:15:09 +02001051}
Kent Overstreet2cefe4d2016-10-31 11:59:24 -06001052
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001053static void submit_bio_wait_endio(struct bio *bio)
Kent Overstreet9e882242012-09-10 14:41:12 -07001054{
Christoph Hellwig65e53aa2017-10-25 17:55:57 +09001055 complete(bio->bi_private);
Kent Overstreet9e882242012-09-10 14:41:12 -07001056}
1057
1058/**
1059 * submit_bio_wait - submit a bio, and wait until it completes
Kent Overstreet9e882242012-09-10 14:41:12 -07001060 * @bio: The &struct bio which describes the I/O
1061 *
1062 * Simple wrapper around submit_bio(). Returns 0 on success, or the error from
1063 * bio_endio() on failure.
Jan Kara3d289d62017-08-02 10:25:21 +02001064 *
1065 * WARNING: Unlike to how submit_bio() is usually used, this function does not
1066 * result in bio reference to be consumed. The caller must drop the reference
1067 * on his own.
Kent Overstreet9e882242012-09-10 14:41:12 -07001068 */
Mike Christie4e49ea42016-06-05 14:31:41 -05001069int submit_bio_wait(struct bio *bio)
Kent Overstreet9e882242012-09-10 14:41:12 -07001070{
Byungchul Parke319e1f2017-10-25 17:56:05 +09001071 DECLARE_COMPLETION_ONSTACK_MAP(done, bio->bi_disk->lockdep_map);
Ming Leide6a78b2020-03-18 11:43:36 +08001072 unsigned long hang_check;
Kent Overstreet9e882242012-09-10 14:41:12 -07001073
Christoph Hellwig65e53aa2017-10-25 17:55:57 +09001074 bio->bi_private = &done;
Kent Overstreet9e882242012-09-10 14:41:12 -07001075 bio->bi_end_io = submit_bio_wait_endio;
Jens Axboe1eff9d32016-08-05 15:35:16 -06001076 bio->bi_opf |= REQ_SYNC;
Mike Christie4e49ea42016-06-05 14:31:41 -05001077 submit_bio(bio);
Ming Leide6a78b2020-03-18 11:43:36 +08001078
1079 /* Prevent hang_check timer from firing at us during very long I/O */
1080 hang_check = sysctl_hung_task_timeout_secs;
1081 if (hang_check)
1082 while (!wait_for_completion_io_timeout(&done,
1083 hang_check * (HZ/2)))
1084 ;
1085 else
1086 wait_for_completion_io(&done);
Kent Overstreet9e882242012-09-10 14:41:12 -07001087
Christoph Hellwig65e53aa2017-10-25 17:55:57 +09001088 return blk_status_to_errno(bio->bi_status);
Kent Overstreet9e882242012-09-10 14:41:12 -07001089}
1090EXPORT_SYMBOL(submit_bio_wait);
1091
Kent Overstreet054bdf62012-09-28 13:17:55 -07001092/**
1093 * bio_advance - increment/complete a bio by some number of bytes
1094 * @bio: bio to advance
1095 * @bytes: number of bytes to complete
1096 *
1097 * This updates bi_sector, bi_size and bi_idx; if the number of bytes to
1098 * complete doesn't align with a bvec boundary, then bv_len and bv_offset will
1099 * be updated on the last bvec as well.
1100 *
1101 * @bio will then represent the remaining, uncompleted portion of the io.
1102 */
1103void bio_advance(struct bio *bio, unsigned bytes)
1104{
1105 if (bio_integrity(bio))
1106 bio_integrity_advance(bio, bytes);
1107
Kent Overstreet4550dd62013-08-07 14:26:21 -07001108 bio_advance_iter(bio, &bio->bi_iter, bytes);
Kent Overstreet054bdf62012-09-28 13:17:55 -07001109}
1110EXPORT_SYMBOL(bio_advance);
1111
Kent Overstreet45db54d2018-05-08 21:33:54 -04001112void bio_copy_data_iter(struct bio *dst, struct bvec_iter *dst_iter,
1113 struct bio *src, struct bvec_iter *src_iter)
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001114{
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001115 struct bio_vec src_bv, dst_bv;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001116 void *src_p, *dst_p;
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001117 unsigned bytes;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001118
Kent Overstreet45db54d2018-05-08 21:33:54 -04001119 while (src_iter->bi_size && dst_iter->bi_size) {
1120 src_bv = bio_iter_iovec(src, *src_iter);
1121 dst_bv = bio_iter_iovec(dst, *dst_iter);
1122
1123 bytes = min(src_bv.bv_len, dst_bv.bv_len);
1124
1125 src_p = kmap_atomic(src_bv.bv_page);
1126 dst_p = kmap_atomic(dst_bv.bv_page);
1127
1128 memcpy(dst_p + dst_bv.bv_offset,
1129 src_p + src_bv.bv_offset,
1130 bytes);
1131
1132 kunmap_atomic(dst_p);
1133 kunmap_atomic(src_p);
1134
Kent Overstreet6e6e8112018-05-08 21:33:55 -04001135 flush_dcache_page(dst_bv.bv_page);
1136
Kent Overstreet45db54d2018-05-08 21:33:54 -04001137 bio_advance_iter(src, src_iter, bytes);
1138 bio_advance_iter(dst, dst_iter, bytes);
1139 }
1140}
1141EXPORT_SYMBOL(bio_copy_data_iter);
1142
1143/**
1144 * bio_copy_data - copy contents of data buffers from one bio to another
1145 * @src: source bio
1146 * @dst: destination bio
1147 *
1148 * Stops when it reaches the end of either @src or @dst - that is, copies
1149 * min(src->bi_size, dst->bi_size) bytes (or the equivalent for lists of bios).
1150 */
1151void bio_copy_data(struct bio *dst, struct bio *src)
1152{
1153 struct bvec_iter src_iter = src->bi_iter;
1154 struct bvec_iter dst_iter = dst->bi_iter;
1155
1156 bio_copy_data_iter(dst, &dst_iter, src, &src_iter);
1157}
1158EXPORT_SYMBOL(bio_copy_data);
1159
1160/**
1161 * bio_list_copy_data - copy contents of data buffers from one chain of bios to
1162 * another
1163 * @src: source bio list
1164 * @dst: destination bio list
1165 *
1166 * Stops when it reaches the end of either the @src list or @dst list - that is,
1167 * copies min(src->bi_size, dst->bi_size) bytes (or the equivalent for lists of
1168 * bios).
1169 */
1170void bio_list_copy_data(struct bio *dst, struct bio *src)
1171{
1172 struct bvec_iter src_iter = src->bi_iter;
1173 struct bvec_iter dst_iter = dst->bi_iter;
1174
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001175 while (1) {
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001176 if (!src_iter.bi_size) {
1177 src = src->bi_next;
1178 if (!src)
1179 break;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001180
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001181 src_iter = src->bi_iter;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001182 }
1183
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001184 if (!dst_iter.bi_size) {
1185 dst = dst->bi_next;
1186 if (!dst)
1187 break;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001188
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001189 dst_iter = dst->bi_iter;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001190 }
1191
Kent Overstreet45db54d2018-05-08 21:33:54 -04001192 bio_copy_data_iter(dst, &dst_iter, src, &src_iter);
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001193 }
1194}
Kent Overstreet45db54d2018-05-08 21:33:54 -04001195EXPORT_SYMBOL(bio_list_copy_data);
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001196
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197struct bio_map_data {
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001198 int is_our_pages;
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001199 struct iov_iter iter;
1200 struct iovec iov[];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201};
1202
Al Viro0e5b9352017-09-24 13:14:35 -04001203static struct bio_map_data *bio_alloc_map_data(struct iov_iter *data,
FUJITA Tomonori76029ff2008-08-25 20:36:08 +02001204 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001205{
Al Viro0e5b9352017-09-24 13:14:35 -04001206 struct bio_map_data *bmd;
1207 if (data->nr_segs > UIO_MAXIOV)
Jens Axboef3f63c12010-10-29 11:46:56 -06001208 return NULL;
1209
Gustavo A. R. Silvaf1f8f292019-06-10 10:04:12 -05001210 bmd = kmalloc(struct_size(bmd, iov, data->nr_segs), gfp_mask);
Al Viro0e5b9352017-09-24 13:14:35 -04001211 if (!bmd)
1212 return NULL;
1213 memcpy(bmd->iov, data->iov, sizeof(struct iovec) * data->nr_segs);
1214 bmd->iter = *data;
1215 bmd->iter.iov = bmd->iov;
1216 return bmd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001217}
1218
Dongsu Park9124d3f2015-01-18 16:16:34 +01001219/**
1220 * bio_copy_from_iter - copy all pages from iov_iter to bio
1221 * @bio: The &struct bio which describes the I/O as destination
1222 * @iter: iov_iter as source
1223 *
1224 * Copy all pages from iov_iter to bio.
1225 * Returns 0 on success, or error on failure.
1226 */
Al Viro98a09d62017-09-24 12:14:36 -04001227static int bio_copy_from_iter(struct bio *bio, struct iov_iter *iter)
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001228{
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001229 struct bio_vec *bvec;
Ming Lei6dc4f102019-02-15 19:13:19 +08001230 struct bvec_iter_all iter_all;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001231
Christoph Hellwig2b070cf2019-04-25 09:03:00 +02001232 bio_for_each_segment_all(bvec, bio, iter_all) {
Dongsu Park9124d3f2015-01-18 16:16:34 +01001233 ssize_t ret;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001234
Dongsu Park9124d3f2015-01-18 16:16:34 +01001235 ret = copy_page_from_iter(bvec->bv_page,
1236 bvec->bv_offset,
1237 bvec->bv_len,
Al Viro98a09d62017-09-24 12:14:36 -04001238 iter);
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001239
Al Viro98a09d62017-09-24 12:14:36 -04001240 if (!iov_iter_count(iter))
Dongsu Park9124d3f2015-01-18 16:16:34 +01001241 break;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001242
Dongsu Park9124d3f2015-01-18 16:16:34 +01001243 if (ret < bvec->bv_len)
1244 return -EFAULT;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001245 }
1246
Dongsu Park9124d3f2015-01-18 16:16:34 +01001247 return 0;
1248}
1249
1250/**
1251 * bio_copy_to_iter - copy all pages from bio to iov_iter
1252 * @bio: The &struct bio which describes the I/O as source
1253 * @iter: iov_iter as destination
1254 *
1255 * Copy all pages from bio to iov_iter.
1256 * Returns 0 on success, or error on failure.
1257 */
1258static int bio_copy_to_iter(struct bio *bio, struct iov_iter iter)
1259{
Dongsu Park9124d3f2015-01-18 16:16:34 +01001260 struct bio_vec *bvec;
Ming Lei6dc4f102019-02-15 19:13:19 +08001261 struct bvec_iter_all iter_all;
Dongsu Park9124d3f2015-01-18 16:16:34 +01001262
Christoph Hellwig2b070cf2019-04-25 09:03:00 +02001263 bio_for_each_segment_all(bvec, bio, iter_all) {
Dongsu Park9124d3f2015-01-18 16:16:34 +01001264 ssize_t ret;
1265
1266 ret = copy_page_to_iter(bvec->bv_page,
1267 bvec->bv_offset,
1268 bvec->bv_len,
1269 &iter);
1270
1271 if (!iov_iter_count(&iter))
1272 break;
1273
1274 if (ret < bvec->bv_len)
1275 return -EFAULT;
1276 }
1277
1278 return 0;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001279}
1280
Guoqing Jiang491221f2016-09-22 03:10:01 -04001281void bio_free_pages(struct bio *bio)
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001282{
1283 struct bio_vec *bvec;
Ming Lei6dc4f102019-02-15 19:13:19 +08001284 struct bvec_iter_all iter_all;
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001285
Christoph Hellwig2b070cf2019-04-25 09:03:00 +02001286 bio_for_each_segment_all(bvec, bio, iter_all)
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001287 __free_page(bvec->bv_page);
1288}
Guoqing Jiang491221f2016-09-22 03:10:01 -04001289EXPORT_SYMBOL(bio_free_pages);
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001290
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291/**
1292 * bio_uncopy_user - finish previously mapped bio
1293 * @bio: bio being terminated
1294 *
Christoph Hellwigddad8dd2015-01-18 16:16:29 +01001295 * Free pages allocated from bio_copy_user_iov() and write back data
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 * to user space in case of a read.
1297 */
1298int bio_uncopy_user(struct bio *bio)
1299{
1300 struct bio_map_data *bmd = bio->bi_private;
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001301 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302
Roland Dreier35dc2482013-08-05 17:55:01 -07001303 if (!bio_flagged(bio, BIO_NULL_MAPPED)) {
1304 /*
1305 * if we're in a workqueue, the request is orphaned, so
Hannes Reinecke2d99b552016-02-12 09:39:15 +01001306 * don't copy into a random user address space, just free
1307 * and return -EINTR so user space doesn't expect any data.
Roland Dreier35dc2482013-08-05 17:55:01 -07001308 */
Hannes Reinecke2d99b552016-02-12 09:39:15 +01001309 if (!current->mm)
1310 ret = -EINTR;
1311 else if (bio_data_dir(bio) == READ)
Dongsu Park9124d3f2015-01-18 16:16:34 +01001312 ret = bio_copy_to_iter(bio, bmd->iter);
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001313 if (bmd->is_our_pages)
1314 bio_free_pages(bio);
Roland Dreier35dc2482013-08-05 17:55:01 -07001315 }
Kent Overstreetc8db4442013-11-22 19:39:06 -08001316 kfree(bmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001317 bio_put(bio);
1318 return ret;
1319}
1320
1321/**
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001322 * bio_copy_user_iov - copy user data to bio
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001323 * @q: destination block queue
1324 * @map_data: pointer to the rq_map_data holding pages (if necessary)
1325 * @iter: iovec iterator
1326 * @gfp_mask: memory allocation flags
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 *
1328 * Prepares and returns a bio for indirect user io, bouncing data
1329 * to/from kernel pages as necessary. Must be paired with
1330 * call bio_uncopy_user() on io completion.
1331 */
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001332struct bio *bio_copy_user_iov(struct request_queue *q,
1333 struct rq_map_data *map_data,
Al Viroe81cef52017-09-24 09:25:39 -04001334 struct iov_iter *iter,
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001335 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337 struct bio_map_data *bmd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 struct page *page;
1339 struct bio *bio;
Al Virod16d44e2017-09-24 13:09:18 -04001340 int i = 0, ret;
1341 int nr_pages;
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001342 unsigned int len = iter->count;
Geliang Tangbd5cece2015-11-21 17:27:31 +08001343 unsigned int offset = map_data ? offset_in_page(map_data->offset) : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344
Al Viro0e5b9352017-09-24 13:14:35 -04001345 bmd = bio_alloc_map_data(iter, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001346 if (!bmd)
1347 return ERR_PTR(-ENOMEM);
1348
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001349 /*
1350 * We need to do a deep copy of the iov_iter including the iovecs.
1351 * The caller provided iov might point to an on-stack or otherwise
1352 * shortlived one.
1353 */
1354 bmd->is_our_pages = map_data ? 0 : 1;
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001355
Al Virod16d44e2017-09-24 13:09:18 -04001356 nr_pages = DIV_ROUND_UP(offset + len, PAGE_SIZE);
1357 if (nr_pages > BIO_MAX_PAGES)
1358 nr_pages = BIO_MAX_PAGES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001359
Linus Torvalds1da177e2005-04-16 15:20:36 -07001360 ret = -ENOMEM;
Tejun Heoa9e9dc22009-04-15 22:10:27 +09001361 bio = bio_kmalloc(gfp_mask, nr_pages);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001362 if (!bio)
1363 goto out_bmd;
1364
Linus Torvalds1da177e2005-04-16 15:20:36 -07001365 ret = 0;
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001366
1367 if (map_data) {
FUJITA Tomonorie623ddb2008-12-18 14:49:36 +09001368 nr_pages = 1 << map_data->page_order;
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001369 i = map_data->offset / PAGE_SIZE;
1370 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371 while (len) {
FUJITA Tomonorie623ddb2008-12-18 14:49:36 +09001372 unsigned int bytes = PAGE_SIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001374 bytes -= offset;
1375
Linus Torvalds1da177e2005-04-16 15:20:36 -07001376 if (bytes > len)
1377 bytes = len;
1378
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001379 if (map_data) {
FUJITA Tomonorie623ddb2008-12-18 14:49:36 +09001380 if (i == map_data->nr_entries * nr_pages) {
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001381 ret = -ENOMEM;
1382 break;
1383 }
FUJITA Tomonorie623ddb2008-12-18 14:49:36 +09001384
1385 page = map_data->pages[i / nr_pages];
1386 page += (i % nr_pages);
1387
1388 i++;
1389 } else {
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001390 page = alloc_page(q->bounce_gfp | gfp_mask);
FUJITA Tomonorie623ddb2008-12-18 14:49:36 +09001391 if (!page) {
1392 ret = -ENOMEM;
1393 break;
1394 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395 }
1396
Jérôme Glissea3761c32019-04-10 16:27:51 -04001397 if (bio_add_pc_page(q, bio, page, bytes, offset) < bytes) {
1398 if (!map_data)
1399 __free_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001400 break;
Jérôme Glissea3761c32019-04-10 16:27:51 -04001401 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001402
1403 len -= bytes;
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001404 offset = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001405 }
1406
1407 if (ret)
1408 goto cleanup;
1409
Al Viro2884d0b2017-09-24 12:09:21 -04001410 if (map_data)
1411 map_data->offset += bio->bi_iter.bi_size;
1412
Linus Torvalds1da177e2005-04-16 15:20:36 -07001413 /*
1414 * success
1415 */
David Howells00e23702018-10-22 13:07:28 +01001416 if ((iov_iter_rw(iter) == WRITE && (!map_data || !map_data->null_mapped)) ||
FUJITA Tomonoriecb554a2009-07-09 14:46:53 +02001417 (map_data && map_data->from_user)) {
Al Viro98a09d62017-09-24 12:14:36 -04001418 ret = bio_copy_from_iter(bio, iter);
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001419 if (ret)
1420 goto cleanup;
Al Viro98a09d62017-09-24 12:14:36 -04001421 } else {
Keith Buschf55adad2018-12-10 08:44:42 -07001422 if (bmd->is_our_pages)
1423 zero_fill_bio(bio);
Al Viro98a09d62017-09-24 12:14:36 -04001424 iov_iter_advance(iter, bio->bi_iter.bi_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 }
1426
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001427 bio->bi_private = bmd;
Al Viro2884d0b2017-09-24 12:09:21 -04001428 if (map_data && map_data->null_mapped)
1429 bio_set_flag(bio, BIO_NULL_MAPPED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430 return bio;
1431cleanup:
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001432 if (!map_data)
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001433 bio_free_pages(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001434 bio_put(bio);
1435out_bmd:
Kent Overstreetc8db4442013-11-22 19:39:06 -08001436 kfree(bmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437 return ERR_PTR(ret);
1438}
1439
Christoph Hellwig37f19e52015-01-18 16:16:33 +01001440/**
1441 * bio_map_user_iov - map user iovec into bio
1442 * @q: the struct request_queue for the bio
1443 * @iter: iovec iterator
1444 * @gfp_mask: memory allocation flags
1445 *
1446 * Map the user space address into a bio suitable for io to a block
1447 * device. Returns an error pointer in case of error.
1448 */
1449struct bio *bio_map_user_iov(struct request_queue *q,
Al Viroe81cef52017-09-24 09:25:39 -04001450 struct iov_iter *iter,
Christoph Hellwig37f19e52015-01-18 16:16:33 +01001451 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452{
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001453 int j;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001454 struct bio *bio;
Al Viro076098e2017-09-23 16:08:57 -04001455 int ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456
Al Virob282cc72017-09-23 16:24:59 -04001457 if (!iov_iter_count(iter))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458 return ERR_PTR(-EINVAL);
1459
Al Virob282cc72017-09-23 16:24:59 -04001460 bio = bio_kmalloc(gfp_mask, iov_iter_npages(iter, BIO_MAX_PAGES));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001461 if (!bio)
1462 return ERR_PTR(-ENOMEM);
1463
Al Viro0a0f1512017-09-24 12:30:17 -04001464 while (iov_iter_count(iter)) {
Al Viro629e42b2017-09-23 16:13:10 -04001465 struct page **pages;
Al Viro076098e2017-09-23 16:08:57 -04001466 ssize_t bytes;
1467 size_t offs, added = 0;
1468 int npages;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001469
Al Viro0a0f1512017-09-24 12:30:17 -04001470 bytes = iov_iter_get_pages_alloc(iter, &pages, LONG_MAX, &offs);
Al Viro076098e2017-09-23 16:08:57 -04001471 if (unlikely(bytes <= 0)) {
1472 ret = bytes ? bytes : -EFAULT;
James Bottomley f1970ba2005-06-20 14:06:52 +02001473 goto out_unmap;
Jens Axboe99172152006-06-16 13:02:29 +02001474 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001475
Al Viro076098e2017-09-23 16:08:57 -04001476 npages = DIV_ROUND_UP(offs + bytes, PAGE_SIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001477
Al Viro98f0bc92017-09-23 16:23:18 -04001478 if (unlikely(offs & queue_dma_alignment(q))) {
1479 ret = -EINVAL;
1480 j = 0;
1481 } else {
1482 for (j = 0; j < npages; j++) {
1483 struct page *page = pages[j];
1484 unsigned int n = PAGE_SIZE - offs;
Christoph Hellwigd1916c82019-08-12 17:39:58 +02001485 bool same_page = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001486
Al Viro98f0bc92017-09-23 16:23:18 -04001487 if (n > bytes)
1488 n = bytes;
James Bottomley f1970ba2005-06-20 14:06:52 +02001489
Ming Lei19047082019-03-17 18:01:08 +08001490 if (!__bio_add_pc_page(q, bio, page, n, offs,
Christoph Hellwigd1916c82019-08-12 17:39:58 +02001491 &same_page)) {
1492 if (same_page)
1493 put_page(page);
Al Viro98f0bc92017-09-23 16:23:18 -04001494 break;
Christoph Hellwigd1916c82019-08-12 17:39:58 +02001495 }
Vitaly Mayatskikh95d78c22017-09-22 01:18:39 -04001496
Al Viro98f0bc92017-09-23 16:23:18 -04001497 added += n;
1498 bytes -= n;
1499 offs = 0;
1500 }
Al Viro0a0f1512017-09-24 12:30:17 -04001501 iov_iter_advance(iter, added);
James Bottomley f1970ba2005-06-20 14:06:52 +02001502 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001503 /*
James Bottomley f1970ba2005-06-20 14:06:52 +02001504 * release the pages we didn't map into the bio, if any
Linus Torvalds1da177e2005-04-16 15:20:36 -07001505 */
Al Viro629e42b2017-09-23 16:13:10 -04001506 while (j < npages)
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001507 put_page(pages[j++]);
Al Viro629e42b2017-09-23 16:13:10 -04001508 kvfree(pages);
Al Viroe2e115d2017-09-23 16:16:06 -04001509 /* couldn't stuff something into bio? */
1510 if (bytes)
1511 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001512 }
1513
Jens Axboeb7c44ed2015-07-24 12:37:59 -06001514 bio_set_flag(bio, BIO_USER_MAPPED);
Christoph Hellwig37f19e52015-01-18 16:16:33 +01001515
1516 /*
Bart Van Assche5fad1b62017-02-01 08:20:08 -08001517 * subtle -- if bio_map_user_iov() ended up bouncing a bio,
Christoph Hellwig37f19e52015-01-18 16:16:33 +01001518 * it would normally disappear when its bi_end_io is run.
1519 * however, we need it for the unmap, so grab an extra
1520 * reference to it
1521 */
1522 bio_get(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001523 return bio;
James Bottomley f1970ba2005-06-20 14:06:52 +02001524
1525 out_unmap:
Christoph Hellwig506e0792019-06-26 15:49:23 +02001526 bio_release_pages(bio, false);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527 bio_put(bio);
1528 return ERR_PTR(ret);
1529}
1530
Linus Torvalds1da177e2005-04-16 15:20:36 -07001531/**
1532 * bio_unmap_user - unmap a bio
1533 * @bio: the bio being unmapped
1534 *
Bart Van Assche5fad1b62017-02-01 08:20:08 -08001535 * Unmap a bio previously mapped by bio_map_user_iov(). Must be called from
1536 * process context.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001537 *
1538 * bio_unmap_user() may sleep.
1539 */
1540void bio_unmap_user(struct bio *bio)
1541{
Christoph Hellwig163cc2d2019-06-26 15:49:22 +02001542 bio_release_pages(bio, bio_data_dir(bio) == READ);
1543 bio_put(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544 bio_put(bio);
1545}
1546
Damien Le Moalb4c58752019-07-01 14:09:15 +09001547static void bio_invalidate_vmalloc_pages(struct bio *bio)
1548{
1549#ifdef ARCH_HAS_FLUSH_KERNEL_DCACHE_PAGE
1550 if (bio->bi_private && !op_is_write(bio_op(bio))) {
1551 unsigned long i, len = 0;
1552
1553 for (i = 0; i < bio->bi_vcnt; i++)
1554 len += bio->bi_io_vec[i].bv_len;
1555 invalidate_kernel_vmap_range(bio->bi_private, len);
1556 }
1557#endif
1558}
1559
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001560static void bio_map_kern_endio(struct bio *bio)
Jens Axboeb8238252005-06-20 14:05:27 +02001561{
Damien Le Moalb4c58752019-07-01 14:09:15 +09001562 bio_invalidate_vmalloc_pages(bio);
Jens Axboeb8238252005-06-20 14:05:27 +02001563 bio_put(bio);
Jens Axboeb8238252005-06-20 14:05:27 +02001564}
1565
Christoph Hellwig75c72b82015-01-18 16:16:32 +01001566/**
1567 * bio_map_kern - map kernel address into bio
1568 * @q: the struct request_queue for the bio
1569 * @data: pointer to buffer to map
1570 * @len: length in bytes
1571 * @gfp_mask: allocation flags for bio allocation
1572 *
1573 * Map the kernel address into a bio suitable for io to a block
1574 * device. Returns an error pointer in case of error.
1575 */
1576struct bio *bio_map_kern(struct request_queue *q, void *data, unsigned int len,
1577 gfp_t gfp_mask)
Mike Christie df46b9a2005-06-20 14:04:44 +02001578{
1579 unsigned long kaddr = (unsigned long)data;
1580 unsigned long end = (kaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1581 unsigned long start = kaddr >> PAGE_SHIFT;
1582 const int nr_pages = end - start;
Damien Le Moalb4c58752019-07-01 14:09:15 +09001583 bool is_vmalloc = is_vmalloc_addr(data);
1584 struct page *page;
Mike Christie df46b9a2005-06-20 14:04:44 +02001585 int offset, i;
1586 struct bio *bio;
1587
Tejun Heoa9e9dc22009-04-15 22:10:27 +09001588 bio = bio_kmalloc(gfp_mask, nr_pages);
Mike Christie df46b9a2005-06-20 14:04:44 +02001589 if (!bio)
1590 return ERR_PTR(-ENOMEM);
1591
Damien Le Moalb4c58752019-07-01 14:09:15 +09001592 if (is_vmalloc) {
1593 flush_kernel_vmap_range(data, len);
1594 bio->bi_private = data;
1595 }
1596
Mike Christie df46b9a2005-06-20 14:04:44 +02001597 offset = offset_in_page(kaddr);
1598 for (i = 0; i < nr_pages; i++) {
1599 unsigned int bytes = PAGE_SIZE - offset;
1600
1601 if (len <= 0)
1602 break;
1603
1604 if (bytes > len)
1605 bytes = len;
1606
Damien Le Moalb4c58752019-07-01 14:09:15 +09001607 if (!is_vmalloc)
1608 page = virt_to_page(data);
1609 else
1610 page = vmalloc_to_page(data);
1611 if (bio_add_pc_page(q, bio, page, bytes,
Christoph Hellwig75c72b82015-01-18 16:16:32 +01001612 offset) < bytes) {
1613 /* we don't support partial mappings */
1614 bio_put(bio);
1615 return ERR_PTR(-EINVAL);
1616 }
Mike Christie df46b9a2005-06-20 14:04:44 +02001617
1618 data += bytes;
1619 len -= bytes;
1620 offset = 0;
1621 }
1622
Jens Axboeb8238252005-06-20 14:05:27 +02001623 bio->bi_end_io = bio_map_kern_endio;
Mike Christie df46b9a2005-06-20 14:04:44 +02001624 return bio;
1625}
Mike Christie df46b9a2005-06-20 14:04:44 +02001626
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001627static void bio_copy_kern_endio(struct bio *bio)
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001628{
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001629 bio_free_pages(bio);
1630 bio_put(bio);
1631}
1632
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001633static void bio_copy_kern_endio_read(struct bio *bio)
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001634{
Christoph Hellwig42d26832015-01-18 16:16:28 +01001635 char *p = bio->bi_private;
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001636 struct bio_vec *bvec;
Ming Lei6dc4f102019-02-15 19:13:19 +08001637 struct bvec_iter_all iter_all;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001638
Christoph Hellwig2b070cf2019-04-25 09:03:00 +02001639 bio_for_each_segment_all(bvec, bio, iter_all) {
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001640 memcpy(p, page_address(bvec->bv_page), bvec->bv_len);
Kent Overstreetc8db4442013-11-22 19:39:06 -08001641 p += bvec->bv_len;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001642 }
1643
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001644 bio_copy_kern_endio(bio);
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001645}
1646
1647/**
1648 * bio_copy_kern - copy kernel address into bio
1649 * @q: the struct request_queue for the bio
1650 * @data: pointer to buffer to copy
1651 * @len: length in bytes
1652 * @gfp_mask: allocation flags for bio and page allocation
Randy Dunlapffee0252008-04-30 09:08:54 +02001653 * @reading: data direction is READ
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001654 *
1655 * copy the kernel address into a bio suitable for io to a block
1656 * device. Returns an error pointer in case of error.
1657 */
1658struct bio *bio_copy_kern(struct request_queue *q, void *data, unsigned int len,
1659 gfp_t gfp_mask, int reading)
1660{
Christoph Hellwig42d26832015-01-18 16:16:28 +01001661 unsigned long kaddr = (unsigned long)data;
1662 unsigned long end = (kaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1663 unsigned long start = kaddr >> PAGE_SHIFT;
Christoph Hellwig42d26832015-01-18 16:16:28 +01001664 struct bio *bio;
1665 void *p = data;
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001666 int nr_pages = 0;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001667
Christoph Hellwig42d26832015-01-18 16:16:28 +01001668 /*
1669 * Overflow, abort
1670 */
1671 if (end < start)
1672 return ERR_PTR(-EINVAL);
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001673
Christoph Hellwig42d26832015-01-18 16:16:28 +01001674 nr_pages = end - start;
1675 bio = bio_kmalloc(gfp_mask, nr_pages);
1676 if (!bio)
1677 return ERR_PTR(-ENOMEM);
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001678
Christoph Hellwig42d26832015-01-18 16:16:28 +01001679 while (len) {
1680 struct page *page;
1681 unsigned int bytes = PAGE_SIZE;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001682
Christoph Hellwig42d26832015-01-18 16:16:28 +01001683 if (bytes > len)
1684 bytes = len;
1685
1686 page = alloc_page(q->bounce_gfp | gfp_mask);
1687 if (!page)
1688 goto cleanup;
1689
1690 if (!reading)
1691 memcpy(page_address(page), p, bytes);
1692
1693 if (bio_add_pc_page(q, bio, page, bytes, 0) < bytes)
1694 break;
1695
1696 len -= bytes;
1697 p += bytes;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001698 }
1699
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001700 if (reading) {
1701 bio->bi_end_io = bio_copy_kern_endio_read;
1702 bio->bi_private = data;
1703 } else {
1704 bio->bi_end_io = bio_copy_kern_endio;
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001705 }
FUJITA Tomonori76029ff2008-08-25 20:36:08 +02001706
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001707 return bio;
Christoph Hellwig42d26832015-01-18 16:16:28 +01001708
1709cleanup:
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001710 bio_free_pages(bio);
Christoph Hellwig42d26832015-01-18 16:16:28 +01001711 bio_put(bio);
1712 return ERR_PTR(-ENOMEM);
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001713}
1714
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715/*
1716 * bio_set_pages_dirty() and bio_check_pages_dirty() are support functions
1717 * for performing direct-IO in BIOs.
1718 *
1719 * The problem is that we cannot run set_page_dirty() from interrupt context
1720 * because the required locks are not interrupt-safe. So what we can do is to
1721 * mark the pages dirty _before_ performing IO. And in interrupt context,
1722 * check that the pages are still dirty. If so, fine. If not, redirty them
1723 * in process context.
1724 *
1725 * We special-case compound pages here: normally this means reads into hugetlb
1726 * pages. The logic in here doesn't really work right for compound pages
1727 * because the VM does not uniformly chase down the head page in all cases.
1728 * But dirtiness of compound pages is pretty meaningless anyway: the VM doesn't
1729 * handle them at all. So we skip compound pages here at an early stage.
1730 *
1731 * Note that this code is very hard to test under normal circumstances because
1732 * direct-io pins the pages with get_user_pages(). This makes
1733 * is_page_cache_freeable return false, and the VM will not clean the pages.
Artem Bityutskiy0d5c3eb2012-07-25 18:12:08 +03001734 * But other code (eg, flusher threads) could clean the pages if they are mapped
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735 * pagecache.
1736 *
1737 * Simply disabling the call to bio_set_pages_dirty() is a good way to test the
1738 * deferred bio dirtying paths.
1739 */
1740
1741/*
1742 * bio_set_pages_dirty() will mark all the bio's pages as dirty.
1743 */
1744void bio_set_pages_dirty(struct bio *bio)
1745{
Kent Overstreetcb34e052012-09-05 15:22:02 -07001746 struct bio_vec *bvec;
Ming Lei6dc4f102019-02-15 19:13:19 +08001747 struct bvec_iter_all iter_all;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748
Christoph Hellwig2b070cf2019-04-25 09:03:00 +02001749 bio_for_each_segment_all(bvec, bio, iter_all) {
Christoph Hellwig3bb50982018-07-24 14:04:13 +02001750 if (!PageCompound(bvec->bv_page))
1751 set_page_dirty_lock(bvec->bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001752 }
1753}
1754
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755/*
1756 * bio_check_pages_dirty() will check that all the BIO's pages are still dirty.
1757 * If they are, then fine. If, however, some pages are clean then they must
1758 * have been written out during the direct-IO read. So we take another ref on
Christoph Hellwig24d54932018-07-24 14:04:12 +02001759 * the BIO and re-dirty the pages in process context.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760 *
1761 * It is expected that bio_check_pages_dirty() will wholly own the BIO from
Kirill A. Shutemovea1754a2016-04-01 15:29:48 +03001762 * here on. It will run one put_page() against each page and will run one
1763 * bio_put() against the BIO.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001764 */
1765
David Howells65f27f32006-11-22 14:55:48 +00001766static void bio_dirty_fn(struct work_struct *work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001767
David Howells65f27f32006-11-22 14:55:48 +00001768static DECLARE_WORK(bio_dirty_work, bio_dirty_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001769static DEFINE_SPINLOCK(bio_dirty_lock);
1770static struct bio *bio_dirty_list;
1771
1772/*
1773 * This runs in process context
1774 */
David Howells65f27f32006-11-22 14:55:48 +00001775static void bio_dirty_fn(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001776{
Christoph Hellwig24d54932018-07-24 14:04:12 +02001777 struct bio *bio, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778
Christoph Hellwig24d54932018-07-24 14:04:12 +02001779 spin_lock_irq(&bio_dirty_lock);
1780 next = bio_dirty_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781 bio_dirty_list = NULL;
Christoph Hellwig24d54932018-07-24 14:04:12 +02001782 spin_unlock_irq(&bio_dirty_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783
Christoph Hellwig24d54932018-07-24 14:04:12 +02001784 while ((bio = next) != NULL) {
1785 next = bio->bi_private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786
Christoph Hellwigd241a952019-06-26 15:49:21 +02001787 bio_release_pages(bio, true);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001788 bio_put(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789 }
1790}
1791
1792void bio_check_pages_dirty(struct bio *bio)
1793{
Kent Overstreetcb34e052012-09-05 15:22:02 -07001794 struct bio_vec *bvec;
Christoph Hellwig24d54932018-07-24 14:04:12 +02001795 unsigned long flags;
Ming Lei6dc4f102019-02-15 19:13:19 +08001796 struct bvec_iter_all iter_all;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001797
Christoph Hellwig2b070cf2019-04-25 09:03:00 +02001798 bio_for_each_segment_all(bvec, bio, iter_all) {
Christoph Hellwig24d54932018-07-24 14:04:12 +02001799 if (!PageDirty(bvec->bv_page) && !PageCompound(bvec->bv_page))
1800 goto defer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001801 }
1802
Christoph Hellwigd241a952019-06-26 15:49:21 +02001803 bio_release_pages(bio, false);
Christoph Hellwig24d54932018-07-24 14:04:12 +02001804 bio_put(bio);
1805 return;
1806defer:
1807 spin_lock_irqsave(&bio_dirty_lock, flags);
1808 bio->bi_private = bio_dirty_list;
1809 bio_dirty_list = bio;
1810 spin_unlock_irqrestore(&bio_dirty_lock, flags);
1811 schedule_work(&bio_dirty_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001812}
1813
Konstantin Khlebnikov2b8bd422020-03-25 16:07:04 +03001814void update_io_ticks(struct hd_struct *part, unsigned long now, bool end)
Mikulas Patocka5b18b5a2018-12-06 11:41:19 -05001815{
1816 unsigned long stamp;
1817again:
1818 stamp = READ_ONCE(part->stamp);
1819 if (unlikely(stamp != now)) {
1820 if (likely(cmpxchg(&part->stamp, stamp, now) == stamp)) {
Konstantin Khlebnikov2b8bd422020-03-25 16:07:04 +03001821 __part_stat_add(part, io_ticks, end ? now - stamp : 1);
Mikulas Patocka5b18b5a2018-12-06 11:41:19 -05001822 }
1823 }
1824 if (part->partno) {
1825 part = &part_to_disk(part)->part0;
1826 goto again;
1827 }
1828}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829
Michael Callahanddcf35d2018-07-18 04:47:39 -07001830void generic_start_io_acct(struct request_queue *q, int op,
Jens Axboed62e26b2017-06-30 21:55:08 -06001831 unsigned long sectors, struct hd_struct *part)
Gu Zheng394ffa52014-11-24 11:05:22 +08001832{
Michael Callahanddcf35d2018-07-18 04:47:39 -07001833 const int sgrp = op_stat_group(op);
Gu Zheng394ffa52014-11-24 11:05:22 +08001834
Mike Snitzer112f1582018-12-06 11:41:18 -05001835 part_stat_lock();
1836
Konstantin Khlebnikov2b8bd422020-03-25 16:07:04 +03001837 update_io_ticks(part, jiffies, false);
Mike Snitzer112f1582018-12-06 11:41:18 -05001838 part_stat_inc(part, ios[sgrp]);
1839 part_stat_add(part, sectors[sgrp], sectors);
Michael Callahanddcf35d2018-07-18 04:47:39 -07001840 part_inc_in_flight(q, part, op_is_write(op));
Gu Zheng394ffa52014-11-24 11:05:22 +08001841
1842 part_stat_unlock();
1843}
1844EXPORT_SYMBOL(generic_start_io_acct);
1845
Michael Callahanddcf35d2018-07-18 04:47:39 -07001846void generic_end_io_acct(struct request_queue *q, int req_op,
Jens Axboed62e26b2017-06-30 21:55:08 -06001847 struct hd_struct *part, unsigned long start_time)
Gu Zheng394ffa52014-11-24 11:05:22 +08001848{
Mikulas Patocka5b18b5a2018-12-06 11:41:19 -05001849 unsigned long now = jiffies;
1850 unsigned long duration = now - start_time;
Michael Callahanddcf35d2018-07-18 04:47:39 -07001851 const int sgrp = op_stat_group(req_op);
Gu Zheng394ffa52014-11-24 11:05:22 +08001852
Mike Snitzer112f1582018-12-06 11:41:18 -05001853 part_stat_lock();
1854
Konstantin Khlebnikov2b8bd422020-03-25 16:07:04 +03001855 update_io_ticks(part, now, true);
Mike Snitzer112f1582018-12-06 11:41:18 -05001856 part_stat_add(part, nsecs[sgrp], jiffies_to_nsecs(duration));
Michael Callahanddcf35d2018-07-18 04:47:39 -07001857 part_dec_in_flight(q, part, op_is_write(req_op));
Gu Zheng394ffa52014-11-24 11:05:22 +08001858
1859 part_stat_unlock();
1860}
1861EXPORT_SYMBOL(generic_end_io_acct);
1862
Jens Axboec4cf5262015-04-17 16:15:18 -06001863static inline bool bio_remaining_done(struct bio *bio)
1864{
1865 /*
1866 * If we're not chaining, then ->__bi_remaining is always 1 and
1867 * we always end io on the first invocation.
1868 */
1869 if (!bio_flagged(bio, BIO_CHAIN))
1870 return true;
1871
1872 BUG_ON(atomic_read(&bio->__bi_remaining) <= 0);
1873
Mike Snitzer326e1db2015-05-22 09:14:03 -04001874 if (atomic_dec_and_test(&bio->__bi_remaining)) {
Jens Axboeb7c44ed2015-07-24 12:37:59 -06001875 bio_clear_flag(bio, BIO_CHAIN);
Jens Axboec4cf5262015-04-17 16:15:18 -06001876 return true;
Mike Snitzer326e1db2015-05-22 09:14:03 -04001877 }
Jens Axboec4cf5262015-04-17 16:15:18 -06001878
1879 return false;
1880}
1881
Linus Torvalds1da177e2005-04-16 15:20:36 -07001882/**
1883 * bio_endio - end I/O on a bio
1884 * @bio: bio
Linus Torvalds1da177e2005-04-16 15:20:36 -07001885 *
1886 * Description:
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001887 * bio_endio() will end I/O on the whole bio. bio_endio() is the preferred
1888 * way to end I/O on a bio. No one should call bi_end_io() directly on a
1889 * bio unless they own it and thus know that it has an end_io function.
NeilBrownfbbaf702017-04-07 09:40:52 -06001890 *
1891 * bio_endio() can be called several times on a bio that has been chained
1892 * using bio_chain(). The ->bi_end_io() function will only be called the
1893 * last time. At this point the BLK_TA_COMPLETE tracing event will be
1894 * generated if BIO_TRACE_COMPLETION is set.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001895 **/
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001896void bio_endio(struct bio *bio)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001897{
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001898again:
Christoph Hellwig2b885512016-03-11 17:34:53 +01001899 if (!bio_remaining_done(bio))
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001900 return;
Christoph Hellwig7c20f112017-07-03 16:58:43 -06001901 if (!bio_integrity_endio(bio))
1902 return;
Kent Overstreet196d38bc2013-11-23 18:34:15 -08001903
Josef Bacik67b42d02018-07-03 11:15:00 -04001904 if (bio->bi_disk)
1905 rq_qos_done_bio(bio->bi_disk->queue, bio);
1906
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001907 /*
1908 * Need to have a real endio function for chained bios, otherwise
1909 * various corner cases will break (like stacking block devices that
1910 * save/restore bi_end_io) - however, we want to avoid unbounded
1911 * recursion and blowing the stack. Tail call optimization would
1912 * handle this, but compiling with frame pointers also disables
1913 * gcc's sibling call optimization.
1914 */
1915 if (bio->bi_end_io == bio_chain_endio) {
1916 bio = __bio_chain_endio(bio);
1917 goto again;
Kent Overstreet196d38bc2013-11-23 18:34:15 -08001918 }
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001919
Christoph Hellwig74d46992017-08-23 19:10:32 +02001920 if (bio->bi_disk && bio_flagged(bio, BIO_TRACE_COMPLETION)) {
1921 trace_block_bio_complete(bio->bi_disk->queue, bio,
Bart Van Asschea462b952017-06-13 08:07:33 -07001922 blk_status_to_errno(bio->bi_status));
NeilBrownfbbaf702017-04-07 09:40:52 -06001923 bio_clear_flag(bio, BIO_TRACE_COMPLETION);
1924 }
1925
Shaohua Li9e234ee2017-03-27 10:51:41 -07001926 blk_throtl_bio_endio(bio);
Shaohua Lib222dd22017-07-10 11:40:17 -07001927 /* release cgroup info */
1928 bio_uninit(bio);
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001929 if (bio->bi_end_io)
1930 bio->bi_end_io(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001931}
H Hartley Sweetena112a712009-09-26 16:19:21 +02001932EXPORT_SYMBOL(bio_endio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933
Kent Overstreet196d38bc2013-11-23 18:34:15 -08001934/**
Kent Overstreet20d01892013-11-23 18:21:01 -08001935 * bio_split - split a bio
1936 * @bio: bio to split
1937 * @sectors: number of sectors to split from the front of @bio
1938 * @gfp: gfp mask
1939 * @bs: bio set to allocate from
1940 *
1941 * Allocates and returns a new bio which represents @sectors from the start of
1942 * @bio, and updates @bio to represent the remaining sectors.
1943 *
Martin K. Petersenf3f5da62015-07-22 07:57:12 -04001944 * Unless this is a discard request the newly allocated bio will point
Bart Van Asschedad77582019-08-01 15:50:41 -07001945 * to @bio's bi_io_vec. It is the caller's responsibility to ensure that
1946 * neither @bio nor @bs are freed before the split bio.
Kent Overstreet20d01892013-11-23 18:21:01 -08001947 */
1948struct bio *bio_split(struct bio *bio, int sectors,
1949 gfp_t gfp, struct bio_set *bs)
1950{
Mikulas Patockaf341a4d2017-11-22 13:18:05 -05001951 struct bio *split;
Kent Overstreet20d01892013-11-23 18:21:01 -08001952
1953 BUG_ON(sectors <= 0);
1954 BUG_ON(sectors >= bio_sectors(bio));
1955
Christoph Hellwigf9d03f92016-12-08 15:20:32 -07001956 split = bio_clone_fast(bio, gfp, bs);
Kent Overstreet20d01892013-11-23 18:21:01 -08001957 if (!split)
1958 return NULL;
1959
1960 split->bi_iter.bi_size = sectors << 9;
1961
1962 if (bio_integrity(split))
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -07001963 bio_integrity_trim(split);
Kent Overstreet20d01892013-11-23 18:21:01 -08001964
1965 bio_advance(bio, split->bi_iter.bi_size);
1966
NeilBrownfbbaf702017-04-07 09:40:52 -06001967 if (bio_flagged(bio, BIO_TRACE_COMPLETION))
Goldwyn Rodrigues20d59022018-01-23 09:10:19 -07001968 bio_set_flag(split, BIO_TRACE_COMPLETION);
NeilBrownfbbaf702017-04-07 09:40:52 -06001969
Kent Overstreet20d01892013-11-23 18:21:01 -08001970 return split;
1971}
1972EXPORT_SYMBOL(bio_split);
1973
Martin K. Petersenad3316b2008-10-01 22:42:53 -04001974/**
Kent Overstreet6678d832013-08-07 11:14:32 -07001975 * bio_trim - trim a bio
1976 * @bio: bio to trim
1977 * @offset: number of sectors to trim from the front of @bio
1978 * @size: size we want to trim @bio to, in sectors
1979 */
1980void bio_trim(struct bio *bio, int offset, int size)
1981{
1982 /* 'bio' is a cloned bio which we need to trim to match
1983 * the given offset and size.
Kent Overstreet6678d832013-08-07 11:14:32 -07001984 */
Kent Overstreet6678d832013-08-07 11:14:32 -07001985
1986 size <<= 9;
Kent Overstreet4f024f32013-10-11 15:44:27 -07001987 if (offset == 0 && size == bio->bi_iter.bi_size)
Kent Overstreet6678d832013-08-07 11:14:32 -07001988 return;
1989
Kent Overstreet6678d832013-08-07 11:14:32 -07001990 bio_advance(bio, offset << 9);
Kent Overstreet4f024f32013-10-11 15:44:27 -07001991 bio->bi_iter.bi_size = size;
Dmitry Monakhov376a78a2017-06-29 11:31:08 -07001992
1993 if (bio_integrity(bio))
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -07001994 bio_integrity_trim(bio);
Dmitry Monakhov376a78a2017-06-29 11:31:08 -07001995
Kent Overstreet6678d832013-08-07 11:14:32 -07001996}
1997EXPORT_SYMBOL_GPL(bio_trim);
1998
Linus Torvalds1da177e2005-04-16 15:20:36 -07001999/*
2000 * create memory pools for biovec's in a bio_set.
2001 * use the global biovec slabs created for general use.
2002 */
Kent Overstreet8aa6ba22018-05-08 21:33:50 -04002003int biovec_init_pool(mempool_t *pool, int pool_entries)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002004{
Christoph Hellwiged996a52016-07-19 11:28:42 +02002005 struct biovec_slab *bp = bvec_slabs + BVEC_POOL_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002006
Kent Overstreet8aa6ba22018-05-08 21:33:50 -04002007 return mempool_init_slab_pool(pool, pool_entries, bp->slab);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008}
2009
Kent Overstreet917a38c2018-05-08 21:33:51 -04002010/*
2011 * bioset_exit - exit a bioset initialized with bioset_init()
2012 *
2013 * May be called on a zeroed but uninitialized bioset (i.e. allocated with
2014 * kzalloc()).
2015 */
2016void bioset_exit(struct bio_set *bs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002017{
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -07002018 if (bs->rescue_workqueue)
2019 destroy_workqueue(bs->rescue_workqueue);
Kent Overstreet917a38c2018-05-08 21:33:51 -04002020 bs->rescue_workqueue = NULL;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -07002021
Kent Overstreet8aa6ba22018-05-08 21:33:50 -04002022 mempool_exit(&bs->bio_pool);
2023 mempool_exit(&bs->bvec_pool);
Kent Overstreet9f060e22012-10-12 15:29:33 -07002024
Martin K. Petersen7878cba2009-06-26 15:37:49 +02002025 bioset_integrity_free(bs);
Kent Overstreet917a38c2018-05-08 21:33:51 -04002026 if (bs->bio_slab)
2027 bio_put_slab(bs);
2028 bs->bio_slab = NULL;
2029}
2030EXPORT_SYMBOL(bioset_exit);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002031
NeilBrown011067b2017-06-18 14:38:57 +10002032/**
Kent Overstreet917a38c2018-05-08 21:33:51 -04002033 * bioset_init - Initialize a bio_set
Kent Overstreetdad08522018-05-20 18:25:58 -04002034 * @bs: pool to initialize
Kent Overstreet917a38c2018-05-08 21:33:51 -04002035 * @pool_size: Number of bio and bio_vecs to cache in the mempool
2036 * @front_pad: Number of bytes to allocate in front of the returned bio
2037 * @flags: Flags to modify behavior, currently %BIOSET_NEED_BVECS
2038 * and %BIOSET_NEED_RESCUER
2039 *
Kent Overstreetdad08522018-05-20 18:25:58 -04002040 * Description:
2041 * Set up a bio_set to be used with @bio_alloc_bioset. Allows the caller
2042 * to ask for a number of bytes to be allocated in front of the bio.
2043 * Front pad allocation is useful for embedding the bio inside
2044 * another structure, to avoid allocating extra data to go with the bio.
2045 * Note that the bio must be embedded at the END of that structure always,
2046 * or things will break badly.
2047 * If %BIOSET_NEED_BVECS is set in @flags, a separate pool will be allocated
2048 * for allocating iovecs. This pool is not needed e.g. for bio_clone_fast().
2049 * If %BIOSET_NEED_RESCUER is set, a workqueue is created which can be used to
2050 * dispatch queued requests when the mempool runs out of space.
2051 *
Kent Overstreet917a38c2018-05-08 21:33:51 -04002052 */
2053int bioset_init(struct bio_set *bs,
2054 unsigned int pool_size,
2055 unsigned int front_pad,
2056 int flags)
2057{
2058 unsigned int back_pad = BIO_INLINE_VECS * sizeof(struct bio_vec);
2059
2060 bs->front_pad = front_pad;
2061
2062 spin_lock_init(&bs->rescue_lock);
2063 bio_list_init(&bs->rescue_list);
2064 INIT_WORK(&bs->rescue_work, bio_alloc_rescue);
2065
2066 bs->bio_slab = bio_find_or_create_slab(front_pad + back_pad);
2067 if (!bs->bio_slab)
2068 return -ENOMEM;
2069
2070 if (mempool_init_slab_pool(&bs->bio_pool, pool_size, bs->bio_slab))
2071 goto bad;
2072
2073 if ((flags & BIOSET_NEED_BVECS) &&
2074 biovec_init_pool(&bs->bvec_pool, pool_size))
2075 goto bad;
2076
2077 if (!(flags & BIOSET_NEED_RESCUER))
2078 return 0;
2079
2080 bs->rescue_workqueue = alloc_workqueue("bioset", WQ_MEM_RECLAIM, 0);
2081 if (!bs->rescue_workqueue)
2082 goto bad;
2083
2084 return 0;
2085bad:
2086 bioset_exit(bs);
2087 return -ENOMEM;
2088}
2089EXPORT_SYMBOL(bioset_init);
2090
Jens Axboe28e89fd92018-06-07 14:42:05 -06002091/*
2092 * Initialize and setup a new bio_set, based on the settings from
2093 * another bio_set.
2094 */
2095int bioset_init_from_src(struct bio_set *bs, struct bio_set *src)
2096{
2097 int flags;
2098
2099 flags = 0;
2100 if (src->bvec_pool.min_nr)
2101 flags |= BIOSET_NEED_BVECS;
2102 if (src->rescue_workqueue)
2103 flags |= BIOSET_NEED_RESCUER;
2104
2105 return bioset_init(bs, src->bio_pool.min_nr, src->front_pad, flags);
2106}
2107EXPORT_SYMBOL(bioset_init_from_src);
2108
Tejun Heo852c7882012-03-05 13:15:27 -08002109#ifdef CONFIG_BLK_CGROUP
Tejun Heo1d933cf2015-05-22 17:13:24 -04002110
2111/**
Dennis Zhou2268c0f2018-12-05 12:10:29 -05002112 * bio_disassociate_blkg - puts back the blkg reference if associated
Dennis Zhoub5f29542018-11-01 17:24:10 -04002113 * @bio: target bio
Dennis Zhoub5f29542018-11-01 17:24:10 -04002114 *
Dennis Zhou2268c0f2018-12-05 12:10:29 -05002115 * Helper to disassociate the blkg from @bio if a blkg is associated.
Dennis Zhoub5f29542018-11-01 17:24:10 -04002116 */
Dennis Zhou2268c0f2018-12-05 12:10:29 -05002117void bio_disassociate_blkg(struct bio *bio)
Dennis Zhoub5f29542018-11-01 17:24:10 -04002118{
Josef Bacik08e18ea2018-07-03 11:14:50 -04002119 if (bio->bi_blkg) {
2120 blkg_put(bio->bi_blkg);
2121 bio->bi_blkg = NULL;
2122 }
Tejun Heo852c7882012-03-05 13:15:27 -08002123}
Dennis Zhou892ad712018-12-05 12:10:30 -05002124EXPORT_SYMBOL_GPL(bio_disassociate_blkg);
Tejun Heo852c7882012-03-05 13:15:27 -08002125
Paolo Valente20bd7232016-07-27 07:22:05 +02002126/**
Dennis Zhou2268c0f2018-12-05 12:10:29 -05002127 * __bio_associate_blkg - associate a bio with the a blkg
Tejun Heo852c7882012-03-05 13:15:27 -08002128 * @bio: target bio
2129 * @blkg: the blkg to associate
2130 *
Dennis Zhoubeea9da2018-12-05 12:10:28 -05002131 * This tries to associate @bio with the specified @blkg. Association failure
2132 * is handled by walking up the blkg tree. Therefore, the blkg associated can
2133 * be anything between @blkg and the root_blkg. This situation only happens
2134 * when a cgroup is dying and then the remaining bios will spill to the closest
2135 * alive blkg.
2136 *
2137 * A reference will be taken on the @blkg and will be released when @bio is
2138 * freed.
Tejun Heo852c7882012-03-05 13:15:27 -08002139 */
Dennis Zhou2268c0f2018-12-05 12:10:29 -05002140static void __bio_associate_blkg(struct bio *bio, struct blkcg_gq *blkg)
Tejun Heo852c7882012-03-05 13:15:27 -08002141{
Dennis Zhou2268c0f2018-12-05 12:10:29 -05002142 bio_disassociate_blkg(bio);
2143
Dennis Zhou7754f662018-12-05 12:10:39 -05002144 bio->bi_blkg = blkg_tryget_closest(blkg);
Dennis Zhou2268c0f2018-12-05 12:10:29 -05002145}
2146
Dennis Zhoufd42df32018-12-05 12:10:34 -05002147/**
2148 * bio_associate_blkg_from_css - associate a bio with a specified css
2149 * @bio: target bio
2150 * @css: target css
2151 *
2152 * Associate @bio with the blkg found by combining the css's blkg and the
Dennis Zhoufc5a8282018-12-05 12:10:36 -05002153 * request_queue of the @bio. This falls back to the queue's root_blkg if
2154 * the association fails with the css.
Dennis Zhoufd42df32018-12-05 12:10:34 -05002155 */
2156void bio_associate_blkg_from_css(struct bio *bio,
2157 struct cgroup_subsys_state *css)
2158{
Dennis Zhoufc5a8282018-12-05 12:10:36 -05002159 struct request_queue *q = bio->bi_disk->queue;
2160 struct blkcg_gq *blkg;
2161
2162 rcu_read_lock();
2163
2164 if (!css || !css->parent)
2165 blkg = q->root_blkg;
2166 else
2167 blkg = blkg_lookup_create(css_to_blkcg(css), q);
2168
2169 __bio_associate_blkg(bio, blkg);
2170
2171 rcu_read_unlock();
Dennis Zhoufd42df32018-12-05 12:10:34 -05002172}
2173EXPORT_SYMBOL_GPL(bio_associate_blkg_from_css);
2174
Dennis Zhou6a7f6d82018-12-05 12:10:33 -05002175#ifdef CONFIG_MEMCG
2176/**
2177 * bio_associate_blkg_from_page - associate a bio with the page's blkg
2178 * @bio: target bio
2179 * @page: the page to lookup the blkcg from
2180 *
2181 * Associate @bio with the blkg from @page's owning memcg and the respective
Dennis Zhoufc5a8282018-12-05 12:10:36 -05002182 * request_queue. If cgroup_e_css returns %NULL, fall back to the queue's
2183 * root_blkg.
Dennis Zhou6a7f6d82018-12-05 12:10:33 -05002184 */
2185void bio_associate_blkg_from_page(struct bio *bio, struct page *page)
2186{
2187 struct cgroup_subsys_state *css;
2188
Dennis Zhou6a7f6d82018-12-05 12:10:33 -05002189 if (!page->mem_cgroup)
2190 return;
2191
Dennis Zhoufc5a8282018-12-05 12:10:36 -05002192 rcu_read_lock();
2193
2194 css = cgroup_e_css(page->mem_cgroup->css.cgroup, &io_cgrp_subsys);
2195 bio_associate_blkg_from_css(bio, css);
2196
2197 rcu_read_unlock();
Dennis Zhou6a7f6d82018-12-05 12:10:33 -05002198}
2199#endif /* CONFIG_MEMCG */
2200
Dennis Zhou2268c0f2018-12-05 12:10:29 -05002201/**
2202 * bio_associate_blkg - associate a bio with a blkg
2203 * @bio: target bio
2204 *
2205 * Associate @bio with the blkg found from the bio's css and request_queue.
2206 * If one is not found, bio_lookup_blkg() creates the blkg. If a blkg is
2207 * already associated, the css is reused and association redone as the
2208 * request_queue may have changed.
2209 */
2210void bio_associate_blkg(struct bio *bio)
2211{
Dennis Zhoufc5a8282018-12-05 12:10:36 -05002212 struct cgroup_subsys_state *css;
Dennis Zhou2268c0f2018-12-05 12:10:29 -05002213
2214 rcu_read_lock();
2215
Dennis Zhoudb6638d2018-12-05 12:10:35 -05002216 if (bio->bi_blkg)
Dennis Zhoufc5a8282018-12-05 12:10:36 -05002217 css = &bio_blkcg(bio)->css;
Dennis Zhoudb6638d2018-12-05 12:10:35 -05002218 else
Dennis Zhoufc5a8282018-12-05 12:10:36 -05002219 css = blkcg_css();
Dennis Zhou2268c0f2018-12-05 12:10:29 -05002220
Dennis Zhoufc5a8282018-12-05 12:10:36 -05002221 bio_associate_blkg_from_css(bio, css);
Dennis Zhou2268c0f2018-12-05 12:10:29 -05002222
2223 rcu_read_unlock();
Tejun Heo852c7882012-03-05 13:15:27 -08002224}
Dennis Zhou5cdf2e32018-12-05 12:10:31 -05002225EXPORT_SYMBOL_GPL(bio_associate_blkg);
Tejun Heo852c7882012-03-05 13:15:27 -08002226
Paolo Valente20bd7232016-07-27 07:22:05 +02002227/**
Dennis Zhoudb6638d2018-12-05 12:10:35 -05002228 * bio_clone_blkg_association - clone blkg association from src to dst bio
Paolo Valente20bd7232016-07-27 07:22:05 +02002229 * @dst: destination bio
2230 * @src: source bio
2231 */
Dennis Zhoudb6638d2018-12-05 12:10:35 -05002232void bio_clone_blkg_association(struct bio *dst, struct bio *src)
Paolo Valente20bd7232016-07-27 07:22:05 +02002233{
Dennis Zhou6ab21872018-12-19 16:43:21 -06002234 rcu_read_lock();
2235
Dennis Zhoufc5a8282018-12-05 12:10:36 -05002236 if (src->bi_blkg)
Dennis Zhou2268c0f2018-12-05 12:10:29 -05002237 __bio_associate_blkg(dst, src->bi_blkg);
Dennis Zhou6ab21872018-12-19 16:43:21 -06002238
2239 rcu_read_unlock();
Paolo Valente20bd7232016-07-27 07:22:05 +02002240}
Dennis Zhoudb6638d2018-12-05 12:10:35 -05002241EXPORT_SYMBOL_GPL(bio_clone_blkg_association);
Tejun Heo852c7882012-03-05 13:15:27 -08002242#endif /* CONFIG_BLK_CGROUP */
2243
Linus Torvalds1da177e2005-04-16 15:20:36 -07002244static void __init biovec_init_slabs(void)
2245{
2246 int i;
2247
Christoph Hellwiged996a52016-07-19 11:28:42 +02002248 for (i = 0; i < BVEC_POOL_NR; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002249 int size;
2250 struct biovec_slab *bvs = bvec_slabs + i;
2251
Jens Axboea7fcd372008-12-05 16:10:29 +01002252 if (bvs->nr_vecs <= BIO_INLINE_VECS) {
2253 bvs->slab = NULL;
2254 continue;
2255 }
Jens Axboea7fcd372008-12-05 16:10:29 +01002256
Linus Torvalds1da177e2005-04-16 15:20:36 -07002257 size = bvs->nr_vecs * sizeof(struct bio_vec);
2258 bvs->slab = kmem_cache_create(bvs->name, size, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09002259 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002260 }
2261}
2262
2263static int __init init_bio(void)
2264{
Jens Axboebb799ca2008-12-10 15:35:05 +01002265 bio_slab_max = 2;
2266 bio_slab_nr = 0;
Kees Cook6396bb22018-06-12 14:03:40 -07002267 bio_slabs = kcalloc(bio_slab_max, sizeof(struct bio_slab),
2268 GFP_KERNEL);
Johannes Thumshirn2b24e6f2019-04-03 11:15:19 +02002269
2270 BUILD_BUG_ON(BIO_FLAG_LAST > BVEC_POOL_OFFSET);
2271
Jens Axboebb799ca2008-12-10 15:35:05 +01002272 if (!bio_slabs)
2273 panic("bio: can't allocate bios\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002274
Martin K. Petersen7878cba2009-06-26 15:37:49 +02002275 bio_integrity_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002276 biovec_init_slabs();
2277
Kent Overstreetf4f81542018-05-08 21:33:52 -04002278 if (bioset_init(&fs_bio_set, BIO_POOL_SIZE, 0, BIOSET_NEED_BVECS))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002279 panic("bio: can't allocate bios\n");
2280
Kent Overstreetf4f81542018-05-08 21:33:52 -04002281 if (bioset_integrity_create(&fs_bio_set, BIO_POOL_SIZE))
Martin K. Petersena91a2782011-03-17 11:11:05 +01002282 panic("bio: can't create integrity pool\n");
2283
Linus Torvalds1da177e2005-04-16 15:20:36 -07002284 return 0;
2285}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002286subsys_initcall(init_bio);