blob: e849efff46169514559ce307de24b251e0bc3b56 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
Jens Axboe0fe23472006-09-04 15:41:16 +02002 * Copyright (C) 2001 Jens Axboe <axboe@kernel.dk>
Linus Torvalds1da177e2005-04-16 15:20:36 -07003 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation.
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public Licens
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-
16 *
17 */
18#include <linux/mm.h>
19#include <linux/swap.h>
20#include <linux/bio.h>
21#include <linux/blkdev.h>
Kent Overstreeta27bb332013-05-07 16:19:08 -070022#include <linux/uio.h>
Tejun Heo852c7882012-03-05 13:15:27 -080023#include <linux/iocontext.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024#include <linux/slab.h>
25#include <linux/init.h>
26#include <linux/kernel.h>
Paul Gortmaker630d9c42011-11-16 23:57:37 -050027#include <linux/export.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070028#include <linux/mempool.h>
29#include <linux/workqueue.h>
Tejun Heo852c7882012-03-05 13:15:27 -080030#include <linux/cgroup.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070031
Li Zefan55782132009-06-09 13:43:05 +080032#include <trace/events/block.h>
Shaohua Li9e234ee2017-03-27 10:51:41 -070033#include "blk.h"
Ingo Molnar0bfc2452008-11-26 11:59:56 +010034
Jens Axboe392ddc32008-12-23 12:42:54 +010035/*
36 * Test patch to inline a certain number of bi_io_vec's inside the bio
37 * itself, to shrink a bio data allocation from two mempool calls to one
38 */
39#define BIO_INLINE_VECS 4
40
Linus Torvalds1da177e2005-04-16 15:20:36 -070041/*
42 * if you change this list, also change bvec_alloc or things will
43 * break badly! cannot be bigger than what you can fit into an
44 * unsigned short
45 */
Mikulas Patockabd5c4fa2018-03-21 12:49:29 -040046#define BV(x, n) { .nr_vecs = x, .name = "biovec-"#n }
Christoph Hellwiged996a52016-07-19 11:28:42 +020047static struct biovec_slab bvec_slabs[BVEC_POOL_NR] __read_mostly = {
Mikulas Patockabd5c4fa2018-03-21 12:49:29 -040048 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 -070049};
50#undef BV
51
52/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070053 * fs_bio_set is the bio_set containing bio and iovec memory pools used by
54 * IO code that does not need private memory pools.
55 */
Kent Overstreetf4f81542018-05-08 21:33:52 -040056struct bio_set fs_bio_set;
Kent Overstreet3f86a822012-09-06 15:35:01 -070057EXPORT_SYMBOL(fs_bio_set);
Linus Torvalds1da177e2005-04-16 15:20:36 -070058
Jens Axboebb799ca2008-12-10 15:35:05 +010059/*
60 * Our slab pool management
61 */
62struct bio_slab {
63 struct kmem_cache *slab;
64 unsigned int slab_ref;
65 unsigned int slab_size;
66 char name[8];
67};
68static DEFINE_MUTEX(bio_slab_lock);
69static struct bio_slab *bio_slabs;
70static unsigned int bio_slab_nr, bio_slab_max;
71
72static struct kmem_cache *bio_find_or_create_slab(unsigned int extra_size)
73{
74 unsigned int sz = sizeof(struct bio) + extra_size;
75 struct kmem_cache *slab = NULL;
Alexey Khoroshilov389d7b22012-08-09 15:19:25 +020076 struct bio_slab *bslab, *new_bio_slabs;
Anna Leuschner386bc352012-10-22 21:53:36 +020077 unsigned int new_bio_slab_max;
Jens Axboebb799ca2008-12-10 15:35:05 +010078 unsigned int i, entry = -1;
79
80 mutex_lock(&bio_slab_lock);
81
82 i = 0;
83 while (i < bio_slab_nr) {
Thiago Farinaf06f1352010-01-19 14:07:09 +010084 bslab = &bio_slabs[i];
Jens Axboebb799ca2008-12-10 15:35:05 +010085
86 if (!bslab->slab && entry == -1)
87 entry = i;
88 else if (bslab->slab_size == sz) {
89 slab = bslab->slab;
90 bslab->slab_ref++;
91 break;
92 }
93 i++;
94 }
95
96 if (slab)
97 goto out_unlock;
98
99 if (bio_slab_nr == bio_slab_max && entry == -1) {
Anna Leuschner386bc352012-10-22 21:53:36 +0200100 new_bio_slab_max = bio_slab_max << 1;
Alexey Khoroshilov389d7b22012-08-09 15:19:25 +0200101 new_bio_slabs = krealloc(bio_slabs,
Anna Leuschner386bc352012-10-22 21:53:36 +0200102 new_bio_slab_max * sizeof(struct bio_slab),
Alexey Khoroshilov389d7b22012-08-09 15:19:25 +0200103 GFP_KERNEL);
104 if (!new_bio_slabs)
Jens Axboebb799ca2008-12-10 15:35:05 +0100105 goto out_unlock;
Anna Leuschner386bc352012-10-22 21:53:36 +0200106 bio_slab_max = new_bio_slab_max;
Alexey Khoroshilov389d7b22012-08-09 15:19:25 +0200107 bio_slabs = new_bio_slabs;
Jens Axboebb799ca2008-12-10 15:35:05 +0100108 }
109 if (entry == -1)
110 entry = bio_slab_nr++;
111
112 bslab = &bio_slabs[entry];
113
114 snprintf(bslab->name, sizeof(bslab->name), "bio-%d", entry);
Mikulas Patocka6a241482014-03-28 15:51:55 -0400115 slab = kmem_cache_create(bslab->name, sz, ARCH_KMALLOC_MINALIGN,
116 SLAB_HWCACHE_ALIGN, NULL);
Jens Axboebb799ca2008-12-10 15:35:05 +0100117 if (!slab)
118 goto out_unlock;
119
Jens Axboebb799ca2008-12-10 15:35:05 +0100120 bslab->slab = slab;
121 bslab->slab_ref = 1;
122 bslab->slab_size = sz;
123out_unlock:
124 mutex_unlock(&bio_slab_lock);
125 return slab;
126}
127
128static void bio_put_slab(struct bio_set *bs)
129{
130 struct bio_slab *bslab = NULL;
131 unsigned int i;
132
133 mutex_lock(&bio_slab_lock);
134
135 for (i = 0; i < bio_slab_nr; i++) {
136 if (bs->bio_slab == bio_slabs[i].slab) {
137 bslab = &bio_slabs[i];
138 break;
139 }
140 }
141
142 if (WARN(!bslab, KERN_ERR "bio: unable to find slab!\n"))
143 goto out;
144
145 WARN_ON(!bslab->slab_ref);
146
147 if (--bslab->slab_ref)
148 goto out;
149
150 kmem_cache_destroy(bslab->slab);
151 bslab->slab = NULL;
152
153out:
154 mutex_unlock(&bio_slab_lock);
155}
156
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200157unsigned int bvec_nr_vecs(unsigned short idx)
158{
159 return bvec_slabs[idx].nr_vecs;
160}
161
Kent Overstreet9f060e22012-10-12 15:29:33 -0700162void bvec_free(mempool_t *pool, struct bio_vec *bv, unsigned int idx)
Jens Axboebb799ca2008-12-10 15:35:05 +0100163{
Christoph Hellwiged996a52016-07-19 11:28:42 +0200164 if (!idx)
165 return;
166 idx--;
Jens Axboebb799ca2008-12-10 15:35:05 +0100167
Christoph Hellwiged996a52016-07-19 11:28:42 +0200168 BIO_BUG_ON(idx >= BVEC_POOL_NR);
169
170 if (idx == BVEC_POOL_MAX) {
Kent Overstreet9f060e22012-10-12 15:29:33 -0700171 mempool_free(bv, pool);
Christoph Hellwiged996a52016-07-19 11:28:42 +0200172 } else {
Jens Axboebb799ca2008-12-10 15:35:05 +0100173 struct biovec_slab *bvs = bvec_slabs + idx;
174
175 kmem_cache_free(bvs->slab, bv);
176 }
177}
178
Kent Overstreet9f060e22012-10-12 15:29:33 -0700179struct bio_vec *bvec_alloc(gfp_t gfp_mask, int nr, unsigned long *idx,
180 mempool_t *pool)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181{
182 struct bio_vec *bvl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183
184 /*
Jens Axboe7ff93452008-12-11 11:53:43 +0100185 * see comment near bvec_array define!
186 */
187 switch (nr) {
188 case 1:
189 *idx = 0;
190 break;
191 case 2 ... 4:
192 *idx = 1;
193 break;
194 case 5 ... 16:
195 *idx = 2;
196 break;
197 case 17 ... 64:
198 *idx = 3;
199 break;
200 case 65 ... 128:
201 *idx = 4;
202 break;
203 case 129 ... BIO_MAX_PAGES:
204 *idx = 5;
205 break;
206 default:
207 return NULL;
208 }
209
210 /*
211 * idx now points to the pool we want to allocate from. only the
212 * 1-vec entry pool is mempool backed.
213 */
Christoph Hellwiged996a52016-07-19 11:28:42 +0200214 if (*idx == BVEC_POOL_MAX) {
Jens Axboe7ff93452008-12-11 11:53:43 +0100215fallback:
Kent Overstreet9f060e22012-10-12 15:29:33 -0700216 bvl = mempool_alloc(pool, gfp_mask);
Jens Axboe7ff93452008-12-11 11:53:43 +0100217 } else {
218 struct biovec_slab *bvs = bvec_slabs + *idx;
Mel Gormand0164ad2015-11-06 16:28:21 -0800219 gfp_t __gfp_mask = gfp_mask & ~(__GFP_DIRECT_RECLAIM | __GFP_IO);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
Jens Axboe0a0d96b2008-09-11 13:17:37 +0200221 /*
Jens Axboe7ff93452008-12-11 11:53:43 +0100222 * Make this allocation restricted and don't dump info on
223 * allocation failures, since we'll fallback to the mempool
224 * in case of failure.
Jens Axboe0a0d96b2008-09-11 13:17:37 +0200225 */
Jens Axboe7ff93452008-12-11 11:53:43 +0100226 __gfp_mask |= __GFP_NOMEMALLOC | __GFP_NORETRY | __GFP_NOWARN;
227
228 /*
Mel Gormand0164ad2015-11-06 16:28:21 -0800229 * Try a slab allocation. If this fails and __GFP_DIRECT_RECLAIM
Jens Axboe7ff93452008-12-11 11:53:43 +0100230 * is set, retry with the 1-entry mempool
231 */
232 bvl = kmem_cache_alloc(bvs->slab, __gfp_mask);
Mel Gormand0164ad2015-11-06 16:28:21 -0800233 if (unlikely(!bvl && (gfp_mask & __GFP_DIRECT_RECLAIM))) {
Christoph Hellwiged996a52016-07-19 11:28:42 +0200234 *idx = BVEC_POOL_MAX;
Jens Axboe7ff93452008-12-11 11:53:43 +0100235 goto fallback;
236 }
237 }
238
Christoph Hellwiged996a52016-07-19 11:28:42 +0200239 (*idx)++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 return bvl;
241}
242
Jens Axboe9ae3b3f2017-06-28 15:30:13 -0600243void bio_uninit(struct bio *bio)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244{
Kent Overstreet4254bba2012-09-06 15:35:00 -0700245 bio_disassociate_task(bio);
Kent Overstreet4254bba2012-09-06 15:35:00 -0700246}
Jens Axboe9ae3b3f2017-06-28 15:30:13 -0600247EXPORT_SYMBOL(bio_uninit);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200248
Kent Overstreet4254bba2012-09-06 15:35:00 -0700249static void bio_free(struct bio *bio)
250{
251 struct bio_set *bs = bio->bi_pool;
252 void *p;
253
Jens Axboe9ae3b3f2017-06-28 15:30:13 -0600254 bio_uninit(bio);
Kent Overstreet4254bba2012-09-06 15:35:00 -0700255
256 if (bs) {
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400257 bvec_free(&bs->bvec_pool, bio->bi_io_vec, BVEC_POOL_IDX(bio));
Kent Overstreet4254bba2012-09-06 15:35:00 -0700258
259 /*
260 * If we have front padding, adjust the bio pointer before freeing
261 */
262 p = bio;
Jens Axboebb799ca2008-12-10 15:35:05 +0100263 p -= bs->front_pad;
264
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400265 mempool_free(p, &bs->bio_pool);
Kent Overstreet4254bba2012-09-06 15:35:00 -0700266 } else {
267 /* Bio was allocated by bio_kmalloc() */
268 kfree(bio);
269 }
Peter Osterlund36763472005-09-06 15:16:42 -0700270}
271
Jens Axboe9ae3b3f2017-06-28 15:30:13 -0600272/*
273 * Users of this function have their own bio allocation. Subsequently,
274 * they must remember to pair any call to bio_init() with bio_uninit()
275 * when IO has completed, or when the bio is released.
276 */
Ming Lei3a83f462016-11-22 08:57:21 -0700277void bio_init(struct bio *bio, struct bio_vec *table,
278 unsigned short max_vecs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700279{
Jens Axboe2b94de52007-07-18 13:14:03 +0200280 memset(bio, 0, sizeof(*bio));
Jens Axboec4cf5262015-04-17 16:15:18 -0600281 atomic_set(&bio->__bi_remaining, 1);
Jens Axboedac56212015-04-17 16:23:59 -0600282 atomic_set(&bio->__bi_cnt, 1);
Ming Lei3a83f462016-11-22 08:57:21 -0700283
284 bio->bi_io_vec = table;
285 bio->bi_max_vecs = max_vecs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200287EXPORT_SYMBOL(bio_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288
289/**
Kent Overstreetf44b48c2012-09-06 15:34:58 -0700290 * bio_reset - reinitialize a bio
291 * @bio: bio to reset
292 *
293 * Description:
294 * After calling bio_reset(), @bio will be in the same state as a freshly
295 * allocated bio returned bio bio_alloc_bioset() - the only fields that are
296 * preserved are the ones that are initialized by bio_alloc_bioset(). See
297 * comment in struct bio.
298 */
299void bio_reset(struct bio *bio)
300{
301 unsigned long flags = bio->bi_flags & (~0UL << BIO_RESET_BITS);
302
Jens Axboe9ae3b3f2017-06-28 15:30:13 -0600303 bio_uninit(bio);
Kent Overstreetf44b48c2012-09-06 15:34:58 -0700304
305 memset(bio, 0, BIO_RESET_BYTES);
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200306 bio->bi_flags = flags;
Jens Axboec4cf5262015-04-17 16:15:18 -0600307 atomic_set(&bio->__bi_remaining, 1);
Kent Overstreetf44b48c2012-09-06 15:34:58 -0700308}
309EXPORT_SYMBOL(bio_reset);
310
Christoph Hellwig38f8baa2016-03-11 17:34:51 +0100311static struct bio *__bio_chain_endio(struct bio *bio)
Kent Overstreet196d38b2013-11-23 18:34:15 -0800312{
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200313 struct bio *parent = bio->bi_private;
314
Christoph Hellwig4e4cbee2017-06-03 09:38:06 +0200315 if (!parent->bi_status)
316 parent->bi_status = bio->bi_status;
Kent Overstreet196d38b2013-11-23 18:34:15 -0800317 bio_put(bio);
Christoph Hellwig38f8baa2016-03-11 17:34:51 +0100318 return parent;
319}
320
321static void bio_chain_endio(struct bio *bio)
322{
323 bio_endio(__bio_chain_endio(bio));
Kent Overstreet196d38b2013-11-23 18:34:15 -0800324}
325
326/**
327 * bio_chain - chain bio completions
Randy Dunlap1051a902014-04-20 16:03:31 -0700328 * @bio: the target bio
329 * @parent: the @bio's parent bio
Kent Overstreet196d38b2013-11-23 18:34:15 -0800330 *
331 * The caller won't have a bi_end_io called when @bio completes - instead,
332 * @parent's bi_end_io won't be called until both @parent and @bio have
333 * completed; the chained bio will also be freed when it completes.
334 *
335 * The caller must not set bi_private or bi_end_io in @bio.
336 */
337void bio_chain(struct bio *bio, struct bio *parent)
338{
339 BUG_ON(bio->bi_private || bio->bi_end_io);
340
341 bio->bi_private = parent;
342 bio->bi_end_io = bio_chain_endio;
Jens Axboec4cf5262015-04-17 16:15:18 -0600343 bio_inc_remaining(parent);
Kent Overstreet196d38b2013-11-23 18:34:15 -0800344}
345EXPORT_SYMBOL(bio_chain);
346
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700347static void bio_alloc_rescue(struct work_struct *work)
348{
349 struct bio_set *bs = container_of(work, struct bio_set, rescue_work);
350 struct bio *bio;
351
352 while (1) {
353 spin_lock(&bs->rescue_lock);
354 bio = bio_list_pop(&bs->rescue_list);
355 spin_unlock(&bs->rescue_lock);
356
357 if (!bio)
358 break;
359
360 generic_make_request(bio);
361 }
362}
363
364static void punt_bios_to_rescuer(struct bio_set *bs)
365{
366 struct bio_list punt, nopunt;
367 struct bio *bio;
368
NeilBrown47e0fb42017-06-18 14:38:57 +1000369 if (WARN_ON_ONCE(!bs->rescue_workqueue))
370 return;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700371 /*
372 * In order to guarantee forward progress we must punt only bios that
373 * were allocated from this bio_set; otherwise, if there was a bio on
374 * there for a stacking driver higher up in the stack, processing it
375 * could require allocating bios from this bio_set, and doing that from
376 * our own rescuer would be bad.
377 *
378 * Since bio lists are singly linked, pop them all instead of trying to
379 * remove from the middle of the list:
380 */
381
382 bio_list_init(&punt);
383 bio_list_init(&nopunt);
384
NeilBrownf5fe1b52017-03-10 17:00:47 +1100385 while ((bio = bio_list_pop(&current->bio_list[0])))
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700386 bio_list_add(bio->bi_pool == bs ? &punt : &nopunt, bio);
NeilBrownf5fe1b52017-03-10 17:00:47 +1100387 current->bio_list[0] = nopunt;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700388
NeilBrownf5fe1b52017-03-10 17:00:47 +1100389 bio_list_init(&nopunt);
390 while ((bio = bio_list_pop(&current->bio_list[1])))
391 bio_list_add(bio->bi_pool == bs ? &punt : &nopunt, bio);
392 current->bio_list[1] = nopunt;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700393
394 spin_lock(&bs->rescue_lock);
395 bio_list_merge(&bs->rescue_list, &punt);
396 spin_unlock(&bs->rescue_lock);
397
398 queue_work(bs->rescue_workqueue, &bs->rescue_work);
399}
400
Kent Overstreetf44b48c2012-09-06 15:34:58 -0700401/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402 * bio_alloc_bioset - allocate a bio for I/O
Randy Dunlap519c8e92017-10-16 11:01:00 -0700403 * @gfp_mask: the GFP_* mask given to the slab allocator
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 * @nr_iovecs: number of iovecs to pre-allocate
Jaak Ristiojadb18efa2010-01-15 12:05:07 +0200405 * @bs: the bio_set to allocate from.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 *
407 * Description:
Kent Overstreet3f86a822012-09-06 15:35:01 -0700408 * If @bs is NULL, uses kmalloc() to allocate the bio; else the allocation is
409 * backed by the @bs's mempool.
410 *
Mel Gormand0164ad2015-11-06 16:28:21 -0800411 * When @bs is not NULL, if %__GFP_DIRECT_RECLAIM is set then bio_alloc will
412 * always be able to allocate a bio. This is due to the mempool guarantees.
413 * To make this work, callers must never allocate more than 1 bio at a time
414 * from this pool. Callers that need to allocate more than 1 bio must always
415 * submit the previously allocated bio for IO before attempting to allocate
416 * a new one. Failure to do so can cause deadlocks under memory pressure.
Kent Overstreet3f86a822012-09-06 15:35:01 -0700417 *
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700418 * Note that when running under generic_make_request() (i.e. any block
419 * driver), bios are not submitted until after you return - see the code in
420 * generic_make_request() that converts recursion into iteration, to prevent
421 * stack overflows.
422 *
423 * This would normally mean allocating multiple bios under
424 * generic_make_request() would be susceptible to deadlocks, but we have
425 * deadlock avoidance code that resubmits any blocked bios from a rescuer
426 * thread.
427 *
428 * However, we do not guarantee forward progress for allocations from other
429 * mempools. Doing multiple allocations from the same mempool under
430 * generic_make_request() should be avoided - instead, use bio_set's front_pad
431 * for per bio allocations.
432 *
Kent Overstreet3f86a822012-09-06 15:35:01 -0700433 * RETURNS:
434 * Pointer to new bio on success, NULL on failure.
435 */
Dan Carpenter7a88fa12017-03-23 13:24:55 +0300436struct bio *bio_alloc_bioset(gfp_t gfp_mask, unsigned int nr_iovecs,
437 struct bio_set *bs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438{
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700439 gfp_t saved_gfp = gfp_mask;
Kent Overstreet3f86a822012-09-06 15:35:01 -0700440 unsigned front_pad;
441 unsigned inline_vecs;
Ingo Molnar34053972009-02-21 11:16:36 +0100442 struct bio_vec *bvl = NULL;
Tejun Heo451a9eb2009-04-15 19:50:51 +0200443 struct bio *bio;
444 void *p;
Jens Axboe0a0d96b2008-09-11 13:17:37 +0200445
Kent Overstreet3f86a822012-09-06 15:35:01 -0700446 if (!bs) {
447 if (nr_iovecs > UIO_MAXIOV)
448 return NULL;
449
450 p = kmalloc(sizeof(struct bio) +
451 nr_iovecs * sizeof(struct bio_vec),
452 gfp_mask);
453 front_pad = 0;
454 inline_vecs = nr_iovecs;
455 } else {
Junichi Nomurad8f429e2014-10-03 17:27:12 -0400456 /* should not use nobvec bioset for nr_iovecs > 0 */
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400457 if (WARN_ON_ONCE(!mempool_initialized(&bs->bvec_pool) &&
458 nr_iovecs > 0))
Junichi Nomurad8f429e2014-10-03 17:27:12 -0400459 return NULL;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700460 /*
461 * generic_make_request() converts recursion to iteration; this
462 * means if we're running beneath it, any bios we allocate and
463 * submit will not be submitted (and thus freed) until after we
464 * return.
465 *
466 * This exposes us to a potential deadlock if we allocate
467 * multiple bios from the same bio_set() while running
468 * underneath generic_make_request(). If we were to allocate
469 * multiple bios (say a stacking block driver that was splitting
470 * bios), we would deadlock if we exhausted the mempool's
471 * reserve.
472 *
473 * We solve this, and guarantee forward progress, with a rescuer
474 * workqueue per bio_set. If we go to allocate and there are
475 * bios on current->bio_list, we first try the allocation
Mel Gormand0164ad2015-11-06 16:28:21 -0800476 * without __GFP_DIRECT_RECLAIM; if that fails, we punt those
477 * bios we would be blocking to the rescuer workqueue before
478 * we retry with the original gfp_flags.
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700479 */
480
NeilBrownf5fe1b52017-03-10 17:00:47 +1100481 if (current->bio_list &&
482 (!bio_list_empty(&current->bio_list[0]) ||
NeilBrown47e0fb42017-06-18 14:38:57 +1000483 !bio_list_empty(&current->bio_list[1])) &&
484 bs->rescue_workqueue)
Mel Gormand0164ad2015-11-06 16:28:21 -0800485 gfp_mask &= ~__GFP_DIRECT_RECLAIM;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700486
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400487 p = mempool_alloc(&bs->bio_pool, gfp_mask);
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700488 if (!p && gfp_mask != saved_gfp) {
489 punt_bios_to_rescuer(bs);
490 gfp_mask = saved_gfp;
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400491 p = mempool_alloc(&bs->bio_pool, gfp_mask);
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700492 }
493
Kent Overstreet3f86a822012-09-06 15:35:01 -0700494 front_pad = bs->front_pad;
495 inline_vecs = BIO_INLINE_VECS;
496 }
497
Tejun Heo451a9eb2009-04-15 19:50:51 +0200498 if (unlikely(!p))
499 return NULL;
Ingo Molnar34053972009-02-21 11:16:36 +0100500
Kent Overstreet3f86a822012-09-06 15:35:01 -0700501 bio = p + front_pad;
Ming Lei3a83f462016-11-22 08:57:21 -0700502 bio_init(bio, NULL, 0);
Ingo Molnar34053972009-02-21 11:16:36 +0100503
Kent Overstreet3f86a822012-09-06 15:35:01 -0700504 if (nr_iovecs > inline_vecs) {
Christoph Hellwiged996a52016-07-19 11:28:42 +0200505 unsigned long idx = 0;
506
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400507 bvl = bvec_alloc(gfp_mask, nr_iovecs, &idx, &bs->bvec_pool);
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700508 if (!bvl && gfp_mask != saved_gfp) {
509 punt_bios_to_rescuer(bs);
510 gfp_mask = saved_gfp;
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400511 bvl = bvec_alloc(gfp_mask, nr_iovecs, &idx, &bs->bvec_pool);
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700512 }
513
Ingo Molnar34053972009-02-21 11:16:36 +0100514 if (unlikely(!bvl))
515 goto err_free;
Kent Overstreeta38352e2012-05-25 13:03:11 -0700516
Christoph Hellwiged996a52016-07-19 11:28:42 +0200517 bio->bi_flags |= idx << BVEC_POOL_OFFSET;
Kent Overstreet3f86a822012-09-06 15:35:01 -0700518 } else if (nr_iovecs) {
519 bvl = bio->bi_inline_vecs;
Ingo Molnar34053972009-02-21 11:16:36 +0100520 }
Kent Overstreet3f86a822012-09-06 15:35:01 -0700521
522 bio->bi_pool = bs;
Ingo Molnar34053972009-02-21 11:16:36 +0100523 bio->bi_max_vecs = nr_iovecs;
Ingo Molnar34053972009-02-21 11:16:36 +0100524 bio->bi_io_vec = bvl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525 return bio;
Ingo Molnar34053972009-02-21 11:16:36 +0100526
527err_free:
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400528 mempool_free(p, &bs->bio_pool);
Ingo Molnar34053972009-02-21 11:16:36 +0100529 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200531EXPORT_SYMBOL(bio_alloc_bioset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532
Kent Overstreet38a72da2018-05-08 21:33:53 -0400533void zero_fill_bio_iter(struct bio *bio, struct bvec_iter start)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534{
535 unsigned long flags;
Kent Overstreet79886132013-11-23 17:19:00 -0800536 struct bio_vec bv;
537 struct bvec_iter iter;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538
Kent Overstreet38a72da2018-05-08 21:33:53 -0400539 __bio_for_each_segment(bv, bio, iter, start) {
Kent Overstreet79886132013-11-23 17:19:00 -0800540 char *data = bvec_kmap_irq(&bv, &flags);
541 memset(data, 0, bv.bv_len);
542 flush_dcache_page(bv.bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 bvec_kunmap_irq(data, &flags);
544 }
545}
Kent Overstreet38a72da2018-05-08 21:33:53 -0400546EXPORT_SYMBOL(zero_fill_bio_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547
548/**
549 * bio_put - release a reference to a bio
550 * @bio: bio to release reference to
551 *
552 * Description:
553 * Put a reference to a &struct bio, either one you have gotten with
NeilBrown9b10f6a2017-06-18 14:38:59 +1000554 * bio_alloc, bio_get or bio_clone_*. The last put of a bio will free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 **/
556void bio_put(struct bio *bio)
557{
Jens Axboedac56212015-04-17 16:23:59 -0600558 if (!bio_flagged(bio, BIO_REFFED))
Kent Overstreet4254bba2012-09-06 15:35:00 -0700559 bio_free(bio);
Jens Axboedac56212015-04-17 16:23:59 -0600560 else {
561 BIO_BUG_ON(!atomic_read(&bio->__bi_cnt));
562
563 /*
564 * last put frees it
565 */
566 if (atomic_dec_and_test(&bio->__bi_cnt))
567 bio_free(bio);
568 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200570EXPORT_SYMBOL(bio_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571
Jens Axboe165125e2007-07-24 09:28:11 +0200572inline int bio_phys_segments(struct request_queue *q, struct bio *bio)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573{
574 if (unlikely(!bio_flagged(bio, BIO_SEG_VALID)))
575 blk_recount_segments(q, bio);
576
577 return bio->bi_phys_segments;
578}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200579EXPORT_SYMBOL(bio_phys_segments);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581/**
Kent Overstreet59d276f2013-11-23 18:19:27 -0800582 * __bio_clone_fast - clone a bio that shares the original bio's biovec
583 * @bio: destination bio
584 * @bio_src: bio to clone
585 *
586 * Clone a &bio. Caller will own the returned bio, but not
587 * the actual data it points to. Reference count of returned
588 * bio will be one.
589 *
590 * Caller must ensure that @bio_src is not freed before @bio.
591 */
592void __bio_clone_fast(struct bio *bio, struct bio *bio_src)
593{
Christoph Hellwiged996a52016-07-19 11:28:42 +0200594 BUG_ON(bio->bi_pool && BVEC_POOL_IDX(bio));
Kent Overstreet59d276f2013-11-23 18:19:27 -0800595
596 /*
Christoph Hellwig74d46992017-08-23 19:10:32 +0200597 * most users will be overriding ->bi_disk with a new target,
Kent Overstreet59d276f2013-11-23 18:19:27 -0800598 * so we don't set nor calculate new physical/hw segment counts here
599 */
Christoph Hellwig74d46992017-08-23 19:10:32 +0200600 bio->bi_disk = bio_src->bi_disk;
Michael Lyle62530ed2017-11-16 23:47:25 -0800601 bio->bi_partno = bio_src->bi_partno;
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600602 bio_set_flag(bio, BIO_CLONED);
Shaohua Li111be882017-12-20 11:10:17 -0700603 if (bio_flagged(bio_src, BIO_THROTTLED))
604 bio_set_flag(bio, BIO_THROTTLED);
Jens Axboe1eff9d32016-08-05 15:35:16 -0600605 bio->bi_opf = bio_src->bi_opf;
Jens Axboecb6934f2017-06-27 09:22:02 -0600606 bio->bi_write_hint = bio_src->bi_write_hint;
Kent Overstreet59d276f2013-11-23 18:19:27 -0800607 bio->bi_iter = bio_src->bi_iter;
608 bio->bi_io_vec = bio_src->bi_io_vec;
Paolo Valente20bd7232016-07-27 07:22:05 +0200609
610 bio_clone_blkcg_association(bio, bio_src);
Kent Overstreet59d276f2013-11-23 18:19:27 -0800611}
612EXPORT_SYMBOL(__bio_clone_fast);
613
614/**
615 * bio_clone_fast - clone a bio that shares the original bio's biovec
616 * @bio: bio to clone
617 * @gfp_mask: allocation priority
618 * @bs: bio_set to allocate from
619 *
620 * Like __bio_clone_fast, only also allocates the returned bio
621 */
622struct bio *bio_clone_fast(struct bio *bio, gfp_t gfp_mask, struct bio_set *bs)
623{
624 struct bio *b;
625
626 b = bio_alloc_bioset(gfp_mask, 0, bs);
627 if (!b)
628 return NULL;
629
630 __bio_clone_fast(b, bio);
631
632 if (bio_integrity(bio)) {
633 int ret;
634
635 ret = bio_integrity_clone(b, bio, gfp_mask);
636
637 if (ret < 0) {
638 bio_put(b);
639 return NULL;
640 }
641 }
642
643 return b;
644}
645EXPORT_SYMBOL(bio_clone_fast);
646
Shaohua Lif4595872017-03-24 10:34:43 -0700647/**
648 * bio_clone_bioset - clone a bio
649 * @bio_src: bio to clone
650 * @gfp_mask: allocation priority
651 * @bs: bio_set to allocate from
652 *
653 * Clone bio. Caller will own the returned bio, but not the actual data it
654 * points to. Reference count of returned bio will be one.
655 */
656struct bio *bio_clone_bioset(struct bio *bio_src, gfp_t gfp_mask,
657 struct bio_set *bs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658{
Kent Overstreetbdb53202013-11-23 17:26:46 -0800659 struct bvec_iter iter;
660 struct bio_vec bv;
661 struct bio *bio;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700662
Kent Overstreetbdb53202013-11-23 17:26:46 -0800663 /*
664 * Pre immutable biovecs, __bio_clone() used to just do a memcpy from
665 * bio_src->bi_io_vec to bio->bi_io_vec.
666 *
667 * We can't do that anymore, because:
668 *
669 * - The point of cloning the biovec is to produce a bio with a biovec
670 * the caller can modify: bi_idx and bi_bvec_done should be 0.
671 *
672 * - The original bio could've had more than BIO_MAX_PAGES biovecs; if
673 * we tried to clone the whole thing bio_alloc_bioset() would fail.
674 * But the clone should succeed as long as the number of biovecs we
675 * actually need to allocate is fewer than BIO_MAX_PAGES.
676 *
677 * - Lastly, bi_vcnt should not be looked at or relied upon by code
678 * that does not own the bio - reason being drivers don't use it for
679 * iterating over the biovec anymore, so expecting it to be kept up
680 * to date (i.e. for clones that share the parent biovec) is just
681 * asking for trouble and would force extra work on
682 * __bio_clone_fast() anyways.
683 */
684
Shaohua Lif4595872017-03-24 10:34:43 -0700685 bio = bio_alloc_bioset(gfp_mask, bio_segments(bio_src), bs);
Kent Overstreetbdb53202013-11-23 17:26:46 -0800686 if (!bio)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200687 return NULL;
Christoph Hellwig74d46992017-08-23 19:10:32 +0200688 bio->bi_disk = bio_src->bi_disk;
Jens Axboe1eff9d32016-08-05 15:35:16 -0600689 bio->bi_opf = bio_src->bi_opf;
Jens Axboecb6934f2017-06-27 09:22:02 -0600690 bio->bi_write_hint = bio_src->bi_write_hint;
Kent Overstreetbdb53202013-11-23 17:26:46 -0800691 bio->bi_iter.bi_sector = bio_src->bi_iter.bi_sector;
692 bio->bi_iter.bi_size = bio_src->bi_iter.bi_size;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200693
Adrian Hunter7afafc82016-08-16 10:59:35 +0300694 switch (bio_op(bio)) {
695 case REQ_OP_DISCARD:
696 case REQ_OP_SECURE_ERASE:
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800697 case REQ_OP_WRITE_ZEROES:
Adrian Hunter7afafc82016-08-16 10:59:35 +0300698 break;
699 case REQ_OP_WRITE_SAME:
Kent Overstreet8423ae32014-02-10 17:45:50 -0800700 bio->bi_io_vec[bio->bi_vcnt++] = bio_src->bi_io_vec[0];
Adrian Hunter7afafc82016-08-16 10:59:35 +0300701 break;
702 default:
Shaohua Lif4595872017-03-24 10:34:43 -0700703 bio_for_each_segment(bv, bio_src, iter)
Adrian Hunter7afafc82016-08-16 10:59:35 +0300704 bio->bi_io_vec[bio->bi_vcnt++] = bv;
705 break;
Kent Overstreet8423ae32014-02-10 17:45:50 -0800706 }
707
Kent Overstreetbdb53202013-11-23 17:26:46 -0800708 if (bio_integrity(bio_src)) {
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200709 int ret;
710
Kent Overstreetbdb53202013-11-23 17:26:46 -0800711 ret = bio_integrity_clone(bio, bio_src, gfp_mask);
Li Zefan059ea332009-03-09 10:42:45 +0100712 if (ret < 0) {
Kent Overstreetbdb53202013-11-23 17:26:46 -0800713 bio_put(bio);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200714 return NULL;
Li Zefan059ea332009-03-09 10:42:45 +0100715 }
Peter Osterlund36763472005-09-06 15:16:42 -0700716 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717
Paolo Valente20bd7232016-07-27 07:22:05 +0200718 bio_clone_blkcg_association(bio, bio_src);
719
Kent Overstreetbdb53202013-11-23 17:26:46 -0800720 return bio;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700721}
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700722EXPORT_SYMBOL(bio_clone_bioset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723
724/**
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800725 * bio_add_pc_page - attempt to add page to bio
726 * @q: the target queue
727 * @bio: destination bio
728 * @page: page to add
729 * @len: vec entry length
730 * @offset: vec entry offset
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731 *
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800732 * Attempt to add a page to the bio_vec maplist. This can fail for a
733 * number of reasons, such as the bio being full or target block device
734 * limitations. The target block device must allow bio's up to PAGE_SIZE,
735 * so it is always possible to add a single page to an empty bio.
736 *
737 * This should only be used by REQ_PC bios.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 */
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800739int bio_add_pc_page(struct request_queue *q, struct bio *bio, struct page
740 *page, unsigned int len, unsigned int offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741{
742 int retried_segments = 0;
743 struct bio_vec *bvec;
744
745 /*
746 * cloned bio must not modify vec list
747 */
748 if (unlikely(bio_flagged(bio, BIO_CLONED)))
749 return 0;
750
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800751 if (((bio->bi_iter.bi_size + len) >> 9) > queue_max_hw_sectors(q))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 return 0;
753
Jens Axboe80cfd542006-01-06 09:43:28 +0100754 /*
755 * For filesystems with a blocksize smaller than the pagesize
756 * we will often be called with the same page as last time and
757 * a consecutive offset. Optimize this special case.
758 */
759 if (bio->bi_vcnt > 0) {
760 struct bio_vec *prev = &bio->bi_io_vec[bio->bi_vcnt - 1];
761
762 if (page == prev->bv_page &&
763 offset == prev->bv_offset + prev->bv_len) {
764 prev->bv_len += len;
Maurizio Lombardifcbf6a02014-12-10 14:16:53 -0800765 bio->bi_iter.bi_size += len;
Jens Axboe80cfd542006-01-06 09:43:28 +0100766 goto done;
767 }
Jens Axboe66cb45a2014-06-24 16:22:24 -0600768
769 /*
770 * If the queue doesn't support SG gaps and adding this
771 * offset would create a gap, disallow it.
772 */
Keith Busch03100aa2015-08-19 14:24:05 -0700773 if (bvec_gap_to_prev(q, prev, offset))
Jens Axboe66cb45a2014-06-24 16:22:24 -0600774 return 0;
Jens Axboe80cfd542006-01-06 09:43:28 +0100775 }
776
777 if (bio->bi_vcnt >= bio->bi_max_vecs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700778 return 0;
779
780 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 * setup the new entry, we might clear it again later if we
782 * cannot add the page
783 */
784 bvec = &bio->bi_io_vec[bio->bi_vcnt];
785 bvec->bv_page = page;
786 bvec->bv_len = len;
787 bvec->bv_offset = offset;
Maurizio Lombardifcbf6a02014-12-10 14:16:53 -0800788 bio->bi_vcnt++;
789 bio->bi_phys_segments++;
790 bio->bi_iter.bi_size += len;
791
792 /*
793 * Perform a recount if the number of segments is greater
794 * than queue_max_segments(q).
795 */
796
797 while (bio->bi_phys_segments > queue_max_segments(q)) {
798
799 if (retried_segments)
800 goto failed;
801
802 retried_segments = 1;
803 blk_recount_segments(q, bio);
804 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 /* If we may be able to merge these biovecs, force a recount */
Maurizio Lombardifcbf6a02014-12-10 14:16:53 -0800807 if (bio->bi_vcnt > 1 && (BIOVEC_PHYS_MERGEABLE(bvec-1, bvec)))
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600808 bio_clear_flag(bio, BIO_SEG_VALID);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809
Jens Axboe80cfd542006-01-06 09:43:28 +0100810 done:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 return len;
Maurizio Lombardifcbf6a02014-12-10 14:16:53 -0800812
813 failed:
814 bvec->bv_page = NULL;
815 bvec->bv_len = 0;
816 bvec->bv_offset = 0;
817 bio->bi_vcnt--;
818 bio->bi_iter.bi_size -= len;
819 blk_recount_segments(q, bio);
820 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200822EXPORT_SYMBOL(bio_add_pc_page);
Mike Christie6e68af62005-11-11 05:30:27 -0600823
824/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 * bio_add_page - attempt to add page to bio
826 * @bio: destination bio
827 * @page: page to add
828 * @len: vec entry length
829 * @offset: vec entry offset
830 *
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800831 * Attempt to add a page to the bio_vec maplist. This will only fail
832 * if either bio->bi_vcnt == bio->bi_max_vecs or it's a cloned bio.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833 */
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800834int bio_add_page(struct bio *bio, struct page *page,
835 unsigned int len, unsigned int offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836{
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800837 struct bio_vec *bv;
Jens Axboe762380a2014-06-05 13:38:39 -0600838
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800839 /*
840 * cloned bio must not modify vec list
841 */
842 if (WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED)))
843 return 0;
Jens Axboe58a49152014-06-10 12:53:56 -0600844
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800845 /*
846 * For filesystems with a blocksize smaller than the pagesize
847 * we will often be called with the same page as last time and
848 * a consecutive offset. Optimize this special case.
849 */
850 if (bio->bi_vcnt > 0) {
851 bv = &bio->bi_io_vec[bio->bi_vcnt - 1];
852
853 if (page == bv->bv_page &&
854 offset == bv->bv_offset + bv->bv_len) {
855 bv->bv_len += len;
856 goto done;
857 }
858 }
859
860 if (bio->bi_vcnt >= bio->bi_max_vecs)
861 return 0;
862
863 bv = &bio->bi_io_vec[bio->bi_vcnt];
864 bv->bv_page = page;
865 bv->bv_len = len;
866 bv->bv_offset = offset;
867
868 bio->bi_vcnt++;
869done:
870 bio->bi_iter.bi_size += len;
871 return len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200873EXPORT_SYMBOL(bio_add_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600875/**
876 * bio_iov_iter_get_pages - pin user or kernel pages and add them to a bio
877 * @bio: bio to add pages to
878 * @iter: iov iterator describing the region to be mapped
879 *
880 * Pins as many pages from *iter and appends them to @bio's bvec array. The
881 * pages will have to be released using put_page() when done.
882 */
883int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter)
884{
885 unsigned short nr_pages = bio->bi_max_vecs - bio->bi_vcnt;
886 struct bio_vec *bv = bio->bi_io_vec + bio->bi_vcnt;
887 struct page **pages = (struct page **)bv;
888 size_t offset, diff;
889 ssize_t size;
890
891 size = iov_iter_get_pages(iter, pages, LONG_MAX, nr_pages, &offset);
892 if (unlikely(size <= 0))
893 return size ? size : -EFAULT;
894 nr_pages = (size + offset + PAGE_SIZE - 1) / PAGE_SIZE;
895
896 /*
897 * Deep magic below: We need to walk the pinned pages backwards
898 * because we are abusing the space allocated for the bio_vecs
899 * for the page array. Because the bio_vecs are larger than the
900 * page pointers by definition this will always work. But it also
901 * means we can't use bio_add_page, so any changes to it's semantics
902 * need to be reflected here as well.
903 */
904 bio->bi_iter.bi_size += size;
905 bio->bi_vcnt += nr_pages;
906
907 diff = (nr_pages * PAGE_SIZE - offset) - size;
908 while (nr_pages--) {
909 bv[nr_pages].bv_page = pages[nr_pages];
910 bv[nr_pages].bv_len = PAGE_SIZE;
911 bv[nr_pages].bv_offset = 0;
912 }
913
914 bv[0].bv_offset += offset;
915 bv[0].bv_len -= offset;
916 if (diff)
917 bv[bio->bi_vcnt - 1].bv_len -= diff;
918
919 iov_iter_advance(iter, size);
920 return 0;
921}
922EXPORT_SYMBOL_GPL(bio_iov_iter_get_pages);
923
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200924static void submit_bio_wait_endio(struct bio *bio)
Kent Overstreet9e882242012-09-10 14:41:12 -0700925{
Christoph Hellwig65e53aa2017-10-25 17:55:57 +0900926 complete(bio->bi_private);
Kent Overstreet9e882242012-09-10 14:41:12 -0700927}
928
929/**
930 * submit_bio_wait - submit a bio, and wait until it completes
Kent Overstreet9e882242012-09-10 14:41:12 -0700931 * @bio: The &struct bio which describes the I/O
932 *
933 * Simple wrapper around submit_bio(). Returns 0 on success, or the error from
934 * bio_endio() on failure.
Jan Kara3d289d62017-08-02 10:25:21 +0200935 *
936 * WARNING: Unlike to how submit_bio() is usually used, this function does not
937 * result in bio reference to be consumed. The caller must drop the reference
938 * on his own.
Kent Overstreet9e882242012-09-10 14:41:12 -0700939 */
Mike Christie4e49ea42016-06-05 14:31:41 -0500940int submit_bio_wait(struct bio *bio)
Kent Overstreet9e882242012-09-10 14:41:12 -0700941{
Byungchul Parke319e1f2017-10-25 17:56:05 +0900942 DECLARE_COMPLETION_ONSTACK_MAP(done, bio->bi_disk->lockdep_map);
Kent Overstreet9e882242012-09-10 14:41:12 -0700943
Christoph Hellwig65e53aa2017-10-25 17:55:57 +0900944 bio->bi_private = &done;
Kent Overstreet9e882242012-09-10 14:41:12 -0700945 bio->bi_end_io = submit_bio_wait_endio;
Jens Axboe1eff9d32016-08-05 15:35:16 -0600946 bio->bi_opf |= REQ_SYNC;
Mike Christie4e49ea42016-06-05 14:31:41 -0500947 submit_bio(bio);
Christoph Hellwig65e53aa2017-10-25 17:55:57 +0900948 wait_for_completion_io(&done);
Kent Overstreet9e882242012-09-10 14:41:12 -0700949
Christoph Hellwig65e53aa2017-10-25 17:55:57 +0900950 return blk_status_to_errno(bio->bi_status);
Kent Overstreet9e882242012-09-10 14:41:12 -0700951}
952EXPORT_SYMBOL(submit_bio_wait);
953
Kent Overstreet054bdf62012-09-28 13:17:55 -0700954/**
955 * bio_advance - increment/complete a bio by some number of bytes
956 * @bio: bio to advance
957 * @bytes: number of bytes to complete
958 *
959 * This updates bi_sector, bi_size and bi_idx; if the number of bytes to
960 * complete doesn't align with a bvec boundary, then bv_len and bv_offset will
961 * be updated on the last bvec as well.
962 *
963 * @bio will then represent the remaining, uncompleted portion of the io.
964 */
965void bio_advance(struct bio *bio, unsigned bytes)
966{
967 if (bio_integrity(bio))
968 bio_integrity_advance(bio, bytes);
969
Kent Overstreet4550dd62013-08-07 14:26:21 -0700970 bio_advance_iter(bio, &bio->bi_iter, bytes);
Kent Overstreet054bdf62012-09-28 13:17:55 -0700971}
972EXPORT_SYMBOL(bio_advance);
973
Kent Overstreet38a72da2018-05-08 21:33:53 -0400974void bio_copy_data_iter(struct bio *dst, struct bvec_iter dst_iter,
975 struct bio *src, struct bvec_iter src_iter)
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700976{
Kent Overstreet1cb9dda2013-08-07 14:26:39 -0700977 struct bio_vec src_bv, dst_bv;
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700978 void *src_p, *dst_p;
Kent Overstreet1cb9dda2013-08-07 14:26:39 -0700979 unsigned bytes;
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700980
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700981 while (1) {
Kent Overstreet1cb9dda2013-08-07 14:26:39 -0700982 if (!src_iter.bi_size) {
983 src = src->bi_next;
984 if (!src)
985 break;
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700986
Kent Overstreet1cb9dda2013-08-07 14:26:39 -0700987 src_iter = src->bi_iter;
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700988 }
989
Kent Overstreet1cb9dda2013-08-07 14:26:39 -0700990 if (!dst_iter.bi_size) {
991 dst = dst->bi_next;
992 if (!dst)
993 break;
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700994
Kent Overstreet1cb9dda2013-08-07 14:26:39 -0700995 dst_iter = dst->bi_iter;
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700996 }
997
Kent Overstreet1cb9dda2013-08-07 14:26:39 -0700998 src_bv = bio_iter_iovec(src, src_iter);
999 dst_bv = bio_iter_iovec(dst, dst_iter);
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001000
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001001 bytes = min(src_bv.bv_len, dst_bv.bv_len);
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001002
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001003 src_p = kmap_atomic(src_bv.bv_page);
1004 dst_p = kmap_atomic(dst_bv.bv_page);
1005
1006 memcpy(dst_p + dst_bv.bv_offset,
1007 src_p + src_bv.bv_offset,
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001008 bytes);
1009
1010 kunmap_atomic(dst_p);
1011 kunmap_atomic(src_p);
1012
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001013 bio_advance_iter(src, &src_iter, bytes);
1014 bio_advance_iter(dst, &dst_iter, bytes);
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001015 }
1016}
Kent Overstreet38a72da2018-05-08 21:33:53 -04001017EXPORT_SYMBOL(bio_copy_data_iter);
1018
1019/**
1020 * bio_copy_data - copy contents of data buffers from one chain of bios to
1021 * another
1022 * @src: source bio list
1023 * @dst: destination bio list
1024 *
1025 * If @src and @dst are single bios, bi_next must be NULL - otherwise, treats
1026 * @src and @dst as linked lists of bios.
1027 *
1028 * Stops when it reaches the end of either @src or @dst - that is, copies
1029 * min(src->bi_size, dst->bi_size) bytes (or the equivalent for lists of bios).
1030 */
1031void bio_copy_data(struct bio *dst, struct bio *src)
1032{
1033 bio_copy_data_iter(dst, dst->bi_iter,
1034 src, src->bi_iter);
1035}
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001036EXPORT_SYMBOL(bio_copy_data);
1037
Linus Torvalds1da177e2005-04-16 15:20:36 -07001038struct bio_map_data {
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001039 int is_our_pages;
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001040 struct iov_iter iter;
1041 struct iovec iov[];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042};
1043
Al Viro0e5b9352017-09-24 13:14:35 -04001044static struct bio_map_data *bio_alloc_map_data(struct iov_iter *data,
FUJITA Tomonori76029ff2008-08-25 20:36:08 +02001045 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001046{
Al Viro0e5b9352017-09-24 13:14:35 -04001047 struct bio_map_data *bmd;
1048 if (data->nr_segs > UIO_MAXIOV)
Jens Axboef3f63c12010-10-29 11:46:56 -06001049 return NULL;
1050
Al Viro0e5b9352017-09-24 13:14:35 -04001051 bmd = kmalloc(sizeof(struct bio_map_data) +
1052 sizeof(struct iovec) * data->nr_segs, gfp_mask);
1053 if (!bmd)
1054 return NULL;
1055 memcpy(bmd->iov, data->iov, sizeof(struct iovec) * data->nr_segs);
1056 bmd->iter = *data;
1057 bmd->iter.iov = bmd->iov;
1058 return bmd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059}
1060
Dongsu Park9124d3f2015-01-18 16:16:34 +01001061/**
1062 * bio_copy_from_iter - copy all pages from iov_iter to bio
1063 * @bio: The &struct bio which describes the I/O as destination
1064 * @iter: iov_iter as source
1065 *
1066 * Copy all pages from iov_iter to bio.
1067 * Returns 0 on success, or error on failure.
1068 */
Al Viro98a09d62017-09-24 12:14:36 -04001069static int bio_copy_from_iter(struct bio *bio, struct iov_iter *iter)
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001070{
Dongsu Park9124d3f2015-01-18 16:16:34 +01001071 int i;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001072 struct bio_vec *bvec;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001073
Kent Overstreetd74c6d52013-02-06 12:23:11 -08001074 bio_for_each_segment_all(bvec, bio, i) {
Dongsu Park9124d3f2015-01-18 16:16:34 +01001075 ssize_t ret;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001076
Dongsu Park9124d3f2015-01-18 16:16:34 +01001077 ret = copy_page_from_iter(bvec->bv_page,
1078 bvec->bv_offset,
1079 bvec->bv_len,
Al Viro98a09d62017-09-24 12:14:36 -04001080 iter);
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001081
Al Viro98a09d62017-09-24 12:14:36 -04001082 if (!iov_iter_count(iter))
Dongsu Park9124d3f2015-01-18 16:16:34 +01001083 break;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001084
Dongsu Park9124d3f2015-01-18 16:16:34 +01001085 if (ret < bvec->bv_len)
1086 return -EFAULT;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001087 }
1088
Dongsu Park9124d3f2015-01-18 16:16:34 +01001089 return 0;
1090}
1091
1092/**
1093 * bio_copy_to_iter - copy all pages from bio to iov_iter
1094 * @bio: The &struct bio which describes the I/O as source
1095 * @iter: iov_iter as destination
1096 *
1097 * Copy all pages from bio to iov_iter.
1098 * Returns 0 on success, or error on failure.
1099 */
1100static int bio_copy_to_iter(struct bio *bio, struct iov_iter iter)
1101{
1102 int i;
1103 struct bio_vec *bvec;
1104
1105 bio_for_each_segment_all(bvec, bio, i) {
1106 ssize_t ret;
1107
1108 ret = copy_page_to_iter(bvec->bv_page,
1109 bvec->bv_offset,
1110 bvec->bv_len,
1111 &iter);
1112
1113 if (!iov_iter_count(&iter))
1114 break;
1115
1116 if (ret < bvec->bv_len)
1117 return -EFAULT;
1118 }
1119
1120 return 0;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001121}
1122
Guoqing Jiang491221f2016-09-22 03:10:01 -04001123void bio_free_pages(struct bio *bio)
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001124{
1125 struct bio_vec *bvec;
1126 int i;
1127
1128 bio_for_each_segment_all(bvec, bio, i)
1129 __free_page(bvec->bv_page);
1130}
Guoqing Jiang491221f2016-09-22 03:10:01 -04001131EXPORT_SYMBOL(bio_free_pages);
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001132
Linus Torvalds1da177e2005-04-16 15:20:36 -07001133/**
1134 * bio_uncopy_user - finish previously mapped bio
1135 * @bio: bio being terminated
1136 *
Christoph Hellwigddad8dd2015-01-18 16:16:29 +01001137 * Free pages allocated from bio_copy_user_iov() and write back data
Linus Torvalds1da177e2005-04-16 15:20:36 -07001138 * to user space in case of a read.
1139 */
1140int bio_uncopy_user(struct bio *bio)
1141{
1142 struct bio_map_data *bmd = bio->bi_private;
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001143 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144
Roland Dreier35dc2482013-08-05 17:55:01 -07001145 if (!bio_flagged(bio, BIO_NULL_MAPPED)) {
1146 /*
1147 * if we're in a workqueue, the request is orphaned, so
Hannes Reinecke2d99b552016-02-12 09:39:15 +01001148 * don't copy into a random user address space, just free
1149 * and return -EINTR so user space doesn't expect any data.
Roland Dreier35dc2482013-08-05 17:55:01 -07001150 */
Hannes Reinecke2d99b552016-02-12 09:39:15 +01001151 if (!current->mm)
1152 ret = -EINTR;
1153 else if (bio_data_dir(bio) == READ)
Dongsu Park9124d3f2015-01-18 16:16:34 +01001154 ret = bio_copy_to_iter(bio, bmd->iter);
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001155 if (bmd->is_our_pages)
1156 bio_free_pages(bio);
Roland Dreier35dc2482013-08-05 17:55:01 -07001157 }
Kent Overstreetc8db4442013-11-22 19:39:06 -08001158 kfree(bmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001159 bio_put(bio);
1160 return ret;
1161}
1162
1163/**
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001164 * bio_copy_user_iov - copy user data to bio
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001165 * @q: destination block queue
1166 * @map_data: pointer to the rq_map_data holding pages (if necessary)
1167 * @iter: iovec iterator
1168 * @gfp_mask: memory allocation flags
Linus Torvalds1da177e2005-04-16 15:20:36 -07001169 *
1170 * Prepares and returns a bio for indirect user io, bouncing data
1171 * to/from kernel pages as necessary. Must be paired with
1172 * call bio_uncopy_user() on io completion.
1173 */
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001174struct bio *bio_copy_user_iov(struct request_queue *q,
1175 struct rq_map_data *map_data,
Al Viroe81cef52017-09-24 09:25:39 -04001176 struct iov_iter *iter,
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001177 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001178{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001179 struct bio_map_data *bmd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001180 struct page *page;
1181 struct bio *bio;
Al Virod16d44e2017-09-24 13:09:18 -04001182 int i = 0, ret;
1183 int nr_pages;
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001184 unsigned int len = iter->count;
Geliang Tangbd5cece2015-11-21 17:27:31 +08001185 unsigned int offset = map_data ? offset_in_page(map_data->offset) : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186
Al Viro0e5b9352017-09-24 13:14:35 -04001187 bmd = bio_alloc_map_data(iter, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188 if (!bmd)
1189 return ERR_PTR(-ENOMEM);
1190
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001191 /*
1192 * We need to do a deep copy of the iov_iter including the iovecs.
1193 * The caller provided iov might point to an on-stack or otherwise
1194 * shortlived one.
1195 */
1196 bmd->is_our_pages = map_data ? 0 : 1;
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001197
Al Virod16d44e2017-09-24 13:09:18 -04001198 nr_pages = DIV_ROUND_UP(offset + len, PAGE_SIZE);
1199 if (nr_pages > BIO_MAX_PAGES)
1200 nr_pages = BIO_MAX_PAGES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202 ret = -ENOMEM;
Tejun Heoa9e9dc22009-04-15 22:10:27 +09001203 bio = bio_kmalloc(gfp_mask, nr_pages);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001204 if (!bio)
1205 goto out_bmd;
1206
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207 ret = 0;
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001208
1209 if (map_data) {
FUJITA Tomonorie623ddb2008-12-18 14:49:36 +09001210 nr_pages = 1 << map_data->page_order;
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001211 i = map_data->offset / PAGE_SIZE;
1212 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001213 while (len) {
FUJITA Tomonorie623ddb2008-12-18 14:49:36 +09001214 unsigned int bytes = PAGE_SIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001215
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001216 bytes -= offset;
1217
Linus Torvalds1da177e2005-04-16 15:20:36 -07001218 if (bytes > len)
1219 bytes = len;
1220
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001221 if (map_data) {
FUJITA Tomonorie623ddb2008-12-18 14:49:36 +09001222 if (i == map_data->nr_entries * nr_pages) {
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001223 ret = -ENOMEM;
1224 break;
1225 }
FUJITA Tomonorie623ddb2008-12-18 14:49:36 +09001226
1227 page = map_data->pages[i / nr_pages];
1228 page += (i % nr_pages);
1229
1230 i++;
1231 } else {
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001232 page = alloc_page(q->bounce_gfp | gfp_mask);
FUJITA Tomonorie623ddb2008-12-18 14:49:36 +09001233 if (!page) {
1234 ret = -ENOMEM;
1235 break;
1236 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237 }
1238
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001239 if (bio_add_pc_page(q, bio, page, bytes, offset) < bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241
1242 len -= bytes;
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001243 offset = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001244 }
1245
1246 if (ret)
1247 goto cleanup;
1248
Al Viro2884d0b2017-09-24 12:09:21 -04001249 if (map_data)
1250 map_data->offset += bio->bi_iter.bi_size;
1251
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252 /*
1253 * success
1254 */
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001255 if (((iter->type & WRITE) && (!map_data || !map_data->null_mapped)) ||
FUJITA Tomonoriecb554a2009-07-09 14:46:53 +02001256 (map_data && map_data->from_user)) {
Al Viro98a09d62017-09-24 12:14:36 -04001257 ret = bio_copy_from_iter(bio, iter);
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001258 if (ret)
1259 goto cleanup;
Al Viro98a09d62017-09-24 12:14:36 -04001260 } else {
1261 iov_iter_advance(iter, bio->bi_iter.bi_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 }
1263
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001264 bio->bi_private = bmd;
Al Viro2884d0b2017-09-24 12:09:21 -04001265 if (map_data && map_data->null_mapped)
1266 bio_set_flag(bio, BIO_NULL_MAPPED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001267 return bio;
1268cleanup:
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001269 if (!map_data)
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001270 bio_free_pages(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271 bio_put(bio);
1272out_bmd:
Kent Overstreetc8db4442013-11-22 19:39:06 -08001273 kfree(bmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274 return ERR_PTR(ret);
1275}
1276
Christoph Hellwig37f19e52015-01-18 16:16:33 +01001277/**
1278 * bio_map_user_iov - map user iovec into bio
1279 * @q: the struct request_queue for the bio
1280 * @iter: iovec iterator
1281 * @gfp_mask: memory allocation flags
1282 *
1283 * Map the user space address into a bio suitable for io to a block
1284 * device. Returns an error pointer in case of error.
1285 */
1286struct bio *bio_map_user_iov(struct request_queue *q,
Al Viroe81cef52017-09-24 09:25:39 -04001287 struct iov_iter *iter,
Christoph Hellwig37f19e52015-01-18 16:16:33 +01001288 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289{
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001290 int j;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 struct bio *bio;
Al Viro076098e2017-09-23 16:08:57 -04001292 int ret;
Al Viro2b04e8f2017-09-23 15:51:23 -04001293 struct bio_vec *bvec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294
Al Virob282cc72017-09-23 16:24:59 -04001295 if (!iov_iter_count(iter))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 return ERR_PTR(-EINVAL);
1297
Al Virob282cc72017-09-23 16:24:59 -04001298 bio = bio_kmalloc(gfp_mask, iov_iter_npages(iter, BIO_MAX_PAGES));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299 if (!bio)
1300 return ERR_PTR(-ENOMEM);
1301
Al Viro0a0f1512017-09-24 12:30:17 -04001302 while (iov_iter_count(iter)) {
Al Viro629e42b2017-09-23 16:13:10 -04001303 struct page **pages;
Al Viro076098e2017-09-23 16:08:57 -04001304 ssize_t bytes;
1305 size_t offs, added = 0;
1306 int npages;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001307
Al Viro0a0f1512017-09-24 12:30:17 -04001308 bytes = iov_iter_get_pages_alloc(iter, &pages, LONG_MAX, &offs);
Al Viro076098e2017-09-23 16:08:57 -04001309 if (unlikely(bytes <= 0)) {
1310 ret = bytes ? bytes : -EFAULT;
James Bottomley f1970ba2005-06-20 14:06:52 +02001311 goto out_unmap;
Jens Axboe99172152006-06-16 13:02:29 +02001312 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313
Al Viro076098e2017-09-23 16:08:57 -04001314 npages = DIV_ROUND_UP(offs + bytes, PAGE_SIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001315
Al Viro98f0bc92017-09-23 16:23:18 -04001316 if (unlikely(offs & queue_dma_alignment(q))) {
1317 ret = -EINVAL;
1318 j = 0;
1319 } else {
1320 for (j = 0; j < npages; j++) {
1321 struct page *page = pages[j];
1322 unsigned int n = PAGE_SIZE - offs;
1323 unsigned short prev_bi_vcnt = bio->bi_vcnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324
Al Viro98f0bc92017-09-23 16:23:18 -04001325 if (n > bytes)
1326 n = bytes;
James Bottomley f1970ba2005-06-20 14:06:52 +02001327
Al Viro98f0bc92017-09-23 16:23:18 -04001328 if (!bio_add_pc_page(q, bio, page, n, offs))
1329 break;
Vitaly Mayatskikh95d78c22017-09-22 01:18:39 -04001330
Al Viro98f0bc92017-09-23 16:23:18 -04001331 /*
1332 * check if vector was merged with previous
1333 * drop page reference if needed
1334 */
1335 if (bio->bi_vcnt == prev_bi_vcnt)
1336 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337
Al Viro98f0bc92017-09-23 16:23:18 -04001338 added += n;
1339 bytes -= n;
1340 offs = 0;
1341 }
Al Viro0a0f1512017-09-24 12:30:17 -04001342 iov_iter_advance(iter, added);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001344 /*
1345 * release the pages we didn't map into the bio, if any
1346 */
Al Viro629e42b2017-09-23 16:13:10 -04001347 while (j < npages)
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001348 put_page(pages[j++]);
Al Viro629e42b2017-09-23 16:13:10 -04001349 kvfree(pages);
Al Viroe2e115d2017-09-23 16:16:06 -04001350 /* couldn't stuff something into bio? */
1351 if (bytes)
1352 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001353 }
1354
Jens Axboeb7c44ed2015-07-24 12:37:59 -06001355 bio_set_flag(bio, BIO_USER_MAPPED);
Christoph Hellwig37f19e52015-01-18 16:16:33 +01001356
1357 /*
Bart Van Assche5fad1b62017-02-01 08:20:08 -08001358 * subtle -- if bio_map_user_iov() ended up bouncing a bio,
Christoph Hellwig37f19e52015-01-18 16:16:33 +01001359 * it would normally disappear when its bi_end_io is run.
1360 * however, we need it for the unmap, so grab an extra
1361 * reference to it
1362 */
1363 bio_get(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001364 return bio;
James Bottomley f1970ba2005-06-20 14:06:52 +02001365
1366 out_unmap:
Al Viro2b04e8f2017-09-23 15:51:23 -04001367 bio_for_each_segment_all(bvec, bio, j) {
1368 put_page(bvec->bv_page);
James Bottomley f1970ba2005-06-20 14:06:52 +02001369 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001370 bio_put(bio);
1371 return ERR_PTR(ret);
1372}
1373
Linus Torvalds1da177e2005-04-16 15:20:36 -07001374static void __bio_unmap_user(struct bio *bio)
1375{
1376 struct bio_vec *bvec;
1377 int i;
1378
1379 /*
1380 * make sure we dirty pages we wrote to
1381 */
Kent Overstreetd74c6d52013-02-06 12:23:11 -08001382 bio_for_each_segment_all(bvec, bio, i) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 if (bio_data_dir(bio) == READ)
1384 set_page_dirty_lock(bvec->bv_page);
1385
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001386 put_page(bvec->bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387 }
1388
1389 bio_put(bio);
1390}
1391
1392/**
1393 * bio_unmap_user - unmap a bio
1394 * @bio: the bio being unmapped
1395 *
Bart Van Assche5fad1b62017-02-01 08:20:08 -08001396 * Unmap a bio previously mapped by bio_map_user_iov(). Must be called from
1397 * process context.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398 *
1399 * bio_unmap_user() may sleep.
1400 */
1401void bio_unmap_user(struct bio *bio)
1402{
1403 __bio_unmap_user(bio);
1404 bio_put(bio);
1405}
1406
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001407static void bio_map_kern_endio(struct bio *bio)
Jens Axboeb8238252005-06-20 14:05:27 +02001408{
Jens Axboeb8238252005-06-20 14:05:27 +02001409 bio_put(bio);
Jens Axboeb8238252005-06-20 14:05:27 +02001410}
1411
Christoph Hellwig75c72b82015-01-18 16:16:32 +01001412/**
1413 * bio_map_kern - map kernel address into bio
1414 * @q: the struct request_queue for the bio
1415 * @data: pointer to buffer to map
1416 * @len: length in bytes
1417 * @gfp_mask: allocation flags for bio allocation
1418 *
1419 * Map the kernel address into a bio suitable for io to a block
1420 * device. Returns an error pointer in case of error.
1421 */
1422struct bio *bio_map_kern(struct request_queue *q, void *data, unsigned int len,
1423 gfp_t gfp_mask)
Mike Christie df46b9a2005-06-20 14:04:44 +02001424{
1425 unsigned long kaddr = (unsigned long)data;
1426 unsigned long end = (kaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1427 unsigned long start = kaddr >> PAGE_SHIFT;
1428 const int nr_pages = end - start;
1429 int offset, i;
1430 struct bio *bio;
1431
Tejun Heoa9e9dc22009-04-15 22:10:27 +09001432 bio = bio_kmalloc(gfp_mask, nr_pages);
Mike Christie df46b9a2005-06-20 14:04:44 +02001433 if (!bio)
1434 return ERR_PTR(-ENOMEM);
1435
1436 offset = offset_in_page(kaddr);
1437 for (i = 0; i < nr_pages; i++) {
1438 unsigned int bytes = PAGE_SIZE - offset;
1439
1440 if (len <= 0)
1441 break;
1442
1443 if (bytes > len)
1444 bytes = len;
1445
Mike Christiedefd94b2005-12-05 02:37:06 -06001446 if (bio_add_pc_page(q, bio, virt_to_page(data), bytes,
Christoph Hellwig75c72b82015-01-18 16:16:32 +01001447 offset) < bytes) {
1448 /* we don't support partial mappings */
1449 bio_put(bio);
1450 return ERR_PTR(-EINVAL);
1451 }
Mike Christie df46b9a2005-06-20 14:04:44 +02001452
1453 data += bytes;
1454 len -= bytes;
1455 offset = 0;
1456 }
1457
Jens Axboeb8238252005-06-20 14:05:27 +02001458 bio->bi_end_io = bio_map_kern_endio;
Mike Christie df46b9a2005-06-20 14:04:44 +02001459 return bio;
1460}
H Hartley Sweetena112a712009-09-26 16:19:21 +02001461EXPORT_SYMBOL(bio_map_kern);
Mike Christie df46b9a2005-06-20 14:04:44 +02001462
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001463static void bio_copy_kern_endio(struct bio *bio)
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001464{
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001465 bio_free_pages(bio);
1466 bio_put(bio);
1467}
1468
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001469static void bio_copy_kern_endio_read(struct bio *bio)
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001470{
Christoph Hellwig42d26832015-01-18 16:16:28 +01001471 char *p = bio->bi_private;
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001472 struct bio_vec *bvec;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001473 int i;
1474
Kent Overstreetd74c6d52013-02-06 12:23:11 -08001475 bio_for_each_segment_all(bvec, bio, i) {
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001476 memcpy(p, page_address(bvec->bv_page), bvec->bv_len);
Kent Overstreetc8db4442013-11-22 19:39:06 -08001477 p += bvec->bv_len;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001478 }
1479
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001480 bio_copy_kern_endio(bio);
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001481}
1482
1483/**
1484 * bio_copy_kern - copy kernel address into bio
1485 * @q: the struct request_queue for the bio
1486 * @data: pointer to buffer to copy
1487 * @len: length in bytes
1488 * @gfp_mask: allocation flags for bio and page allocation
Randy Dunlapffee0252008-04-30 09:08:54 +02001489 * @reading: data direction is READ
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001490 *
1491 * copy the kernel address into a bio suitable for io to a block
1492 * device. Returns an error pointer in case of error.
1493 */
1494struct bio *bio_copy_kern(struct request_queue *q, void *data, unsigned int len,
1495 gfp_t gfp_mask, int reading)
1496{
Christoph Hellwig42d26832015-01-18 16:16:28 +01001497 unsigned long kaddr = (unsigned long)data;
1498 unsigned long end = (kaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1499 unsigned long start = kaddr >> PAGE_SHIFT;
Christoph Hellwig42d26832015-01-18 16:16:28 +01001500 struct bio *bio;
1501 void *p = data;
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001502 int nr_pages = 0;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001503
Christoph Hellwig42d26832015-01-18 16:16:28 +01001504 /*
1505 * Overflow, abort
1506 */
1507 if (end < start)
1508 return ERR_PTR(-EINVAL);
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001509
Christoph Hellwig42d26832015-01-18 16:16:28 +01001510 nr_pages = end - start;
1511 bio = bio_kmalloc(gfp_mask, nr_pages);
1512 if (!bio)
1513 return ERR_PTR(-ENOMEM);
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001514
Christoph Hellwig42d26832015-01-18 16:16:28 +01001515 while (len) {
1516 struct page *page;
1517 unsigned int bytes = PAGE_SIZE;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001518
Christoph Hellwig42d26832015-01-18 16:16:28 +01001519 if (bytes > len)
1520 bytes = len;
1521
1522 page = alloc_page(q->bounce_gfp | gfp_mask);
1523 if (!page)
1524 goto cleanup;
1525
1526 if (!reading)
1527 memcpy(page_address(page), p, bytes);
1528
1529 if (bio_add_pc_page(q, bio, page, bytes, 0) < bytes)
1530 break;
1531
1532 len -= bytes;
1533 p += bytes;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001534 }
1535
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001536 if (reading) {
1537 bio->bi_end_io = bio_copy_kern_endio_read;
1538 bio->bi_private = data;
1539 } else {
1540 bio->bi_end_io = bio_copy_kern_endio;
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001541 }
FUJITA Tomonori76029ff2008-08-25 20:36:08 +02001542
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001543 return bio;
Christoph Hellwig42d26832015-01-18 16:16:28 +01001544
1545cleanup:
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001546 bio_free_pages(bio);
Christoph Hellwig42d26832015-01-18 16:16:28 +01001547 bio_put(bio);
1548 return ERR_PTR(-ENOMEM);
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001549}
1550
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551/*
1552 * bio_set_pages_dirty() and bio_check_pages_dirty() are support functions
1553 * for performing direct-IO in BIOs.
1554 *
1555 * The problem is that we cannot run set_page_dirty() from interrupt context
1556 * because the required locks are not interrupt-safe. So what we can do is to
1557 * mark the pages dirty _before_ performing IO. And in interrupt context,
1558 * check that the pages are still dirty. If so, fine. If not, redirty them
1559 * in process context.
1560 *
1561 * We special-case compound pages here: normally this means reads into hugetlb
1562 * pages. The logic in here doesn't really work right for compound pages
1563 * because the VM does not uniformly chase down the head page in all cases.
1564 * But dirtiness of compound pages is pretty meaningless anyway: the VM doesn't
1565 * handle them at all. So we skip compound pages here at an early stage.
1566 *
1567 * Note that this code is very hard to test under normal circumstances because
1568 * direct-io pins the pages with get_user_pages(). This makes
1569 * is_page_cache_freeable return false, and the VM will not clean the pages.
Artem Bityutskiy0d5c3eb2012-07-25 18:12:08 +03001570 * But other code (eg, flusher threads) could clean the pages if they are mapped
Linus Torvalds1da177e2005-04-16 15:20:36 -07001571 * pagecache.
1572 *
1573 * Simply disabling the call to bio_set_pages_dirty() is a good way to test the
1574 * deferred bio dirtying paths.
1575 */
1576
1577/*
1578 * bio_set_pages_dirty() will mark all the bio's pages as dirty.
1579 */
1580void bio_set_pages_dirty(struct bio *bio)
1581{
Kent Overstreetcb34e052012-09-05 15:22:02 -07001582 struct bio_vec *bvec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001583 int i;
1584
Kent Overstreetcb34e052012-09-05 15:22:02 -07001585 bio_for_each_segment_all(bvec, bio, i) {
1586 struct page *page = bvec->bv_page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001587
1588 if (page && !PageCompound(page))
1589 set_page_dirty_lock(page);
1590 }
1591}
1592
Adrian Bunk86b6c7a2008-02-18 13:48:32 +01001593static void bio_release_pages(struct bio *bio)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594{
Kent Overstreetcb34e052012-09-05 15:22:02 -07001595 struct bio_vec *bvec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596 int i;
1597
Kent Overstreetcb34e052012-09-05 15:22:02 -07001598 bio_for_each_segment_all(bvec, bio, i) {
1599 struct page *page = bvec->bv_page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001600
1601 if (page)
1602 put_page(page);
1603 }
1604}
1605
1606/*
1607 * bio_check_pages_dirty() will check that all the BIO's pages are still dirty.
1608 * If they are, then fine. If, however, some pages are clean then they must
1609 * have been written out during the direct-IO read. So we take another ref on
1610 * the BIO and the offending pages and re-dirty the pages in process context.
1611 *
1612 * It is expected that bio_check_pages_dirty() will wholly own the BIO from
Kirill A. Shutemovea1754a2016-04-01 15:29:48 +03001613 * here on. It will run one put_page() against each page and will run one
1614 * bio_put() against the BIO.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615 */
1616
David Howells65f27f32006-11-22 14:55:48 +00001617static void bio_dirty_fn(struct work_struct *work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001618
David Howells65f27f32006-11-22 14:55:48 +00001619static DECLARE_WORK(bio_dirty_work, bio_dirty_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620static DEFINE_SPINLOCK(bio_dirty_lock);
1621static struct bio *bio_dirty_list;
1622
1623/*
1624 * This runs in process context
1625 */
David Howells65f27f32006-11-22 14:55:48 +00001626static void bio_dirty_fn(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001627{
1628 unsigned long flags;
1629 struct bio *bio;
1630
1631 spin_lock_irqsave(&bio_dirty_lock, flags);
1632 bio = bio_dirty_list;
1633 bio_dirty_list = NULL;
1634 spin_unlock_irqrestore(&bio_dirty_lock, flags);
1635
1636 while (bio) {
1637 struct bio *next = bio->bi_private;
1638
1639 bio_set_pages_dirty(bio);
1640 bio_release_pages(bio);
1641 bio_put(bio);
1642 bio = next;
1643 }
1644}
1645
1646void bio_check_pages_dirty(struct bio *bio)
1647{
Kent Overstreetcb34e052012-09-05 15:22:02 -07001648 struct bio_vec *bvec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649 int nr_clean_pages = 0;
1650 int i;
1651
Kent Overstreetcb34e052012-09-05 15:22:02 -07001652 bio_for_each_segment_all(bvec, bio, i) {
1653 struct page *page = bvec->bv_page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654
1655 if (PageDirty(page) || PageCompound(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001656 put_page(page);
Kent Overstreetcb34e052012-09-05 15:22:02 -07001657 bvec->bv_page = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001658 } else {
1659 nr_clean_pages++;
1660 }
1661 }
1662
1663 if (nr_clean_pages) {
1664 unsigned long flags;
1665
1666 spin_lock_irqsave(&bio_dirty_lock, flags);
1667 bio->bi_private = bio_dirty_list;
1668 bio_dirty_list = bio;
1669 spin_unlock_irqrestore(&bio_dirty_lock, flags);
1670 schedule_work(&bio_dirty_work);
1671 } else {
1672 bio_put(bio);
1673 }
1674}
1675
Jens Axboed62e26b2017-06-30 21:55:08 -06001676void generic_start_io_acct(struct request_queue *q, int rw,
1677 unsigned long sectors, struct hd_struct *part)
Gu Zheng394ffa52014-11-24 11:05:22 +08001678{
1679 int cpu = part_stat_lock();
1680
Jens Axboed62e26b2017-06-30 21:55:08 -06001681 part_round_stats(q, cpu, part);
Gu Zheng394ffa52014-11-24 11:05:22 +08001682 part_stat_inc(cpu, part, ios[rw]);
1683 part_stat_add(cpu, part, sectors[rw], sectors);
Jens Axboed62e26b2017-06-30 21:55:08 -06001684 part_inc_in_flight(q, part, rw);
Gu Zheng394ffa52014-11-24 11:05:22 +08001685
1686 part_stat_unlock();
1687}
1688EXPORT_SYMBOL(generic_start_io_acct);
1689
Jens Axboed62e26b2017-06-30 21:55:08 -06001690void generic_end_io_acct(struct request_queue *q, int rw,
1691 struct hd_struct *part, unsigned long start_time)
Gu Zheng394ffa52014-11-24 11:05:22 +08001692{
1693 unsigned long duration = jiffies - start_time;
1694 int cpu = part_stat_lock();
1695
1696 part_stat_add(cpu, part, ticks[rw], duration);
Jens Axboed62e26b2017-06-30 21:55:08 -06001697 part_round_stats(q, cpu, part);
1698 part_dec_in_flight(q, part, rw);
Gu Zheng394ffa52014-11-24 11:05:22 +08001699
1700 part_stat_unlock();
1701}
1702EXPORT_SYMBOL(generic_end_io_acct);
1703
Ilya Loginov2d4dc892009-11-26 09:16:19 +01001704#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
1705void bio_flush_dcache_pages(struct bio *bi)
1706{
Kent Overstreet79886132013-11-23 17:19:00 -08001707 struct bio_vec bvec;
1708 struct bvec_iter iter;
Ilya Loginov2d4dc892009-11-26 09:16:19 +01001709
Kent Overstreet79886132013-11-23 17:19:00 -08001710 bio_for_each_segment(bvec, bi, iter)
1711 flush_dcache_page(bvec.bv_page);
Ilya Loginov2d4dc892009-11-26 09:16:19 +01001712}
1713EXPORT_SYMBOL(bio_flush_dcache_pages);
1714#endif
1715
Jens Axboec4cf5262015-04-17 16:15:18 -06001716static inline bool bio_remaining_done(struct bio *bio)
1717{
1718 /*
1719 * If we're not chaining, then ->__bi_remaining is always 1 and
1720 * we always end io on the first invocation.
1721 */
1722 if (!bio_flagged(bio, BIO_CHAIN))
1723 return true;
1724
1725 BUG_ON(atomic_read(&bio->__bi_remaining) <= 0);
1726
Mike Snitzer326e1db2015-05-22 09:14:03 -04001727 if (atomic_dec_and_test(&bio->__bi_remaining)) {
Jens Axboeb7c44ed2015-07-24 12:37:59 -06001728 bio_clear_flag(bio, BIO_CHAIN);
Jens Axboec4cf5262015-04-17 16:15:18 -06001729 return true;
Mike Snitzer326e1db2015-05-22 09:14:03 -04001730 }
Jens Axboec4cf5262015-04-17 16:15:18 -06001731
1732 return false;
1733}
1734
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735/**
1736 * bio_endio - end I/O on a bio
1737 * @bio: bio
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738 *
1739 * Description:
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001740 * bio_endio() will end I/O on the whole bio. bio_endio() is the preferred
1741 * way to end I/O on a bio. No one should call bi_end_io() directly on a
1742 * bio unless they own it and thus know that it has an end_io function.
NeilBrownfbbaf702017-04-07 09:40:52 -06001743 *
1744 * bio_endio() can be called several times on a bio that has been chained
1745 * using bio_chain(). The ->bi_end_io() function will only be called the
1746 * last time. At this point the BLK_TA_COMPLETE tracing event will be
1747 * generated if BIO_TRACE_COMPLETION is set.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001748 **/
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001749void bio_endio(struct bio *bio)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001750{
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001751again:
Christoph Hellwig2b885512016-03-11 17:34:53 +01001752 if (!bio_remaining_done(bio))
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001753 return;
Christoph Hellwig7c20f112017-07-03 16:58:43 -06001754 if (!bio_integrity_endio(bio))
1755 return;
Kent Overstreet196d38b2013-11-23 18:34:15 -08001756
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001757 /*
1758 * Need to have a real endio function for chained bios, otherwise
1759 * various corner cases will break (like stacking block devices that
1760 * save/restore bi_end_io) - however, we want to avoid unbounded
1761 * recursion and blowing the stack. Tail call optimization would
1762 * handle this, but compiling with frame pointers also disables
1763 * gcc's sibling call optimization.
1764 */
1765 if (bio->bi_end_io == bio_chain_endio) {
1766 bio = __bio_chain_endio(bio);
1767 goto again;
Kent Overstreet196d38b2013-11-23 18:34:15 -08001768 }
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001769
Christoph Hellwig74d46992017-08-23 19:10:32 +02001770 if (bio->bi_disk && bio_flagged(bio, BIO_TRACE_COMPLETION)) {
1771 trace_block_bio_complete(bio->bi_disk->queue, bio,
Bart Van Asschea462b952017-06-13 08:07:33 -07001772 blk_status_to_errno(bio->bi_status));
NeilBrownfbbaf702017-04-07 09:40:52 -06001773 bio_clear_flag(bio, BIO_TRACE_COMPLETION);
1774 }
1775
Shaohua Li9e234ee2017-03-27 10:51:41 -07001776 blk_throtl_bio_endio(bio);
Shaohua Lib222dd22017-07-10 11:40:17 -07001777 /* release cgroup info */
1778 bio_uninit(bio);
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001779 if (bio->bi_end_io)
1780 bio->bi_end_io(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001781}
H Hartley Sweetena112a712009-09-26 16:19:21 +02001782EXPORT_SYMBOL(bio_endio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001783
Kent Overstreet196d38b2013-11-23 18:34:15 -08001784/**
Kent Overstreet20d01892013-11-23 18:21:01 -08001785 * bio_split - split a bio
1786 * @bio: bio to split
1787 * @sectors: number of sectors to split from the front of @bio
1788 * @gfp: gfp mask
1789 * @bs: bio set to allocate from
1790 *
1791 * Allocates and returns a new bio which represents @sectors from the start of
1792 * @bio, and updates @bio to represent the remaining sectors.
1793 *
Martin K. Petersenf3f5da62015-07-22 07:57:12 -04001794 * Unless this is a discard request the newly allocated bio will point
1795 * to @bio's bi_io_vec; it is the caller's responsibility to ensure that
1796 * @bio is not freed before the split.
Kent Overstreet20d01892013-11-23 18:21:01 -08001797 */
1798struct bio *bio_split(struct bio *bio, int sectors,
1799 gfp_t gfp, struct bio_set *bs)
1800{
Mikulas Patockaf341a4d2017-11-22 13:18:05 -05001801 struct bio *split;
Kent Overstreet20d01892013-11-23 18:21:01 -08001802
1803 BUG_ON(sectors <= 0);
1804 BUG_ON(sectors >= bio_sectors(bio));
1805
Christoph Hellwigf9d03f92016-12-08 15:20:32 -07001806 split = bio_clone_fast(bio, gfp, bs);
Kent Overstreet20d01892013-11-23 18:21:01 -08001807 if (!split)
1808 return NULL;
1809
1810 split->bi_iter.bi_size = sectors << 9;
1811
1812 if (bio_integrity(split))
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -07001813 bio_integrity_trim(split);
Kent Overstreet20d01892013-11-23 18:21:01 -08001814
1815 bio_advance(bio, split->bi_iter.bi_size);
1816
NeilBrownfbbaf702017-04-07 09:40:52 -06001817 if (bio_flagged(bio, BIO_TRACE_COMPLETION))
Goldwyn Rodrigues20d59022018-01-23 09:10:19 -07001818 bio_set_flag(split, BIO_TRACE_COMPLETION);
NeilBrownfbbaf702017-04-07 09:40:52 -06001819
Kent Overstreet20d01892013-11-23 18:21:01 -08001820 return split;
1821}
1822EXPORT_SYMBOL(bio_split);
1823
Martin K. Petersenad3316b2008-10-01 22:42:53 -04001824/**
Kent Overstreet6678d832013-08-07 11:14:32 -07001825 * bio_trim - trim a bio
1826 * @bio: bio to trim
1827 * @offset: number of sectors to trim from the front of @bio
1828 * @size: size we want to trim @bio to, in sectors
1829 */
1830void bio_trim(struct bio *bio, int offset, int size)
1831{
1832 /* 'bio' is a cloned bio which we need to trim to match
1833 * the given offset and size.
Kent Overstreet6678d832013-08-07 11:14:32 -07001834 */
Kent Overstreet6678d832013-08-07 11:14:32 -07001835
1836 size <<= 9;
Kent Overstreet4f024f32013-10-11 15:44:27 -07001837 if (offset == 0 && size == bio->bi_iter.bi_size)
Kent Overstreet6678d832013-08-07 11:14:32 -07001838 return;
1839
Jens Axboeb7c44ed2015-07-24 12:37:59 -06001840 bio_clear_flag(bio, BIO_SEG_VALID);
Kent Overstreet6678d832013-08-07 11:14:32 -07001841
1842 bio_advance(bio, offset << 9);
1843
Kent Overstreet4f024f32013-10-11 15:44:27 -07001844 bio->bi_iter.bi_size = size;
Dmitry Monakhov376a78a2017-06-29 11:31:08 -07001845
1846 if (bio_integrity(bio))
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -07001847 bio_integrity_trim(bio);
Dmitry Monakhov376a78a2017-06-29 11:31:08 -07001848
Kent Overstreet6678d832013-08-07 11:14:32 -07001849}
1850EXPORT_SYMBOL_GPL(bio_trim);
1851
Linus Torvalds1da177e2005-04-16 15:20:36 -07001852/*
1853 * create memory pools for biovec's in a bio_set.
1854 * use the global biovec slabs created for general use.
1855 */
Kent Overstreet8aa6ba22018-05-08 21:33:50 -04001856int biovec_init_pool(mempool_t *pool, int pool_entries)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857{
Christoph Hellwiged996a52016-07-19 11:28:42 +02001858 struct biovec_slab *bp = bvec_slabs + BVEC_POOL_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859
Kent Overstreet8aa6ba22018-05-08 21:33:50 -04001860 return mempool_init_slab_pool(pool, pool_entries, bp->slab);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001861}
1862
Kent Overstreet917a38c2018-05-08 21:33:51 -04001863/*
1864 * bioset_exit - exit a bioset initialized with bioset_init()
1865 *
1866 * May be called on a zeroed but uninitialized bioset (i.e. allocated with
1867 * kzalloc()).
1868 */
1869void bioset_exit(struct bio_set *bs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870{
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -07001871 if (bs->rescue_workqueue)
1872 destroy_workqueue(bs->rescue_workqueue);
Kent Overstreet917a38c2018-05-08 21:33:51 -04001873 bs->rescue_workqueue = NULL;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -07001874
Kent Overstreet8aa6ba22018-05-08 21:33:50 -04001875 mempool_exit(&bs->bio_pool);
1876 mempool_exit(&bs->bvec_pool);
Kent Overstreet9f060e22012-10-12 15:29:33 -07001877
Martin K. Petersen7878cba2009-06-26 15:37:49 +02001878 bioset_integrity_free(bs);
Kent Overstreet917a38c2018-05-08 21:33:51 -04001879 if (bs->bio_slab)
1880 bio_put_slab(bs);
1881 bs->bio_slab = NULL;
1882}
1883EXPORT_SYMBOL(bioset_exit);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001884
Kent Overstreet917a38c2018-05-08 21:33:51 -04001885void bioset_free(struct bio_set *bs)
1886{
1887 bioset_exit(bs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888 kfree(bs);
1889}
H Hartley Sweetena112a712009-09-26 16:19:21 +02001890EXPORT_SYMBOL(bioset_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001891
NeilBrown011067b2017-06-18 14:38:57 +10001892/**
Kent Overstreet917a38c2018-05-08 21:33:51 -04001893 * bioset_init - Initialize a bio_set
1894 * @pool_size: Number of bio and bio_vecs to cache in the mempool
1895 * @front_pad: Number of bytes to allocate in front of the returned bio
1896 * @flags: Flags to modify behavior, currently %BIOSET_NEED_BVECS
1897 * and %BIOSET_NEED_RESCUER
1898 *
1899 * Similar to bioset_create(), but initializes a passed-in bioset instead of
1900 * separately allocating it.
1901 */
1902int bioset_init(struct bio_set *bs,
1903 unsigned int pool_size,
1904 unsigned int front_pad,
1905 int flags)
1906{
1907 unsigned int back_pad = BIO_INLINE_VECS * sizeof(struct bio_vec);
1908
1909 bs->front_pad = front_pad;
1910
1911 spin_lock_init(&bs->rescue_lock);
1912 bio_list_init(&bs->rescue_list);
1913 INIT_WORK(&bs->rescue_work, bio_alloc_rescue);
1914
1915 bs->bio_slab = bio_find_or_create_slab(front_pad + back_pad);
1916 if (!bs->bio_slab)
1917 return -ENOMEM;
1918
1919 if (mempool_init_slab_pool(&bs->bio_pool, pool_size, bs->bio_slab))
1920 goto bad;
1921
1922 if ((flags & BIOSET_NEED_BVECS) &&
1923 biovec_init_pool(&bs->bvec_pool, pool_size))
1924 goto bad;
1925
1926 if (!(flags & BIOSET_NEED_RESCUER))
1927 return 0;
1928
1929 bs->rescue_workqueue = alloc_workqueue("bioset", WQ_MEM_RECLAIM, 0);
1930 if (!bs->rescue_workqueue)
1931 goto bad;
1932
1933 return 0;
1934bad:
1935 bioset_exit(bs);
1936 return -ENOMEM;
1937}
1938EXPORT_SYMBOL(bioset_init);
1939
1940/**
NeilBrown011067b2017-06-18 14:38:57 +10001941 * bioset_create - Create a bio_set
1942 * @pool_size: Number of bio and bio_vecs to cache in the mempool
1943 * @front_pad: Number of bytes to allocate in front of the returned bio
NeilBrown47e0fb42017-06-18 14:38:57 +10001944 * @flags: Flags to modify behavior, currently %BIOSET_NEED_BVECS
1945 * and %BIOSET_NEED_RESCUER
NeilBrown011067b2017-06-18 14:38:57 +10001946 *
1947 * Description:
1948 * Set up a bio_set to be used with @bio_alloc_bioset. Allows the caller
1949 * to ask for a number of bytes to be allocated in front of the bio.
1950 * Front pad allocation is useful for embedding the bio inside
1951 * another structure, to avoid allocating extra data to go with the bio.
1952 * Note that the bio must be embedded at the END of that structure always,
1953 * or things will break badly.
1954 * If %BIOSET_NEED_BVECS is set in @flags, a separate pool will be allocated
1955 * for allocating iovecs. This pool is not needed e.g. for bio_clone_fast().
NeilBrown47e0fb42017-06-18 14:38:57 +10001956 * If %BIOSET_NEED_RESCUER is set, a workqueue is created which can be used to
1957 * dispatch queued requests when the mempool runs out of space.
NeilBrown011067b2017-06-18 14:38:57 +10001958 *
1959 */
1960struct bio_set *bioset_create(unsigned int pool_size,
1961 unsigned int front_pad,
1962 int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001963{
Jens Axboe1b434492008-10-22 20:32:58 +02001964 struct bio_set *bs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965
Jens Axboe1b434492008-10-22 20:32:58 +02001966 bs = kzalloc(sizeof(*bs), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967 if (!bs)
1968 return NULL;
1969
Kent Overstreet917a38c2018-05-08 21:33:51 -04001970 if (bioset_init(bs, pool_size, front_pad, flags)) {
Jens Axboebb799ca2008-12-10 15:35:05 +01001971 kfree(bs);
1972 return NULL;
1973 }
1974
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -07001975 return bs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976}
H Hartley Sweetena112a712009-09-26 16:19:21 +02001977EXPORT_SYMBOL(bioset_create);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978
Tejun Heo852c7882012-03-05 13:15:27 -08001979#ifdef CONFIG_BLK_CGROUP
Tejun Heo1d933cf2015-05-22 17:13:24 -04001980
1981/**
1982 * bio_associate_blkcg - associate a bio with the specified blkcg
1983 * @bio: target bio
1984 * @blkcg_css: css of the blkcg to associate
1985 *
1986 * Associate @bio with the blkcg specified by @blkcg_css. Block layer will
1987 * treat @bio as if it were issued by a task which belongs to the blkcg.
1988 *
1989 * This function takes an extra reference of @blkcg_css which will be put
1990 * when @bio is released. The caller must own @bio and is responsible for
1991 * synchronizing calls to this function.
1992 */
1993int bio_associate_blkcg(struct bio *bio, struct cgroup_subsys_state *blkcg_css)
1994{
1995 if (unlikely(bio->bi_css))
1996 return -EBUSY;
1997 css_get(blkcg_css);
1998 bio->bi_css = blkcg_css;
1999 return 0;
2000}
Tejun Heo5aa2a962015-07-23 14:27:09 -04002001EXPORT_SYMBOL_GPL(bio_associate_blkcg);
Tejun Heo1d933cf2015-05-22 17:13:24 -04002002
Tejun Heo852c7882012-03-05 13:15:27 -08002003/**
Tejun Heo852c7882012-03-05 13:15:27 -08002004 * bio_disassociate_task - undo bio_associate_current()
2005 * @bio: target bio
2006 */
2007void bio_disassociate_task(struct bio *bio)
2008{
2009 if (bio->bi_ioc) {
2010 put_io_context(bio->bi_ioc);
2011 bio->bi_ioc = NULL;
2012 }
2013 if (bio->bi_css) {
2014 css_put(bio->bi_css);
2015 bio->bi_css = NULL;
2016 }
2017}
2018
Paolo Valente20bd7232016-07-27 07:22:05 +02002019/**
2020 * bio_clone_blkcg_association - clone blkcg association from src to dst bio
2021 * @dst: destination bio
2022 * @src: source bio
2023 */
2024void bio_clone_blkcg_association(struct bio *dst, struct bio *src)
2025{
2026 if (src->bi_css)
2027 WARN_ON(bio_associate_blkcg(dst, src->bi_css));
2028}
Shaohua Li8a8e6f82017-08-18 10:27:59 -07002029EXPORT_SYMBOL_GPL(bio_clone_blkcg_association);
Tejun Heo852c7882012-03-05 13:15:27 -08002030#endif /* CONFIG_BLK_CGROUP */
2031
Linus Torvalds1da177e2005-04-16 15:20:36 -07002032static void __init biovec_init_slabs(void)
2033{
2034 int i;
2035
Christoph Hellwiged996a52016-07-19 11:28:42 +02002036 for (i = 0; i < BVEC_POOL_NR; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037 int size;
2038 struct biovec_slab *bvs = bvec_slabs + i;
2039
Jens Axboea7fcd372008-12-05 16:10:29 +01002040 if (bvs->nr_vecs <= BIO_INLINE_VECS) {
2041 bvs->slab = NULL;
2042 continue;
2043 }
Jens Axboea7fcd372008-12-05 16:10:29 +01002044
Linus Torvalds1da177e2005-04-16 15:20:36 -07002045 size = bvs->nr_vecs * sizeof(struct bio_vec);
2046 bvs->slab = kmem_cache_create(bvs->name, size, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09002047 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048 }
2049}
2050
2051static int __init init_bio(void)
2052{
Jens Axboebb799ca2008-12-10 15:35:05 +01002053 bio_slab_max = 2;
2054 bio_slab_nr = 0;
2055 bio_slabs = kzalloc(bio_slab_max * sizeof(struct bio_slab), GFP_KERNEL);
2056 if (!bio_slabs)
2057 panic("bio: can't allocate bios\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002058
Martin K. Petersen7878cba2009-06-26 15:37:49 +02002059 bio_integrity_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002060 biovec_init_slabs();
2061
Kent Overstreetf4f81542018-05-08 21:33:52 -04002062 if (bioset_init(&fs_bio_set, BIO_POOL_SIZE, 0, BIOSET_NEED_BVECS))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063 panic("bio: can't allocate bios\n");
2064
Kent Overstreetf4f81542018-05-08 21:33:52 -04002065 if (bioset_integrity_create(&fs_bio_set, BIO_POOL_SIZE))
Martin K. Petersena91a2782011-03-17 11:11:05 +01002066 panic("bio: can't create integrity pool\n");
2067
Linus Torvalds1da177e2005-04-16 15:20:36 -07002068 return 0;
2069}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070subsys_initcall(init_bio);