blob: 2bd064906e068995cdc5163b795424c6fb30fff8 [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
Kent Overstreet4254bba2012-09-06 15:35:00 -0700243static void __bio_free(struct bio *bio)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244{
Kent Overstreet4254bba2012-09-06 15:35:00 -0700245 bio_disassociate_task(bio);
Jens Axboe992c5dd2007-07-18 13:18:08 +0200246
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200247 if (bio_integrity(bio))
Kent Overstreet1e2a410f2012-09-06 15:34:56 -0700248 bio_integrity_free(bio);
Kent Overstreet4254bba2012-09-06 15:35:00 -0700249}
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200250
Kent Overstreet4254bba2012-09-06 15:35:00 -0700251static void bio_free(struct bio *bio)
252{
253 struct bio_set *bs = bio->bi_pool;
254 void *p;
255
256 __bio_free(bio);
257
258 if (bs) {
Christoph Hellwiged996a52016-07-19 11:28:42 +0200259 bvec_free(bs->bvec_pool, bio->bi_io_vec, BVEC_POOL_IDX(bio));
Kent Overstreet4254bba2012-09-06 15:35:00 -0700260
261 /*
262 * If we have front padding, adjust the bio pointer before freeing
263 */
264 p = bio;
Jens Axboebb799ca2008-12-10 15:35:05 +0100265 p -= bs->front_pad;
266
Kent Overstreet4254bba2012-09-06 15:35:00 -0700267 mempool_free(p, bs->bio_pool);
268 } else {
269 /* Bio was allocated by bio_kmalloc() */
270 kfree(bio);
271 }
Peter Osterlund36763472005-09-06 15:16:42 -0700272}
273
Ming Lei3a83f462016-11-22 08:57:21 -0700274void bio_init(struct bio *bio, struct bio_vec *table,
275 unsigned short max_vecs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276{
Jens Axboe2b94de52007-07-18 13:14:03 +0200277 memset(bio, 0, sizeof(*bio));
Jens Axboec4cf5262015-04-17 16:15:18 -0600278 atomic_set(&bio->__bi_remaining, 1);
Jens Axboedac56212015-04-17 16:23:59 -0600279 atomic_set(&bio->__bi_cnt, 1);
Ming Lei3a83f462016-11-22 08:57:21 -0700280
281 bio->bi_io_vec = table;
282 bio->bi_max_vecs = max_vecs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200284EXPORT_SYMBOL(bio_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285
286/**
Kent Overstreetf44b48c2012-09-06 15:34:58 -0700287 * bio_reset - reinitialize a bio
288 * @bio: bio to reset
289 *
290 * Description:
291 * After calling bio_reset(), @bio will be in the same state as a freshly
292 * allocated bio returned bio bio_alloc_bioset() - the only fields that are
293 * preserved are the ones that are initialized by bio_alloc_bioset(). See
294 * comment in struct bio.
295 */
296void bio_reset(struct bio *bio)
297{
298 unsigned long flags = bio->bi_flags & (~0UL << BIO_RESET_BITS);
299
Kent Overstreet4254bba2012-09-06 15:35:00 -0700300 __bio_free(bio);
Kent Overstreetf44b48c2012-09-06 15:34:58 -0700301
302 memset(bio, 0, BIO_RESET_BYTES);
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200303 bio->bi_flags = flags;
Jens Axboec4cf5262015-04-17 16:15:18 -0600304 atomic_set(&bio->__bi_remaining, 1);
Kent Overstreetf44b48c2012-09-06 15:34:58 -0700305}
306EXPORT_SYMBOL(bio_reset);
307
Christoph Hellwig38f8baa2016-03-11 17:34:51 +0100308static struct bio *__bio_chain_endio(struct bio *bio)
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800309{
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200310 struct bio *parent = bio->bi_private;
311
Christoph Hellwig4e4cbee2017-06-03 09:38:06 +0200312 if (!parent->bi_status)
313 parent->bi_status = bio->bi_status;
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800314 bio_put(bio);
Christoph Hellwig38f8baa2016-03-11 17:34:51 +0100315 return parent;
316}
317
318static void bio_chain_endio(struct bio *bio)
319{
320 bio_endio(__bio_chain_endio(bio));
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800321}
322
323/**
324 * bio_chain - chain bio completions
Randy Dunlap1051a902014-04-20 16:03:31 -0700325 * @bio: the target bio
326 * @parent: the @bio's parent bio
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800327 *
328 * The caller won't have a bi_end_io called when @bio completes - instead,
329 * @parent's bi_end_io won't be called until both @parent and @bio have
330 * completed; the chained bio will also be freed when it completes.
331 *
332 * The caller must not set bi_private or bi_end_io in @bio.
333 */
334void bio_chain(struct bio *bio, struct bio *parent)
335{
336 BUG_ON(bio->bi_private || bio->bi_end_io);
337
338 bio->bi_private = parent;
339 bio->bi_end_io = bio_chain_endio;
Jens Axboec4cf5262015-04-17 16:15:18 -0600340 bio_inc_remaining(parent);
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800341}
342EXPORT_SYMBOL(bio_chain);
343
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700344static void bio_alloc_rescue(struct work_struct *work)
345{
346 struct bio_set *bs = container_of(work, struct bio_set, rescue_work);
347 struct bio *bio;
348
349 while (1) {
350 spin_lock(&bs->rescue_lock);
351 bio = bio_list_pop(&bs->rescue_list);
352 spin_unlock(&bs->rescue_lock);
353
354 if (!bio)
355 break;
356
357 generic_make_request(bio);
358 }
359}
360
361static void punt_bios_to_rescuer(struct bio_set *bs)
362{
363 struct bio_list punt, nopunt;
364 struct bio *bio;
365
NeilBrown47e0fb42017-06-18 14:38:57 +1000366 if (WARN_ON_ONCE(!bs->rescue_workqueue))
367 return;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700368 /*
369 * In order to guarantee forward progress we must punt only bios that
370 * were allocated from this bio_set; otherwise, if there was a bio on
371 * there for a stacking driver higher up in the stack, processing it
372 * could require allocating bios from this bio_set, and doing that from
373 * our own rescuer would be bad.
374 *
375 * Since bio lists are singly linked, pop them all instead of trying to
376 * remove from the middle of the list:
377 */
378
379 bio_list_init(&punt);
380 bio_list_init(&nopunt);
381
NeilBrownf5fe1b52017-03-10 17:00:47 +1100382 while ((bio = bio_list_pop(&current->bio_list[0])))
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700383 bio_list_add(bio->bi_pool == bs ? &punt : &nopunt, bio);
NeilBrownf5fe1b52017-03-10 17:00:47 +1100384 current->bio_list[0] = nopunt;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700385
NeilBrownf5fe1b52017-03-10 17:00:47 +1100386 bio_list_init(&nopunt);
387 while ((bio = bio_list_pop(&current->bio_list[1])))
388 bio_list_add(bio->bi_pool == bs ? &punt : &nopunt, bio);
389 current->bio_list[1] = nopunt;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700390
391 spin_lock(&bs->rescue_lock);
392 bio_list_merge(&bs->rescue_list, &punt);
393 spin_unlock(&bs->rescue_lock);
394
395 queue_work(bs->rescue_workqueue, &bs->rescue_work);
396}
397
Kent Overstreetf44b48c2012-09-06 15:34:58 -0700398/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399 * bio_alloc_bioset - allocate a bio for I/O
400 * @gfp_mask: the GFP_ mask given to the slab allocator
401 * @nr_iovecs: number of iovecs to pre-allocate
Jaak Ristiojadb18efa2010-01-15 12:05:07 +0200402 * @bs: the bio_set to allocate from.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 *
404 * Description:
Kent Overstreet3f86a822012-09-06 15:35:01 -0700405 * If @bs is NULL, uses kmalloc() to allocate the bio; else the allocation is
406 * backed by the @bs's mempool.
407 *
Mel Gormand0164ad2015-11-06 16:28:21 -0800408 * When @bs is not NULL, if %__GFP_DIRECT_RECLAIM is set then bio_alloc will
409 * always be able to allocate a bio. This is due to the mempool guarantees.
410 * To make this work, callers must never allocate more than 1 bio at a time
411 * from this pool. Callers that need to allocate more than 1 bio must always
412 * submit the previously allocated bio for IO before attempting to allocate
413 * a new one. Failure to do so can cause deadlocks under memory pressure.
Kent Overstreet3f86a822012-09-06 15:35:01 -0700414 *
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700415 * Note that when running under generic_make_request() (i.e. any block
416 * driver), bios are not submitted until after you return - see the code in
417 * generic_make_request() that converts recursion into iteration, to prevent
418 * stack overflows.
419 *
420 * This would normally mean allocating multiple bios under
421 * generic_make_request() would be susceptible to deadlocks, but we have
422 * deadlock avoidance code that resubmits any blocked bios from a rescuer
423 * thread.
424 *
425 * However, we do not guarantee forward progress for allocations from other
426 * mempools. Doing multiple allocations from the same mempool under
427 * generic_make_request() should be avoided - instead, use bio_set's front_pad
428 * for per bio allocations.
429 *
Kent Overstreet3f86a822012-09-06 15:35:01 -0700430 * RETURNS:
431 * Pointer to new bio on success, NULL on failure.
432 */
Dan Carpenter7a88fa12017-03-23 13:24:55 +0300433struct bio *bio_alloc_bioset(gfp_t gfp_mask, unsigned int nr_iovecs,
434 struct bio_set *bs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435{
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700436 gfp_t saved_gfp = gfp_mask;
Kent Overstreet3f86a822012-09-06 15:35:01 -0700437 unsigned front_pad;
438 unsigned inline_vecs;
Ingo Molnar34053972009-02-21 11:16:36 +0100439 struct bio_vec *bvl = NULL;
Tejun Heo451a9eb2009-04-15 19:50:51 +0200440 struct bio *bio;
441 void *p;
Jens Axboe0a0d96b2008-09-11 13:17:37 +0200442
Kent Overstreet3f86a822012-09-06 15:35:01 -0700443 if (!bs) {
444 if (nr_iovecs > UIO_MAXIOV)
445 return NULL;
446
447 p = kmalloc(sizeof(struct bio) +
448 nr_iovecs * sizeof(struct bio_vec),
449 gfp_mask);
450 front_pad = 0;
451 inline_vecs = nr_iovecs;
452 } else {
Junichi Nomurad8f429e2014-10-03 17:27:12 -0400453 /* should not use nobvec bioset for nr_iovecs > 0 */
454 if (WARN_ON_ONCE(!bs->bvec_pool && nr_iovecs > 0))
455 return NULL;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700456 /*
457 * generic_make_request() converts recursion to iteration; this
458 * means if we're running beneath it, any bios we allocate and
459 * submit will not be submitted (and thus freed) until after we
460 * return.
461 *
462 * This exposes us to a potential deadlock if we allocate
463 * multiple bios from the same bio_set() while running
464 * underneath generic_make_request(). If we were to allocate
465 * multiple bios (say a stacking block driver that was splitting
466 * bios), we would deadlock if we exhausted the mempool's
467 * reserve.
468 *
469 * We solve this, and guarantee forward progress, with a rescuer
470 * workqueue per bio_set. If we go to allocate and there are
471 * bios on current->bio_list, we first try the allocation
Mel Gormand0164ad2015-11-06 16:28:21 -0800472 * without __GFP_DIRECT_RECLAIM; if that fails, we punt those
473 * bios we would be blocking to the rescuer workqueue before
474 * we retry with the original gfp_flags.
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700475 */
476
NeilBrownf5fe1b52017-03-10 17:00:47 +1100477 if (current->bio_list &&
478 (!bio_list_empty(&current->bio_list[0]) ||
NeilBrown47e0fb42017-06-18 14:38:57 +1000479 !bio_list_empty(&current->bio_list[1])) &&
480 bs->rescue_workqueue)
Mel Gormand0164ad2015-11-06 16:28:21 -0800481 gfp_mask &= ~__GFP_DIRECT_RECLAIM;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700482
Kent Overstreet3f86a822012-09-06 15:35:01 -0700483 p = mempool_alloc(bs->bio_pool, gfp_mask);
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700484 if (!p && gfp_mask != saved_gfp) {
485 punt_bios_to_rescuer(bs);
486 gfp_mask = saved_gfp;
487 p = mempool_alloc(bs->bio_pool, gfp_mask);
488 }
489
Kent Overstreet3f86a822012-09-06 15:35:01 -0700490 front_pad = bs->front_pad;
491 inline_vecs = BIO_INLINE_VECS;
492 }
493
Tejun Heo451a9eb2009-04-15 19:50:51 +0200494 if (unlikely(!p))
495 return NULL;
Ingo Molnar34053972009-02-21 11:16:36 +0100496
Kent Overstreet3f86a822012-09-06 15:35:01 -0700497 bio = p + front_pad;
Ming Lei3a83f462016-11-22 08:57:21 -0700498 bio_init(bio, NULL, 0);
Ingo Molnar34053972009-02-21 11:16:36 +0100499
Kent Overstreet3f86a822012-09-06 15:35:01 -0700500 if (nr_iovecs > inline_vecs) {
Christoph Hellwiged996a52016-07-19 11:28:42 +0200501 unsigned long idx = 0;
502
Kent Overstreet9f060e22012-10-12 15:29:33 -0700503 bvl = bvec_alloc(gfp_mask, nr_iovecs, &idx, bs->bvec_pool);
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700504 if (!bvl && gfp_mask != saved_gfp) {
505 punt_bios_to_rescuer(bs);
506 gfp_mask = saved_gfp;
Kent Overstreet9f060e22012-10-12 15:29:33 -0700507 bvl = bvec_alloc(gfp_mask, nr_iovecs, &idx, bs->bvec_pool);
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700508 }
509
Ingo Molnar34053972009-02-21 11:16:36 +0100510 if (unlikely(!bvl))
511 goto err_free;
Kent Overstreeta38352e2012-05-25 13:03:11 -0700512
Christoph Hellwiged996a52016-07-19 11:28:42 +0200513 bio->bi_flags |= idx << BVEC_POOL_OFFSET;
Kent Overstreet3f86a822012-09-06 15:35:01 -0700514 } else if (nr_iovecs) {
515 bvl = bio->bi_inline_vecs;
Ingo Molnar34053972009-02-21 11:16:36 +0100516 }
Kent Overstreet3f86a822012-09-06 15:35:01 -0700517
518 bio->bi_pool = bs;
Ingo Molnar34053972009-02-21 11:16:36 +0100519 bio->bi_max_vecs = nr_iovecs;
Ingo Molnar34053972009-02-21 11:16:36 +0100520 bio->bi_io_vec = bvl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 return bio;
Ingo Molnar34053972009-02-21 11:16:36 +0100522
523err_free:
Tejun Heo451a9eb2009-04-15 19:50:51 +0200524 mempool_free(p, bs->bio_pool);
Ingo Molnar34053972009-02-21 11:16:36 +0100525 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700526}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200527EXPORT_SYMBOL(bio_alloc_bioset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529void zero_fill_bio(struct bio *bio)
530{
531 unsigned long flags;
Kent Overstreet79886132013-11-23 17:19:00 -0800532 struct bio_vec bv;
533 struct bvec_iter iter;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534
Kent Overstreet79886132013-11-23 17:19:00 -0800535 bio_for_each_segment(bv, bio, iter) {
536 char *data = bvec_kmap_irq(&bv, &flags);
537 memset(data, 0, bv.bv_len);
538 flush_dcache_page(bv.bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539 bvec_kunmap_irq(data, &flags);
540 }
541}
542EXPORT_SYMBOL(zero_fill_bio);
543
544/**
545 * bio_put - release a reference to a bio
546 * @bio: bio to release reference to
547 *
548 * Description:
549 * Put a reference to a &struct bio, either one you have gotten with
Alberto Bertogliad0bf112009-11-02 11:39:22 +0100550 * bio_alloc, bio_get or bio_clone. The last put of a bio will free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 **/
552void bio_put(struct bio *bio)
553{
Jens Axboedac56212015-04-17 16:23:59 -0600554 if (!bio_flagged(bio, BIO_REFFED))
Kent Overstreet4254bba2012-09-06 15:35:00 -0700555 bio_free(bio);
Jens Axboedac56212015-04-17 16:23:59 -0600556 else {
557 BIO_BUG_ON(!atomic_read(&bio->__bi_cnt));
558
559 /*
560 * last put frees it
561 */
562 if (atomic_dec_and_test(&bio->__bi_cnt))
563 bio_free(bio);
564 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200566EXPORT_SYMBOL(bio_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567
Jens Axboe165125e2007-07-24 09:28:11 +0200568inline int bio_phys_segments(struct request_queue *q, struct bio *bio)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569{
570 if (unlikely(!bio_flagged(bio, BIO_SEG_VALID)))
571 blk_recount_segments(q, bio);
572
573 return bio->bi_phys_segments;
574}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200575EXPORT_SYMBOL(bio_phys_segments);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577/**
Kent Overstreet59d276f2013-11-23 18:19:27 -0800578 * __bio_clone_fast - clone a bio that shares the original bio's biovec
579 * @bio: destination bio
580 * @bio_src: bio to clone
581 *
582 * Clone a &bio. Caller will own the returned bio, but not
583 * the actual data it points to. Reference count of returned
584 * bio will be one.
585 *
586 * Caller must ensure that @bio_src is not freed before @bio.
587 */
588void __bio_clone_fast(struct bio *bio, struct bio *bio_src)
589{
Christoph Hellwiged996a52016-07-19 11:28:42 +0200590 BUG_ON(bio->bi_pool && BVEC_POOL_IDX(bio));
Kent Overstreet59d276f2013-11-23 18:19:27 -0800591
592 /*
593 * most users will be overriding ->bi_bdev with a new target,
594 * so we don't set nor calculate new physical/hw segment counts here
595 */
596 bio->bi_bdev = bio_src->bi_bdev;
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600597 bio_set_flag(bio, BIO_CLONED);
Jens Axboe1eff9d32016-08-05 15:35:16 -0600598 bio->bi_opf = bio_src->bi_opf;
Kent Overstreet59d276f2013-11-23 18:19:27 -0800599 bio->bi_iter = bio_src->bi_iter;
600 bio->bi_io_vec = bio_src->bi_io_vec;
Paolo Valente20bd7232016-07-27 07:22:05 +0200601
602 bio_clone_blkcg_association(bio, bio_src);
Kent Overstreet59d276f2013-11-23 18:19:27 -0800603}
604EXPORT_SYMBOL(__bio_clone_fast);
605
606/**
607 * bio_clone_fast - clone a bio that shares the original bio's biovec
608 * @bio: bio to clone
609 * @gfp_mask: allocation priority
610 * @bs: bio_set to allocate from
611 *
612 * Like __bio_clone_fast, only also allocates the returned bio
613 */
614struct bio *bio_clone_fast(struct bio *bio, gfp_t gfp_mask, struct bio_set *bs)
615{
616 struct bio *b;
617
618 b = bio_alloc_bioset(gfp_mask, 0, bs);
619 if (!b)
620 return NULL;
621
622 __bio_clone_fast(b, bio);
623
624 if (bio_integrity(bio)) {
625 int ret;
626
627 ret = bio_integrity_clone(b, bio, gfp_mask);
628
629 if (ret < 0) {
630 bio_put(b);
631 return NULL;
632 }
633 }
634
635 return b;
636}
637EXPORT_SYMBOL(bio_clone_fast);
638
Shaohua Lif4595872017-03-24 10:34:43 -0700639/**
640 * bio_clone_bioset - clone a bio
641 * @bio_src: bio to clone
642 * @gfp_mask: allocation priority
643 * @bs: bio_set to allocate from
644 *
645 * Clone bio. Caller will own the returned bio, but not the actual data it
646 * points to. Reference count of returned bio will be one.
647 */
648struct bio *bio_clone_bioset(struct bio *bio_src, gfp_t gfp_mask,
649 struct bio_set *bs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650{
Kent Overstreetbdb53202013-11-23 17:26:46 -0800651 struct bvec_iter iter;
652 struct bio_vec bv;
653 struct bio *bio;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654
Kent Overstreetbdb53202013-11-23 17:26:46 -0800655 /*
656 * Pre immutable biovecs, __bio_clone() used to just do a memcpy from
657 * bio_src->bi_io_vec to bio->bi_io_vec.
658 *
659 * We can't do that anymore, because:
660 *
661 * - The point of cloning the biovec is to produce a bio with a biovec
662 * the caller can modify: bi_idx and bi_bvec_done should be 0.
663 *
664 * - The original bio could've had more than BIO_MAX_PAGES biovecs; if
665 * we tried to clone the whole thing bio_alloc_bioset() would fail.
666 * But the clone should succeed as long as the number of biovecs we
667 * actually need to allocate is fewer than BIO_MAX_PAGES.
668 *
669 * - Lastly, bi_vcnt should not be looked at or relied upon by code
670 * that does not own the bio - reason being drivers don't use it for
671 * iterating over the biovec anymore, so expecting it to be kept up
672 * to date (i.e. for clones that share the parent biovec) is just
673 * asking for trouble and would force extra work on
674 * __bio_clone_fast() anyways.
675 */
676
Shaohua Lif4595872017-03-24 10:34:43 -0700677 bio = bio_alloc_bioset(gfp_mask, bio_segments(bio_src), bs);
Kent Overstreetbdb53202013-11-23 17:26:46 -0800678 if (!bio)
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200679 return NULL;
Kent Overstreetbdb53202013-11-23 17:26:46 -0800680 bio->bi_bdev = bio_src->bi_bdev;
Jens Axboe1eff9d32016-08-05 15:35:16 -0600681 bio->bi_opf = bio_src->bi_opf;
Kent Overstreetbdb53202013-11-23 17:26:46 -0800682 bio->bi_iter.bi_sector = bio_src->bi_iter.bi_sector;
683 bio->bi_iter.bi_size = bio_src->bi_iter.bi_size;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200684
Adrian Hunter7afafc82016-08-16 10:59:35 +0300685 switch (bio_op(bio)) {
686 case REQ_OP_DISCARD:
687 case REQ_OP_SECURE_ERASE:
Chaitanya Kulkarnia6f07882016-11-30 12:28:59 -0800688 case REQ_OP_WRITE_ZEROES:
Adrian Hunter7afafc82016-08-16 10:59:35 +0300689 break;
690 case REQ_OP_WRITE_SAME:
Kent Overstreet8423ae32014-02-10 17:45:50 -0800691 bio->bi_io_vec[bio->bi_vcnt++] = bio_src->bi_io_vec[0];
Adrian Hunter7afafc82016-08-16 10:59:35 +0300692 break;
693 default:
Shaohua Lif4595872017-03-24 10:34:43 -0700694 bio_for_each_segment(bv, bio_src, iter)
Adrian Hunter7afafc82016-08-16 10:59:35 +0300695 bio->bi_io_vec[bio->bi_vcnt++] = bv;
696 break;
Kent Overstreet8423ae32014-02-10 17:45:50 -0800697 }
698
Kent Overstreetbdb53202013-11-23 17:26:46 -0800699 if (bio_integrity(bio_src)) {
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200700 int ret;
701
Kent Overstreetbdb53202013-11-23 17:26:46 -0800702 ret = bio_integrity_clone(bio, bio_src, gfp_mask);
Li Zefan059ea332009-03-09 10:42:45 +0100703 if (ret < 0) {
Kent Overstreetbdb53202013-11-23 17:26:46 -0800704 bio_put(bio);
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200705 return NULL;
Li Zefan059ea332009-03-09 10:42:45 +0100706 }
Peter Osterlund36763472005-09-06 15:16:42 -0700707 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708
Paolo Valente20bd7232016-07-27 07:22:05 +0200709 bio_clone_blkcg_association(bio, bio_src);
710
Kent Overstreetbdb53202013-11-23 17:26:46 -0800711 return bio;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712}
Kent Overstreetbf800ef2012-09-06 15:35:02 -0700713EXPORT_SYMBOL(bio_clone_bioset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714
715/**
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800716 * bio_add_pc_page - attempt to add page to bio
717 * @q: the target queue
718 * @bio: destination bio
719 * @page: page to add
720 * @len: vec entry length
721 * @offset: vec entry offset
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 *
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800723 * Attempt to add a page to the bio_vec maplist. This can fail for a
724 * number of reasons, such as the bio being full or target block device
725 * limitations. The target block device must allow bio's up to PAGE_SIZE,
726 * so it is always possible to add a single page to an empty bio.
727 *
728 * This should only be used by REQ_PC bios.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729 */
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800730int bio_add_pc_page(struct request_queue *q, struct bio *bio, struct page
731 *page, unsigned int len, unsigned int offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732{
733 int retried_segments = 0;
734 struct bio_vec *bvec;
735
736 /*
737 * cloned bio must not modify vec list
738 */
739 if (unlikely(bio_flagged(bio, BIO_CLONED)))
740 return 0;
741
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800742 if (((bio->bi_iter.bi_size + len) >> 9) > queue_max_hw_sectors(q))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 return 0;
744
Jens Axboe80cfd542006-01-06 09:43:28 +0100745 /*
746 * For filesystems with a blocksize smaller than the pagesize
747 * we will often be called with the same page as last time and
748 * a consecutive offset. Optimize this special case.
749 */
750 if (bio->bi_vcnt > 0) {
751 struct bio_vec *prev = &bio->bi_io_vec[bio->bi_vcnt - 1];
752
753 if (page == prev->bv_page &&
754 offset == prev->bv_offset + prev->bv_len) {
755 prev->bv_len += len;
Maurizio Lombardifcbf6a02014-12-10 14:16:53 -0800756 bio->bi_iter.bi_size += len;
Jens Axboe80cfd542006-01-06 09:43:28 +0100757 goto done;
758 }
Jens Axboe66cb45a2014-06-24 16:22:24 -0600759
760 /*
761 * If the queue doesn't support SG gaps and adding this
762 * offset would create a gap, disallow it.
763 */
Keith Busch03100aa2015-08-19 14:24:05 -0700764 if (bvec_gap_to_prev(q, prev, offset))
Jens Axboe66cb45a2014-06-24 16:22:24 -0600765 return 0;
Jens Axboe80cfd542006-01-06 09:43:28 +0100766 }
767
768 if (bio->bi_vcnt >= bio->bi_max_vecs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769 return 0;
770
771 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772 * setup the new entry, we might clear it again later if we
773 * cannot add the page
774 */
775 bvec = &bio->bi_io_vec[bio->bi_vcnt];
776 bvec->bv_page = page;
777 bvec->bv_len = len;
778 bvec->bv_offset = offset;
Maurizio Lombardifcbf6a02014-12-10 14:16:53 -0800779 bio->bi_vcnt++;
780 bio->bi_phys_segments++;
781 bio->bi_iter.bi_size += len;
782
783 /*
784 * Perform a recount if the number of segments is greater
785 * than queue_max_segments(q).
786 */
787
788 while (bio->bi_phys_segments > queue_max_segments(q)) {
789
790 if (retried_segments)
791 goto failed;
792
793 retried_segments = 1;
794 blk_recount_segments(q, bio);
795 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 /* If we may be able to merge these biovecs, force a recount */
Maurizio Lombardifcbf6a02014-12-10 14:16:53 -0800798 if (bio->bi_vcnt > 1 && (BIOVEC_PHYS_MERGEABLE(bvec-1, bvec)))
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600799 bio_clear_flag(bio, BIO_SEG_VALID);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800
Jens Axboe80cfd542006-01-06 09:43:28 +0100801 done:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 return len;
Maurizio Lombardifcbf6a02014-12-10 14:16:53 -0800803
804 failed:
805 bvec->bv_page = NULL;
806 bvec->bv_len = 0;
807 bvec->bv_offset = 0;
808 bio->bi_vcnt--;
809 bio->bi_iter.bi_size -= len;
810 blk_recount_segments(q, bio);
811 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700812}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200813EXPORT_SYMBOL(bio_add_pc_page);
Mike Christie6e68af62005-11-11 05:30:27 -0600814
815/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700816 * bio_add_page - attempt to add page to bio
817 * @bio: destination bio
818 * @page: page to add
819 * @len: vec entry length
820 * @offset: vec entry offset
821 *
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800822 * Attempt to add a page to the bio_vec maplist. This will only fail
823 * if either bio->bi_vcnt == bio->bi_max_vecs or it's a cloned bio.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824 */
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800825int bio_add_page(struct bio *bio, struct page *page,
826 unsigned int len, unsigned int offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700827{
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800828 struct bio_vec *bv;
Jens Axboe762380a2014-06-05 13:38:39 -0600829
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800830 /*
831 * cloned bio must not modify vec list
832 */
833 if (WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED)))
834 return 0;
Jens Axboe58a49152014-06-10 12:53:56 -0600835
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800836 /*
837 * For filesystems with a blocksize smaller than the pagesize
838 * we will often be called with the same page as last time and
839 * a consecutive offset. Optimize this special case.
840 */
841 if (bio->bi_vcnt > 0) {
842 bv = &bio->bi_io_vec[bio->bi_vcnt - 1];
843
844 if (page == bv->bv_page &&
845 offset == bv->bv_offset + bv->bv_len) {
846 bv->bv_len += len;
847 goto done;
848 }
849 }
850
851 if (bio->bi_vcnt >= bio->bi_max_vecs)
852 return 0;
853
854 bv = &bio->bi_io_vec[bio->bi_vcnt];
855 bv->bv_page = page;
856 bv->bv_len = len;
857 bv->bv_offset = offset;
858
859 bio->bi_vcnt++;
860done:
861 bio->bi_iter.bi_size += len;
862 return len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200864EXPORT_SYMBOL(bio_add_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600866/**
867 * bio_iov_iter_get_pages - pin user or kernel pages and add them to a bio
868 * @bio: bio to add pages to
869 * @iter: iov iterator describing the region to be mapped
870 *
871 * Pins as many pages from *iter and appends them to @bio's bvec array. The
872 * pages will have to be released using put_page() when done.
873 */
874int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter)
875{
876 unsigned short nr_pages = bio->bi_max_vecs - bio->bi_vcnt;
877 struct bio_vec *bv = bio->bi_io_vec + bio->bi_vcnt;
878 struct page **pages = (struct page **)bv;
879 size_t offset, diff;
880 ssize_t size;
881
882 size = iov_iter_get_pages(iter, pages, LONG_MAX, nr_pages, &offset);
883 if (unlikely(size <= 0))
884 return size ? size : -EFAULT;
885 nr_pages = (size + offset + PAGE_SIZE - 1) / PAGE_SIZE;
886
887 /*
888 * Deep magic below: We need to walk the pinned pages backwards
889 * because we are abusing the space allocated for the bio_vecs
890 * for the page array. Because the bio_vecs are larger than the
891 * page pointers by definition this will always work. But it also
892 * means we can't use bio_add_page, so any changes to it's semantics
893 * need to be reflected here as well.
894 */
895 bio->bi_iter.bi_size += size;
896 bio->bi_vcnt += nr_pages;
897
898 diff = (nr_pages * PAGE_SIZE - offset) - size;
899 while (nr_pages--) {
900 bv[nr_pages].bv_page = pages[nr_pages];
901 bv[nr_pages].bv_len = PAGE_SIZE;
902 bv[nr_pages].bv_offset = 0;
903 }
904
905 bv[0].bv_offset += offset;
906 bv[0].bv_len -= offset;
907 if (diff)
908 bv[bio->bi_vcnt - 1].bv_len -= diff;
909
910 iov_iter_advance(iter, size);
911 return 0;
912}
913EXPORT_SYMBOL_GPL(bio_iov_iter_get_pages);
914
Kent Overstreet9e882242012-09-10 14:41:12 -0700915struct submit_bio_ret {
916 struct completion event;
917 int error;
918};
919
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200920static void submit_bio_wait_endio(struct bio *bio)
Kent Overstreet9e882242012-09-10 14:41:12 -0700921{
922 struct submit_bio_ret *ret = bio->bi_private;
923
Christoph Hellwig4e4cbee2017-06-03 09:38:06 +0200924 ret->error = blk_status_to_errno(bio->bi_status);
Kent Overstreet9e882242012-09-10 14:41:12 -0700925 complete(&ret->event);
926}
927
928/**
929 * submit_bio_wait - submit a bio, and wait until it completes
Kent Overstreet9e882242012-09-10 14:41:12 -0700930 * @bio: The &struct bio which describes the I/O
931 *
932 * Simple wrapper around submit_bio(). Returns 0 on success, or the error from
933 * bio_endio() on failure.
934 */
Mike Christie4e49ea42016-06-05 14:31:41 -0500935int submit_bio_wait(struct bio *bio)
Kent Overstreet9e882242012-09-10 14:41:12 -0700936{
937 struct submit_bio_ret ret;
938
Kent Overstreet9e882242012-09-10 14:41:12 -0700939 init_completion(&ret.event);
940 bio->bi_private = &ret;
941 bio->bi_end_io = submit_bio_wait_endio;
Jens Axboe1eff9d32016-08-05 15:35:16 -0600942 bio->bi_opf |= REQ_SYNC;
Mike Christie4e49ea42016-06-05 14:31:41 -0500943 submit_bio(bio);
Stephane Gasparinid57d6112016-02-09 17:07:38 +0100944 wait_for_completion_io(&ret.event);
Kent Overstreet9e882242012-09-10 14:41:12 -0700945
946 return ret.error;
947}
948EXPORT_SYMBOL(submit_bio_wait);
949
Kent Overstreet054bdf62012-09-28 13:17:55 -0700950/**
951 * bio_advance - increment/complete a bio by some number of bytes
952 * @bio: bio to advance
953 * @bytes: number of bytes to complete
954 *
955 * This updates bi_sector, bi_size and bi_idx; if the number of bytes to
956 * complete doesn't align with a bvec boundary, then bv_len and bv_offset will
957 * be updated on the last bvec as well.
958 *
959 * @bio will then represent the remaining, uncompleted portion of the io.
960 */
961void bio_advance(struct bio *bio, unsigned bytes)
962{
963 if (bio_integrity(bio))
964 bio_integrity_advance(bio, bytes);
965
Kent Overstreet4550dd62013-08-07 14:26:21 -0700966 bio_advance_iter(bio, &bio->bi_iter, bytes);
Kent Overstreet054bdf62012-09-28 13:17:55 -0700967}
968EXPORT_SYMBOL(bio_advance);
969
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700970/**
Kent Overstreeta0787602012-09-10 14:03:28 -0700971 * bio_alloc_pages - allocates a single page for each bvec in a bio
972 * @bio: bio to allocate pages for
973 * @gfp_mask: flags for allocation
974 *
975 * Allocates pages up to @bio->bi_vcnt.
976 *
977 * Returns 0 on success, -ENOMEM on failure. On failure, any allocated pages are
978 * freed.
979 */
980int bio_alloc_pages(struct bio *bio, gfp_t gfp_mask)
981{
982 int i;
983 struct bio_vec *bv;
984
985 bio_for_each_segment_all(bv, bio, i) {
986 bv->bv_page = alloc_page(gfp_mask);
987 if (!bv->bv_page) {
988 while (--bv >= bio->bi_io_vec)
989 __free_page(bv->bv_page);
990 return -ENOMEM;
991 }
992 }
993
994 return 0;
995}
996EXPORT_SYMBOL(bio_alloc_pages);
997
998/**
Kent Overstreet16ac3d62012-09-10 13:57:51 -0700999 * bio_copy_data - copy contents of data buffers from one chain of bios to
1000 * another
1001 * @src: source bio list
1002 * @dst: destination bio list
1003 *
1004 * If @src and @dst are single bios, bi_next must be NULL - otherwise, treats
1005 * @src and @dst as linked lists of bios.
1006 *
1007 * Stops when it reaches the end of either @src or @dst - that is, copies
1008 * min(src->bi_size, dst->bi_size) bytes (or the equivalent for lists of bios).
1009 */
1010void bio_copy_data(struct bio *dst, struct bio *src)
1011{
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001012 struct bvec_iter src_iter, dst_iter;
1013 struct bio_vec src_bv, dst_bv;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001014 void *src_p, *dst_p;
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001015 unsigned bytes;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001016
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001017 src_iter = src->bi_iter;
1018 dst_iter = dst->bi_iter;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001019
1020 while (1) {
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001021 if (!src_iter.bi_size) {
1022 src = src->bi_next;
1023 if (!src)
1024 break;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001025
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001026 src_iter = src->bi_iter;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001027 }
1028
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001029 if (!dst_iter.bi_size) {
1030 dst = dst->bi_next;
1031 if (!dst)
1032 break;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001033
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001034 dst_iter = dst->bi_iter;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001035 }
1036
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001037 src_bv = bio_iter_iovec(src, src_iter);
1038 dst_bv = bio_iter_iovec(dst, dst_iter);
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001039
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001040 bytes = min(src_bv.bv_len, dst_bv.bv_len);
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001041
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001042 src_p = kmap_atomic(src_bv.bv_page);
1043 dst_p = kmap_atomic(dst_bv.bv_page);
1044
1045 memcpy(dst_p + dst_bv.bv_offset,
1046 src_p + src_bv.bv_offset,
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001047 bytes);
1048
1049 kunmap_atomic(dst_p);
1050 kunmap_atomic(src_p);
1051
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001052 bio_advance_iter(src, &src_iter, bytes);
1053 bio_advance_iter(dst, &dst_iter, bytes);
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001054 }
1055}
1056EXPORT_SYMBOL(bio_copy_data);
1057
Linus Torvalds1da177e2005-04-16 15:20:36 -07001058struct bio_map_data {
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001059 int is_our_pages;
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001060 struct iov_iter iter;
1061 struct iovec iov[];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001062};
1063
Fabian Frederick7410b3c2014-04-22 15:09:07 -06001064static struct bio_map_data *bio_alloc_map_data(unsigned int iov_count,
FUJITA Tomonori76029ff2008-08-25 20:36:08 +02001065 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066{
Jens Axboef3f63c12010-10-29 11:46:56 -06001067 if (iov_count > UIO_MAXIOV)
1068 return NULL;
1069
Kent Overstreetc8db4442013-11-22 19:39:06 -08001070 return kmalloc(sizeof(struct bio_map_data) +
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001071 sizeof(struct iovec) * iov_count, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001072}
1073
Dongsu Park9124d3f2015-01-18 16:16:34 +01001074/**
1075 * bio_copy_from_iter - copy all pages from iov_iter to bio
1076 * @bio: The &struct bio which describes the I/O as destination
1077 * @iter: iov_iter as source
1078 *
1079 * Copy all pages from iov_iter to bio.
1080 * Returns 0 on success, or error on failure.
1081 */
1082static int bio_copy_from_iter(struct bio *bio, struct iov_iter iter)
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001083{
Dongsu Park9124d3f2015-01-18 16:16:34 +01001084 int i;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001085 struct bio_vec *bvec;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001086
Kent Overstreetd74c6d52013-02-06 12:23:11 -08001087 bio_for_each_segment_all(bvec, bio, i) {
Dongsu Park9124d3f2015-01-18 16:16:34 +01001088 ssize_t ret;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001089
Dongsu Park9124d3f2015-01-18 16:16:34 +01001090 ret = copy_page_from_iter(bvec->bv_page,
1091 bvec->bv_offset,
1092 bvec->bv_len,
1093 &iter);
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001094
Dongsu Park9124d3f2015-01-18 16:16:34 +01001095 if (!iov_iter_count(&iter))
1096 break;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001097
Dongsu Park9124d3f2015-01-18 16:16:34 +01001098 if (ret < bvec->bv_len)
1099 return -EFAULT;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001100 }
1101
Dongsu Park9124d3f2015-01-18 16:16:34 +01001102 return 0;
1103}
1104
1105/**
1106 * bio_copy_to_iter - copy all pages from bio to iov_iter
1107 * @bio: The &struct bio which describes the I/O as source
1108 * @iter: iov_iter as destination
1109 *
1110 * Copy all pages from bio to iov_iter.
1111 * Returns 0 on success, or error on failure.
1112 */
1113static int bio_copy_to_iter(struct bio *bio, struct iov_iter iter)
1114{
1115 int i;
1116 struct bio_vec *bvec;
1117
1118 bio_for_each_segment_all(bvec, bio, i) {
1119 ssize_t ret;
1120
1121 ret = copy_page_to_iter(bvec->bv_page,
1122 bvec->bv_offset,
1123 bvec->bv_len,
1124 &iter);
1125
1126 if (!iov_iter_count(&iter))
1127 break;
1128
1129 if (ret < bvec->bv_len)
1130 return -EFAULT;
1131 }
1132
1133 return 0;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001134}
1135
Guoqing Jiang491221f2016-09-22 03:10:01 -04001136void bio_free_pages(struct bio *bio)
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001137{
1138 struct bio_vec *bvec;
1139 int i;
1140
1141 bio_for_each_segment_all(bvec, bio, i)
1142 __free_page(bvec->bv_page);
1143}
Guoqing Jiang491221f2016-09-22 03:10:01 -04001144EXPORT_SYMBOL(bio_free_pages);
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001145
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146/**
1147 * bio_uncopy_user - finish previously mapped bio
1148 * @bio: bio being terminated
1149 *
Christoph Hellwigddad8dd2015-01-18 16:16:29 +01001150 * Free pages allocated from bio_copy_user_iov() and write back data
Linus Torvalds1da177e2005-04-16 15:20:36 -07001151 * to user space in case of a read.
1152 */
1153int bio_uncopy_user(struct bio *bio)
1154{
1155 struct bio_map_data *bmd = bio->bi_private;
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001156 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157
Roland Dreier35dc2482013-08-05 17:55:01 -07001158 if (!bio_flagged(bio, BIO_NULL_MAPPED)) {
1159 /*
1160 * if we're in a workqueue, the request is orphaned, so
Hannes Reinecke2d99b552016-02-12 09:39:15 +01001161 * don't copy into a random user address space, just free
1162 * and return -EINTR so user space doesn't expect any data.
Roland Dreier35dc2482013-08-05 17:55:01 -07001163 */
Hannes Reinecke2d99b552016-02-12 09:39:15 +01001164 if (!current->mm)
1165 ret = -EINTR;
1166 else if (bio_data_dir(bio) == READ)
Dongsu Park9124d3f2015-01-18 16:16:34 +01001167 ret = bio_copy_to_iter(bio, bmd->iter);
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001168 if (bmd->is_our_pages)
1169 bio_free_pages(bio);
Roland Dreier35dc2482013-08-05 17:55:01 -07001170 }
Kent Overstreetc8db4442013-11-22 19:39:06 -08001171 kfree(bmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172 bio_put(bio);
1173 return ret;
1174}
1175
1176/**
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001177 * bio_copy_user_iov - copy user data to bio
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001178 * @q: destination block queue
1179 * @map_data: pointer to the rq_map_data holding pages (if necessary)
1180 * @iter: iovec iterator
1181 * @gfp_mask: memory allocation flags
Linus Torvalds1da177e2005-04-16 15:20:36 -07001182 *
1183 * Prepares and returns a bio for indirect user io, bouncing data
1184 * to/from kernel pages as necessary. Must be paired with
1185 * call bio_uncopy_user() on io completion.
1186 */
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001187struct bio *bio_copy_user_iov(struct request_queue *q,
1188 struct rq_map_data *map_data,
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001189 const struct iov_iter *iter,
1190 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001191{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001192 struct bio_map_data *bmd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001193 struct page *page;
1194 struct bio *bio;
1195 int i, ret;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001196 int nr_pages = 0;
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001197 unsigned int len = iter->count;
Geliang Tangbd5cece2015-11-21 17:27:31 +08001198 unsigned int offset = map_data ? offset_in_page(map_data->offset) : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001199
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001200 for (i = 0; i < iter->nr_segs; i++) {
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001201 unsigned long uaddr;
1202 unsigned long end;
1203 unsigned long start;
1204
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001205 uaddr = (unsigned long) iter->iov[i].iov_base;
1206 end = (uaddr + iter->iov[i].iov_len + PAGE_SIZE - 1)
1207 >> PAGE_SHIFT;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001208 start = uaddr >> PAGE_SHIFT;
1209
Jens Axboecb4644c2010-11-10 14:36:25 +01001210 /*
1211 * Overflow, abort
1212 */
1213 if (end < start)
1214 return ERR_PTR(-EINVAL);
1215
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001216 nr_pages += end - start;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001217 }
1218
FUJITA Tomonori69838722009-04-28 20:24:29 +02001219 if (offset)
1220 nr_pages++;
1221
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001222 bmd = bio_alloc_map_data(iter->nr_segs, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001223 if (!bmd)
1224 return ERR_PTR(-ENOMEM);
1225
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001226 /*
1227 * We need to do a deep copy of the iov_iter including the iovecs.
1228 * The caller provided iov might point to an on-stack or otherwise
1229 * shortlived one.
1230 */
1231 bmd->is_our_pages = map_data ? 0 : 1;
1232 memcpy(bmd->iov, iter->iov, sizeof(struct iovec) * iter->nr_segs);
1233 iov_iter_init(&bmd->iter, iter->type, bmd->iov,
1234 iter->nr_segs, iter->count);
1235
Linus Torvalds1da177e2005-04-16 15:20:36 -07001236 ret = -ENOMEM;
Tejun Heoa9e9dc22009-04-15 22:10:27 +09001237 bio = bio_kmalloc(gfp_mask, nr_pages);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238 if (!bio)
1239 goto out_bmd;
1240
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 ret = 0;
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001242
1243 if (map_data) {
FUJITA Tomonorie623ddb2008-12-18 14:49:36 +09001244 nr_pages = 1 << map_data->page_order;
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001245 i = map_data->offset / PAGE_SIZE;
1246 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247 while (len) {
FUJITA Tomonorie623ddb2008-12-18 14:49:36 +09001248 unsigned int bytes = PAGE_SIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001250 bytes -= offset;
1251
Linus Torvalds1da177e2005-04-16 15:20:36 -07001252 if (bytes > len)
1253 bytes = len;
1254
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001255 if (map_data) {
FUJITA Tomonorie623ddb2008-12-18 14:49:36 +09001256 if (i == map_data->nr_entries * nr_pages) {
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001257 ret = -ENOMEM;
1258 break;
1259 }
FUJITA Tomonorie623ddb2008-12-18 14:49:36 +09001260
1261 page = map_data->pages[i / nr_pages];
1262 page += (i % nr_pages);
1263
1264 i++;
1265 } else {
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001266 page = alloc_page(q->bounce_gfp | gfp_mask);
FUJITA Tomonorie623ddb2008-12-18 14:49:36 +09001267 if (!page) {
1268 ret = -ENOMEM;
1269 break;
1270 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001271 }
1272
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001273 if (bio_add_pc_page(q, bio, page, bytes, offset) < bytes)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275
1276 len -= bytes;
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001277 offset = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001278 }
1279
1280 if (ret)
1281 goto cleanup;
1282
1283 /*
1284 * success
1285 */
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001286 if (((iter->type & WRITE) && (!map_data || !map_data->null_mapped)) ||
FUJITA Tomonoriecb554a2009-07-09 14:46:53 +02001287 (map_data && map_data->from_user)) {
Dongsu Park9124d3f2015-01-18 16:16:34 +01001288 ret = bio_copy_from_iter(bio, *iter);
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001289 if (ret)
1290 goto cleanup;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001291 }
1292
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001293 bio->bi_private = bmd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294 return bio;
1295cleanup:
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001296 if (!map_data)
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001297 bio_free_pages(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298 bio_put(bio);
1299out_bmd:
Kent Overstreetc8db4442013-11-22 19:39:06 -08001300 kfree(bmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001301 return ERR_PTR(ret);
1302}
1303
Christoph Hellwig37f19e52015-01-18 16:16:33 +01001304/**
1305 * bio_map_user_iov - map user iovec into bio
1306 * @q: the struct request_queue for the bio
1307 * @iter: iovec iterator
1308 * @gfp_mask: memory allocation flags
1309 *
1310 * Map the user space address into a bio suitable for io to a block
1311 * device. Returns an error pointer in case of error.
1312 */
1313struct bio *bio_map_user_iov(struct request_queue *q,
1314 const struct iov_iter *iter,
1315 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316{
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001317 int j;
James Bottomley f1970ba2005-06-20 14:06:52 +02001318 int nr_pages = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319 struct page **pages;
1320 struct bio *bio;
James Bottomley f1970ba2005-06-20 14:06:52 +02001321 int cur_page = 0;
1322 int ret, offset;
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001323 struct iov_iter i;
1324 struct iovec iov;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001326 iov_for_each(iov, i, *iter) {
1327 unsigned long uaddr = (unsigned long) iov.iov_base;
1328 unsigned long len = iov.iov_len;
James Bottomley f1970ba2005-06-20 14:06:52 +02001329 unsigned long end = (uaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1330 unsigned long start = uaddr >> PAGE_SHIFT;
1331
Jens Axboecb4644c2010-11-10 14:36:25 +01001332 /*
1333 * Overflow, abort
1334 */
1335 if (end < start)
1336 return ERR_PTR(-EINVAL);
1337
James Bottomley f1970ba2005-06-20 14:06:52 +02001338 nr_pages += end - start;
1339 /*
Linus Walleija441b0d2016-09-14 14:32:52 +02001340 * buffer must be aligned to at least logical block size for now
James Bottomley f1970ba2005-06-20 14:06:52 +02001341 */
Mike Christiead2d7222006-12-01 10:40:20 +01001342 if (uaddr & queue_dma_alignment(q))
James Bottomley f1970ba2005-06-20 14:06:52 +02001343 return ERR_PTR(-EINVAL);
1344 }
1345
1346 if (!nr_pages)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001347 return ERR_PTR(-EINVAL);
1348
Tejun Heoa9e9dc22009-04-15 22:10:27 +09001349 bio = bio_kmalloc(gfp_mask, nr_pages);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001350 if (!bio)
1351 return ERR_PTR(-ENOMEM);
1352
1353 ret = -ENOMEM;
FUJITA Tomonoria3bce902008-08-28 16:17:05 +09001354 pages = kcalloc(nr_pages, sizeof(struct page *), gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001355 if (!pages)
1356 goto out;
1357
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001358 iov_for_each(iov, i, *iter) {
1359 unsigned long uaddr = (unsigned long) iov.iov_base;
1360 unsigned long len = iov.iov_len;
James Bottomley f1970ba2005-06-20 14:06:52 +02001361 unsigned long end = (uaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1362 unsigned long start = uaddr >> PAGE_SHIFT;
1363 const int local_nr_pages = end - start;
1364 const int page_limit = cur_page + local_nr_pages;
Jens Axboecb4644c2010-11-10 14:36:25 +01001365
Nick Pigginf5dd33c2008-07-25 19:45:25 -07001366 ret = get_user_pages_fast(uaddr, local_nr_pages,
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001367 (iter->type & WRITE) != WRITE,
1368 &pages[cur_page]);
Jens Axboe99172152006-06-16 13:02:29 +02001369 if (ret < local_nr_pages) {
1370 ret = -EFAULT;
James Bottomley f1970ba2005-06-20 14:06:52 +02001371 goto out_unmap;
Jens Axboe99172152006-06-16 13:02:29 +02001372 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373
Geliang Tangbd5cece2015-11-21 17:27:31 +08001374 offset = offset_in_page(uaddr);
James Bottomley f1970ba2005-06-20 14:06:52 +02001375 for (j = cur_page; j < page_limit; j++) {
1376 unsigned int bytes = PAGE_SIZE - offset;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377
James Bottomley f1970ba2005-06-20 14:06:52 +02001378 if (len <= 0)
1379 break;
1380
1381 if (bytes > len)
1382 bytes = len;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383
James Bottomley f1970ba2005-06-20 14:06:52 +02001384 /*
1385 * sorry...
1386 */
Mike Christiedefd94b2005-12-05 02:37:06 -06001387 if (bio_add_pc_page(q, bio, pages[j], bytes, offset) <
1388 bytes)
James Bottomley f1970ba2005-06-20 14:06:52 +02001389 break;
1390
1391 len -= bytes;
1392 offset = 0;
1393 }
1394
1395 cur_page = j;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001396 /*
James Bottomley f1970ba2005-06-20 14:06:52 +02001397 * release the pages we didn't map into the bio, if any
Linus Torvalds1da177e2005-04-16 15:20:36 -07001398 */
James Bottomley f1970ba2005-06-20 14:06:52 +02001399 while (j < page_limit)
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001400 put_page(pages[j++]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401 }
1402
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 kfree(pages);
1404
Jens Axboeb7c44ed2015-07-24 12:37:59 -06001405 bio_set_flag(bio, BIO_USER_MAPPED);
Christoph Hellwig37f19e52015-01-18 16:16:33 +01001406
1407 /*
Bart Van Assche5fad1b62017-02-01 08:20:08 -08001408 * subtle -- if bio_map_user_iov() ended up bouncing a bio,
Christoph Hellwig37f19e52015-01-18 16:16:33 +01001409 * it would normally disappear when its bi_end_io is run.
1410 * however, we need it for the unmap, so grab an extra
1411 * reference to it
1412 */
1413 bio_get(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414 return bio;
James Bottomley f1970ba2005-06-20 14:06:52 +02001415
1416 out_unmap:
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001417 for (j = 0; j < nr_pages; j++) {
1418 if (!pages[j])
James Bottomley f1970ba2005-06-20 14:06:52 +02001419 break;
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001420 put_page(pages[j]);
James Bottomley f1970ba2005-06-20 14:06:52 +02001421 }
1422 out:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001423 kfree(pages);
1424 bio_put(bio);
1425 return ERR_PTR(ret);
1426}
1427
Linus Torvalds1da177e2005-04-16 15:20:36 -07001428static void __bio_unmap_user(struct bio *bio)
1429{
1430 struct bio_vec *bvec;
1431 int i;
1432
1433 /*
1434 * make sure we dirty pages we wrote to
1435 */
Kent Overstreetd74c6d52013-02-06 12:23:11 -08001436 bio_for_each_segment_all(bvec, bio, i) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001437 if (bio_data_dir(bio) == READ)
1438 set_page_dirty_lock(bvec->bv_page);
1439
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001440 put_page(bvec->bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001441 }
1442
1443 bio_put(bio);
1444}
1445
1446/**
1447 * bio_unmap_user - unmap a bio
1448 * @bio: the bio being unmapped
1449 *
Bart Van Assche5fad1b62017-02-01 08:20:08 -08001450 * Unmap a bio previously mapped by bio_map_user_iov(). Must be called from
1451 * process context.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452 *
1453 * bio_unmap_user() may sleep.
1454 */
1455void bio_unmap_user(struct bio *bio)
1456{
1457 __bio_unmap_user(bio);
1458 bio_put(bio);
1459}
1460
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001461static void bio_map_kern_endio(struct bio *bio)
Jens Axboeb8238252005-06-20 14:05:27 +02001462{
Jens Axboeb8238252005-06-20 14:05:27 +02001463 bio_put(bio);
Jens Axboeb8238252005-06-20 14:05:27 +02001464}
1465
Christoph Hellwig75c72b82015-01-18 16:16:32 +01001466/**
1467 * bio_map_kern - map kernel address into bio
1468 * @q: the struct request_queue for the bio
1469 * @data: pointer to buffer to map
1470 * @len: length in bytes
1471 * @gfp_mask: allocation flags for bio allocation
1472 *
1473 * Map the kernel address into a bio suitable for io to a block
1474 * device. Returns an error pointer in case of error.
1475 */
1476struct bio *bio_map_kern(struct request_queue *q, void *data, unsigned int len,
1477 gfp_t gfp_mask)
Mike Christie df46b9a2005-06-20 14:04:44 +02001478{
1479 unsigned long kaddr = (unsigned long)data;
1480 unsigned long end = (kaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1481 unsigned long start = kaddr >> PAGE_SHIFT;
1482 const int nr_pages = end - start;
1483 int offset, i;
1484 struct bio *bio;
1485
Tejun Heoa9e9dc22009-04-15 22:10:27 +09001486 bio = bio_kmalloc(gfp_mask, nr_pages);
Mike Christie df46b9a2005-06-20 14:04:44 +02001487 if (!bio)
1488 return ERR_PTR(-ENOMEM);
1489
1490 offset = offset_in_page(kaddr);
1491 for (i = 0; i < nr_pages; i++) {
1492 unsigned int bytes = PAGE_SIZE - offset;
1493
1494 if (len <= 0)
1495 break;
1496
1497 if (bytes > len)
1498 bytes = len;
1499
Mike Christiedefd94b2005-12-05 02:37:06 -06001500 if (bio_add_pc_page(q, bio, virt_to_page(data), bytes,
Christoph Hellwig75c72b82015-01-18 16:16:32 +01001501 offset) < bytes) {
1502 /* we don't support partial mappings */
1503 bio_put(bio);
1504 return ERR_PTR(-EINVAL);
1505 }
Mike Christie df46b9a2005-06-20 14:04:44 +02001506
1507 data += bytes;
1508 len -= bytes;
1509 offset = 0;
1510 }
1511
Jens Axboeb8238252005-06-20 14:05:27 +02001512 bio->bi_end_io = bio_map_kern_endio;
Mike Christie df46b9a2005-06-20 14:04:44 +02001513 return bio;
1514}
H Hartley Sweetena112a712009-09-26 16:19:21 +02001515EXPORT_SYMBOL(bio_map_kern);
Mike Christie df46b9a2005-06-20 14:04:44 +02001516
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001517static void bio_copy_kern_endio(struct bio *bio)
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001518{
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001519 bio_free_pages(bio);
1520 bio_put(bio);
1521}
1522
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001523static void bio_copy_kern_endio_read(struct bio *bio)
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001524{
Christoph Hellwig42d26832015-01-18 16:16:28 +01001525 char *p = bio->bi_private;
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001526 struct bio_vec *bvec;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001527 int i;
1528
Kent Overstreetd74c6d52013-02-06 12:23:11 -08001529 bio_for_each_segment_all(bvec, bio, i) {
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001530 memcpy(p, page_address(bvec->bv_page), bvec->bv_len);
Kent Overstreetc8db4442013-11-22 19:39:06 -08001531 p += bvec->bv_len;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001532 }
1533
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001534 bio_copy_kern_endio(bio);
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001535}
1536
1537/**
1538 * bio_copy_kern - copy kernel address into bio
1539 * @q: the struct request_queue for the bio
1540 * @data: pointer to buffer to copy
1541 * @len: length in bytes
1542 * @gfp_mask: allocation flags for bio and page allocation
Randy Dunlapffee0252008-04-30 09:08:54 +02001543 * @reading: data direction is READ
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001544 *
1545 * copy the kernel address into a bio suitable for io to a block
1546 * device. Returns an error pointer in case of error.
1547 */
1548struct bio *bio_copy_kern(struct request_queue *q, void *data, unsigned int len,
1549 gfp_t gfp_mask, int reading)
1550{
Christoph Hellwig42d26832015-01-18 16:16:28 +01001551 unsigned long kaddr = (unsigned long)data;
1552 unsigned long end = (kaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1553 unsigned long start = kaddr >> PAGE_SHIFT;
Christoph Hellwig42d26832015-01-18 16:16:28 +01001554 struct bio *bio;
1555 void *p = data;
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001556 int nr_pages = 0;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001557
Christoph Hellwig42d26832015-01-18 16:16:28 +01001558 /*
1559 * Overflow, abort
1560 */
1561 if (end < start)
1562 return ERR_PTR(-EINVAL);
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001563
Christoph Hellwig42d26832015-01-18 16:16:28 +01001564 nr_pages = end - start;
1565 bio = bio_kmalloc(gfp_mask, nr_pages);
1566 if (!bio)
1567 return ERR_PTR(-ENOMEM);
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001568
Christoph Hellwig42d26832015-01-18 16:16:28 +01001569 while (len) {
1570 struct page *page;
1571 unsigned int bytes = PAGE_SIZE;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001572
Christoph Hellwig42d26832015-01-18 16:16:28 +01001573 if (bytes > len)
1574 bytes = len;
1575
1576 page = alloc_page(q->bounce_gfp | gfp_mask);
1577 if (!page)
1578 goto cleanup;
1579
1580 if (!reading)
1581 memcpy(page_address(page), p, bytes);
1582
1583 if (bio_add_pc_page(q, bio, page, bytes, 0) < bytes)
1584 break;
1585
1586 len -= bytes;
1587 p += bytes;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001588 }
1589
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001590 if (reading) {
1591 bio->bi_end_io = bio_copy_kern_endio_read;
1592 bio->bi_private = data;
1593 } else {
1594 bio->bi_end_io = bio_copy_kern_endio;
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001595 }
FUJITA Tomonori76029ff2008-08-25 20:36:08 +02001596
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001597 return bio;
Christoph Hellwig42d26832015-01-18 16:16:28 +01001598
1599cleanup:
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001600 bio_free_pages(bio);
Christoph Hellwig42d26832015-01-18 16:16:28 +01001601 bio_put(bio);
1602 return ERR_PTR(-ENOMEM);
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001603}
1604
Linus Torvalds1da177e2005-04-16 15:20:36 -07001605/*
1606 * bio_set_pages_dirty() and bio_check_pages_dirty() are support functions
1607 * for performing direct-IO in BIOs.
1608 *
1609 * The problem is that we cannot run set_page_dirty() from interrupt context
1610 * because the required locks are not interrupt-safe. So what we can do is to
1611 * mark the pages dirty _before_ performing IO. And in interrupt context,
1612 * check that the pages are still dirty. If so, fine. If not, redirty them
1613 * in process context.
1614 *
1615 * We special-case compound pages here: normally this means reads into hugetlb
1616 * pages. The logic in here doesn't really work right for compound pages
1617 * because the VM does not uniformly chase down the head page in all cases.
1618 * But dirtiness of compound pages is pretty meaningless anyway: the VM doesn't
1619 * handle them at all. So we skip compound pages here at an early stage.
1620 *
1621 * Note that this code is very hard to test under normal circumstances because
1622 * direct-io pins the pages with get_user_pages(). This makes
1623 * is_page_cache_freeable return false, and the VM will not clean the pages.
Artem Bityutskiy0d5c3eb2012-07-25 18:12:08 +03001624 * But other code (eg, flusher threads) could clean the pages if they are mapped
Linus Torvalds1da177e2005-04-16 15:20:36 -07001625 * pagecache.
1626 *
1627 * Simply disabling the call to bio_set_pages_dirty() is a good way to test the
1628 * deferred bio dirtying paths.
1629 */
1630
1631/*
1632 * bio_set_pages_dirty() will mark all the bio's pages as dirty.
1633 */
1634void bio_set_pages_dirty(struct bio *bio)
1635{
Kent Overstreetcb34e052012-09-05 15:22:02 -07001636 struct bio_vec *bvec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637 int i;
1638
Kent Overstreetcb34e052012-09-05 15:22:02 -07001639 bio_for_each_segment_all(bvec, bio, i) {
1640 struct page *page = bvec->bv_page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641
1642 if (page && !PageCompound(page))
1643 set_page_dirty_lock(page);
1644 }
1645}
1646
Adrian Bunk86b6c7a2008-02-18 13:48:32 +01001647static void bio_release_pages(struct bio *bio)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001648{
Kent Overstreetcb34e052012-09-05 15:22:02 -07001649 struct bio_vec *bvec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001650 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 (page)
1656 put_page(page);
1657 }
1658}
1659
1660/*
1661 * bio_check_pages_dirty() will check that all the BIO's pages are still dirty.
1662 * If they are, then fine. If, however, some pages are clean then they must
1663 * have been written out during the direct-IO read. So we take another ref on
1664 * the BIO and the offending pages and re-dirty the pages in process context.
1665 *
1666 * It is expected that bio_check_pages_dirty() will wholly own the BIO from
Kirill A. Shutemovea1754a2016-04-01 15:29:48 +03001667 * here on. It will run one put_page() against each page and will run one
1668 * bio_put() against the BIO.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669 */
1670
David Howells65f27f32006-11-22 14:55:48 +00001671static void bio_dirty_fn(struct work_struct *work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001672
David Howells65f27f32006-11-22 14:55:48 +00001673static DECLARE_WORK(bio_dirty_work, bio_dirty_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001674static DEFINE_SPINLOCK(bio_dirty_lock);
1675static struct bio *bio_dirty_list;
1676
1677/*
1678 * This runs in process context
1679 */
David Howells65f27f32006-11-22 14:55:48 +00001680static void bio_dirty_fn(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001681{
1682 unsigned long flags;
1683 struct bio *bio;
1684
1685 spin_lock_irqsave(&bio_dirty_lock, flags);
1686 bio = bio_dirty_list;
1687 bio_dirty_list = NULL;
1688 spin_unlock_irqrestore(&bio_dirty_lock, flags);
1689
1690 while (bio) {
1691 struct bio *next = bio->bi_private;
1692
1693 bio_set_pages_dirty(bio);
1694 bio_release_pages(bio);
1695 bio_put(bio);
1696 bio = next;
1697 }
1698}
1699
1700void bio_check_pages_dirty(struct bio *bio)
1701{
Kent Overstreetcb34e052012-09-05 15:22:02 -07001702 struct bio_vec *bvec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703 int nr_clean_pages = 0;
1704 int i;
1705
Kent Overstreetcb34e052012-09-05 15:22:02 -07001706 bio_for_each_segment_all(bvec, bio, i) {
1707 struct page *page = bvec->bv_page;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708
1709 if (PageDirty(page) || PageCompound(page)) {
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001710 put_page(page);
Kent Overstreetcb34e052012-09-05 15:22:02 -07001711 bvec->bv_page = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001712 } else {
1713 nr_clean_pages++;
1714 }
1715 }
1716
1717 if (nr_clean_pages) {
1718 unsigned long flags;
1719
1720 spin_lock_irqsave(&bio_dirty_lock, flags);
1721 bio->bi_private = bio_dirty_list;
1722 bio_dirty_list = bio;
1723 spin_unlock_irqrestore(&bio_dirty_lock, flags);
1724 schedule_work(&bio_dirty_work);
1725 } else {
1726 bio_put(bio);
1727 }
1728}
1729
Gu Zheng394ffa52014-11-24 11:05:22 +08001730void generic_start_io_acct(int rw, unsigned long sectors,
1731 struct hd_struct *part)
1732{
1733 int cpu = part_stat_lock();
1734
1735 part_round_stats(cpu, part);
1736 part_stat_inc(cpu, part, ios[rw]);
1737 part_stat_add(cpu, part, sectors[rw], sectors);
1738 part_inc_in_flight(part, rw);
1739
1740 part_stat_unlock();
1741}
1742EXPORT_SYMBOL(generic_start_io_acct);
1743
1744void generic_end_io_acct(int rw, struct hd_struct *part,
1745 unsigned long start_time)
1746{
1747 unsigned long duration = jiffies - start_time;
1748 int cpu = part_stat_lock();
1749
1750 part_stat_add(cpu, part, ticks[rw], duration);
1751 part_round_stats(cpu, part);
1752 part_dec_in_flight(part, rw);
1753
1754 part_stat_unlock();
1755}
1756EXPORT_SYMBOL(generic_end_io_acct);
1757
Ilya Loginov2d4dc892009-11-26 09:16:19 +01001758#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
1759void bio_flush_dcache_pages(struct bio *bi)
1760{
Kent Overstreet79886132013-11-23 17:19:00 -08001761 struct bio_vec bvec;
1762 struct bvec_iter iter;
Ilya Loginov2d4dc892009-11-26 09:16:19 +01001763
Kent Overstreet79886132013-11-23 17:19:00 -08001764 bio_for_each_segment(bvec, bi, iter)
1765 flush_dcache_page(bvec.bv_page);
Ilya Loginov2d4dc892009-11-26 09:16:19 +01001766}
1767EXPORT_SYMBOL(bio_flush_dcache_pages);
1768#endif
1769
Jens Axboec4cf5262015-04-17 16:15:18 -06001770static inline bool bio_remaining_done(struct bio *bio)
1771{
1772 /*
1773 * If we're not chaining, then ->__bi_remaining is always 1 and
1774 * we always end io on the first invocation.
1775 */
1776 if (!bio_flagged(bio, BIO_CHAIN))
1777 return true;
1778
1779 BUG_ON(atomic_read(&bio->__bi_remaining) <= 0);
1780
Mike Snitzer326e1db2015-05-22 09:14:03 -04001781 if (atomic_dec_and_test(&bio->__bi_remaining)) {
Jens Axboeb7c44ed2015-07-24 12:37:59 -06001782 bio_clear_flag(bio, BIO_CHAIN);
Jens Axboec4cf5262015-04-17 16:15:18 -06001783 return true;
Mike Snitzer326e1db2015-05-22 09:14:03 -04001784 }
Jens Axboec4cf5262015-04-17 16:15:18 -06001785
1786 return false;
1787}
1788
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789/**
1790 * bio_endio - end I/O on a bio
1791 * @bio: bio
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792 *
1793 * Description:
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001794 * bio_endio() will end I/O on the whole bio. bio_endio() is the preferred
1795 * way to end I/O on a bio. No one should call bi_end_io() directly on a
1796 * bio unless they own it and thus know that it has an end_io function.
NeilBrownfbbaf702017-04-07 09:40:52 -06001797 *
1798 * bio_endio() can be called several times on a bio that has been chained
1799 * using bio_chain(). The ->bi_end_io() function will only be called the
1800 * last time. At this point the BLK_TA_COMPLETE tracing event will be
1801 * generated if BIO_TRACE_COMPLETION is set.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001802 **/
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001803void bio_endio(struct bio *bio)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804{
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001805again:
Christoph Hellwig2b885512016-03-11 17:34:53 +01001806 if (!bio_remaining_done(bio))
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001807 return;
Kent Overstreet196d38bc2013-11-23 18:34:15 -08001808
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001809 /*
1810 * Need to have a real endio function for chained bios, otherwise
1811 * various corner cases will break (like stacking block devices that
1812 * save/restore bi_end_io) - however, we want to avoid unbounded
1813 * recursion and blowing the stack. Tail call optimization would
1814 * handle this, but compiling with frame pointers also disables
1815 * gcc's sibling call optimization.
1816 */
1817 if (bio->bi_end_io == bio_chain_endio) {
1818 bio = __bio_chain_endio(bio);
1819 goto again;
Kent Overstreet196d38bc2013-11-23 18:34:15 -08001820 }
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001821
NeilBrownfbbaf702017-04-07 09:40:52 -06001822 if (bio->bi_bdev && bio_flagged(bio, BIO_TRACE_COMPLETION)) {
Bart Van Asschea462b952017-06-13 08:07:33 -07001823 trace_block_bio_complete(bdev_get_queue(bio->bi_bdev), bio,
1824 blk_status_to_errno(bio->bi_status));
NeilBrownfbbaf702017-04-07 09:40:52 -06001825 bio_clear_flag(bio, BIO_TRACE_COMPLETION);
1826 }
1827
Shaohua Li9e234ee2017-03-27 10:51:41 -07001828 blk_throtl_bio_endio(bio);
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001829 if (bio->bi_end_io)
1830 bio->bi_end_io(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831}
H Hartley Sweetena112a712009-09-26 16:19:21 +02001832EXPORT_SYMBOL(bio_endio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001833
Kent Overstreet196d38bc2013-11-23 18:34:15 -08001834/**
Kent Overstreet20d01892013-11-23 18:21:01 -08001835 * bio_split - split a bio
1836 * @bio: bio to split
1837 * @sectors: number of sectors to split from the front of @bio
1838 * @gfp: gfp mask
1839 * @bs: bio set to allocate from
1840 *
1841 * Allocates and returns a new bio which represents @sectors from the start of
1842 * @bio, and updates @bio to represent the remaining sectors.
1843 *
Martin K. Petersenf3f5da62015-07-22 07:57:12 -04001844 * Unless this is a discard request the newly allocated bio will point
1845 * to @bio's bi_io_vec; it is the caller's responsibility to ensure that
1846 * @bio is not freed before the split.
Kent Overstreet20d01892013-11-23 18:21:01 -08001847 */
1848struct bio *bio_split(struct bio *bio, int sectors,
1849 gfp_t gfp, struct bio_set *bs)
1850{
1851 struct bio *split = NULL;
1852
1853 BUG_ON(sectors <= 0);
1854 BUG_ON(sectors >= bio_sectors(bio));
1855
Christoph Hellwigf9d03f92016-12-08 15:20:32 -07001856 split = bio_clone_fast(bio, gfp, bs);
Kent Overstreet20d01892013-11-23 18:21:01 -08001857 if (!split)
1858 return NULL;
1859
1860 split->bi_iter.bi_size = sectors << 9;
1861
1862 if (bio_integrity(split))
1863 bio_integrity_trim(split, 0, sectors);
1864
1865 bio_advance(bio, split->bi_iter.bi_size);
1866
NeilBrownfbbaf702017-04-07 09:40:52 -06001867 if (bio_flagged(bio, BIO_TRACE_COMPLETION))
1868 bio_set_flag(bio, BIO_TRACE_COMPLETION);
1869
Kent Overstreet20d01892013-11-23 18:21:01 -08001870 return split;
1871}
1872EXPORT_SYMBOL(bio_split);
1873
Martin K. Petersenad3316b2008-10-01 22:42:53 -04001874/**
Kent Overstreet6678d832013-08-07 11:14:32 -07001875 * bio_trim - trim a bio
1876 * @bio: bio to trim
1877 * @offset: number of sectors to trim from the front of @bio
1878 * @size: size we want to trim @bio to, in sectors
1879 */
1880void bio_trim(struct bio *bio, int offset, int size)
1881{
1882 /* 'bio' is a cloned bio which we need to trim to match
1883 * the given offset and size.
Kent Overstreet6678d832013-08-07 11:14:32 -07001884 */
Kent Overstreet6678d832013-08-07 11:14:32 -07001885
1886 size <<= 9;
Kent Overstreet4f024f32013-10-11 15:44:27 -07001887 if (offset == 0 && size == bio->bi_iter.bi_size)
Kent Overstreet6678d832013-08-07 11:14:32 -07001888 return;
1889
Jens Axboeb7c44ed2015-07-24 12:37:59 -06001890 bio_clear_flag(bio, BIO_SEG_VALID);
Kent Overstreet6678d832013-08-07 11:14:32 -07001891
1892 bio_advance(bio, offset << 9);
1893
Kent Overstreet4f024f32013-10-11 15:44:27 -07001894 bio->bi_iter.bi_size = size;
Kent Overstreet6678d832013-08-07 11:14:32 -07001895}
1896EXPORT_SYMBOL_GPL(bio_trim);
1897
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898/*
1899 * create memory pools for biovec's in a bio_set.
1900 * use the global biovec slabs created for general use.
1901 */
Fabian Fredericka6c39cb4f2014-04-22 15:09:05 -06001902mempool_t *biovec_create_pool(int pool_entries)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001903{
Christoph Hellwiged996a52016-07-19 11:28:42 +02001904 struct biovec_slab *bp = bvec_slabs + BVEC_POOL_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001905
Kent Overstreet9f060e22012-10-12 15:29:33 -07001906 return mempool_create_slab_pool(pool_entries, bp->slab);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907}
1908
1909void bioset_free(struct bio_set *bs)
1910{
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -07001911 if (bs->rescue_workqueue)
1912 destroy_workqueue(bs->rescue_workqueue);
1913
Linus Torvalds1da177e2005-04-16 15:20:36 -07001914 if (bs->bio_pool)
1915 mempool_destroy(bs->bio_pool);
1916
Kent Overstreet9f060e22012-10-12 15:29:33 -07001917 if (bs->bvec_pool)
1918 mempool_destroy(bs->bvec_pool);
1919
Martin K. Petersen7878cba2009-06-26 15:37:49 +02001920 bioset_integrity_free(bs);
Jens Axboebb799ca2008-12-10 15:35:05 +01001921 bio_put_slab(bs);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001922
1923 kfree(bs);
1924}
H Hartley Sweetena112a712009-09-26 16:19:21 +02001925EXPORT_SYMBOL(bioset_free);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926
NeilBrown011067b2017-06-18 14:38:57 +10001927/**
1928 * bioset_create - Create a bio_set
1929 * @pool_size: Number of bio and bio_vecs to cache in the mempool
1930 * @front_pad: Number of bytes to allocate in front of the returned bio
NeilBrown47e0fb42017-06-18 14:38:57 +10001931 * @flags: Flags to modify behavior, currently %BIOSET_NEED_BVECS
1932 * and %BIOSET_NEED_RESCUER
NeilBrown011067b2017-06-18 14:38:57 +10001933 *
1934 * Description:
1935 * Set up a bio_set to be used with @bio_alloc_bioset. Allows the caller
1936 * to ask for a number of bytes to be allocated in front of the bio.
1937 * Front pad allocation is useful for embedding the bio inside
1938 * another structure, to avoid allocating extra data to go with the bio.
1939 * Note that the bio must be embedded at the END of that structure always,
1940 * or things will break badly.
1941 * If %BIOSET_NEED_BVECS is set in @flags, a separate pool will be allocated
1942 * for allocating iovecs. This pool is not needed e.g. for bio_clone_fast().
NeilBrown47e0fb42017-06-18 14:38:57 +10001943 * If %BIOSET_NEED_RESCUER is set, a workqueue is created which can be used to
1944 * dispatch queued requests when the mempool runs out of space.
NeilBrown011067b2017-06-18 14:38:57 +10001945 *
1946 */
1947struct bio_set *bioset_create(unsigned int pool_size,
1948 unsigned int front_pad,
1949 int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950{
Jens Axboe392ddc32008-12-23 12:42:54 +01001951 unsigned int back_pad = BIO_INLINE_VECS * sizeof(struct bio_vec);
Jens Axboe1b434492008-10-22 20:32:58 +02001952 struct bio_set *bs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001953
Jens Axboe1b434492008-10-22 20:32:58 +02001954 bs = kzalloc(sizeof(*bs), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001955 if (!bs)
1956 return NULL;
1957
Jens Axboebb799ca2008-12-10 15:35:05 +01001958 bs->front_pad = front_pad;
Jens Axboe1b434492008-10-22 20:32:58 +02001959
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -07001960 spin_lock_init(&bs->rescue_lock);
1961 bio_list_init(&bs->rescue_list);
1962 INIT_WORK(&bs->rescue_work, bio_alloc_rescue);
1963
Jens Axboe392ddc32008-12-23 12:42:54 +01001964 bs->bio_slab = bio_find_or_create_slab(front_pad + back_pad);
Jens Axboebb799ca2008-12-10 15:35:05 +01001965 if (!bs->bio_slab) {
1966 kfree(bs);
1967 return NULL;
1968 }
1969
1970 bs->bio_pool = mempool_create_slab_pool(pool_size, bs->bio_slab);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971 if (!bs->bio_pool)
1972 goto bad;
1973
NeilBrown011067b2017-06-18 14:38:57 +10001974 if (flags & BIOSET_NEED_BVECS) {
Junichi Nomurad8f429e2014-10-03 17:27:12 -04001975 bs->bvec_pool = biovec_create_pool(pool_size);
1976 if (!bs->bvec_pool)
1977 goto bad;
1978 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001979
NeilBrown47e0fb42017-06-18 14:38:57 +10001980 if (!(flags & BIOSET_NEED_RESCUER))
1981 return bs;
1982
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -07001983 bs->rescue_workqueue = alloc_workqueue("bioset", WQ_MEM_RECLAIM, 0);
1984 if (!bs->rescue_workqueue)
1985 goto bad;
1986
1987 return bs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001988bad:
1989 bioset_free(bs);
1990 return NULL;
1991}
H Hartley Sweetena112a712009-09-26 16:19:21 +02001992EXPORT_SYMBOL(bioset_create);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993
Tejun Heo852c7882012-03-05 13:15:27 -08001994#ifdef CONFIG_BLK_CGROUP
Tejun Heo1d933cf2015-05-22 17:13:24 -04001995
1996/**
1997 * bio_associate_blkcg - associate a bio with the specified blkcg
1998 * @bio: target bio
1999 * @blkcg_css: css of the blkcg to associate
2000 *
2001 * Associate @bio with the blkcg specified by @blkcg_css. Block layer will
2002 * treat @bio as if it were issued by a task which belongs to the blkcg.
2003 *
2004 * This function takes an extra reference of @blkcg_css which will be put
2005 * when @bio is released. The caller must own @bio and is responsible for
2006 * synchronizing calls to this function.
2007 */
2008int bio_associate_blkcg(struct bio *bio, struct cgroup_subsys_state *blkcg_css)
2009{
2010 if (unlikely(bio->bi_css))
2011 return -EBUSY;
2012 css_get(blkcg_css);
2013 bio->bi_css = blkcg_css;
2014 return 0;
2015}
Tejun Heo5aa2a962015-07-23 14:27:09 -04002016EXPORT_SYMBOL_GPL(bio_associate_blkcg);
Tejun Heo1d933cf2015-05-22 17:13:24 -04002017
Tejun Heo852c7882012-03-05 13:15:27 -08002018/**
2019 * bio_associate_current - associate a bio with %current
2020 * @bio: target bio
2021 *
2022 * Associate @bio with %current if it hasn't been associated yet. Block
2023 * layer will treat @bio as if it were issued by %current no matter which
2024 * task actually issues it.
2025 *
2026 * This function takes an extra reference of @task's io_context and blkcg
2027 * which will be put when @bio is released. The caller must own @bio,
2028 * ensure %current->io_context exists, and is responsible for synchronizing
2029 * calls to this function.
2030 */
2031int bio_associate_current(struct bio *bio)
2032{
2033 struct io_context *ioc;
Tejun Heo852c7882012-03-05 13:15:27 -08002034
Tejun Heo1d933cf2015-05-22 17:13:24 -04002035 if (bio->bi_css)
Tejun Heo852c7882012-03-05 13:15:27 -08002036 return -EBUSY;
2037
2038 ioc = current->io_context;
2039 if (!ioc)
2040 return -ENOENT;
2041
Tejun Heo852c7882012-03-05 13:15:27 -08002042 get_io_context_active(ioc);
2043 bio->bi_ioc = ioc;
Tejun Heoc165b3e2015-08-18 14:55:29 -07002044 bio->bi_css = task_get_css(current, io_cgrp_id);
Tejun Heo852c7882012-03-05 13:15:27 -08002045 return 0;
2046}
Tejun Heo5aa2a962015-07-23 14:27:09 -04002047EXPORT_SYMBOL_GPL(bio_associate_current);
Tejun Heo852c7882012-03-05 13:15:27 -08002048
2049/**
2050 * bio_disassociate_task - undo bio_associate_current()
2051 * @bio: target bio
2052 */
2053void bio_disassociate_task(struct bio *bio)
2054{
2055 if (bio->bi_ioc) {
2056 put_io_context(bio->bi_ioc);
2057 bio->bi_ioc = NULL;
2058 }
2059 if (bio->bi_css) {
2060 css_put(bio->bi_css);
2061 bio->bi_css = NULL;
2062 }
2063}
2064
Paolo Valente20bd7232016-07-27 07:22:05 +02002065/**
2066 * bio_clone_blkcg_association - clone blkcg association from src to dst bio
2067 * @dst: destination bio
2068 * @src: source bio
2069 */
2070void bio_clone_blkcg_association(struct bio *dst, struct bio *src)
2071{
2072 if (src->bi_css)
2073 WARN_ON(bio_associate_blkcg(dst, src->bi_css));
2074}
2075
Tejun Heo852c7882012-03-05 13:15:27 -08002076#endif /* CONFIG_BLK_CGROUP */
2077
Linus Torvalds1da177e2005-04-16 15:20:36 -07002078static void __init biovec_init_slabs(void)
2079{
2080 int i;
2081
Christoph Hellwiged996a52016-07-19 11:28:42 +02002082 for (i = 0; i < BVEC_POOL_NR; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002083 int size;
2084 struct biovec_slab *bvs = bvec_slabs + i;
2085
Jens Axboea7fcd372008-12-05 16:10:29 +01002086 if (bvs->nr_vecs <= BIO_INLINE_VECS) {
2087 bvs->slab = NULL;
2088 continue;
2089 }
Jens Axboea7fcd372008-12-05 16:10:29 +01002090
Linus Torvalds1da177e2005-04-16 15:20:36 -07002091 size = bvs->nr_vecs * sizeof(struct bio_vec);
2092 bvs->slab = kmem_cache_create(bvs->name, size, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09002093 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094 }
2095}
2096
2097static int __init init_bio(void)
2098{
Jens Axboebb799ca2008-12-10 15:35:05 +01002099 bio_slab_max = 2;
2100 bio_slab_nr = 0;
2101 bio_slabs = kzalloc(bio_slab_max * sizeof(struct bio_slab), GFP_KERNEL);
2102 if (!bio_slabs)
2103 panic("bio: can't allocate bios\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002104
Martin K. Petersen7878cba2009-06-26 15:37:49 +02002105 bio_integrity_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106 biovec_init_slabs();
2107
NeilBrown011067b2017-06-18 14:38:57 +10002108 fs_bio_set = bioset_create(BIO_POOL_SIZE, 0, BIOSET_NEED_BVECS);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 if (!fs_bio_set)
2110 panic("bio: can't allocate bios\n");
2111
Martin K. Petersena91a2782011-03-17 11:11:05 +01002112 if (bioset_integrity_create(fs_bio_set, BIO_POOL_SIZE))
2113 panic("bio: can't create integrity pool\n");
2114
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115 return 0;
2116}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002117subsys_initcall(init_bio);