blob: e87f70cd528ea08d4896ea53e91aa80a72a83b9b [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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070046#define BV(x) { .nr_vecs = x, .name = "biovec-"__stringify(x) }
Christoph Hellwiged996a52016-07-19 11:28:42 +020047static struct biovec_slab bvec_slabs[BVEC_POOL_NR] __read_mostly = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070048 BV(1), BV(4), BV(16), BV(64), BV(128), BV(BIO_MAX_PAGES),
49};
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 */
Martin K. Petersen51d654e2008-06-17 18:59:56 +020056struct 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) {
Christoph Hellwiged996a52016-07-19 11:28:42 +0200257 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 Overstreet4254bba2012-09-06 15:35:00 -0700265 mempool_free(p, bs->bio_pool);
266 } 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
403 * @gfp_mask: the GFP_ mask given to the slab allocator
404 * @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 */
457 if (WARN_ON_ONCE(!bs->bvec_pool && nr_iovecs > 0))
458 return NULL;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700459 /*
460 * generic_make_request() converts recursion to iteration; this
461 * means if we're running beneath it, any bios we allocate and
462 * submit will not be submitted (and thus freed) until after we
463 * return.
464 *
465 * This exposes us to a potential deadlock if we allocate
466 * multiple bios from the same bio_set() while running
467 * underneath generic_make_request(). If we were to allocate
468 * multiple bios (say a stacking block driver that was splitting
469 * bios), we would deadlock if we exhausted the mempool's
470 * reserve.
471 *
472 * We solve this, and guarantee forward progress, with a rescuer
473 * workqueue per bio_set. If we go to allocate and there are
474 * bios on current->bio_list, we first try the allocation
Mel Gormand0164ad2015-11-06 16:28:21 -0800475 * without __GFP_DIRECT_RECLAIM; if that fails, we punt those
476 * bios we would be blocking to the rescuer workqueue before
477 * we retry with the original gfp_flags.
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700478 */
479
NeilBrownf5fe1b52017-03-10 17:00:47 +1100480 if (current->bio_list &&
481 (!bio_list_empty(&current->bio_list[0]) ||
NeilBrown47e0fb42017-06-18 14:38:57 +1000482 !bio_list_empty(&current->bio_list[1])) &&
483 bs->rescue_workqueue)
Mel Gormand0164ad2015-11-06 16:28:21 -0800484 gfp_mask &= ~__GFP_DIRECT_RECLAIM;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700485
Kent Overstreet3f86a822012-09-06 15:35:01 -0700486 p = mempool_alloc(bs->bio_pool, gfp_mask);
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700487 if (!p && gfp_mask != saved_gfp) {
488 punt_bios_to_rescuer(bs);
489 gfp_mask = saved_gfp;
490 p = mempool_alloc(bs->bio_pool, gfp_mask);
491 }
492
Kent Overstreet3f86a822012-09-06 15:35:01 -0700493 front_pad = bs->front_pad;
494 inline_vecs = BIO_INLINE_VECS;
495 }
496
Tejun Heo451a9eb2009-04-15 19:50:51 +0200497 if (unlikely(!p))
498 return NULL;
Ingo Molnar34053972009-02-21 11:16:36 +0100499
Kent Overstreet3f86a822012-09-06 15:35:01 -0700500 bio = p + front_pad;
Ming Lei3a83f462016-11-22 08:57:21 -0700501 bio_init(bio, NULL, 0);
Ingo Molnar34053972009-02-21 11:16:36 +0100502
Kent Overstreet3f86a822012-09-06 15:35:01 -0700503 if (nr_iovecs > inline_vecs) {
Christoph Hellwiged996a52016-07-19 11:28:42 +0200504 unsigned long idx = 0;
505
Kent Overstreet9f060e22012-10-12 15:29:33 -0700506 bvl = bvec_alloc(gfp_mask, nr_iovecs, &idx, bs->bvec_pool);
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700507 if (!bvl && gfp_mask != saved_gfp) {
508 punt_bios_to_rescuer(bs);
509 gfp_mask = saved_gfp;
Kent Overstreet9f060e22012-10-12 15:29:33 -0700510 bvl = bvec_alloc(gfp_mask, nr_iovecs, &idx, bs->bvec_pool);
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700511 }
512
Ingo Molnar34053972009-02-21 11:16:36 +0100513 if (unlikely(!bvl))
514 goto err_free;
Kent Overstreeta38352e2012-05-25 13:03:11 -0700515
Christoph Hellwiged996a52016-07-19 11:28:42 +0200516 bio->bi_flags |= idx << BVEC_POOL_OFFSET;
Kent Overstreet3f86a822012-09-06 15:35:01 -0700517 } else if (nr_iovecs) {
518 bvl = bio->bi_inline_vecs;
Ingo Molnar34053972009-02-21 11:16:36 +0100519 }
Kent Overstreet3f86a822012-09-06 15:35:01 -0700520
521 bio->bi_pool = bs;
Ingo Molnar34053972009-02-21 11:16:36 +0100522 bio->bi_max_vecs = nr_iovecs;
Ingo Molnar34053972009-02-21 11:16:36 +0100523 bio->bi_io_vec = bvl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524 return bio;
Ingo Molnar34053972009-02-21 11:16:36 +0100525
526err_free:
Tejun Heo451a9eb2009-04-15 19:50:51 +0200527 mempool_free(p, bs->bio_pool);
Ingo Molnar34053972009-02-21 11:16:36 +0100528 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200530EXPORT_SYMBOL(bio_alloc_bioset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532void zero_fill_bio(struct bio *bio)
533{
534 unsigned long flags;
Kent Overstreet79886132013-11-23 17:19:00 -0800535 struct bio_vec bv;
536 struct bvec_iter iter;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537
Kent Overstreet79886132013-11-23 17:19:00 -0800538 bio_for_each_segment(bv, bio, iter) {
539 char *data = bvec_kmap_irq(&bv, &flags);
540 memset(data, 0, bv.bv_len);
541 flush_dcache_page(bv.bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 bvec_kunmap_irq(data, &flags);
543 }
544}
545EXPORT_SYMBOL(zero_fill_bio);
546
547/**
548 * bio_put - release a reference to a bio
549 * @bio: bio to release reference to
550 *
551 * Description:
552 * Put a reference to a &struct bio, either one you have gotten with
NeilBrown9b10f6a2017-06-18 14:38:59 +1000553 * bio_alloc, bio_get or bio_clone_*. The last put of a bio will free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700554 **/
555void bio_put(struct bio *bio)
556{
Jens Axboedac56212015-04-17 16:23:59 -0600557 if (!bio_flagged(bio, BIO_REFFED))
Kent Overstreet4254bba2012-09-06 15:35:00 -0700558 bio_free(bio);
Jens Axboedac56212015-04-17 16:23:59 -0600559 else {
560 BIO_BUG_ON(!atomic_read(&bio->__bi_cnt));
561
562 /*
563 * last put frees it
564 */
565 if (atomic_dec_and_test(&bio->__bi_cnt))
566 bio_free(bio);
567 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200569EXPORT_SYMBOL(bio_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570
Jens Axboe165125e2007-07-24 09:28:11 +0200571inline int bio_phys_segments(struct request_queue *q, struct bio *bio)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572{
573 if (unlikely(!bio_flagged(bio, BIO_SEG_VALID)))
574 blk_recount_segments(q, bio);
575
576 return bio->bi_phys_segments;
577}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200578EXPORT_SYMBOL(bio_phys_segments);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580/**
Kent Overstreet59d276f2013-11-23 18:19:27 -0800581 * __bio_clone_fast - clone a bio that shares the original bio's biovec
582 * @bio: destination bio
583 * @bio_src: bio to clone
584 *
585 * Clone a &bio. Caller will own the returned bio, but not
586 * the actual data it points to. Reference count of returned
587 * bio will be one.
588 *
589 * Caller must ensure that @bio_src is not freed before @bio.
590 */
591void __bio_clone_fast(struct bio *bio, struct bio *bio_src)
592{
Christoph Hellwiged996a52016-07-19 11:28:42 +0200593 BUG_ON(bio->bi_pool && BVEC_POOL_IDX(bio));
Kent Overstreet59d276f2013-11-23 18:19:27 -0800594
595 /*
Christoph Hellwig74d46992017-08-23 19:10:32 +0200596 * most users will be overriding ->bi_disk with a new target,
Kent Overstreet59d276f2013-11-23 18:19:27 -0800597 * so we don't set nor calculate new physical/hw segment counts here
598 */
Christoph Hellwig74d46992017-08-23 19:10:32 +0200599 bio->bi_disk = bio_src->bi_disk;
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600600 bio_set_flag(bio, BIO_CLONED);
Jens Axboe1eff9d32016-08-05 15:35:16 -0600601 bio->bi_opf = bio_src->bi_opf;
Jens Axboecb6934f2017-06-27 09:22:02 -0600602 bio->bi_write_hint = bio_src->bi_write_hint;
Kent Overstreet59d276f2013-11-23 18:19:27 -0800603 bio->bi_iter = bio_src->bi_iter;
604 bio->bi_io_vec = bio_src->bi_io_vec;
Paolo Valente20bd7232016-07-27 07:22:05 +0200605
606 bio_clone_blkcg_association(bio, bio_src);
Kent Overstreet59d276f2013-11-23 18:19:27 -0800607}
608EXPORT_SYMBOL(__bio_clone_fast);
609
610/**
611 * bio_clone_fast - clone a bio that shares the original bio's biovec
612 * @bio: bio to clone
613 * @gfp_mask: allocation priority
614 * @bs: bio_set to allocate from
615 *
616 * Like __bio_clone_fast, only also allocates the returned bio
617 */
618struct bio *bio_clone_fast(struct bio *bio, gfp_t gfp_mask, struct bio_set *bs)
619{
620 struct bio *b;
621
622 b = bio_alloc_bioset(gfp_mask, 0, bs);
623 if (!b)
624 return NULL;
625
626 __bio_clone_fast(b, bio);
627
628 if (bio_integrity(bio)) {
629 int ret;
630
631 ret = bio_integrity_clone(b, bio, gfp_mask);
632
633 if (ret < 0) {
634 bio_put(b);
635 return NULL;
636 }
637 }
638
639 return b;
640}
641EXPORT_SYMBOL(bio_clone_fast);
642
Shaohua Lif4595872017-03-24 10:34:43 -0700643/**
644 * bio_clone_bioset - clone a bio
645 * @bio_src: bio to clone
646 * @gfp_mask: allocation priority
647 * @bs: bio_set to allocate from
648 *
649 * Clone bio. Caller will own the returned bio, but not the actual data it
650 * points to. Reference count of returned bio will be one.
651 */
652struct bio *bio_clone_bioset(struct bio *bio_src, gfp_t gfp_mask,
653 struct bio_set *bs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654{
Kent Overstreetbdb53202013-11-23 17:26:46 -0800655 struct bvec_iter iter;
656 struct bio_vec bv;
657 struct bio *bio;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700658
Kent Overstreetbdb53202013-11-23 17:26:46 -0800659 /*
660 * Pre immutable biovecs, __bio_clone() used to just do a memcpy from
661 * bio_src->bi_io_vec to bio->bi_io_vec.
662 *
663 * We can't do that anymore, because:
664 *
665 * - The point of cloning the biovec is to produce a bio with a biovec
666 * the caller can modify: bi_idx and bi_bvec_done should be 0.
667 *
668 * - The original bio could've had more than BIO_MAX_PAGES biovecs; if
669 * we tried to clone the whole thing bio_alloc_bioset() would fail.
670 * But the clone should succeed as long as the number of biovecs we
671 * actually need to allocate is fewer than BIO_MAX_PAGES.
672 *
673 * - Lastly, bi_vcnt should not be looked at or relied upon by code
674 * that does not own the bio - reason being drivers don't use it for
675 * iterating over the biovec anymore, so expecting it to be kept up
676 * to date (i.e. for clones that share the parent biovec) is just
677 * asking for trouble and would force extra work on
678 * __bio_clone_fast() anyways.
679 */
680
Shaohua Lif4595872017-03-24 10:34:43 -0700681 bio = bio_alloc_bioset(gfp_mask, bio_segments(bio_src), bs);
Kent Overstreetbdb53202013-11-23 17:26:46 -0800682 if (!bio)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200683 return NULL;
Christoph Hellwig74d46992017-08-23 19:10:32 +0200684 bio->bi_disk = bio_src->bi_disk;
Jens Axboe1eff9d32016-08-05 15:35:16 -0600685 bio->bi_opf = bio_src->bi_opf;
Jens Axboecb6934f2017-06-27 09:22:02 -0600686 bio->bi_write_hint = bio_src->bi_write_hint;
Kent Overstreetbdb53202013-11-23 17:26:46 -0800687 bio->bi_iter.bi_sector = bio_src->bi_iter.bi_sector;
688 bio->bi_iter.bi_size = bio_src->bi_iter.bi_size;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200689
Adrian Hunter7afafc82016-08-16 10:59:35 +0300690 switch (bio_op(bio)) {
691 case REQ_OP_DISCARD:
692 case REQ_OP_SECURE_ERASE:
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800693 case REQ_OP_WRITE_ZEROES:
Adrian Hunter7afafc82016-08-16 10:59:35 +0300694 break;
695 case REQ_OP_WRITE_SAME:
Kent Overstreet8423ae32014-02-10 17:45:50 -0800696 bio->bi_io_vec[bio->bi_vcnt++] = bio_src->bi_io_vec[0];
Adrian Hunter7afafc82016-08-16 10:59:35 +0300697 break;
698 default:
Shaohua Lif4595872017-03-24 10:34:43 -0700699 bio_for_each_segment(bv, bio_src, iter)
Adrian Hunter7afafc82016-08-16 10:59:35 +0300700 bio->bi_io_vec[bio->bi_vcnt++] = bv;
701 break;
Kent Overstreet8423ae32014-02-10 17:45:50 -0800702 }
703
Kent Overstreetbdb53202013-11-23 17:26:46 -0800704 if (bio_integrity(bio_src)) {
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200705 int ret;
706
Kent Overstreetbdb53202013-11-23 17:26:46 -0800707 ret = bio_integrity_clone(bio, bio_src, gfp_mask);
Li Zefan059ea332009-03-09 10:42:45 +0100708 if (ret < 0) {
Kent Overstreetbdb53202013-11-23 17:26:46 -0800709 bio_put(bio);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200710 return NULL;
Li Zefan059ea332009-03-09 10:42:45 +0100711 }
Peter Osterlund36763472005-09-06 15:16:42 -0700712 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713
Paolo Valente20bd7232016-07-27 07:22:05 +0200714 bio_clone_blkcg_association(bio, bio_src);
715
Kent Overstreetbdb53202013-11-23 17:26:46 -0800716 return bio;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717}
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700718EXPORT_SYMBOL(bio_clone_bioset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700719
720/**
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800721 * bio_add_pc_page - attempt to add page to bio
722 * @q: the target queue
723 * @bio: destination bio
724 * @page: page to add
725 * @len: vec entry length
726 * @offset: vec entry offset
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 *
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800728 * Attempt to add a page to the bio_vec maplist. This can fail for a
729 * number of reasons, such as the bio being full or target block device
730 * limitations. The target block device must allow bio's up to PAGE_SIZE,
731 * so it is always possible to add a single page to an empty bio.
732 *
733 * This should only be used by REQ_PC bios.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734 */
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800735int bio_add_pc_page(struct request_queue *q, struct bio *bio, struct page
736 *page, unsigned int len, unsigned int offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737{
738 int retried_segments = 0;
739 struct bio_vec *bvec;
740
741 /*
742 * cloned bio must not modify vec list
743 */
744 if (unlikely(bio_flagged(bio, BIO_CLONED)))
745 return 0;
746
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800747 if (((bio->bi_iter.bi_size + len) >> 9) > queue_max_hw_sectors(q))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748 return 0;
749
Jens Axboe80cfd542006-01-06 09:43:28 +0100750 /*
751 * For filesystems with a blocksize smaller than the pagesize
752 * we will often be called with the same page as last time and
753 * a consecutive offset. Optimize this special case.
754 */
755 if (bio->bi_vcnt > 0) {
756 struct bio_vec *prev = &bio->bi_io_vec[bio->bi_vcnt - 1];
757
758 if (page == prev->bv_page &&
759 offset == prev->bv_offset + prev->bv_len) {
760 prev->bv_len += len;
Maurizio Lombardifcbf6a02014-12-10 14:16:53 -0800761 bio->bi_iter.bi_size += len;
Jens Axboe80cfd542006-01-06 09:43:28 +0100762 goto done;
763 }
Jens Axboe66cb45a2014-06-24 16:22:24 -0600764
765 /*
766 * If the queue doesn't support SG gaps and adding this
767 * offset would create a gap, disallow it.
768 */
Keith Busch03100aa2015-08-19 14:24:05 -0700769 if (bvec_gap_to_prev(q, prev, offset))
Jens Axboe66cb45a2014-06-24 16:22:24 -0600770 return 0;
Jens Axboe80cfd542006-01-06 09:43:28 +0100771 }
772
773 if (bio->bi_vcnt >= bio->bi_max_vecs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700774 return 0;
775
776 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 * setup the new entry, we might clear it again later if we
778 * cannot add the page
779 */
780 bvec = &bio->bi_io_vec[bio->bi_vcnt];
781 bvec->bv_page = page;
782 bvec->bv_len = len;
783 bvec->bv_offset = offset;
Maurizio Lombardifcbf6a02014-12-10 14:16:53 -0800784 bio->bi_vcnt++;
785 bio->bi_phys_segments++;
786 bio->bi_iter.bi_size += len;
787
788 /*
789 * Perform a recount if the number of segments is greater
790 * than queue_max_segments(q).
791 */
792
793 while (bio->bi_phys_segments > queue_max_segments(q)) {
794
795 if (retried_segments)
796 goto failed;
797
798 retried_segments = 1;
799 blk_recount_segments(q, bio);
800 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 /* If we may be able to merge these biovecs, force a recount */
Maurizio Lombardifcbf6a02014-12-10 14:16:53 -0800803 if (bio->bi_vcnt > 1 && (BIOVEC_PHYS_MERGEABLE(bvec-1, bvec)))
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600804 bio_clear_flag(bio, BIO_SEG_VALID);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805
Jens Axboe80cfd542006-01-06 09:43:28 +0100806 done:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 return len;
Maurizio Lombardifcbf6a02014-12-10 14:16:53 -0800808
809 failed:
810 bvec->bv_page = NULL;
811 bvec->bv_len = 0;
812 bvec->bv_offset = 0;
813 bio->bi_vcnt--;
814 bio->bi_iter.bi_size -= len;
815 blk_recount_segments(q, bio);
816 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200818EXPORT_SYMBOL(bio_add_pc_page);
Mike Christie6e68af62005-11-11 05:30:27 -0600819
820/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700821 * bio_add_page - attempt to add page to bio
822 * @bio: destination bio
823 * @page: page to add
824 * @len: vec entry length
825 * @offset: vec entry offset
826 *
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800827 * Attempt to add a page to the bio_vec maplist. This will only fail
828 * if either bio->bi_vcnt == bio->bi_max_vecs or it's a cloned bio.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700829 */
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800830int bio_add_page(struct bio *bio, struct page *page,
831 unsigned int len, unsigned int offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832{
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800833 struct bio_vec *bv;
Jens Axboe762380a2014-06-05 13:38:39 -0600834
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800835 /*
836 * cloned bio must not modify vec list
837 */
838 if (WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED)))
839 return 0;
Jens Axboe58a49152014-06-10 12:53:56 -0600840
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800841 /*
842 * For filesystems with a blocksize smaller than the pagesize
843 * we will often be called with the same page as last time and
844 * a consecutive offset. Optimize this special case.
845 */
846 if (bio->bi_vcnt > 0) {
847 bv = &bio->bi_io_vec[bio->bi_vcnt - 1];
848
849 if (page == bv->bv_page &&
850 offset == bv->bv_offset + bv->bv_len) {
851 bv->bv_len += len;
852 goto done;
853 }
854 }
855
856 if (bio->bi_vcnt >= bio->bi_max_vecs)
857 return 0;
858
859 bv = &bio->bi_io_vec[bio->bi_vcnt];
860 bv->bv_page = page;
861 bv->bv_len = len;
862 bv->bv_offset = offset;
863
864 bio->bi_vcnt++;
865done:
866 bio->bi_iter.bi_size += len;
867 return len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200869EXPORT_SYMBOL(bio_add_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600871/**
872 * bio_iov_iter_get_pages - pin user or kernel pages and add them to a bio
873 * @bio: bio to add pages to
874 * @iter: iov iterator describing the region to be mapped
875 *
876 * Pins as many pages from *iter and appends them to @bio's bvec array. The
877 * pages will have to be released using put_page() when done.
878 */
879int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter)
880{
881 unsigned short nr_pages = bio->bi_max_vecs - bio->bi_vcnt;
882 struct bio_vec *bv = bio->bi_io_vec + bio->bi_vcnt;
883 struct page **pages = (struct page **)bv;
884 size_t offset, diff;
885 ssize_t size;
886
887 size = iov_iter_get_pages(iter, pages, LONG_MAX, nr_pages, &offset);
888 if (unlikely(size <= 0))
889 return size ? size : -EFAULT;
890 nr_pages = (size + offset + PAGE_SIZE - 1) / PAGE_SIZE;
891
892 /*
893 * Deep magic below: We need to walk the pinned pages backwards
894 * because we are abusing the space allocated for the bio_vecs
895 * for the page array. Because the bio_vecs are larger than the
896 * page pointers by definition this will always work. But it also
897 * means we can't use bio_add_page, so any changes to it's semantics
898 * need to be reflected here as well.
899 */
900 bio->bi_iter.bi_size += size;
901 bio->bi_vcnt += nr_pages;
902
903 diff = (nr_pages * PAGE_SIZE - offset) - size;
904 while (nr_pages--) {
905 bv[nr_pages].bv_page = pages[nr_pages];
906 bv[nr_pages].bv_len = PAGE_SIZE;
907 bv[nr_pages].bv_offset = 0;
908 }
909
910 bv[0].bv_offset += offset;
911 bv[0].bv_len -= offset;
912 if (diff)
913 bv[bio->bi_vcnt - 1].bv_len -= diff;
914
915 iov_iter_advance(iter, size);
916 return 0;
917}
918EXPORT_SYMBOL_GPL(bio_iov_iter_get_pages);
919
Kent Overstreet9e882242012-09-10 14:41:12 -0700920struct submit_bio_ret {
921 struct completion event;
922 int error;
923};
924
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200925static void submit_bio_wait_endio(struct bio *bio)
Kent Overstreet9e882242012-09-10 14:41:12 -0700926{
927 struct submit_bio_ret *ret = bio->bi_private;
928
Christoph Hellwig4e4cbee2017-06-03 09:38:06 +0200929 ret->error = blk_status_to_errno(bio->bi_status);
Kent Overstreet9e882242012-09-10 14:41:12 -0700930 complete(&ret->event);
931}
932
933/**
934 * submit_bio_wait - submit a bio, and wait until it completes
Kent Overstreet9e882242012-09-10 14:41:12 -0700935 * @bio: The &struct bio which describes the I/O
936 *
937 * Simple wrapper around submit_bio(). Returns 0 on success, or the error from
938 * bio_endio() on failure.
Jan Kara3d289d62017-08-02 10:25:21 +0200939 *
940 * WARNING: Unlike to how submit_bio() is usually used, this function does not
941 * result in bio reference to be consumed. The caller must drop the reference
942 * on his own.
Kent Overstreet9e882242012-09-10 14:41:12 -0700943 */
Mike Christie4e49ea42016-06-05 14:31:41 -0500944int submit_bio_wait(struct bio *bio)
Kent Overstreet9e882242012-09-10 14:41:12 -0700945{
946 struct submit_bio_ret ret;
947
Kent Overstreet9e882242012-09-10 14:41:12 -0700948 init_completion(&ret.event);
949 bio->bi_private = &ret;
950 bio->bi_end_io = submit_bio_wait_endio;
Jens Axboe1eff9d32016-08-05 15:35:16 -0600951 bio->bi_opf |= REQ_SYNC;
Mike Christie4e49ea42016-06-05 14:31:41 -0500952 submit_bio(bio);
Stephane Gasparinid57d6112016-02-09 17:07:38 +0100953 wait_for_completion_io(&ret.event);
Kent Overstreet9e882242012-09-10 14:41:12 -0700954
955 return ret.error;
956}
957EXPORT_SYMBOL(submit_bio_wait);
958
Kent Overstreet054bdf62012-09-28 13:17:55 -0700959/**
960 * bio_advance - increment/complete a bio by some number of bytes
961 * @bio: bio to advance
962 * @bytes: number of bytes to complete
963 *
964 * This updates bi_sector, bi_size and bi_idx; if the number of bytes to
965 * complete doesn't align with a bvec boundary, then bv_len and bv_offset will
966 * be updated on the last bvec as well.
967 *
968 * @bio will then represent the remaining, uncompleted portion of the io.
969 */
970void bio_advance(struct bio *bio, unsigned bytes)
971{
972 if (bio_integrity(bio))
973 bio_integrity_advance(bio, bytes);
974
Kent Overstreet4550dd62013-08-07 14:26:21 -0700975 bio_advance_iter(bio, &bio->bi_iter, bytes);
Kent Overstreet054bdf62012-09-28 13:17:55 -0700976}
977EXPORT_SYMBOL(bio_advance);
978
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700979/**
Kent Overstreeta0787602012-09-10 14:03:28 -0700980 * bio_alloc_pages - allocates a single page for each bvec in a bio
981 * @bio: bio to allocate pages for
982 * @gfp_mask: flags for allocation
983 *
984 * Allocates pages up to @bio->bi_vcnt.
985 *
986 * Returns 0 on success, -ENOMEM on failure. On failure, any allocated pages are
987 * freed.
988 */
989int bio_alloc_pages(struct bio *bio, gfp_t gfp_mask)
990{
991 int i;
992 struct bio_vec *bv;
993
994 bio_for_each_segment_all(bv, bio, i) {
995 bv->bv_page = alloc_page(gfp_mask);
996 if (!bv->bv_page) {
997 while (--bv >= bio->bi_io_vec)
998 __free_page(bv->bv_page);
999 return -ENOMEM;
1000 }
1001 }
1002
1003 return 0;
1004}
1005EXPORT_SYMBOL(bio_alloc_pages);
1006
1007/**
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001008 * bio_copy_data - copy contents of data buffers from one chain of bios to
1009 * another
1010 * @src: source bio list
1011 * @dst: destination bio list
1012 *
1013 * If @src and @dst are single bios, bi_next must be NULL - otherwise, treats
1014 * @src and @dst as linked lists of bios.
1015 *
1016 * Stops when it reaches the end of either @src or @dst - that is, copies
1017 * min(src->bi_size, dst->bi_size) bytes (or the equivalent for lists of bios).
1018 */
1019void bio_copy_data(struct bio *dst, struct bio *src)
1020{
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001021 struct bvec_iter src_iter, dst_iter;
1022 struct bio_vec src_bv, dst_bv;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001023 void *src_p, *dst_p;
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001024 unsigned bytes;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001025
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001026 src_iter = src->bi_iter;
1027 dst_iter = dst->bi_iter;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001028
1029 while (1) {
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001030 if (!src_iter.bi_size) {
1031 src = src->bi_next;
1032 if (!src)
1033 break;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001034
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001035 src_iter = src->bi_iter;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001036 }
1037
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001038 if (!dst_iter.bi_size) {
1039 dst = dst->bi_next;
1040 if (!dst)
1041 break;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001042
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001043 dst_iter = dst->bi_iter;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001044 }
1045
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001046 src_bv = bio_iter_iovec(src, src_iter);
1047 dst_bv = bio_iter_iovec(dst, dst_iter);
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001048
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001049 bytes = min(src_bv.bv_len, dst_bv.bv_len);
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001050
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001051 src_p = kmap_atomic(src_bv.bv_page);
1052 dst_p = kmap_atomic(dst_bv.bv_page);
1053
1054 memcpy(dst_p + dst_bv.bv_offset,
1055 src_p + src_bv.bv_offset,
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001056 bytes);
1057
1058 kunmap_atomic(dst_p);
1059 kunmap_atomic(src_p);
1060
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001061 bio_advance_iter(src, &src_iter, bytes);
1062 bio_advance_iter(dst, &dst_iter, bytes);
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001063 }
1064}
1065EXPORT_SYMBOL(bio_copy_data);
1066
Linus Torvalds1da177e2005-04-16 15:20:36 -07001067struct bio_map_data {
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001068 int is_our_pages;
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001069 struct iov_iter iter;
1070 struct iovec iov[];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071};
1072
Fabian Frederick7410b3c2014-04-22 15:09:07 -06001073static struct bio_map_data *bio_alloc_map_data(unsigned int iov_count,
FUJITA Tomonori76029ff2008-08-25 20:36:08 +02001074 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001075{
Jens Axboef3f63c12010-10-29 11:46:56 -06001076 if (iov_count > UIO_MAXIOV)
1077 return NULL;
1078
Kent Overstreetc8db4442013-11-22 19:39:06 -08001079 return kmalloc(sizeof(struct bio_map_data) +
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001080 sizeof(struct iovec) * iov_count, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081}
1082
Dongsu Park9124d3f2015-01-18 16:16:34 +01001083/**
1084 * bio_copy_from_iter - copy all pages from iov_iter to bio
1085 * @bio: The &struct bio which describes the I/O as destination
1086 * @iter: iov_iter as source
1087 *
1088 * Copy all pages from iov_iter to bio.
1089 * Returns 0 on success, or error on failure.
1090 */
Al Viro98a09d62017-09-24 12:14:36 -04001091static int bio_copy_from_iter(struct bio *bio, struct iov_iter *iter)
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001092{
Dongsu Park9124d3f2015-01-18 16:16:34 +01001093 int i;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001094 struct bio_vec *bvec;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001095
Kent Overstreetd74c6d52013-02-06 12:23:11 -08001096 bio_for_each_segment_all(bvec, bio, i) {
Dongsu Park9124d3f2015-01-18 16:16:34 +01001097 ssize_t ret;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001098
Dongsu Park9124d3f2015-01-18 16:16:34 +01001099 ret = copy_page_from_iter(bvec->bv_page,
1100 bvec->bv_offset,
1101 bvec->bv_len,
Al Viro98a09d62017-09-24 12:14:36 -04001102 iter);
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001103
Al Viro98a09d62017-09-24 12:14:36 -04001104 if (!iov_iter_count(iter))
Dongsu Park9124d3f2015-01-18 16:16:34 +01001105 break;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001106
Dongsu Park9124d3f2015-01-18 16:16:34 +01001107 if (ret < bvec->bv_len)
1108 return -EFAULT;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001109 }
1110
Dongsu Park9124d3f2015-01-18 16:16:34 +01001111 return 0;
1112}
1113
1114/**
1115 * bio_copy_to_iter - copy all pages from bio to iov_iter
1116 * @bio: The &struct bio which describes the I/O as source
1117 * @iter: iov_iter as destination
1118 *
1119 * Copy all pages from bio to iov_iter.
1120 * Returns 0 on success, or error on failure.
1121 */
1122static int bio_copy_to_iter(struct bio *bio, struct iov_iter iter)
1123{
1124 int i;
1125 struct bio_vec *bvec;
1126
1127 bio_for_each_segment_all(bvec, bio, i) {
1128 ssize_t ret;
1129
1130 ret = copy_page_to_iter(bvec->bv_page,
1131 bvec->bv_offset,
1132 bvec->bv_len,
1133 &iter);
1134
1135 if (!iov_iter_count(&iter))
1136 break;
1137
1138 if (ret < bvec->bv_len)
1139 return -EFAULT;
1140 }
1141
1142 return 0;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001143}
1144
Guoqing Jiang491221f2016-09-22 03:10:01 -04001145void bio_free_pages(struct bio *bio)
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001146{
1147 struct bio_vec *bvec;
1148 int i;
1149
1150 bio_for_each_segment_all(bvec, bio, i)
1151 __free_page(bvec->bv_page);
1152}
Guoqing Jiang491221f2016-09-22 03:10:01 -04001153EXPORT_SYMBOL(bio_free_pages);
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001154
Linus Torvalds1da177e2005-04-16 15:20:36 -07001155/**
1156 * bio_uncopy_user - finish previously mapped bio
1157 * @bio: bio being terminated
1158 *
Christoph Hellwigddad8dd2015-01-18 16:16:29 +01001159 * Free pages allocated from bio_copy_user_iov() and write back data
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160 * to user space in case of a read.
1161 */
1162int bio_uncopy_user(struct bio *bio)
1163{
1164 struct bio_map_data *bmd = bio->bi_private;
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001165 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001166
Roland Dreier35dc2482013-08-05 17:55:01 -07001167 if (!bio_flagged(bio, BIO_NULL_MAPPED)) {
1168 /*
1169 * if we're in a workqueue, the request is orphaned, so
Hannes Reinecke2d99b552016-02-12 09:39:15 +01001170 * don't copy into a random user address space, just free
1171 * and return -EINTR so user space doesn't expect any data.
Roland Dreier35dc2482013-08-05 17:55:01 -07001172 */
Hannes Reinecke2d99b552016-02-12 09:39:15 +01001173 if (!current->mm)
1174 ret = -EINTR;
1175 else if (bio_data_dir(bio) == READ)
Dongsu Park9124d3f2015-01-18 16:16:34 +01001176 ret = bio_copy_to_iter(bio, bmd->iter);
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001177 if (bmd->is_our_pages)
1178 bio_free_pages(bio);
Roland Dreier35dc2482013-08-05 17:55:01 -07001179 }
Kent Overstreetc8db4442013-11-22 19:39:06 -08001180 kfree(bmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001181 bio_put(bio);
1182 return ret;
1183}
1184
1185/**
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001186 * bio_copy_user_iov - copy user data to bio
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001187 * @q: destination block queue
1188 * @map_data: pointer to the rq_map_data holding pages (if necessary)
1189 * @iter: iovec iterator
1190 * @gfp_mask: memory allocation flags
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191 *
1192 * Prepares and returns a bio for indirect user io, bouncing data
1193 * to/from kernel pages as necessary. Must be paired with
1194 * call bio_uncopy_user() on io completion.
1195 */
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001196struct bio *bio_copy_user_iov(struct request_queue *q,
1197 struct rq_map_data *map_data,
Al Viroe81cef52017-09-24 09:25:39 -04001198 struct iov_iter *iter,
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001199 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001200{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001201 struct bio_map_data *bmd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202 struct page *page;
1203 struct bio *bio;
Al Virod16d44e2017-09-24 13:09:18 -04001204 int i = 0, ret;
1205 int nr_pages;
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001206 unsigned int len = iter->count;
Geliang Tangbd5cece2015-11-21 17:27:31 +08001207 unsigned int offset = map_data ? offset_in_page(map_data->offset) : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001208
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001209 bmd = bio_alloc_map_data(iter->nr_segs, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210 if (!bmd)
1211 return ERR_PTR(-ENOMEM);
1212
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001213 /*
1214 * We need to do a deep copy of the iov_iter including the iovecs.
1215 * The caller provided iov might point to an on-stack or otherwise
1216 * shortlived one.
1217 */
1218 bmd->is_our_pages = map_data ? 0 : 1;
1219 memcpy(bmd->iov, iter->iov, sizeof(struct iovec) * iter->nr_segs);
Al Viro1cfd0dd2017-09-24 10:21:15 -04001220 bmd->iter = *iter;
1221 bmd->iter.iov = bmd->iov;
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001222
Al Virod16d44e2017-09-24 13:09:18 -04001223 nr_pages = DIV_ROUND_UP(offset + len, PAGE_SIZE);
1224 if (nr_pages > BIO_MAX_PAGES)
1225 nr_pages = BIO_MAX_PAGES;
1226
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227 ret = -ENOMEM;
Tejun Heoa9e9dc22009-04-15 22:10:27 +09001228 bio = bio_kmalloc(gfp_mask, nr_pages);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229 if (!bio)
1230 goto out_bmd;
1231
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232 ret = 0;
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001233
1234 if (map_data) {
FUJITA Tomonorie623ddb2008-12-18 14:49:36 +09001235 nr_pages = 1 << map_data->page_order;
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001236 i = map_data->offset / PAGE_SIZE;
1237 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238 while (len) {
FUJITA Tomonorie623ddb2008-12-18 14:49:36 +09001239 unsigned int bytes = PAGE_SIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001240
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001241 bytes -= offset;
1242
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243 if (bytes > len)
1244 bytes = len;
1245
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001246 if (map_data) {
FUJITA Tomonorie623ddb2008-12-18 14:49:36 +09001247 if (i == map_data->nr_entries * nr_pages) {
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001248 ret = -ENOMEM;
1249 break;
1250 }
FUJITA Tomonorie623ddb2008-12-18 14:49:36 +09001251
1252 page = map_data->pages[i / nr_pages];
1253 page += (i % nr_pages);
1254
1255 i++;
1256 } else {
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001257 page = alloc_page(q->bounce_gfp | gfp_mask);
FUJITA Tomonorie623ddb2008-12-18 14:49:36 +09001258 if (!page) {
1259 ret = -ENOMEM;
1260 break;
1261 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001262 }
1263
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001264 if (bio_add_pc_page(q, bio, page, bytes, offset) < bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266
1267 len -= bytes;
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001268 offset = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001269 }
1270
1271 if (ret)
1272 goto cleanup;
1273
Al Viro2884d0b2017-09-24 12:09:21 -04001274 if (map_data)
1275 map_data->offset += bio->bi_iter.bi_size;
1276
Linus Torvalds1da177e2005-04-16 15:20:36 -07001277 /*
1278 * success
1279 */
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001280 if (((iter->type & WRITE) && (!map_data || !map_data->null_mapped)) ||
FUJITA Tomonoriecb554a2009-07-09 14:46:53 +02001281 (map_data && map_data->from_user)) {
Al Viro98a09d62017-09-24 12:14:36 -04001282 ret = bio_copy_from_iter(bio, iter);
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001283 if (ret)
1284 goto cleanup;
Al Viro98a09d62017-09-24 12:14:36 -04001285 } else {
1286 iov_iter_advance(iter, bio->bi_iter.bi_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287 }
1288
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001289 bio->bi_private = bmd;
Al Viro2884d0b2017-09-24 12:09:21 -04001290 if (map_data && map_data->null_mapped)
1291 bio_set_flag(bio, BIO_NULL_MAPPED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292 return bio;
1293cleanup:
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001294 if (!map_data)
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001295 bio_free_pages(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296 bio_put(bio);
1297out_bmd:
Kent Overstreetc8db4442013-11-22 19:39:06 -08001298 kfree(bmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001299 return ERR_PTR(ret);
1300}
1301
Christoph Hellwig37f19e52015-01-18 16:16:33 +01001302/**
1303 * bio_map_user_iov - map user iovec into bio
1304 * @q: the struct request_queue for the bio
1305 * @iter: iovec iterator
1306 * @gfp_mask: memory allocation flags
1307 *
1308 * Map the user space address into a bio suitable for io to a block
1309 * device. Returns an error pointer in case of error.
1310 */
1311struct bio *bio_map_user_iov(struct request_queue *q,
Al Viroe81cef52017-09-24 09:25:39 -04001312 struct iov_iter *iter,
Christoph Hellwig37f19e52015-01-18 16:16:33 +01001313 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314{
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001315 int j;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316 struct bio *bio;
Al Viro076098e2017-09-23 16:08:57 -04001317 int ret;
Al Viro2b04e8f2017-09-23 15:51:23 -04001318 struct bio_vec *bvec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319
Al Virob282cc72017-09-23 16:24:59 -04001320 if (!iov_iter_count(iter))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 return ERR_PTR(-EINVAL);
1322
Al Virob282cc72017-09-23 16:24:59 -04001323 bio = bio_kmalloc(gfp_mask, iov_iter_npages(iter, BIO_MAX_PAGES));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001324 if (!bio)
1325 return ERR_PTR(-ENOMEM);
1326
Al Viro0a0f1512017-09-24 12:30:17 -04001327 while (iov_iter_count(iter)) {
Al Viro629e42b2017-09-23 16:13:10 -04001328 struct page **pages;
Al Viro076098e2017-09-23 16:08:57 -04001329 ssize_t bytes;
1330 size_t offs, added = 0;
1331 int npages;
Jens Axboecb4644c2010-11-10 14:36:25 +01001332
Al Viro0a0f1512017-09-24 12:30:17 -04001333 bytes = iov_iter_get_pages_alloc(iter, &pages, LONG_MAX, &offs);
Al Viro076098e2017-09-23 16:08:57 -04001334 if (unlikely(bytes <= 0)) {
1335 ret = bytes ? bytes : -EFAULT;
James Bottomley f1970ba2005-06-20 14:06:52 +02001336 goto out_unmap;
Jens Axboe99172152006-06-16 13:02:29 +02001337 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338
Al Viro076098e2017-09-23 16:08:57 -04001339 npages = DIV_ROUND_UP(offs + bytes, PAGE_SIZE);
1340
Al Viro98f0bc92017-09-23 16:23:18 -04001341 if (unlikely(offs & queue_dma_alignment(q))) {
1342 ret = -EINVAL;
1343 j = 0;
1344 } else {
1345 for (j = 0; j < npages; j++) {
1346 struct page *page = pages[j];
1347 unsigned int n = PAGE_SIZE - offs;
1348 unsigned short prev_bi_vcnt = bio->bi_vcnt;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001349
Al Viro98f0bc92017-09-23 16:23:18 -04001350 if (n > bytes)
1351 n = bytes;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001352
Al Viro98f0bc92017-09-23 16:23:18 -04001353 if (!bio_add_pc_page(q, bio, page, n, offs))
1354 break;
James Bottomley f1970ba2005-06-20 14:06:52 +02001355
Al Viro98f0bc92017-09-23 16:23:18 -04001356 /*
1357 * check if vector was merged with previous
1358 * drop page reference if needed
1359 */
1360 if (bio->bi_vcnt == prev_bi_vcnt)
1361 put_page(page);
Vitaly Mayatskikh95d78c22017-09-22 01:18:39 -04001362
Al Viro98f0bc92017-09-23 16:23:18 -04001363 added += n;
1364 bytes -= n;
1365 offs = 0;
1366 }
Al Viro0a0f1512017-09-24 12:30:17 -04001367 iov_iter_advance(iter, added);
James Bottomley f1970ba2005-06-20 14:06:52 +02001368 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001369 /*
James Bottomley f1970ba2005-06-20 14:06:52 +02001370 * release the pages we didn't map into the bio, if any
Linus Torvalds1da177e2005-04-16 15:20:36 -07001371 */
Al Viro629e42b2017-09-23 16:13:10 -04001372 while (j < npages)
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001373 put_page(pages[j++]);
Al Viro629e42b2017-09-23 16:13:10 -04001374 kvfree(pages);
Al Viroe2e115d2017-09-23 16:16:06 -04001375 /* couldn't stuff something into bio? */
1376 if (bytes)
1377 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001378 }
1379
Jens Axboeb7c44ed2015-07-24 12:37:59 -06001380 bio_set_flag(bio, BIO_USER_MAPPED);
Christoph Hellwig37f19e52015-01-18 16:16:33 +01001381
1382 /*
Bart Van Assche5fad1b62017-02-01 08:20:08 -08001383 * subtle -- if bio_map_user_iov() ended up bouncing a bio,
Christoph Hellwig37f19e52015-01-18 16:16:33 +01001384 * it would normally disappear when its bi_end_io is run.
1385 * however, we need it for the unmap, so grab an extra
1386 * reference to it
1387 */
1388 bio_get(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389 return bio;
James Bottomley f1970ba2005-06-20 14:06:52 +02001390
1391 out_unmap:
Al Viro2b04e8f2017-09-23 15:51:23 -04001392 bio_for_each_segment_all(bvec, bio, j) {
1393 put_page(bvec->bv_page);
James Bottomley f1970ba2005-06-20 14:06:52 +02001394 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395 bio_put(bio);
1396 return ERR_PTR(ret);
1397}
1398
Linus Torvalds1da177e2005-04-16 15:20:36 -07001399static void __bio_unmap_user(struct bio *bio)
1400{
1401 struct bio_vec *bvec;
1402 int i;
1403
1404 /*
1405 * make sure we dirty pages we wrote to
1406 */
Kent Overstreetd74c6d52013-02-06 12:23:11 -08001407 bio_for_each_segment_all(bvec, bio, i) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001408 if (bio_data_dir(bio) == READ)
1409 set_page_dirty_lock(bvec->bv_page);
1410
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001411 put_page(bvec->bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001412 }
1413
1414 bio_put(bio);
1415}
1416
1417/**
1418 * bio_unmap_user - unmap a bio
1419 * @bio: the bio being unmapped
1420 *
Bart Van Assche5fad1b62017-02-01 08:20:08 -08001421 * Unmap a bio previously mapped by bio_map_user_iov(). Must be called from
1422 * process context.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423 *
1424 * bio_unmap_user() may sleep.
1425 */
1426void bio_unmap_user(struct bio *bio)
1427{
1428 __bio_unmap_user(bio);
1429 bio_put(bio);
1430}
1431
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001432static void bio_map_kern_endio(struct bio *bio)
Jens Axboeb8238252005-06-20 14:05:27 +02001433{
Jens Axboeb8238252005-06-20 14:05:27 +02001434 bio_put(bio);
Jens Axboeb8238252005-06-20 14:05:27 +02001435}
1436
Christoph Hellwig75c72b82015-01-18 16:16:32 +01001437/**
1438 * bio_map_kern - map kernel address into bio
1439 * @q: the struct request_queue for the bio
1440 * @data: pointer to buffer to map
1441 * @len: length in bytes
1442 * @gfp_mask: allocation flags for bio allocation
1443 *
1444 * Map the kernel address into a bio suitable for io to a block
1445 * device. Returns an error pointer in case of error.
1446 */
1447struct bio *bio_map_kern(struct request_queue *q, void *data, unsigned int len,
1448 gfp_t gfp_mask)
Mike Christie df46b9a2005-06-20 14:04:44 +02001449{
1450 unsigned long kaddr = (unsigned long)data;
1451 unsigned long end = (kaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1452 unsigned long start = kaddr >> PAGE_SHIFT;
1453 const int nr_pages = end - start;
1454 int offset, i;
1455 struct bio *bio;
1456
Tejun Heoa9e9dc22009-04-15 22:10:27 +09001457 bio = bio_kmalloc(gfp_mask, nr_pages);
Mike Christie df46b9a2005-06-20 14:04:44 +02001458 if (!bio)
1459 return ERR_PTR(-ENOMEM);
1460
1461 offset = offset_in_page(kaddr);
1462 for (i = 0; i < nr_pages; i++) {
1463 unsigned int bytes = PAGE_SIZE - offset;
1464
1465 if (len <= 0)
1466 break;
1467
1468 if (bytes > len)
1469 bytes = len;
1470
Mike Christiedefd94b2005-12-05 02:37:06 -06001471 if (bio_add_pc_page(q, bio, virt_to_page(data), bytes,
Christoph Hellwig75c72b82015-01-18 16:16:32 +01001472 offset) < bytes) {
1473 /* we don't support partial mappings */
1474 bio_put(bio);
1475 return ERR_PTR(-EINVAL);
1476 }
Mike Christie df46b9a2005-06-20 14:04:44 +02001477
1478 data += bytes;
1479 len -= bytes;
1480 offset = 0;
1481 }
1482
Jens Axboeb8238252005-06-20 14:05:27 +02001483 bio->bi_end_io = bio_map_kern_endio;
Mike Christie df46b9a2005-06-20 14:04:44 +02001484 return bio;
1485}
H Hartley Sweetena112a712009-09-26 16:19:21 +02001486EXPORT_SYMBOL(bio_map_kern);
Mike Christie df46b9a2005-06-20 14:04:44 +02001487
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001488static void bio_copy_kern_endio(struct bio *bio)
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001489{
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001490 bio_free_pages(bio);
1491 bio_put(bio);
1492}
1493
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001494static void bio_copy_kern_endio_read(struct bio *bio)
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001495{
Christoph Hellwig42d26832015-01-18 16:16:28 +01001496 char *p = bio->bi_private;
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001497 struct bio_vec *bvec;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001498 int i;
1499
Kent Overstreetd74c6d52013-02-06 12:23:11 -08001500 bio_for_each_segment_all(bvec, bio, i) {
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001501 memcpy(p, page_address(bvec->bv_page), bvec->bv_len);
Kent Overstreetc8db4442013-11-22 19:39:06 -08001502 p += bvec->bv_len;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001503 }
1504
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001505 bio_copy_kern_endio(bio);
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001506}
1507
1508/**
1509 * bio_copy_kern - copy kernel address into bio
1510 * @q: the struct request_queue for the bio
1511 * @data: pointer to buffer to copy
1512 * @len: length in bytes
1513 * @gfp_mask: allocation flags for bio and page allocation
Randy Dunlapffee0252008-04-30 09:08:54 +02001514 * @reading: data direction is READ
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001515 *
1516 * copy the kernel address into a bio suitable for io to a block
1517 * device. Returns an error pointer in case of error.
1518 */
1519struct bio *bio_copy_kern(struct request_queue *q, void *data, unsigned int len,
1520 gfp_t gfp_mask, int reading)
1521{
Christoph Hellwig42d26832015-01-18 16:16:28 +01001522 unsigned long kaddr = (unsigned long)data;
1523 unsigned long end = (kaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1524 unsigned long start = kaddr >> PAGE_SHIFT;
Christoph Hellwig42d26832015-01-18 16:16:28 +01001525 struct bio *bio;
1526 void *p = data;
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001527 int nr_pages = 0;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001528
Christoph Hellwig42d26832015-01-18 16:16:28 +01001529 /*
1530 * Overflow, abort
1531 */
1532 if (end < start)
1533 return ERR_PTR(-EINVAL);
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001534
Christoph Hellwig42d26832015-01-18 16:16:28 +01001535 nr_pages = end - start;
1536 bio = bio_kmalloc(gfp_mask, nr_pages);
1537 if (!bio)
1538 return ERR_PTR(-ENOMEM);
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001539
Christoph Hellwig42d26832015-01-18 16:16:28 +01001540 while (len) {
1541 struct page *page;
1542 unsigned int bytes = PAGE_SIZE;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001543
Christoph Hellwig42d26832015-01-18 16:16:28 +01001544 if (bytes > len)
1545 bytes = len;
1546
1547 page = alloc_page(q->bounce_gfp | gfp_mask);
1548 if (!page)
1549 goto cleanup;
1550
1551 if (!reading)
1552 memcpy(page_address(page), p, bytes);
1553
1554 if (bio_add_pc_page(q, bio, page, bytes, 0) < bytes)
1555 break;
1556
1557 len -= bytes;
1558 p += bytes;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001559 }
1560
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001561 if (reading) {
1562 bio->bi_end_io = bio_copy_kern_endio_read;
1563 bio->bi_private = data;
1564 } else {
1565 bio->bi_end_io = bio_copy_kern_endio;
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001566 }
FUJITA Tomonori76029ff2008-08-25 20:36:08 +02001567
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001568 return bio;
Christoph Hellwig42d26832015-01-18 16:16:28 +01001569
1570cleanup:
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001571 bio_free_pages(bio);
Christoph Hellwig42d26832015-01-18 16:16:28 +01001572 bio_put(bio);
1573 return ERR_PTR(-ENOMEM);
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001574}
1575
Linus Torvalds1da177e2005-04-16 15:20:36 -07001576/*
1577 * bio_set_pages_dirty() and bio_check_pages_dirty() are support functions
1578 * for performing direct-IO in BIOs.
1579 *
1580 * The problem is that we cannot run set_page_dirty() from interrupt context
1581 * because the required locks are not interrupt-safe. So what we can do is to
1582 * mark the pages dirty _before_ performing IO. And in interrupt context,
1583 * check that the pages are still dirty. If so, fine. If not, redirty them
1584 * in process context.
1585 *
1586 * We special-case compound pages here: normally this means reads into hugetlb
1587 * pages. The logic in here doesn't really work right for compound pages
1588 * because the VM does not uniformly chase down the head page in all cases.
1589 * But dirtiness of compound pages is pretty meaningless anyway: the VM doesn't
1590 * handle them at all. So we skip compound pages here at an early stage.
1591 *
1592 * Note that this code is very hard to test under normal circumstances because
1593 * direct-io pins the pages with get_user_pages(). This makes
1594 * is_page_cache_freeable return false, and the VM will not clean the pages.
Artem Bityutskiy0d5c3eb2012-07-25 18:12:08 +03001595 * But other code (eg, flusher threads) could clean the pages if they are mapped
Linus Torvalds1da177e2005-04-16 15:20:36 -07001596 * pagecache.
1597 *
1598 * Simply disabling the call to bio_set_pages_dirty() is a good way to test the
1599 * deferred bio dirtying paths.
1600 */
1601
1602/*
1603 * bio_set_pages_dirty() will mark all the bio's pages as dirty.
1604 */
1605void bio_set_pages_dirty(struct bio *bio)
1606{
Kent Overstreetcb34e052012-09-05 15:22:02 -07001607 struct bio_vec *bvec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001608 int i;
1609
Kent Overstreetcb34e052012-09-05 15:22:02 -07001610 bio_for_each_segment_all(bvec, bio, i) {
1611 struct page *page = bvec->bv_page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001612
1613 if (page && !PageCompound(page))
1614 set_page_dirty_lock(page);
1615 }
1616}
1617
Adrian Bunk86b6c7a2008-02-18 13:48:32 +01001618static void bio_release_pages(struct bio *bio)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619{
Kent Overstreetcb34e052012-09-05 15:22:02 -07001620 struct bio_vec *bvec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 int i;
1622
Kent Overstreetcb34e052012-09-05 15:22:02 -07001623 bio_for_each_segment_all(bvec, bio, i) {
1624 struct page *page = bvec->bv_page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625
1626 if (page)
1627 put_page(page);
1628 }
1629}
1630
1631/*
1632 * bio_check_pages_dirty() will check that all the BIO's pages are still dirty.
1633 * If they are, then fine. If, however, some pages are clean then they must
1634 * have been written out during the direct-IO read. So we take another ref on
1635 * the BIO and the offending pages and re-dirty the pages in process context.
1636 *
1637 * It is expected that bio_check_pages_dirty() will wholly own the BIO from
Kirill A. Shutemovea1754a2016-04-01 15:29:48 +03001638 * here on. It will run one put_page() against each page and will run one
1639 * bio_put() against the BIO.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001640 */
1641
David Howells65f27f32006-11-22 14:55:48 +00001642static void bio_dirty_fn(struct work_struct *work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001643
David Howells65f27f32006-11-22 14:55:48 +00001644static DECLARE_WORK(bio_dirty_work, bio_dirty_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645static DEFINE_SPINLOCK(bio_dirty_lock);
1646static struct bio *bio_dirty_list;
1647
1648/*
1649 * This runs in process context
1650 */
David Howells65f27f32006-11-22 14:55:48 +00001651static void bio_dirty_fn(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001652{
1653 unsigned long flags;
1654 struct bio *bio;
1655
1656 spin_lock_irqsave(&bio_dirty_lock, flags);
1657 bio = bio_dirty_list;
1658 bio_dirty_list = NULL;
1659 spin_unlock_irqrestore(&bio_dirty_lock, flags);
1660
1661 while (bio) {
1662 struct bio *next = bio->bi_private;
1663
1664 bio_set_pages_dirty(bio);
1665 bio_release_pages(bio);
1666 bio_put(bio);
1667 bio = next;
1668 }
1669}
1670
1671void bio_check_pages_dirty(struct bio *bio)
1672{
Kent Overstreetcb34e052012-09-05 15:22:02 -07001673 struct bio_vec *bvec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674 int nr_clean_pages = 0;
1675 int i;
1676
Kent Overstreetcb34e052012-09-05 15:22:02 -07001677 bio_for_each_segment_all(bvec, bio, i) {
1678 struct page *page = bvec->bv_page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001679
1680 if (PageDirty(page) || PageCompound(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001681 put_page(page);
Kent Overstreetcb34e052012-09-05 15:22:02 -07001682 bvec->bv_page = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001683 } else {
1684 nr_clean_pages++;
1685 }
1686 }
1687
1688 if (nr_clean_pages) {
1689 unsigned long flags;
1690
1691 spin_lock_irqsave(&bio_dirty_lock, flags);
1692 bio->bi_private = bio_dirty_list;
1693 bio_dirty_list = bio;
1694 spin_unlock_irqrestore(&bio_dirty_lock, flags);
1695 schedule_work(&bio_dirty_work);
1696 } else {
1697 bio_put(bio);
1698 }
1699}
1700
Jens Axboed62e26b2017-06-30 21:55:08 -06001701void generic_start_io_acct(struct request_queue *q, int rw,
1702 unsigned long sectors, struct hd_struct *part)
Gu Zheng394ffa52014-11-24 11:05:22 +08001703{
1704 int cpu = part_stat_lock();
1705
Jens Axboed62e26b2017-06-30 21:55:08 -06001706 part_round_stats(q, cpu, part);
Gu Zheng394ffa52014-11-24 11:05:22 +08001707 part_stat_inc(cpu, part, ios[rw]);
1708 part_stat_add(cpu, part, sectors[rw], sectors);
Jens Axboed62e26b2017-06-30 21:55:08 -06001709 part_inc_in_flight(q, part, rw);
Gu Zheng394ffa52014-11-24 11:05:22 +08001710
1711 part_stat_unlock();
1712}
1713EXPORT_SYMBOL(generic_start_io_acct);
1714
Jens Axboed62e26b2017-06-30 21:55:08 -06001715void generic_end_io_acct(struct request_queue *q, int rw,
1716 struct hd_struct *part, unsigned long start_time)
Gu Zheng394ffa52014-11-24 11:05:22 +08001717{
1718 unsigned long duration = jiffies - start_time;
1719 int cpu = part_stat_lock();
1720
1721 part_stat_add(cpu, part, ticks[rw], duration);
Jens Axboed62e26b2017-06-30 21:55:08 -06001722 part_round_stats(q, cpu, part);
1723 part_dec_in_flight(q, part, rw);
Gu Zheng394ffa52014-11-24 11:05:22 +08001724
1725 part_stat_unlock();
1726}
1727EXPORT_SYMBOL(generic_end_io_acct);
1728
Ilya Loginov2d4dc892009-11-26 09:16:19 +01001729#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
1730void bio_flush_dcache_pages(struct bio *bi)
1731{
Kent Overstreet79886132013-11-23 17:19:00 -08001732 struct bio_vec bvec;
1733 struct bvec_iter iter;
Ilya Loginov2d4dc892009-11-26 09:16:19 +01001734
Kent Overstreet79886132013-11-23 17:19:00 -08001735 bio_for_each_segment(bvec, bi, iter)
1736 flush_dcache_page(bvec.bv_page);
Ilya Loginov2d4dc892009-11-26 09:16:19 +01001737}
1738EXPORT_SYMBOL(bio_flush_dcache_pages);
1739#endif
1740
Jens Axboec4cf5262015-04-17 16:15:18 -06001741static inline bool bio_remaining_done(struct bio *bio)
1742{
1743 /*
1744 * If we're not chaining, then ->__bi_remaining is always 1 and
1745 * we always end io on the first invocation.
1746 */
1747 if (!bio_flagged(bio, BIO_CHAIN))
1748 return true;
1749
1750 BUG_ON(atomic_read(&bio->__bi_remaining) <= 0);
1751
Mike Snitzer326e1db2015-05-22 09:14:03 -04001752 if (atomic_dec_and_test(&bio->__bi_remaining)) {
Jens Axboeb7c44ed2015-07-24 12:37:59 -06001753 bio_clear_flag(bio, BIO_CHAIN);
Jens Axboec4cf5262015-04-17 16:15:18 -06001754 return true;
Mike Snitzer326e1db2015-05-22 09:14:03 -04001755 }
Jens Axboec4cf5262015-04-17 16:15:18 -06001756
1757 return false;
1758}
1759
Linus Torvalds1da177e2005-04-16 15:20:36 -07001760/**
1761 * bio_endio - end I/O on a bio
1762 * @bio: bio
Linus Torvalds1da177e2005-04-16 15:20:36 -07001763 *
1764 * Description:
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001765 * bio_endio() will end I/O on the whole bio. bio_endio() is the preferred
1766 * way to end I/O on a bio. No one should call bi_end_io() directly on a
1767 * bio unless they own it and thus know that it has an end_io function.
NeilBrownfbbaf702017-04-07 09:40:52 -06001768 *
1769 * bio_endio() can be called several times on a bio that has been chained
1770 * using bio_chain(). The ->bi_end_io() function will only be called the
1771 * last time. At this point the BLK_TA_COMPLETE tracing event will be
1772 * generated if BIO_TRACE_COMPLETION is set.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001773 **/
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001774void bio_endio(struct bio *bio)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775{
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001776again:
Christoph Hellwig2b885512016-03-11 17:34:53 +01001777 if (!bio_remaining_done(bio))
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001778 return;
Christoph Hellwig7c20f112017-07-03 16:58:43 -06001779 if (!bio_integrity_endio(bio))
1780 return;
Kent Overstreet196d38b2013-11-23 18:34:15 -08001781
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001782 /*
1783 * Need to have a real endio function for chained bios, otherwise
1784 * various corner cases will break (like stacking block devices that
1785 * save/restore bi_end_io) - however, we want to avoid unbounded
1786 * recursion and blowing the stack. Tail call optimization would
1787 * handle this, but compiling with frame pointers also disables
1788 * gcc's sibling call optimization.
1789 */
1790 if (bio->bi_end_io == bio_chain_endio) {
1791 bio = __bio_chain_endio(bio);
1792 goto again;
Kent Overstreet196d38b2013-11-23 18:34:15 -08001793 }
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001794
Christoph Hellwig74d46992017-08-23 19:10:32 +02001795 if (bio->bi_disk && bio_flagged(bio, BIO_TRACE_COMPLETION)) {
1796 trace_block_bio_complete(bio->bi_disk->queue, bio,
Bart Van Asschea462b952017-06-13 08:07:33 -07001797 blk_status_to_errno(bio->bi_status));
NeilBrownfbbaf702017-04-07 09:40:52 -06001798 bio_clear_flag(bio, BIO_TRACE_COMPLETION);
1799 }
1800
Shaohua Li9e234ee2017-03-27 10:51:41 -07001801 blk_throtl_bio_endio(bio);
Shaohua Lib222dd22017-07-10 11:40:17 -07001802 /* release cgroup info */
1803 bio_uninit(bio);
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001804 if (bio->bi_end_io)
1805 bio->bi_end_io(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001806}
H Hartley Sweetena112a712009-09-26 16:19:21 +02001807EXPORT_SYMBOL(bio_endio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808
Kent Overstreet196d38b2013-11-23 18:34:15 -08001809/**
Kent Overstreet20d01892013-11-23 18:21:01 -08001810 * bio_split - split a bio
1811 * @bio: bio to split
1812 * @sectors: number of sectors to split from the front of @bio
1813 * @gfp: gfp mask
1814 * @bs: bio set to allocate from
1815 *
1816 * Allocates and returns a new bio which represents @sectors from the start of
1817 * @bio, and updates @bio to represent the remaining sectors.
1818 *
Martin K. Petersenf3f5da62015-07-22 07:57:12 -04001819 * Unless this is a discard request the newly allocated bio will point
1820 * to @bio's bi_io_vec; it is the caller's responsibility to ensure that
1821 * @bio is not freed before the split.
Kent Overstreet20d01892013-11-23 18:21:01 -08001822 */
1823struct bio *bio_split(struct bio *bio, int sectors,
1824 gfp_t gfp, struct bio_set *bs)
1825{
1826 struct bio *split = NULL;
1827
1828 BUG_ON(sectors <= 0);
1829 BUG_ON(sectors >= bio_sectors(bio));
1830
Christoph Hellwigf9d03f92016-12-08 15:20:32 -07001831 split = bio_clone_fast(bio, gfp, bs);
Kent Overstreet20d01892013-11-23 18:21:01 -08001832 if (!split)
1833 return NULL;
1834
1835 split->bi_iter.bi_size = sectors << 9;
1836
1837 if (bio_integrity(split))
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -07001838 bio_integrity_trim(split);
Kent Overstreet20d01892013-11-23 18:21:01 -08001839
1840 bio_advance(bio, split->bi_iter.bi_size);
1841
NeilBrownfbbaf702017-04-07 09:40:52 -06001842 if (bio_flagged(bio, BIO_TRACE_COMPLETION))
1843 bio_set_flag(bio, BIO_TRACE_COMPLETION);
1844
Kent Overstreet20d01892013-11-23 18:21:01 -08001845 return split;
1846}
1847EXPORT_SYMBOL(bio_split);
1848
Martin K. Petersenad3316b2008-10-01 22:42:53 -04001849/**
Kent Overstreet6678d832013-08-07 11:14:32 -07001850 * bio_trim - trim a bio
1851 * @bio: bio to trim
1852 * @offset: number of sectors to trim from the front of @bio
1853 * @size: size we want to trim @bio to, in sectors
1854 */
1855void bio_trim(struct bio *bio, int offset, int size)
1856{
1857 /* 'bio' is a cloned bio which we need to trim to match
1858 * the given offset and size.
Kent Overstreet6678d832013-08-07 11:14:32 -07001859 */
Kent Overstreet6678d832013-08-07 11:14:32 -07001860
1861 size <<= 9;
Kent Overstreet4f024f32013-10-11 15:44:27 -07001862 if (offset == 0 && size == bio->bi_iter.bi_size)
Kent Overstreet6678d832013-08-07 11:14:32 -07001863 return;
1864
Jens Axboeb7c44ed2015-07-24 12:37:59 -06001865 bio_clear_flag(bio, BIO_SEG_VALID);
Kent Overstreet6678d832013-08-07 11:14:32 -07001866
1867 bio_advance(bio, offset << 9);
1868
Kent Overstreet4f024f32013-10-11 15:44:27 -07001869 bio->bi_iter.bi_size = size;
Dmitry Monakhov376a78a2017-06-29 11:31:08 -07001870
1871 if (bio_integrity(bio))
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -07001872 bio_integrity_trim(bio);
Dmitry Monakhov376a78a2017-06-29 11:31:08 -07001873
Kent Overstreet6678d832013-08-07 11:14:32 -07001874}
1875EXPORT_SYMBOL_GPL(bio_trim);
1876
Linus Torvalds1da177e2005-04-16 15:20:36 -07001877/*
1878 * create memory pools for biovec's in a bio_set.
1879 * use the global biovec slabs created for general use.
1880 */
Fabian Fredericka6c39cb4f2014-04-22 15:09:05 -06001881mempool_t *biovec_create_pool(int pool_entries)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001882{
Christoph Hellwiged996a52016-07-19 11:28:42 +02001883 struct biovec_slab *bp = bvec_slabs + BVEC_POOL_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001884
Kent Overstreet9f060e22012-10-12 15:29:33 -07001885 return mempool_create_slab_pool(pool_entries, bp->slab);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886}
1887
1888void bioset_free(struct bio_set *bs)
1889{
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -07001890 if (bs->rescue_workqueue)
1891 destroy_workqueue(bs->rescue_workqueue);
1892
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893 if (bs->bio_pool)
1894 mempool_destroy(bs->bio_pool);
1895
Kent Overstreet9f060e22012-10-12 15:29:33 -07001896 if (bs->bvec_pool)
1897 mempool_destroy(bs->bvec_pool);
1898
Martin K. Petersen7878cba2009-06-26 15:37:49 +02001899 bioset_integrity_free(bs);
Jens Axboebb799ca2008-12-10 15:35:05 +01001900 bio_put_slab(bs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001901
1902 kfree(bs);
1903}
H Hartley Sweetena112a712009-09-26 16:19:21 +02001904EXPORT_SYMBOL(bioset_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905
NeilBrown011067b2017-06-18 14:38:57 +10001906/**
1907 * bioset_create - Create a bio_set
1908 * @pool_size: Number of bio and bio_vecs to cache in the mempool
1909 * @front_pad: Number of bytes to allocate in front of the returned bio
NeilBrown47e0fb42017-06-18 14:38:57 +10001910 * @flags: Flags to modify behavior, currently %BIOSET_NEED_BVECS
1911 * and %BIOSET_NEED_RESCUER
NeilBrown011067b2017-06-18 14:38:57 +10001912 *
1913 * Description:
1914 * Set up a bio_set to be used with @bio_alloc_bioset. Allows the caller
1915 * to ask for a number of bytes to be allocated in front of the bio.
1916 * Front pad allocation is useful for embedding the bio inside
1917 * another structure, to avoid allocating extra data to go with the bio.
1918 * Note that the bio must be embedded at the END of that structure always,
1919 * or things will break badly.
1920 * If %BIOSET_NEED_BVECS is set in @flags, a separate pool will be allocated
1921 * for allocating iovecs. This pool is not needed e.g. for bio_clone_fast().
NeilBrown47e0fb42017-06-18 14:38:57 +10001922 * If %BIOSET_NEED_RESCUER is set, a workqueue is created which can be used to
1923 * dispatch queued requests when the mempool runs out of space.
NeilBrown011067b2017-06-18 14:38:57 +10001924 *
1925 */
1926struct bio_set *bioset_create(unsigned int pool_size,
1927 unsigned int front_pad,
1928 int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001929{
Jens Axboe392ddc32008-12-23 12:42:54 +01001930 unsigned int back_pad = BIO_INLINE_VECS * sizeof(struct bio_vec);
Jens Axboe1b434492008-10-22 20:32:58 +02001931 struct bio_set *bs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001932
Jens Axboe1b434492008-10-22 20:32:58 +02001933 bs = kzalloc(sizeof(*bs), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934 if (!bs)
1935 return NULL;
1936
Jens Axboebb799ca2008-12-10 15:35:05 +01001937 bs->front_pad = front_pad;
Jens Axboe1b434492008-10-22 20:32:58 +02001938
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -07001939 spin_lock_init(&bs->rescue_lock);
1940 bio_list_init(&bs->rescue_list);
1941 INIT_WORK(&bs->rescue_work, bio_alloc_rescue);
1942
Jens Axboe392ddc32008-12-23 12:42:54 +01001943 bs->bio_slab = bio_find_or_create_slab(front_pad + back_pad);
Jens Axboebb799ca2008-12-10 15:35:05 +01001944 if (!bs->bio_slab) {
1945 kfree(bs);
1946 return NULL;
1947 }
1948
1949 bs->bio_pool = mempool_create_slab_pool(pool_size, bs->bio_slab);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950 if (!bs->bio_pool)
1951 goto bad;
1952
NeilBrown011067b2017-06-18 14:38:57 +10001953 if (flags & BIOSET_NEED_BVECS) {
Junichi Nomurad8f429e2014-10-03 17:27:12 -04001954 bs->bvec_pool = biovec_create_pool(pool_size);
1955 if (!bs->bvec_pool)
1956 goto bad;
1957 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001958
NeilBrown47e0fb42017-06-18 14:38:57 +10001959 if (!(flags & BIOSET_NEED_RESCUER))
1960 return bs;
1961
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -07001962 bs->rescue_workqueue = alloc_workqueue("bioset", WQ_MEM_RECLAIM, 0);
1963 if (!bs->rescue_workqueue)
1964 goto bad;
1965
1966 return bs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967bad:
1968 bioset_free(bs);
1969 return NULL;
1970}
H Hartley Sweetena112a712009-09-26 16:19:21 +02001971EXPORT_SYMBOL(bioset_create);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001972
Tejun Heo852c7882012-03-05 13:15:27 -08001973#ifdef CONFIG_BLK_CGROUP
Tejun Heo1d933cf2015-05-22 17:13:24 -04001974
1975/**
1976 * bio_associate_blkcg - associate a bio with the specified blkcg
1977 * @bio: target bio
1978 * @blkcg_css: css of the blkcg to associate
1979 *
1980 * Associate @bio with the blkcg specified by @blkcg_css. Block layer will
1981 * treat @bio as if it were issued by a task which belongs to the blkcg.
1982 *
1983 * This function takes an extra reference of @blkcg_css which will be put
1984 * when @bio is released. The caller must own @bio and is responsible for
1985 * synchronizing calls to this function.
1986 */
1987int bio_associate_blkcg(struct bio *bio, struct cgroup_subsys_state *blkcg_css)
1988{
1989 if (unlikely(bio->bi_css))
1990 return -EBUSY;
1991 css_get(blkcg_css);
1992 bio->bi_css = blkcg_css;
1993 return 0;
1994}
Tejun Heo5aa2a962015-07-23 14:27:09 -04001995EXPORT_SYMBOL_GPL(bio_associate_blkcg);
Tejun Heo1d933cf2015-05-22 17:13:24 -04001996
Tejun Heo852c7882012-03-05 13:15:27 -08001997/**
1998 * bio_associate_current - associate a bio with %current
1999 * @bio: target bio
2000 *
2001 * Associate @bio with %current if it hasn't been associated yet. Block
2002 * layer will treat @bio as if it were issued by %current no matter which
2003 * task actually issues it.
2004 *
2005 * This function takes an extra reference of @task's io_context and blkcg
2006 * which will be put when @bio is released. The caller must own @bio,
2007 * ensure %current->io_context exists, and is responsible for synchronizing
2008 * calls to this function.
2009 */
2010int bio_associate_current(struct bio *bio)
2011{
2012 struct io_context *ioc;
Tejun Heo852c7882012-03-05 13:15:27 -08002013
Tejun Heo1d933cf2015-05-22 17:13:24 -04002014 if (bio->bi_css)
Tejun Heo852c7882012-03-05 13:15:27 -08002015 return -EBUSY;
2016
2017 ioc = current->io_context;
2018 if (!ioc)
2019 return -ENOENT;
2020
Tejun Heo852c7882012-03-05 13:15:27 -08002021 get_io_context_active(ioc);
2022 bio->bi_ioc = ioc;
Tejun Heoc165b3e2015-08-18 14:55:29 -07002023 bio->bi_css = task_get_css(current, io_cgrp_id);
Tejun Heo852c7882012-03-05 13:15:27 -08002024 return 0;
2025}
Tejun Heo5aa2a962015-07-23 14:27:09 -04002026EXPORT_SYMBOL_GPL(bio_associate_current);
Tejun Heo852c7882012-03-05 13:15:27 -08002027
2028/**
2029 * bio_disassociate_task - undo bio_associate_current()
2030 * @bio: target bio
2031 */
2032void bio_disassociate_task(struct bio *bio)
2033{
2034 if (bio->bi_ioc) {
2035 put_io_context(bio->bi_ioc);
2036 bio->bi_ioc = NULL;
2037 }
2038 if (bio->bi_css) {
2039 css_put(bio->bi_css);
2040 bio->bi_css = NULL;
2041 }
2042}
2043
Paolo Valente20bd7232016-07-27 07:22:05 +02002044/**
2045 * bio_clone_blkcg_association - clone blkcg association from src to dst bio
2046 * @dst: destination bio
2047 * @src: source bio
2048 */
2049void bio_clone_blkcg_association(struct bio *dst, struct bio *src)
2050{
2051 if (src->bi_css)
2052 WARN_ON(bio_associate_blkcg(dst, src->bi_css));
2053}
Shaohua Li8a8e6f82017-08-18 10:27:59 -07002054EXPORT_SYMBOL_GPL(bio_clone_blkcg_association);
Tejun Heo852c7882012-03-05 13:15:27 -08002055#endif /* CONFIG_BLK_CGROUP */
2056
Linus Torvalds1da177e2005-04-16 15:20:36 -07002057static void __init biovec_init_slabs(void)
2058{
2059 int i;
2060
Christoph Hellwiged996a52016-07-19 11:28:42 +02002061 for (i = 0; i < BVEC_POOL_NR; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002062 int size;
2063 struct biovec_slab *bvs = bvec_slabs + i;
2064
Jens Axboea7fcd372008-12-05 16:10:29 +01002065 if (bvs->nr_vecs <= BIO_INLINE_VECS) {
2066 bvs->slab = NULL;
2067 continue;
2068 }
Jens Axboea7fcd372008-12-05 16:10:29 +01002069
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070 size = bvs->nr_vecs * sizeof(struct bio_vec);
2071 bvs->slab = kmem_cache_create(bvs->name, size, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09002072 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002073 }
2074}
2075
2076static int __init init_bio(void)
2077{
Jens Axboebb799ca2008-12-10 15:35:05 +01002078 bio_slab_max = 2;
2079 bio_slab_nr = 0;
2080 bio_slabs = kzalloc(bio_slab_max * sizeof(struct bio_slab), GFP_KERNEL);
2081 if (!bio_slabs)
2082 panic("bio: can't allocate bios\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083
Martin K. Petersen7878cba2009-06-26 15:37:49 +02002084 bio_integrity_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002085 biovec_init_slabs();
2086
NeilBrown011067b2017-06-18 14:38:57 +10002087 fs_bio_set = bioset_create(BIO_POOL_SIZE, 0, BIOSET_NEED_BVECS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088 if (!fs_bio_set)
2089 panic("bio: can't allocate bios\n");
2090
Martin K. Petersena91a2782011-03-17 11:11:05 +01002091 if (bioset_integrity_create(fs_bio_set, BIO_POOL_SIZE))
2092 panic("bio: can't create integrity pool\n");
2093
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094 return 0;
2095}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096subsys_initcall(init_bio);