blob: 662d45752ec53505a787cff4e9e97d2bf0a808dc [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>
Josef Bacik08e18ea2018-07-03 11:14:50 -040031#include <linux/blk-cgroup.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070032
Li Zefan55782132009-06-09 13:43:05 +080033#include <trace/events/block.h>
Shaohua Li9e234ee2017-03-27 10:51:41 -070034#include "blk.h"
Josef Bacik67b42d02018-07-03 11:15:00 -040035#include "blk-rq-qos.h"
Ingo Molnar0bfc2452008-11-26 11:59:56 +010036
Jens Axboe392ddc32008-12-23 12:42:54 +010037/*
38 * Test patch to inline a certain number of bi_io_vec's inside the bio
39 * itself, to shrink a bio data allocation from two mempool calls to one
40 */
41#define BIO_INLINE_VECS 4
42
Linus Torvalds1da177e2005-04-16 15:20:36 -070043/*
44 * if you change this list, also change bvec_alloc or things will
45 * break badly! cannot be bigger than what you can fit into an
46 * unsigned short
47 */
Mikulas Patockabd5c4fa2018-03-21 12:49:29 -040048#define BV(x, n) { .nr_vecs = x, .name = "biovec-"#n }
Christoph Hellwiged996a52016-07-19 11:28:42 +020049static struct biovec_slab bvec_slabs[BVEC_POOL_NR] __read_mostly = {
Mikulas Patockabd5c4fa2018-03-21 12:49:29 -040050 BV(1, 1), BV(4, 4), BV(16, 16), BV(64, 64), BV(128, 128), BV(BIO_MAX_PAGES, max),
Linus Torvalds1da177e2005-04-16 15:20:36 -070051};
52#undef BV
53
54/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 * fs_bio_set is the bio_set containing bio and iovec memory pools used by
56 * IO code that does not need private memory pools.
57 */
Kent Overstreetf4f81542018-05-08 21:33:52 -040058struct bio_set fs_bio_set;
Kent Overstreet3f86a822012-09-06 15:35:01 -070059EXPORT_SYMBOL(fs_bio_set);
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
Jens Axboebb799ca2008-12-10 15:35:05 +010061/*
62 * Our slab pool management
63 */
64struct bio_slab {
65 struct kmem_cache *slab;
66 unsigned int slab_ref;
67 unsigned int slab_size;
68 char name[8];
69};
70static DEFINE_MUTEX(bio_slab_lock);
71static struct bio_slab *bio_slabs;
72static unsigned int bio_slab_nr, bio_slab_max;
73
74static struct kmem_cache *bio_find_or_create_slab(unsigned int extra_size)
75{
76 unsigned int sz = sizeof(struct bio) + extra_size;
77 struct kmem_cache *slab = NULL;
Alexey Khoroshilov389d7b22012-08-09 15:19:25 +020078 struct bio_slab *bslab, *new_bio_slabs;
Anna Leuschner386bc352012-10-22 21:53:36 +020079 unsigned int new_bio_slab_max;
Jens Axboebb799ca2008-12-10 15:35:05 +010080 unsigned int i, entry = -1;
81
82 mutex_lock(&bio_slab_lock);
83
84 i = 0;
85 while (i < bio_slab_nr) {
Thiago Farinaf06f1352010-01-19 14:07:09 +010086 bslab = &bio_slabs[i];
Jens Axboebb799ca2008-12-10 15:35:05 +010087
88 if (!bslab->slab && entry == -1)
89 entry = i;
90 else if (bslab->slab_size == sz) {
91 slab = bslab->slab;
92 bslab->slab_ref++;
93 break;
94 }
95 i++;
96 }
97
98 if (slab)
99 goto out_unlock;
100
101 if (bio_slab_nr == bio_slab_max && entry == -1) {
Anna Leuschner386bc352012-10-22 21:53:36 +0200102 new_bio_slab_max = bio_slab_max << 1;
Alexey Khoroshilov389d7b22012-08-09 15:19:25 +0200103 new_bio_slabs = krealloc(bio_slabs,
Anna Leuschner386bc352012-10-22 21:53:36 +0200104 new_bio_slab_max * sizeof(struct bio_slab),
Alexey Khoroshilov389d7b22012-08-09 15:19:25 +0200105 GFP_KERNEL);
106 if (!new_bio_slabs)
Jens Axboebb799ca2008-12-10 15:35:05 +0100107 goto out_unlock;
Anna Leuschner386bc352012-10-22 21:53:36 +0200108 bio_slab_max = new_bio_slab_max;
Alexey Khoroshilov389d7b22012-08-09 15:19:25 +0200109 bio_slabs = new_bio_slabs;
Jens Axboebb799ca2008-12-10 15:35:05 +0100110 }
111 if (entry == -1)
112 entry = bio_slab_nr++;
113
114 bslab = &bio_slabs[entry];
115
116 snprintf(bslab->name, sizeof(bslab->name), "bio-%d", entry);
Mikulas Patocka6a241482014-03-28 15:51:55 -0400117 slab = kmem_cache_create(bslab->name, sz, ARCH_KMALLOC_MINALIGN,
118 SLAB_HWCACHE_ALIGN, NULL);
Jens Axboebb799ca2008-12-10 15:35:05 +0100119 if (!slab)
120 goto out_unlock;
121
Jens Axboebb799ca2008-12-10 15:35:05 +0100122 bslab->slab = slab;
123 bslab->slab_ref = 1;
124 bslab->slab_size = sz;
125out_unlock:
126 mutex_unlock(&bio_slab_lock);
127 return slab;
128}
129
130static void bio_put_slab(struct bio_set *bs)
131{
132 struct bio_slab *bslab = NULL;
133 unsigned int i;
134
135 mutex_lock(&bio_slab_lock);
136
137 for (i = 0; i < bio_slab_nr; i++) {
138 if (bs->bio_slab == bio_slabs[i].slab) {
139 bslab = &bio_slabs[i];
140 break;
141 }
142 }
143
144 if (WARN(!bslab, KERN_ERR "bio: unable to find slab!\n"))
145 goto out;
146
147 WARN_ON(!bslab->slab_ref);
148
149 if (--bslab->slab_ref)
150 goto out;
151
152 kmem_cache_destroy(bslab->slab);
153 bslab->slab = NULL;
154
155out:
156 mutex_unlock(&bio_slab_lock);
157}
158
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200159unsigned int bvec_nr_vecs(unsigned short idx)
160{
Greg Edwardsd6c02a92018-08-08 13:27:53 -0600161 return bvec_slabs[--idx].nr_vecs;
Martin K. Petersen7ba1ba12008-06-30 20:04:41 +0200162}
163
Kent Overstreet9f060e22012-10-12 15:29:33 -0700164void bvec_free(mempool_t *pool, struct bio_vec *bv, unsigned int idx)
Jens Axboebb799ca2008-12-10 15:35:05 +0100165{
Christoph Hellwiged996a52016-07-19 11:28:42 +0200166 if (!idx)
167 return;
168 idx--;
Jens Axboebb799ca2008-12-10 15:35:05 +0100169
Christoph Hellwiged996a52016-07-19 11:28:42 +0200170 BIO_BUG_ON(idx >= BVEC_POOL_NR);
171
172 if (idx == BVEC_POOL_MAX) {
Kent Overstreet9f060e22012-10-12 15:29:33 -0700173 mempool_free(bv, pool);
Christoph Hellwiged996a52016-07-19 11:28:42 +0200174 } else {
Jens Axboebb799ca2008-12-10 15:35:05 +0100175 struct biovec_slab *bvs = bvec_slabs + idx;
176
177 kmem_cache_free(bvs->slab, bv);
178 }
179}
180
Kent Overstreet9f060e22012-10-12 15:29:33 -0700181struct bio_vec *bvec_alloc(gfp_t gfp_mask, int nr, unsigned long *idx,
182 mempool_t *pool)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183{
184 struct bio_vec *bvl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
186 /*
Jens Axboe7ff93452008-12-11 11:53:43 +0100187 * see comment near bvec_array define!
188 */
189 switch (nr) {
190 case 1:
191 *idx = 0;
192 break;
193 case 2 ... 4:
194 *idx = 1;
195 break;
196 case 5 ... 16:
197 *idx = 2;
198 break;
199 case 17 ... 64:
200 *idx = 3;
201 break;
202 case 65 ... 128:
203 *idx = 4;
204 break;
205 case 129 ... BIO_MAX_PAGES:
206 *idx = 5;
207 break;
208 default:
209 return NULL;
210 }
211
212 /*
213 * idx now points to the pool we want to allocate from. only the
214 * 1-vec entry pool is mempool backed.
215 */
Christoph Hellwiged996a52016-07-19 11:28:42 +0200216 if (*idx == BVEC_POOL_MAX) {
Jens Axboe7ff93452008-12-11 11:53:43 +0100217fallback:
Kent Overstreet9f060e22012-10-12 15:29:33 -0700218 bvl = mempool_alloc(pool, gfp_mask);
Jens Axboe7ff93452008-12-11 11:53:43 +0100219 } else {
220 struct biovec_slab *bvs = bvec_slabs + *idx;
Mel Gormand0164ad2015-11-06 16:28:21 -0800221 gfp_t __gfp_mask = gfp_mask & ~(__GFP_DIRECT_RECLAIM | __GFP_IO);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222
Jens Axboe0a0d96b2008-09-11 13:17:37 +0200223 /*
Jens Axboe7ff93452008-12-11 11:53:43 +0100224 * Make this allocation restricted and don't dump info on
225 * allocation failures, since we'll fallback to the mempool
226 * in case of failure.
Jens Axboe0a0d96b2008-09-11 13:17:37 +0200227 */
Jens Axboe7ff93452008-12-11 11:53:43 +0100228 __gfp_mask |= __GFP_NOMEMALLOC | __GFP_NORETRY | __GFP_NOWARN;
229
230 /*
Mel Gormand0164ad2015-11-06 16:28:21 -0800231 * Try a slab allocation. If this fails and __GFP_DIRECT_RECLAIM
Jens Axboe7ff93452008-12-11 11:53:43 +0100232 * is set, retry with the 1-entry mempool
233 */
234 bvl = kmem_cache_alloc(bvs->slab, __gfp_mask);
Mel Gormand0164ad2015-11-06 16:28:21 -0800235 if (unlikely(!bvl && (gfp_mask & __GFP_DIRECT_RECLAIM))) {
Christoph Hellwiged996a52016-07-19 11:28:42 +0200236 *idx = BVEC_POOL_MAX;
Jens Axboe7ff93452008-12-11 11:53:43 +0100237 goto fallback;
238 }
239 }
240
Christoph Hellwiged996a52016-07-19 11:28:42 +0200241 (*idx)++;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 return bvl;
243}
244
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600245void bio_uninit(struct bio *bio)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246{
Dennis Zhou6f70fb62018-12-05 12:10:37 -0500247 bio_disassociate_blkg(bio);
Kent Overstreet4254bba2012-09-06 15:35:00 -0700248}
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600249EXPORT_SYMBOL(bio_uninit);
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
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600256 bio_uninit(bio);
Kent Overstreet4254bba2012-09-06 15:35:00 -0700257
258 if (bs) {
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400259 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 Overstreet8aa6ba22018-05-08 21:33:50 -0400267 mempool_free(p, &bs->bio_pool);
Kent Overstreet4254bba2012-09-06 15:35:00 -0700268 } else {
269 /* Bio was allocated by bio_kmalloc() */
270 kfree(bio);
271 }
Peter Osterlund36763472005-09-06 15:16:42 -0700272}
273
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600274/*
275 * Users of this function have their own bio allocation. Subsequently,
276 * they must remember to pair any call to bio_init() with bio_uninit()
277 * when IO has completed, or when the bio is released.
278 */
Ming Lei3a83f462016-11-22 08:57:21 -0700279void bio_init(struct bio *bio, struct bio_vec *table,
280 unsigned short max_vecs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281{
Jens Axboe2b94de52007-07-18 13:14:03 +0200282 memset(bio, 0, sizeof(*bio));
Jens Axboec4cf5262015-04-17 16:15:18 -0600283 atomic_set(&bio->__bi_remaining, 1);
Jens Axboedac56212015-04-17 16:23:59 -0600284 atomic_set(&bio->__bi_cnt, 1);
Ming Lei3a83f462016-11-22 08:57:21 -0700285
286 bio->bi_io_vec = table;
287 bio->bi_max_vecs = max_vecs;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200289EXPORT_SYMBOL(bio_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290
291/**
Kent Overstreetf44b48c72012-09-06 15:34:58 -0700292 * bio_reset - reinitialize a bio
293 * @bio: bio to reset
294 *
295 * Description:
296 * After calling bio_reset(), @bio will be in the same state as a freshly
297 * allocated bio returned bio bio_alloc_bioset() - the only fields that are
298 * preserved are the ones that are initialized by bio_alloc_bioset(). See
299 * comment in struct bio.
300 */
301void bio_reset(struct bio *bio)
302{
303 unsigned long flags = bio->bi_flags & (~0UL << BIO_RESET_BITS);
304
Jens Axboe9ae3b3f52017-06-28 15:30:13 -0600305 bio_uninit(bio);
Kent Overstreetf44b48c72012-09-06 15:34:58 -0700306
307 memset(bio, 0, BIO_RESET_BYTES);
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200308 bio->bi_flags = flags;
Jens Axboec4cf5262015-04-17 16:15:18 -0600309 atomic_set(&bio->__bi_remaining, 1);
Kent Overstreetf44b48c72012-09-06 15:34:58 -0700310}
311EXPORT_SYMBOL(bio_reset);
312
Christoph Hellwig38f8baa2016-03-11 17:34:51 +0100313static struct bio *__bio_chain_endio(struct bio *bio)
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800314{
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200315 struct bio *parent = bio->bi_private;
316
Christoph Hellwig4e4cbee2017-06-03 09:38:06 +0200317 if (!parent->bi_status)
318 parent->bi_status = bio->bi_status;
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800319 bio_put(bio);
Christoph Hellwig38f8baa2016-03-11 17:34:51 +0100320 return parent;
321}
322
323static void bio_chain_endio(struct bio *bio)
324{
325 bio_endio(__bio_chain_endio(bio));
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800326}
327
328/**
329 * bio_chain - chain bio completions
Randy Dunlap1051a902014-04-20 16:03:31 -0700330 * @bio: the target bio
331 * @parent: the @bio's parent bio
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800332 *
333 * The caller won't have a bi_end_io called when @bio completes - instead,
334 * @parent's bi_end_io won't be called until both @parent and @bio have
335 * completed; the chained bio will also be freed when it completes.
336 *
337 * The caller must not set bi_private or bi_end_io in @bio.
338 */
339void bio_chain(struct bio *bio, struct bio *parent)
340{
341 BUG_ON(bio->bi_private || bio->bi_end_io);
342
343 bio->bi_private = parent;
344 bio->bi_end_io = bio_chain_endio;
Jens Axboec4cf5262015-04-17 16:15:18 -0600345 bio_inc_remaining(parent);
Kent Overstreet196d38bc2013-11-23 18:34:15 -0800346}
347EXPORT_SYMBOL(bio_chain);
348
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700349static void bio_alloc_rescue(struct work_struct *work)
350{
351 struct bio_set *bs = container_of(work, struct bio_set, rescue_work);
352 struct bio *bio;
353
354 while (1) {
355 spin_lock(&bs->rescue_lock);
356 bio = bio_list_pop(&bs->rescue_list);
357 spin_unlock(&bs->rescue_lock);
358
359 if (!bio)
360 break;
361
362 generic_make_request(bio);
363 }
364}
365
366static void punt_bios_to_rescuer(struct bio_set *bs)
367{
368 struct bio_list punt, nopunt;
369 struct bio *bio;
370
NeilBrown47e0fb42017-06-18 14:38:57 +1000371 if (WARN_ON_ONCE(!bs->rescue_workqueue))
372 return;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700373 /*
374 * In order to guarantee forward progress we must punt only bios that
375 * were allocated from this bio_set; otherwise, if there was a bio on
376 * there for a stacking driver higher up in the stack, processing it
377 * could require allocating bios from this bio_set, and doing that from
378 * our own rescuer would be bad.
379 *
380 * Since bio lists are singly linked, pop them all instead of trying to
381 * remove from the middle of the list:
382 */
383
384 bio_list_init(&punt);
385 bio_list_init(&nopunt);
386
NeilBrownf5fe1b52017-03-10 17:00:47 +1100387 while ((bio = bio_list_pop(&current->bio_list[0])))
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700388 bio_list_add(bio->bi_pool == bs ? &punt : &nopunt, bio);
NeilBrownf5fe1b52017-03-10 17:00:47 +1100389 current->bio_list[0] = nopunt;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700390
NeilBrownf5fe1b52017-03-10 17:00:47 +1100391 bio_list_init(&nopunt);
392 while ((bio = bio_list_pop(&current->bio_list[1])))
393 bio_list_add(bio->bi_pool == bs ? &punt : &nopunt, bio);
394 current->bio_list[1] = nopunt;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700395
396 spin_lock(&bs->rescue_lock);
397 bio_list_merge(&bs->rescue_list, &punt);
398 spin_unlock(&bs->rescue_lock);
399
400 queue_work(bs->rescue_workqueue, &bs->rescue_work);
401}
402
Kent Overstreetf44b48c72012-09-06 15:34:58 -0700403/**
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 * bio_alloc_bioset - allocate a bio for I/O
Randy Dunlap519c8e92017-10-16 11:01:00 -0700405 * @gfp_mask: the GFP_* mask given to the slab allocator
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 * @nr_iovecs: number of iovecs to pre-allocate
Jaak Ristiojadb18efa2010-01-15 12:05:07 +0200407 * @bs: the bio_set to allocate from.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 *
409 * Description:
Kent Overstreet3f86a822012-09-06 15:35:01 -0700410 * If @bs is NULL, uses kmalloc() to allocate the bio; else the allocation is
411 * backed by the @bs's mempool.
412 *
Mel Gormand0164ad2015-11-06 16:28:21 -0800413 * When @bs is not NULL, if %__GFP_DIRECT_RECLAIM is set then bio_alloc will
414 * always be able to allocate a bio. This is due to the mempool guarantees.
415 * To make this work, callers must never allocate more than 1 bio at a time
416 * from this pool. Callers that need to allocate more than 1 bio must always
417 * submit the previously allocated bio for IO before attempting to allocate
418 * a new one. Failure to do so can cause deadlocks under memory pressure.
Kent Overstreet3f86a822012-09-06 15:35:01 -0700419 *
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700420 * Note that when running under generic_make_request() (i.e. any block
421 * driver), bios are not submitted until after you return - see the code in
422 * generic_make_request() that converts recursion into iteration, to prevent
423 * stack overflows.
424 *
425 * This would normally mean allocating multiple bios under
426 * generic_make_request() would be susceptible to deadlocks, but we have
427 * deadlock avoidance code that resubmits any blocked bios from a rescuer
428 * thread.
429 *
430 * However, we do not guarantee forward progress for allocations from other
431 * mempools. Doing multiple allocations from the same mempool under
432 * generic_make_request() should be avoided - instead, use bio_set's front_pad
433 * for per bio allocations.
434 *
Kent Overstreet3f86a822012-09-06 15:35:01 -0700435 * RETURNS:
436 * Pointer to new bio on success, NULL on failure.
437 */
Dan Carpenter7a88fa12017-03-23 13:24:55 +0300438struct bio *bio_alloc_bioset(gfp_t gfp_mask, unsigned int nr_iovecs,
439 struct bio_set *bs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440{
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700441 gfp_t saved_gfp = gfp_mask;
Kent Overstreet3f86a822012-09-06 15:35:01 -0700442 unsigned front_pad;
443 unsigned inline_vecs;
Ingo Molnar34053972009-02-21 11:16:36 +0100444 struct bio_vec *bvl = NULL;
Tejun Heo451a9eb2009-04-15 19:50:51 +0200445 struct bio *bio;
446 void *p;
Jens Axboe0a0d96b2008-09-11 13:17:37 +0200447
Kent Overstreet3f86a822012-09-06 15:35:01 -0700448 if (!bs) {
449 if (nr_iovecs > UIO_MAXIOV)
450 return NULL;
451
452 p = kmalloc(sizeof(struct bio) +
453 nr_iovecs * sizeof(struct bio_vec),
454 gfp_mask);
455 front_pad = 0;
456 inline_vecs = nr_iovecs;
457 } else {
Junichi Nomurad8f429e2014-10-03 17:27:12 -0400458 /* should not use nobvec bioset for nr_iovecs > 0 */
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400459 if (WARN_ON_ONCE(!mempool_initialized(&bs->bvec_pool) &&
460 nr_iovecs > 0))
Junichi Nomurad8f429e2014-10-03 17:27:12 -0400461 return NULL;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700462 /*
463 * generic_make_request() converts recursion to iteration; this
464 * means if we're running beneath it, any bios we allocate and
465 * submit will not be submitted (and thus freed) until after we
466 * return.
467 *
468 * This exposes us to a potential deadlock if we allocate
469 * multiple bios from the same bio_set() while running
470 * underneath generic_make_request(). If we were to allocate
471 * multiple bios (say a stacking block driver that was splitting
472 * bios), we would deadlock if we exhausted the mempool's
473 * reserve.
474 *
475 * We solve this, and guarantee forward progress, with a rescuer
476 * workqueue per bio_set. If we go to allocate and there are
477 * bios on current->bio_list, we first try the allocation
Mel Gormand0164ad2015-11-06 16:28:21 -0800478 * without __GFP_DIRECT_RECLAIM; if that fails, we punt those
479 * bios we would be blocking to the rescuer workqueue before
480 * we retry with the original gfp_flags.
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700481 */
482
NeilBrownf5fe1b52017-03-10 17:00:47 +1100483 if (current->bio_list &&
484 (!bio_list_empty(&current->bio_list[0]) ||
NeilBrown47e0fb42017-06-18 14:38:57 +1000485 !bio_list_empty(&current->bio_list[1])) &&
486 bs->rescue_workqueue)
Mel Gormand0164ad2015-11-06 16:28:21 -0800487 gfp_mask &= ~__GFP_DIRECT_RECLAIM;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700488
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400489 p = mempool_alloc(&bs->bio_pool, gfp_mask);
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700490 if (!p && gfp_mask != saved_gfp) {
491 punt_bios_to_rescuer(bs);
492 gfp_mask = saved_gfp;
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400493 p = mempool_alloc(&bs->bio_pool, gfp_mask);
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700494 }
495
Kent Overstreet3f86a822012-09-06 15:35:01 -0700496 front_pad = bs->front_pad;
497 inline_vecs = BIO_INLINE_VECS;
498 }
499
Tejun Heo451a9eb2009-04-15 19:50:51 +0200500 if (unlikely(!p))
501 return NULL;
Ingo Molnar34053972009-02-21 11:16:36 +0100502
Kent Overstreet3f86a822012-09-06 15:35:01 -0700503 bio = p + front_pad;
Ming Lei3a83f462016-11-22 08:57:21 -0700504 bio_init(bio, NULL, 0);
Ingo Molnar34053972009-02-21 11:16:36 +0100505
Kent Overstreet3f86a822012-09-06 15:35:01 -0700506 if (nr_iovecs > inline_vecs) {
Christoph Hellwiged996a52016-07-19 11:28:42 +0200507 unsigned long idx = 0;
508
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400509 bvl = bvec_alloc(gfp_mask, nr_iovecs, &idx, &bs->bvec_pool);
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700510 if (!bvl && gfp_mask != saved_gfp) {
511 punt_bios_to_rescuer(bs);
512 gfp_mask = saved_gfp;
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400513 bvl = bvec_alloc(gfp_mask, nr_iovecs, &idx, &bs->bvec_pool);
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -0700514 }
515
Ingo Molnar34053972009-02-21 11:16:36 +0100516 if (unlikely(!bvl))
517 goto err_free;
Kent Overstreeta38352e2012-05-25 13:03:11 -0700518
Christoph Hellwiged996a52016-07-19 11:28:42 +0200519 bio->bi_flags |= idx << BVEC_POOL_OFFSET;
Kent Overstreet3f86a822012-09-06 15:35:01 -0700520 } else if (nr_iovecs) {
521 bvl = bio->bi_inline_vecs;
Ingo Molnar34053972009-02-21 11:16:36 +0100522 }
Kent Overstreet3f86a822012-09-06 15:35:01 -0700523
524 bio->bi_pool = bs;
Ingo Molnar34053972009-02-21 11:16:36 +0100525 bio->bi_max_vecs = nr_iovecs;
Ingo Molnar34053972009-02-21 11:16:36 +0100526 bio->bi_io_vec = bvl;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527 return bio;
Ingo Molnar34053972009-02-21 11:16:36 +0100528
529err_free:
Kent Overstreet8aa6ba22018-05-08 21:33:50 -0400530 mempool_free(p, &bs->bio_pool);
Ingo Molnar34053972009-02-21 11:16:36 +0100531 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200533EXPORT_SYMBOL(bio_alloc_bioset);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534
Kent Overstreet38a72da2018-05-08 21:33:53 -0400535void zero_fill_bio_iter(struct bio *bio, struct bvec_iter start)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536{
537 unsigned long flags;
Kent Overstreet79886132013-11-23 17:19:00 -0800538 struct bio_vec bv;
539 struct bvec_iter iter;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540
Kent Overstreet38a72da2018-05-08 21:33:53 -0400541 __bio_for_each_segment(bv, bio, iter, start) {
Kent Overstreet79886132013-11-23 17:19:00 -0800542 char *data = bvec_kmap_irq(&bv, &flags);
543 memset(data, 0, bv.bv_len);
544 flush_dcache_page(bv.bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545 bvec_kunmap_irq(data, &flags);
546 }
547}
Kent Overstreet38a72da2018-05-08 21:33:53 -0400548EXPORT_SYMBOL(zero_fill_bio_iter);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549
550/**
551 * bio_put - release a reference to a bio
552 * @bio: bio to release reference to
553 *
554 * Description:
555 * Put a reference to a &struct bio, either one you have gotten with
NeilBrown9b10f6a2017-06-18 14:38:59 +1000556 * bio_alloc, bio_get or bio_clone_*. The last put of a bio will free it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 **/
558void bio_put(struct bio *bio)
559{
Jens Axboedac56212015-04-17 16:23:59 -0600560 if (!bio_flagged(bio, BIO_REFFED))
Kent Overstreet4254bba2012-09-06 15:35:00 -0700561 bio_free(bio);
Jens Axboedac56212015-04-17 16:23:59 -0600562 else {
563 BIO_BUG_ON(!atomic_read(&bio->__bi_cnt));
564
565 /*
566 * last put frees it
567 */
568 if (atomic_dec_and_test(&bio->__bi_cnt))
569 bio_free(bio);
570 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200572EXPORT_SYMBOL(bio_put);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573
Christoph Hellwig6c210aa2018-12-13 21:32:09 +0100574int bio_phys_segments(struct request_queue *q, struct bio *bio)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575{
576 if (unlikely(!bio_flagged(bio, BIO_SEG_VALID)))
577 blk_recount_segments(q, bio);
578
579 return bio->bi_phys_segments;
580}
581
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582/**
Kent Overstreet59d276f2013-11-23 18:19:27 -0800583 * __bio_clone_fast - clone a bio that shares the original bio's biovec
584 * @bio: destination bio
585 * @bio_src: bio to clone
586 *
587 * Clone a &bio. Caller will own the returned bio, but not
588 * the actual data it points to. Reference count of returned
589 * bio will be one.
590 *
591 * Caller must ensure that @bio_src is not freed before @bio.
592 */
593void __bio_clone_fast(struct bio *bio, struct bio *bio_src)
594{
Christoph Hellwiged996a52016-07-19 11:28:42 +0200595 BUG_ON(bio->bi_pool && BVEC_POOL_IDX(bio));
Kent Overstreet59d276f2013-11-23 18:19:27 -0800596
597 /*
Christoph Hellwig74d46992017-08-23 19:10:32 +0200598 * most users will be overriding ->bi_disk with a new target,
Kent Overstreet59d276f2013-11-23 18:19:27 -0800599 * so we don't set nor calculate new physical/hw segment counts here
600 */
Christoph Hellwig74d46992017-08-23 19:10:32 +0200601 bio->bi_disk = bio_src->bi_disk;
Michael Lyle62530ed2017-11-16 23:47:25 -0800602 bio->bi_partno = bio_src->bi_partno;
Jens Axboeb7c44ed2015-07-24 12:37:59 -0600603 bio_set_flag(bio, BIO_CLONED);
Shaohua Li111be882017-12-20 11:10:17 -0700604 if (bio_flagged(bio_src, BIO_THROTTLED))
605 bio_set_flag(bio, BIO_THROTTLED);
Jens Axboe1eff9d32016-08-05 15:35:16 -0600606 bio->bi_opf = bio_src->bi_opf;
Hannes Reineckeca474b72018-11-12 10:35:25 -0700607 bio->bi_ioprio = bio_src->bi_ioprio;
Jens Axboecb6934f2017-06-27 09:22:02 -0600608 bio->bi_write_hint = bio_src->bi_write_hint;
Kent Overstreet59d276f2013-11-23 18:19:27 -0800609 bio->bi_iter = bio_src->bi_iter;
610 bio->bi_io_vec = bio_src->bi_io_vec;
Paolo Valente20bd7232016-07-27 07:22:05 +0200611
Dennis Zhoudb6638d2018-12-05 12:10:35 -0500612 bio_clone_blkg_association(bio, bio_src);
Dennis Zhoue439bed2018-12-05 12:10:32 -0500613 blkcg_bio_issue_init(bio);
Kent Overstreet59d276f2013-11-23 18:19:27 -0800614}
615EXPORT_SYMBOL(__bio_clone_fast);
616
617/**
618 * bio_clone_fast - clone a bio that shares the original bio's biovec
619 * @bio: bio to clone
620 * @gfp_mask: allocation priority
621 * @bs: bio_set to allocate from
622 *
623 * Like __bio_clone_fast, only also allocates the returned bio
624 */
625struct bio *bio_clone_fast(struct bio *bio, gfp_t gfp_mask, struct bio_set *bs)
626{
627 struct bio *b;
628
629 b = bio_alloc_bioset(gfp_mask, 0, bs);
630 if (!b)
631 return NULL;
632
633 __bio_clone_fast(b, bio);
634
635 if (bio_integrity(bio)) {
636 int ret;
637
638 ret = bio_integrity_clone(b, bio, gfp_mask);
639
640 if (ret < 0) {
641 bio_put(b);
642 return NULL;
643 }
644 }
645
646 return b;
647}
648EXPORT_SYMBOL(bio_clone_fast);
649
Ming Lei59194822019-03-17 18:01:07 +0800650static inline bool page_is_mergeable(const struct bio_vec *bv,
651 struct page *page, unsigned int len, unsigned int off,
652 bool same_page)
653{
654 phys_addr_t vec_end_addr = page_to_phys(bv->bv_page) +
655 bv->bv_offset + bv->bv_len - 1;
656 phys_addr_t page_addr = page_to_phys(page);
657
658 if (vec_end_addr + 1 != page_addr + off)
659 return false;
660 if (xen_domain() && !xen_biovec_phys_mergeable(bv, page))
661 return false;
Christoph Hellwig52d52d12019-04-11 08:23:31 +0200662
663 if ((vec_end_addr & PAGE_MASK) != page_addr) {
664 if (same_page)
665 return false;
666 if (pfn_to_page(PFN_DOWN(vec_end_addr)) + 1 != page)
667 return false;
668 }
Ming Lei59194822019-03-17 18:01:07 +0800669
Ming Lei551879a2019-04-23 10:51:04 +0800670 WARN_ON_ONCE(same_page && (len + off) > PAGE_SIZE);
671
Ming Lei59194822019-03-17 18:01:07 +0800672 return true;
673}
674
Ming Lei489fbbc2019-03-29 15:08:00 +0800675/*
676 * Check if the @page can be added to the current segment(@bv), and make
677 * sure to call it only if page_is_mergeable(@bv, @page) is true
678 */
679static bool can_add_page_to_seg(struct request_queue *q,
680 struct bio_vec *bv, struct page *page, unsigned len,
681 unsigned offset)
682{
683 unsigned long mask = queue_segment_boundary(q);
684 phys_addr_t addr1 = page_to_phys(bv->bv_page) + bv->bv_offset;
685 phys_addr_t addr2 = page_to_phys(page) + offset + len - 1;
686
687 if ((addr1 | mask) != (addr2 | mask))
688 return false;
689
690 if (bv->bv_len + len > queue_max_segment_size(q))
691 return false;
692
693 return true;
694}
695
Shaohua Lif4595872017-03-24 10:34:43 -0700696/**
Ming Lei19047082019-03-17 18:01:08 +0800697 * __bio_add_pc_page - attempt to add page to passthrough bio
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800698 * @q: the target queue
699 * @bio: destination bio
700 * @page: page to add
701 * @len: vec entry length
702 * @offset: vec entry offset
Ming Lei19047082019-03-17 18:01:08 +0800703 * @put_same_page: put the page if it is same with last added page
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704 *
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800705 * Attempt to add a page to the bio_vec maplist. This can fail for a
706 * number of reasons, such as the bio being full or target block device
707 * limitations. The target block device must allow bio's up to PAGE_SIZE,
708 * so it is always possible to add a single page to an empty bio.
709 *
Ming Lei5a8ce242019-03-17 18:01:06 +0800710 * This should only be used by passthrough bios.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 */
Ming Lei19047082019-03-17 18:01:08 +0800712int __bio_add_pc_page(struct request_queue *q, struct bio *bio,
713 struct page *page, unsigned int len, unsigned int offset,
714 bool put_same_page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700716 struct bio_vec *bvec;
717
718 /*
719 * cloned bio must not modify vec list
720 */
721 if (unlikely(bio_flagged(bio, BIO_CLONED)))
722 return 0;
723
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800724 if (((bio->bi_iter.bi_size + len) >> 9) > queue_max_hw_sectors(q))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725 return 0;
726
Jens Axboe80cfd542006-01-06 09:43:28 +0100727 /*
728 * For filesystems with a blocksize smaller than the pagesize
729 * we will often be called with the same page as last time and
730 * a consecutive offset. Optimize this special case.
731 */
732 if (bio->bi_vcnt > 0) {
Ming Lei5a8ce242019-03-17 18:01:06 +0800733 bvec = &bio->bi_io_vec[bio->bi_vcnt - 1];
Jens Axboe80cfd542006-01-06 09:43:28 +0100734
Ming Lei5a8ce242019-03-17 18:01:06 +0800735 if (page == bvec->bv_page &&
736 offset == bvec->bv_offset + bvec->bv_len) {
Ming Lei19047082019-03-17 18:01:08 +0800737 if (put_same_page)
738 put_page(page);
Ming Lei489fbbc2019-03-29 15:08:00 +0800739 bvec_merge:
Ming Lei5a8ce242019-03-17 18:01:06 +0800740 bvec->bv_len += len;
Maurizio Lombardifcbf6a02014-12-10 14:16:53 -0800741 bio->bi_iter.bi_size += len;
Jens Axboe80cfd542006-01-06 09:43:28 +0100742 goto done;
743 }
Jens Axboe66cb45a2014-06-24 16:22:24 -0600744
745 /*
746 * If the queue doesn't support SG gaps and adding this
747 * offset would create a gap, disallow it.
748 */
Ming Lei5a8ce242019-03-17 18:01:06 +0800749 if (bvec_gap_to_prev(q, bvec, offset))
Jens Axboe66cb45a2014-06-24 16:22:24 -0600750 return 0;
Ming Lei489fbbc2019-03-29 15:08:00 +0800751
752 if (page_is_mergeable(bvec, page, len, offset, false) &&
753 can_add_page_to_seg(q, bvec, page, len, offset))
754 goto bvec_merge;
Jens Axboe80cfd542006-01-06 09:43:28 +0100755 }
756
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700757 if (bio_full(bio))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 return 0;
759
Ming Lei489fbbc2019-03-29 15:08:00 +0800760 if (bio->bi_phys_segments >= queue_max_segments(q))
761 return 0;
762
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 /*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 * setup the new entry, we might clear it again later if we
765 * cannot add the page
766 */
767 bvec = &bio->bi_io_vec[bio->bi_vcnt];
768 bvec->bv_page = page;
769 bvec->bv_len = len;
770 bvec->bv_offset = offset;
Maurizio Lombardifcbf6a02014-12-10 14:16:53 -0800771 bio->bi_vcnt++;
Maurizio Lombardifcbf6a02014-12-10 14:16:53 -0800772 bio->bi_iter.bi_size += len;
773
Jens Axboe80cfd542006-01-06 09:43:28 +0100774 done:
Ming Lei489fbbc2019-03-29 15:08:00 +0800775 bio->bi_phys_segments = bio->bi_vcnt;
776 bio_set_flag(bio, BIO_SEG_VALID);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 return len;
778}
Ming Lei19047082019-03-17 18:01:08 +0800779EXPORT_SYMBOL(__bio_add_pc_page);
780
781int bio_add_pc_page(struct request_queue *q, struct bio *bio,
782 struct page *page, unsigned int len, unsigned int offset)
783{
784 return __bio_add_pc_page(q, bio, page, len, offset, false);
785}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200786EXPORT_SYMBOL(bio_add_pc_page);
Mike Christie6e68af62005-11-11 05:30:27 -0600787
788/**
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700789 * __bio_try_merge_page - try appending data to an existing bvec.
790 * @bio: destination bio
Ming Lei551879a2019-04-23 10:51:04 +0800791 * @page: start page to add
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700792 * @len: length of the data to add
Ming Lei551879a2019-04-23 10:51:04 +0800793 * @off: offset of the data relative to @page
Ming Lei07173c32019-02-15 19:13:20 +0800794 * @same_page: if %true only merge if the new data is in the same physical
795 * page as the last segment of the bio.
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700796 *
797 * Try to add the data at @page + @off to the last bvec of @bio. This is a
798 * a useful optimisation for file systems with a block size smaller than the
799 * page size.
800 *
Ming Lei551879a2019-04-23 10:51:04 +0800801 * Warn if (@len, @off) crosses pages in case that @same_page is true.
802 *
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700803 * Return %true on success or %false on failure.
804 */
805bool __bio_try_merge_page(struct bio *bio, struct page *page,
Ming Lei07173c32019-02-15 19:13:20 +0800806 unsigned int len, unsigned int off, bool same_page)
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700807{
808 if (WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED)))
809 return false;
810
811 if (bio->bi_vcnt > 0) {
812 struct bio_vec *bv = &bio->bi_io_vec[bio->bi_vcnt - 1];
813
Ming Lei59194822019-03-17 18:01:07 +0800814 if (page_is_mergeable(bv, page, len, off, same_page)) {
815 bv->bv_len += len;
816 bio->bi_iter.bi_size += len;
817 return true;
818 }
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700819 }
820 return false;
821}
822EXPORT_SYMBOL_GPL(__bio_try_merge_page);
823
824/**
Ming Lei551879a2019-04-23 10:51:04 +0800825 * __bio_add_page - add page(s) to a bio in a new segment
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700826 * @bio: destination bio
Ming Lei551879a2019-04-23 10:51:04 +0800827 * @page: start page to add
828 * @len: length of the data to add, may cross pages
829 * @off: offset of the data relative to @page, may cross pages
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700830 *
831 * Add the data at @page + @off to @bio as a new bvec. The caller must ensure
832 * that @bio has space for another bvec.
833 */
834void __bio_add_page(struct bio *bio, struct page *page,
835 unsigned int len, unsigned int off)
836{
837 struct bio_vec *bv = &bio->bi_io_vec[bio->bi_vcnt];
838
839 WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED));
840 WARN_ON_ONCE(bio_full(bio));
841
842 bv->bv_page = page;
843 bv->bv_offset = off;
844 bv->bv_len = len;
845
846 bio->bi_iter.bi_size += len;
847 bio->bi_vcnt++;
848}
849EXPORT_SYMBOL_GPL(__bio_add_page);
850
851/**
Ming Lei551879a2019-04-23 10:51:04 +0800852 * bio_add_page - attempt to add page(s) to bio
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853 * @bio: destination bio
Ming Lei551879a2019-04-23 10:51:04 +0800854 * @page: start page to add
855 * @len: vec entry length, may cross pages
856 * @offset: vec entry offset relative to @page, may cross pages
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 *
Ming Lei551879a2019-04-23 10:51:04 +0800858 * Attempt to add page(s) to the bio_vec maplist. This will only fail
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800859 * if either bio->bi_vcnt == bio->bi_max_vecs or it's a cloned bio.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700860 */
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800861int bio_add_page(struct bio *bio, struct page *page,
862 unsigned int len, unsigned int offset)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863{
Ming Lei07173c32019-02-15 19:13:20 +0800864 if (!__bio_try_merge_page(bio, page, len, offset, false)) {
Christoph Hellwig0aa69fd2018-06-01 09:03:05 -0700865 if (bio_full(bio))
866 return 0;
867 __bio_add_page(bio, page, len, offset);
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800868 }
Kent Overstreetc66a14d2013-11-23 22:30:22 -0800869 return len;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870}
H Hartley Sweetena112a712009-09-26 16:19:21 +0200871EXPORT_SYMBOL(bio_add_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872
Christoph Hellwig7321ecb2019-04-11 08:23:30 +0200873static void bio_get_pages(struct bio *bio)
874{
875 struct bvec_iter_all iter_all;
876 struct bio_vec *bvec;
877 int i;
878
879 bio_for_each_segment_all(bvec, bio, i, iter_all)
880 get_page(bvec->bv_page);
881}
882
883static void bio_release_pages(struct bio *bio)
884{
885 struct bvec_iter_all iter_all;
886 struct bio_vec *bvec;
887 int i;
888
889 bio_for_each_segment_all(bvec, bio, i, iter_all)
890 put_page(bvec->bv_page);
891}
892
Jens Axboe6d0c48a2018-11-30 08:47:03 -0700893static int __bio_iov_bvec_add_pages(struct bio *bio, struct iov_iter *iter)
894{
895 const struct bio_vec *bv = iter->bvec;
896 unsigned int len;
897 size_t size;
898
899 if (WARN_ON_ONCE(iter->iov_offset > bv->bv_len))
900 return -EINVAL;
901
902 len = min_t(size_t, bv->bv_len - iter->iov_offset, iter->count);
903 size = bio_add_page(bio, bv->bv_page, len,
904 bv->bv_offset + iter->iov_offset);
Christoph Hellwiga10584c2019-04-11 08:23:28 +0200905 if (unlikely(size != len))
906 return -EINVAL;
Christoph Hellwiga10584c2019-04-11 08:23:28 +0200907 iov_iter_advance(iter, size);
908 return 0;
Jens Axboe6d0c48a2018-11-30 08:47:03 -0700909}
910
Christoph Hellwig576ed912018-09-20 08:28:21 +0200911#define PAGE_PTRS_PER_BVEC (sizeof(struct bio_vec) / sizeof(struct page *))
912
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600913/**
Martin Wilck17d51b12018-07-25 23:15:09 +0200914 * __bio_iov_iter_get_pages - pin user or kernel pages and add them to a bio
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600915 * @bio: bio to add pages to
916 * @iter: iov iterator describing the region to be mapped
917 *
Martin Wilck17d51b12018-07-25 23:15:09 +0200918 * Pins pages from *iter and appends them to @bio's bvec array. The
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600919 * pages will have to be released using put_page() when done.
Martin Wilck17d51b12018-07-25 23:15:09 +0200920 * For multi-segment *iter, this function only adds pages from the
921 * the next non-empty segment of the iov iterator.
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600922 */
Martin Wilck17d51b12018-07-25 23:15:09 +0200923static int __bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter)
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600924{
Christoph Hellwig576ed912018-09-20 08:28:21 +0200925 unsigned short nr_pages = bio->bi_max_vecs - bio->bi_vcnt;
926 unsigned short entries_left = bio->bi_max_vecs - bio->bi_vcnt;
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600927 struct bio_vec *bv = bio->bi_io_vec + bio->bi_vcnt;
928 struct page **pages = (struct page **)bv;
Christoph Hellwig576ed912018-09-20 08:28:21 +0200929 ssize_t size, left;
930 unsigned len, i;
Martin Wilckb403ea22018-07-25 23:15:07 +0200931 size_t offset;
Christoph Hellwig576ed912018-09-20 08:28:21 +0200932
933 /*
934 * Move page array up in the allocated memory for the bio vecs as far as
935 * possible so that we can start filling biovecs from the beginning
936 * without overwriting the temporary page array.
937 */
938 BUILD_BUG_ON(PAGE_PTRS_PER_BVEC < 2);
939 pages += entries_left * (PAGE_PTRS_PER_BVEC - 1);
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600940
941 size = iov_iter_get_pages(iter, pages, LONG_MAX, nr_pages, &offset);
942 if (unlikely(size <= 0))
943 return size ? size : -EFAULT;
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600944
Christoph Hellwig576ed912018-09-20 08:28:21 +0200945 for (left = size, i = 0; left > 0; left -= len, i++) {
946 struct page *page = pages[i];
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600947
Christoph Hellwig576ed912018-09-20 08:28:21 +0200948 len = min_t(size_t, PAGE_SIZE - offset, left);
949 if (WARN_ON_ONCE(bio_add_page(bio, page, len, offset) != len))
950 return -EINVAL;
951 offset = 0;
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600952 }
953
Kent Overstreet2cefe4d2016-10-31 11:59:24 -0600954 iov_iter_advance(iter, size);
955 return 0;
956}
Martin Wilck17d51b12018-07-25 23:15:09 +0200957
958/**
Jens Axboe6d0c48a2018-11-30 08:47:03 -0700959 * bio_iov_iter_get_pages - add user or kernel pages to a bio
Martin Wilck17d51b12018-07-25 23:15:09 +0200960 * @bio: bio to add pages to
Jens Axboe6d0c48a2018-11-30 08:47:03 -0700961 * @iter: iov iterator describing the region to be added
Martin Wilck17d51b12018-07-25 23:15:09 +0200962 *
Jens Axboe6d0c48a2018-11-30 08:47:03 -0700963 * This takes either an iterator pointing to user memory, or one pointing to
964 * kernel pages (BVEC iterator). If we're adding user pages, we pin them and
965 * map them into the kernel. On IO completion, the caller should put those
Jens Axboe399254a2019-02-27 13:13:23 -0700966 * pages. If we're adding kernel pages, and the caller told us it's safe to
967 * do so, we just have to add the pages to the bio directly. We don't grab an
968 * extra reference to those pages (the user should already have that), and we
969 * don't put the page on IO completion. The caller needs to check if the bio is
970 * flagged BIO_NO_PAGE_REF on IO completion. If it isn't, then pages should be
971 * released.
Jens Axboe6d0c48a2018-11-30 08:47:03 -0700972 *
Martin Wilck17d51b12018-07-25 23:15:09 +0200973 * The function tries, but does not guarantee, to pin as many pages as
Jens Axboe6d0c48a2018-11-30 08:47:03 -0700974 * fit into the bio, or are requested in *iter, whatever is smaller. If
975 * MM encounters an error pinning the requested pages, it stops. Error
976 * is returned only if 0 pages could be pinned.
Martin Wilck17d51b12018-07-25 23:15:09 +0200977 */
978int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter)
979{
Jens Axboe6d0c48a2018-11-30 08:47:03 -0700980 const bool is_bvec = iov_iter_is_bvec(iter);
Christoph Hellwig14eacf12019-04-11 08:23:29 +0200981 int ret;
982
983 if (WARN_ON_ONCE(bio->bi_vcnt))
984 return -EINVAL;
Martin Wilck17d51b12018-07-25 23:15:09 +0200985
986 do {
Jens Axboe6d0c48a2018-11-30 08:47:03 -0700987 if (is_bvec)
988 ret = __bio_iov_bvec_add_pages(bio, iter);
989 else
990 ret = __bio_iov_iter_get_pages(bio, iter);
Christoph Hellwig14eacf12019-04-11 08:23:29 +0200991 } while (!ret && iov_iter_count(iter) && !bio_full(bio));
Martin Wilck17d51b12018-07-25 23:15:09 +0200992
Christoph Hellwig7321ecb2019-04-11 08:23:30 +0200993 if (iov_iter_bvec_no_ref(iter))
994 bio_set_flag(bio, BIO_NO_PAGE_REF);
Ming Lei0257c0e2019-04-24 19:01:46 +0800995 else if (is_bvec)
Christoph Hellwig7321ecb2019-04-11 08:23:30 +0200996 bio_get_pages(bio);
997
Christoph Hellwig14eacf12019-04-11 08:23:29 +0200998 return bio->bi_vcnt ? 0 : ret;
Martin Wilck17d51b12018-07-25 23:15:09 +0200999}
Kent Overstreet2cefe4d2016-10-31 11:59:24 -06001000
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001001static void submit_bio_wait_endio(struct bio *bio)
Kent Overstreet9e882242012-09-10 14:41:12 -07001002{
Christoph Hellwig65e53aa2017-10-25 17:55:57 +09001003 complete(bio->bi_private);
Kent Overstreet9e882242012-09-10 14:41:12 -07001004}
1005
1006/**
1007 * submit_bio_wait - submit a bio, and wait until it completes
Kent Overstreet9e882242012-09-10 14:41:12 -07001008 * @bio: The &struct bio which describes the I/O
1009 *
1010 * Simple wrapper around submit_bio(). Returns 0 on success, or the error from
1011 * bio_endio() on failure.
Jan Kara3d289d62017-08-02 10:25:21 +02001012 *
1013 * WARNING: Unlike to how submit_bio() is usually used, this function does not
1014 * result in bio reference to be consumed. The caller must drop the reference
1015 * on his own.
Kent Overstreet9e882242012-09-10 14:41:12 -07001016 */
Mike Christie4e49ea42016-06-05 14:31:41 -05001017int submit_bio_wait(struct bio *bio)
Kent Overstreet9e882242012-09-10 14:41:12 -07001018{
Byungchul Parke319e1f2017-10-25 17:56:05 +09001019 DECLARE_COMPLETION_ONSTACK_MAP(done, bio->bi_disk->lockdep_map);
Kent Overstreet9e882242012-09-10 14:41:12 -07001020
Christoph Hellwig65e53aa2017-10-25 17:55:57 +09001021 bio->bi_private = &done;
Kent Overstreet9e882242012-09-10 14:41:12 -07001022 bio->bi_end_io = submit_bio_wait_endio;
Jens Axboe1eff9d32016-08-05 15:35:16 -06001023 bio->bi_opf |= REQ_SYNC;
Mike Christie4e49ea42016-06-05 14:31:41 -05001024 submit_bio(bio);
Christoph Hellwig65e53aa2017-10-25 17:55:57 +09001025 wait_for_completion_io(&done);
Kent Overstreet9e882242012-09-10 14:41:12 -07001026
Christoph Hellwig65e53aa2017-10-25 17:55:57 +09001027 return blk_status_to_errno(bio->bi_status);
Kent Overstreet9e882242012-09-10 14:41:12 -07001028}
1029EXPORT_SYMBOL(submit_bio_wait);
1030
Kent Overstreet054bdf62012-09-28 13:17:55 -07001031/**
1032 * bio_advance - increment/complete a bio by some number of bytes
1033 * @bio: bio to advance
1034 * @bytes: number of bytes to complete
1035 *
1036 * This updates bi_sector, bi_size and bi_idx; if the number of bytes to
1037 * complete doesn't align with a bvec boundary, then bv_len and bv_offset will
1038 * be updated on the last bvec as well.
1039 *
1040 * @bio will then represent the remaining, uncompleted portion of the io.
1041 */
1042void bio_advance(struct bio *bio, unsigned bytes)
1043{
1044 if (bio_integrity(bio))
1045 bio_integrity_advance(bio, bytes);
1046
Kent Overstreet4550dd62013-08-07 14:26:21 -07001047 bio_advance_iter(bio, &bio->bi_iter, bytes);
Kent Overstreet054bdf62012-09-28 13:17:55 -07001048}
1049EXPORT_SYMBOL(bio_advance);
1050
Kent Overstreet45db54d2018-05-08 21:33:54 -04001051void bio_copy_data_iter(struct bio *dst, struct bvec_iter *dst_iter,
1052 struct bio *src, struct bvec_iter *src_iter)
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001053{
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001054 struct bio_vec src_bv, dst_bv;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001055 void *src_p, *dst_p;
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001056 unsigned bytes;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001057
Kent Overstreet45db54d2018-05-08 21:33:54 -04001058 while (src_iter->bi_size && dst_iter->bi_size) {
1059 src_bv = bio_iter_iovec(src, *src_iter);
1060 dst_bv = bio_iter_iovec(dst, *dst_iter);
1061
1062 bytes = min(src_bv.bv_len, dst_bv.bv_len);
1063
1064 src_p = kmap_atomic(src_bv.bv_page);
1065 dst_p = kmap_atomic(dst_bv.bv_page);
1066
1067 memcpy(dst_p + dst_bv.bv_offset,
1068 src_p + src_bv.bv_offset,
1069 bytes);
1070
1071 kunmap_atomic(dst_p);
1072 kunmap_atomic(src_p);
1073
Kent Overstreet6e6e8112018-05-08 21:33:55 -04001074 flush_dcache_page(dst_bv.bv_page);
1075
Kent Overstreet45db54d2018-05-08 21:33:54 -04001076 bio_advance_iter(src, src_iter, bytes);
1077 bio_advance_iter(dst, dst_iter, bytes);
1078 }
1079}
1080EXPORT_SYMBOL(bio_copy_data_iter);
1081
1082/**
1083 * bio_copy_data - copy contents of data buffers from one bio to another
1084 * @src: source bio
1085 * @dst: destination bio
1086 *
1087 * Stops when it reaches the end of either @src or @dst - that is, copies
1088 * min(src->bi_size, dst->bi_size) bytes (or the equivalent for lists of bios).
1089 */
1090void bio_copy_data(struct bio *dst, struct bio *src)
1091{
1092 struct bvec_iter src_iter = src->bi_iter;
1093 struct bvec_iter dst_iter = dst->bi_iter;
1094
1095 bio_copy_data_iter(dst, &dst_iter, src, &src_iter);
1096}
1097EXPORT_SYMBOL(bio_copy_data);
1098
1099/**
1100 * bio_list_copy_data - copy contents of data buffers from one chain of bios to
1101 * another
1102 * @src: source bio list
1103 * @dst: destination bio list
1104 *
1105 * Stops when it reaches the end of either the @src list or @dst list - that is,
1106 * copies min(src->bi_size, dst->bi_size) bytes (or the equivalent for lists of
1107 * bios).
1108 */
1109void bio_list_copy_data(struct bio *dst, struct bio *src)
1110{
1111 struct bvec_iter src_iter = src->bi_iter;
1112 struct bvec_iter dst_iter = dst->bi_iter;
1113
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001114 while (1) {
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001115 if (!src_iter.bi_size) {
1116 src = src->bi_next;
1117 if (!src)
1118 break;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001119
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001120 src_iter = src->bi_iter;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001121 }
1122
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001123 if (!dst_iter.bi_size) {
1124 dst = dst->bi_next;
1125 if (!dst)
1126 break;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001127
Kent Overstreet1cb9dda2013-08-07 14:26:39 -07001128 dst_iter = dst->bi_iter;
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001129 }
1130
Kent Overstreet45db54d2018-05-08 21:33:54 -04001131 bio_copy_data_iter(dst, &dst_iter, src, &src_iter);
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001132 }
1133}
Kent Overstreet45db54d2018-05-08 21:33:54 -04001134EXPORT_SYMBOL(bio_list_copy_data);
Kent Overstreet16ac3d62012-09-10 13:57:51 -07001135
Linus Torvalds1da177e2005-04-16 15:20:36 -07001136struct bio_map_data {
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001137 int is_our_pages;
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001138 struct iov_iter iter;
1139 struct iovec iov[];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001140};
1141
Al Viro0e5b9352017-09-24 13:14:35 -04001142static struct bio_map_data *bio_alloc_map_data(struct iov_iter *data,
FUJITA Tomonori76029ff2008-08-25 20:36:08 +02001143 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001144{
Al Viro0e5b9352017-09-24 13:14:35 -04001145 struct bio_map_data *bmd;
1146 if (data->nr_segs > UIO_MAXIOV)
Jens Axboef3f63c12010-10-29 11:46:56 -06001147 return NULL;
1148
Al Viro0e5b9352017-09-24 13:14:35 -04001149 bmd = kmalloc(sizeof(struct bio_map_data) +
1150 sizeof(struct iovec) * data->nr_segs, gfp_mask);
1151 if (!bmd)
1152 return NULL;
1153 memcpy(bmd->iov, data->iov, sizeof(struct iovec) * data->nr_segs);
1154 bmd->iter = *data;
1155 bmd->iter.iov = bmd->iov;
1156 return bmd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001157}
1158
Dongsu Park9124d3f2015-01-18 16:16:34 +01001159/**
1160 * bio_copy_from_iter - copy all pages from iov_iter to bio
1161 * @bio: The &struct bio which describes the I/O as destination
1162 * @iter: iov_iter as source
1163 *
1164 * Copy all pages from iov_iter to bio.
1165 * Returns 0 on success, or error on failure.
1166 */
Al Viro98a09d62017-09-24 12:14:36 -04001167static int bio_copy_from_iter(struct bio *bio, struct iov_iter *iter)
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001168{
Dongsu Park9124d3f2015-01-18 16:16:34 +01001169 int i;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001170 struct bio_vec *bvec;
Ming Lei6dc4f102019-02-15 19:13:19 +08001171 struct bvec_iter_all iter_all;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001172
Ming Lei6dc4f102019-02-15 19:13:19 +08001173 bio_for_each_segment_all(bvec, bio, i, iter_all) {
Dongsu Park9124d3f2015-01-18 16:16:34 +01001174 ssize_t ret;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001175
Dongsu Park9124d3f2015-01-18 16:16:34 +01001176 ret = copy_page_from_iter(bvec->bv_page,
1177 bvec->bv_offset,
1178 bvec->bv_len,
Al Viro98a09d62017-09-24 12:14:36 -04001179 iter);
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001180
Al Viro98a09d62017-09-24 12:14:36 -04001181 if (!iov_iter_count(iter))
Dongsu Park9124d3f2015-01-18 16:16:34 +01001182 break;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001183
Dongsu Park9124d3f2015-01-18 16:16:34 +01001184 if (ret < bvec->bv_len)
1185 return -EFAULT;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001186 }
1187
Dongsu Park9124d3f2015-01-18 16:16:34 +01001188 return 0;
1189}
1190
1191/**
1192 * bio_copy_to_iter - copy all pages from bio to iov_iter
1193 * @bio: The &struct bio which describes the I/O as source
1194 * @iter: iov_iter as destination
1195 *
1196 * Copy all pages from bio to iov_iter.
1197 * Returns 0 on success, or error on failure.
1198 */
1199static int bio_copy_to_iter(struct bio *bio, struct iov_iter iter)
1200{
1201 int i;
1202 struct bio_vec *bvec;
Ming Lei6dc4f102019-02-15 19:13:19 +08001203 struct bvec_iter_all iter_all;
Dongsu Park9124d3f2015-01-18 16:16:34 +01001204
Ming Lei6dc4f102019-02-15 19:13:19 +08001205 bio_for_each_segment_all(bvec, bio, i, iter_all) {
Dongsu Park9124d3f2015-01-18 16:16:34 +01001206 ssize_t ret;
1207
1208 ret = copy_page_to_iter(bvec->bv_page,
1209 bvec->bv_offset,
1210 bvec->bv_len,
1211 &iter);
1212
1213 if (!iov_iter_count(&iter))
1214 break;
1215
1216 if (ret < bvec->bv_len)
1217 return -EFAULT;
1218 }
1219
1220 return 0;
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001221}
1222
Guoqing Jiang491221f2016-09-22 03:10:01 -04001223void bio_free_pages(struct bio *bio)
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001224{
1225 struct bio_vec *bvec;
1226 int i;
Ming Lei6dc4f102019-02-15 19:13:19 +08001227 struct bvec_iter_all iter_all;
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001228
Ming Lei6dc4f102019-02-15 19:13:19 +08001229 bio_for_each_segment_all(bvec, bio, i, iter_all)
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001230 __free_page(bvec->bv_page);
1231}
Guoqing Jiang491221f2016-09-22 03:10:01 -04001232EXPORT_SYMBOL(bio_free_pages);
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001233
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234/**
1235 * bio_uncopy_user - finish previously mapped bio
1236 * @bio: bio being terminated
1237 *
Christoph Hellwigddad8dd2015-01-18 16:16:29 +01001238 * Free pages allocated from bio_copy_user_iov() and write back data
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239 * to user space in case of a read.
1240 */
1241int bio_uncopy_user(struct bio *bio)
1242{
1243 struct bio_map_data *bmd = bio->bi_private;
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001244 int ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001245
Roland Dreier35dc2482013-08-05 17:55:01 -07001246 if (!bio_flagged(bio, BIO_NULL_MAPPED)) {
1247 /*
1248 * if we're in a workqueue, the request is orphaned, so
Hannes Reinecke2d99b552016-02-12 09:39:15 +01001249 * don't copy into a random user address space, just free
1250 * and return -EINTR so user space doesn't expect any data.
Roland Dreier35dc2482013-08-05 17:55:01 -07001251 */
Hannes Reinecke2d99b552016-02-12 09:39:15 +01001252 if (!current->mm)
1253 ret = -EINTR;
1254 else if (bio_data_dir(bio) == READ)
Dongsu Park9124d3f2015-01-18 16:16:34 +01001255 ret = bio_copy_to_iter(bio, bmd->iter);
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001256 if (bmd->is_our_pages)
1257 bio_free_pages(bio);
Roland Dreier35dc2482013-08-05 17:55:01 -07001258 }
Kent Overstreetc8db4442013-11-22 19:39:06 -08001259 kfree(bmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001260 bio_put(bio);
1261 return ret;
1262}
1263
1264/**
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001265 * bio_copy_user_iov - copy user data to bio
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001266 * @q: destination block queue
1267 * @map_data: pointer to the rq_map_data holding pages (if necessary)
1268 * @iter: iovec iterator
1269 * @gfp_mask: memory allocation flags
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270 *
1271 * Prepares and returns a bio for indirect user io, bouncing data
1272 * to/from kernel pages as necessary. Must be paired with
1273 * call bio_uncopy_user() on io completion.
1274 */
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001275struct bio *bio_copy_user_iov(struct request_queue *q,
1276 struct rq_map_data *map_data,
Al Viroe81cef52017-09-24 09:25:39 -04001277 struct iov_iter *iter,
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001278 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001279{
Linus Torvalds1da177e2005-04-16 15:20:36 -07001280 struct bio_map_data *bmd;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001281 struct page *page;
1282 struct bio *bio;
Al Virod16d44e2017-09-24 13:09:18 -04001283 int i = 0, ret;
1284 int nr_pages;
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001285 unsigned int len = iter->count;
Geliang Tangbd5cece2015-11-21 17:27:31 +08001286 unsigned int offset = map_data ? offset_in_page(map_data->offset) : 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001287
Al Viro0e5b9352017-09-24 13:14:35 -04001288 bmd = bio_alloc_map_data(iter, gfp_mask);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001289 if (!bmd)
1290 return ERR_PTR(-ENOMEM);
1291
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001292 /*
1293 * We need to do a deep copy of the iov_iter including the iovecs.
1294 * The caller provided iov might point to an on-stack or otherwise
1295 * shortlived one.
1296 */
1297 bmd->is_our_pages = map_data ? 0 : 1;
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001298
Al Virod16d44e2017-09-24 13:09:18 -04001299 nr_pages = DIV_ROUND_UP(offset + len, PAGE_SIZE);
1300 if (nr_pages > BIO_MAX_PAGES)
1301 nr_pages = BIO_MAX_PAGES;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302
Linus Torvalds1da177e2005-04-16 15:20:36 -07001303 ret = -ENOMEM;
Tejun Heoa9e9dc22009-04-15 22:10:27 +09001304 bio = bio_kmalloc(gfp_mask, nr_pages);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001305 if (!bio)
1306 goto out_bmd;
1307
Linus Torvalds1da177e2005-04-16 15:20:36 -07001308 ret = 0;
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001309
1310 if (map_data) {
FUJITA Tomonorie623ddb2008-12-18 14:49:36 +09001311 nr_pages = 1 << map_data->page_order;
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001312 i = map_data->offset / PAGE_SIZE;
1313 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001314 while (len) {
FUJITA Tomonorie623ddb2008-12-18 14:49:36 +09001315 unsigned int bytes = PAGE_SIZE;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001316
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001317 bytes -= offset;
1318
Linus Torvalds1da177e2005-04-16 15:20:36 -07001319 if (bytes > len)
1320 bytes = len;
1321
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001322 if (map_data) {
FUJITA Tomonorie623ddb2008-12-18 14:49:36 +09001323 if (i == map_data->nr_entries * nr_pages) {
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001324 ret = -ENOMEM;
1325 break;
1326 }
FUJITA Tomonorie623ddb2008-12-18 14:49:36 +09001327
1328 page = map_data->pages[i / nr_pages];
1329 page += (i % nr_pages);
1330
1331 i++;
1332 } else {
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001333 page = alloc_page(q->bounce_gfp | gfp_mask);
FUJITA Tomonorie623ddb2008-12-18 14:49:36 +09001334 if (!page) {
1335 ret = -ENOMEM;
1336 break;
1337 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 }
1339
Jérôme Glissea3761c32019-04-10 16:27:51 -04001340 if (bio_add_pc_page(q, bio, page, bytes, offset) < bytes) {
1341 if (!map_data)
1342 __free_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001343 break;
Jérôme Glissea3761c32019-04-10 16:27:51 -04001344 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001345
1346 len -= bytes;
FUJITA Tomonori56c451f2008-12-18 14:49:37 +09001347 offset = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001348 }
1349
1350 if (ret)
1351 goto cleanup;
1352
Al Viro2884d0b2017-09-24 12:09:21 -04001353 if (map_data)
1354 map_data->offset += bio->bi_iter.bi_size;
1355
Linus Torvalds1da177e2005-04-16 15:20:36 -07001356 /*
1357 * success
1358 */
David Howells00e23702018-10-22 13:07:28 +01001359 if ((iov_iter_rw(iter) == WRITE && (!map_data || !map_data->null_mapped)) ||
FUJITA Tomonoriecb554a2009-07-09 14:46:53 +02001360 (map_data && map_data->from_user)) {
Al Viro98a09d62017-09-24 12:14:36 -04001361 ret = bio_copy_from_iter(bio, iter);
FUJITA Tomonoric5dec1c2008-04-11 12:56:49 +02001362 if (ret)
1363 goto cleanup;
Al Viro98a09d62017-09-24 12:14:36 -04001364 } else {
Keith Buschf55adad2018-12-10 08:44:42 -07001365 if (bmd->is_our_pages)
1366 zero_fill_bio(bio);
Al Viro98a09d62017-09-24 12:14:36 -04001367 iov_iter_advance(iter, bio->bi_iter.bi_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001368 }
1369
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001370 bio->bi_private = bmd;
Al Viro2884d0b2017-09-24 12:09:21 -04001371 if (map_data && map_data->null_mapped)
1372 bio_set_flag(bio, BIO_NULL_MAPPED);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001373 return bio;
1374cleanup:
FUJITA Tomonori152e2832008-08-28 16:17:06 +09001375 if (!map_data)
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001376 bio_free_pages(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377 bio_put(bio);
1378out_bmd:
Kent Overstreetc8db4442013-11-22 19:39:06 -08001379 kfree(bmd);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001380 return ERR_PTR(ret);
1381}
1382
Christoph Hellwig37f19e52015-01-18 16:16:33 +01001383/**
1384 * bio_map_user_iov - map user iovec into bio
1385 * @q: the struct request_queue for the bio
1386 * @iter: iovec iterator
1387 * @gfp_mask: memory allocation flags
1388 *
1389 * Map the user space address into a bio suitable for io to a block
1390 * device. Returns an error pointer in case of error.
1391 */
1392struct bio *bio_map_user_iov(struct request_queue *q,
Al Viroe81cef52017-09-24 09:25:39 -04001393 struct iov_iter *iter,
Christoph Hellwig37f19e52015-01-18 16:16:33 +01001394 gfp_t gfp_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001395{
Kent Overstreet26e49cf2015-01-18 16:16:31 +01001396 int j;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001397 struct bio *bio;
Al Viro076098e2017-09-23 16:08:57 -04001398 int ret;
Al Viro2b04e8f2017-09-23 15:51:23 -04001399 struct bio_vec *bvec;
Ming Lei6dc4f102019-02-15 19:13:19 +08001400 struct bvec_iter_all iter_all;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001401
Al Virob282cc72017-09-23 16:24:59 -04001402 if (!iov_iter_count(iter))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001403 return ERR_PTR(-EINVAL);
1404
Al Virob282cc72017-09-23 16:24:59 -04001405 bio = bio_kmalloc(gfp_mask, iov_iter_npages(iter, BIO_MAX_PAGES));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001406 if (!bio)
1407 return ERR_PTR(-ENOMEM);
1408
Al Viro0a0f1512017-09-24 12:30:17 -04001409 while (iov_iter_count(iter)) {
Al Viro629e42b2017-09-23 16:13:10 -04001410 struct page **pages;
Al Viro076098e2017-09-23 16:08:57 -04001411 ssize_t bytes;
1412 size_t offs, added = 0;
1413 int npages;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001414
Al Viro0a0f1512017-09-24 12:30:17 -04001415 bytes = iov_iter_get_pages_alloc(iter, &pages, LONG_MAX, &offs);
Al Viro076098e2017-09-23 16:08:57 -04001416 if (unlikely(bytes <= 0)) {
1417 ret = bytes ? bytes : -EFAULT;
James Bottomley f1970ba2005-06-20 14:06:52 +02001418 goto out_unmap;
Jens Axboe99172152006-06-16 13:02:29 +02001419 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001420
Al Viro076098e2017-09-23 16:08:57 -04001421 npages = DIV_ROUND_UP(offs + bytes, PAGE_SIZE);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001422
Al Viro98f0bc92017-09-23 16:23:18 -04001423 if (unlikely(offs & queue_dma_alignment(q))) {
1424 ret = -EINVAL;
1425 j = 0;
1426 } else {
1427 for (j = 0; j < npages; j++) {
1428 struct page *page = pages[j];
1429 unsigned int n = PAGE_SIZE - offs;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001430
Al Viro98f0bc92017-09-23 16:23:18 -04001431 if (n > bytes)
1432 n = bytes;
James Bottomley f1970ba2005-06-20 14:06:52 +02001433
Ming Lei19047082019-03-17 18:01:08 +08001434 if (!__bio_add_pc_page(q, bio, page, n, offs,
1435 true))
Al Viro98f0bc92017-09-23 16:23:18 -04001436 break;
Vitaly Mayatskikh95d78c22017-09-22 01:18:39 -04001437
Al Viro98f0bc92017-09-23 16:23:18 -04001438 added += n;
1439 bytes -= n;
1440 offs = 0;
1441 }
Al Viro0a0f1512017-09-24 12:30:17 -04001442 iov_iter_advance(iter, added);
James Bottomley f1970ba2005-06-20 14:06:52 +02001443 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001444 /*
James Bottomley f1970ba2005-06-20 14:06:52 +02001445 * release the pages we didn't map into the bio, if any
Linus Torvalds1da177e2005-04-16 15:20:36 -07001446 */
Al Viro629e42b2017-09-23 16:13:10 -04001447 while (j < npages)
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001448 put_page(pages[j++]);
Al Viro629e42b2017-09-23 16:13:10 -04001449 kvfree(pages);
Al Viroe2e115d2017-09-23 16:16:06 -04001450 /* couldn't stuff something into bio? */
1451 if (bytes)
1452 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453 }
1454
Jens Axboeb7c44ed2015-07-24 12:37:59 -06001455 bio_set_flag(bio, BIO_USER_MAPPED);
Christoph Hellwig37f19e52015-01-18 16:16:33 +01001456
1457 /*
Bart Van Assche5fad1b62017-02-01 08:20:08 -08001458 * subtle -- if bio_map_user_iov() ended up bouncing a bio,
Christoph Hellwig37f19e52015-01-18 16:16:33 +01001459 * it would normally disappear when its bi_end_io is run.
1460 * however, we need it for the unmap, so grab an extra
1461 * reference to it
1462 */
1463 bio_get(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001464 return bio;
James Bottomley f1970ba2005-06-20 14:06:52 +02001465
1466 out_unmap:
Ming Lei6dc4f102019-02-15 19:13:19 +08001467 bio_for_each_segment_all(bvec, bio, j, iter_all) {
Al Viro2b04e8f2017-09-23 15:51:23 -04001468 put_page(bvec->bv_page);
James Bottomley f1970ba2005-06-20 14:06:52 +02001469 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001470 bio_put(bio);
1471 return ERR_PTR(ret);
1472}
1473
Linus Torvalds1da177e2005-04-16 15:20:36 -07001474static void __bio_unmap_user(struct bio *bio)
1475{
1476 struct bio_vec *bvec;
1477 int i;
Ming Lei6dc4f102019-02-15 19:13:19 +08001478 struct bvec_iter_all iter_all;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001479
1480 /*
1481 * make sure we dirty pages we wrote to
1482 */
Ming Lei6dc4f102019-02-15 19:13:19 +08001483 bio_for_each_segment_all(bvec, bio, i, iter_all) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001484 if (bio_data_dir(bio) == READ)
1485 set_page_dirty_lock(bvec->bv_page);
1486
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +03001487 put_page(bvec->bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488 }
1489
1490 bio_put(bio);
1491}
1492
1493/**
1494 * bio_unmap_user - unmap a bio
1495 * @bio: the bio being unmapped
1496 *
Bart Van Assche5fad1b62017-02-01 08:20:08 -08001497 * Unmap a bio previously mapped by bio_map_user_iov(). Must be called from
1498 * process context.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001499 *
1500 * bio_unmap_user() may sleep.
1501 */
1502void bio_unmap_user(struct bio *bio)
1503{
1504 __bio_unmap_user(bio);
1505 bio_put(bio);
1506}
1507
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001508static void bio_map_kern_endio(struct bio *bio)
Jens Axboeb8238252005-06-20 14:05:27 +02001509{
Jens Axboeb8238252005-06-20 14:05:27 +02001510 bio_put(bio);
Jens Axboeb8238252005-06-20 14:05:27 +02001511}
1512
Christoph Hellwig75c72b82015-01-18 16:16:32 +01001513/**
1514 * bio_map_kern - map kernel address into bio
1515 * @q: the struct request_queue for the bio
1516 * @data: pointer to buffer to map
1517 * @len: length in bytes
1518 * @gfp_mask: allocation flags for bio allocation
1519 *
1520 * Map the kernel address into a bio suitable for io to a block
1521 * device. Returns an error pointer in case of error.
1522 */
1523struct bio *bio_map_kern(struct request_queue *q, void *data, unsigned int len,
1524 gfp_t gfp_mask)
Mike Christie df46b9a2005-06-20 14:04:44 +02001525{
1526 unsigned long kaddr = (unsigned long)data;
1527 unsigned long end = (kaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1528 unsigned long start = kaddr >> PAGE_SHIFT;
1529 const int nr_pages = end - start;
1530 int offset, i;
1531 struct bio *bio;
1532
Tejun Heoa9e9dc22009-04-15 22:10:27 +09001533 bio = bio_kmalloc(gfp_mask, nr_pages);
Mike Christie df46b9a2005-06-20 14:04:44 +02001534 if (!bio)
1535 return ERR_PTR(-ENOMEM);
1536
1537 offset = offset_in_page(kaddr);
1538 for (i = 0; i < nr_pages; i++) {
1539 unsigned int bytes = PAGE_SIZE - offset;
1540
1541 if (len <= 0)
1542 break;
1543
1544 if (bytes > len)
1545 bytes = len;
1546
Mike Christiedefd94b2005-12-05 02:37:06 -06001547 if (bio_add_pc_page(q, bio, virt_to_page(data), bytes,
Christoph Hellwig75c72b82015-01-18 16:16:32 +01001548 offset) < bytes) {
1549 /* we don't support partial mappings */
1550 bio_put(bio);
1551 return ERR_PTR(-EINVAL);
1552 }
Mike Christie df46b9a2005-06-20 14:04:44 +02001553
1554 data += bytes;
1555 len -= bytes;
1556 offset = 0;
1557 }
1558
Jens Axboeb8238252005-06-20 14:05:27 +02001559 bio->bi_end_io = bio_map_kern_endio;
Mike Christie df46b9a2005-06-20 14:04:44 +02001560 return bio;
1561}
H Hartley Sweetena112a712009-09-26 16:19:21 +02001562EXPORT_SYMBOL(bio_map_kern);
Mike Christie df46b9a2005-06-20 14:04:44 +02001563
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001564static void bio_copy_kern_endio(struct bio *bio)
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001565{
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001566 bio_free_pages(bio);
1567 bio_put(bio);
1568}
1569
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001570static void bio_copy_kern_endio_read(struct bio *bio)
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001571{
Christoph Hellwig42d26832015-01-18 16:16:28 +01001572 char *p = bio->bi_private;
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001573 struct bio_vec *bvec;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001574 int i;
Ming Lei6dc4f102019-02-15 19:13:19 +08001575 struct bvec_iter_all iter_all;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001576
Ming Lei6dc4f102019-02-15 19:13:19 +08001577 bio_for_each_segment_all(bvec, bio, i, iter_all) {
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001578 memcpy(p, page_address(bvec->bv_page), bvec->bv_len);
Kent Overstreetc8db4442013-11-22 19:39:06 -08001579 p += bvec->bv_len;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001580 }
1581
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001582 bio_copy_kern_endio(bio);
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001583}
1584
1585/**
1586 * bio_copy_kern - copy kernel address into bio
1587 * @q: the struct request_queue for the bio
1588 * @data: pointer to buffer to copy
1589 * @len: length in bytes
1590 * @gfp_mask: allocation flags for bio and page allocation
Randy Dunlapffee0252008-04-30 09:08:54 +02001591 * @reading: data direction is READ
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001592 *
1593 * copy the kernel address into a bio suitable for io to a block
1594 * device. Returns an error pointer in case of error.
1595 */
1596struct bio *bio_copy_kern(struct request_queue *q, void *data, unsigned int len,
1597 gfp_t gfp_mask, int reading)
1598{
Christoph Hellwig42d26832015-01-18 16:16:28 +01001599 unsigned long kaddr = (unsigned long)data;
1600 unsigned long end = (kaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1601 unsigned long start = kaddr >> PAGE_SHIFT;
Christoph Hellwig42d26832015-01-18 16:16:28 +01001602 struct bio *bio;
1603 void *p = data;
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001604 int nr_pages = 0;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001605
Christoph Hellwig42d26832015-01-18 16:16:28 +01001606 /*
1607 * Overflow, abort
1608 */
1609 if (end < start)
1610 return ERR_PTR(-EINVAL);
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001611
Christoph Hellwig42d26832015-01-18 16:16:28 +01001612 nr_pages = end - start;
1613 bio = bio_kmalloc(gfp_mask, nr_pages);
1614 if (!bio)
1615 return ERR_PTR(-ENOMEM);
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001616
Christoph Hellwig42d26832015-01-18 16:16:28 +01001617 while (len) {
1618 struct page *page;
1619 unsigned int bytes = PAGE_SIZE;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001620
Christoph Hellwig42d26832015-01-18 16:16:28 +01001621 if (bytes > len)
1622 bytes = len;
1623
1624 page = alloc_page(q->bounce_gfp | gfp_mask);
1625 if (!page)
1626 goto cleanup;
1627
1628 if (!reading)
1629 memcpy(page_address(page), p, bytes);
1630
1631 if (bio_add_pc_page(q, bio, page, bytes, 0) < bytes)
1632 break;
1633
1634 len -= bytes;
1635 p += bytes;
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001636 }
1637
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001638 if (reading) {
1639 bio->bi_end_io = bio_copy_kern_endio_read;
1640 bio->bi_private = data;
1641 } else {
1642 bio->bi_end_io = bio_copy_kern_endio;
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001643 }
FUJITA Tomonori76029ff2008-08-25 20:36:08 +02001644
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001645 return bio;
Christoph Hellwig42d26832015-01-18 16:16:28 +01001646
1647cleanup:
Christoph Hellwig1dfa0f62015-01-18 16:16:30 +01001648 bio_free_pages(bio);
Christoph Hellwig42d26832015-01-18 16:16:28 +01001649 bio_put(bio);
1650 return ERR_PTR(-ENOMEM);
FUJITA Tomonori68154e92008-04-25 12:47:50 +02001651}
1652
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653/*
1654 * bio_set_pages_dirty() and bio_check_pages_dirty() are support functions
1655 * for performing direct-IO in BIOs.
1656 *
1657 * The problem is that we cannot run set_page_dirty() from interrupt context
1658 * because the required locks are not interrupt-safe. So what we can do is to
1659 * mark the pages dirty _before_ performing IO. And in interrupt context,
1660 * check that the pages are still dirty. If so, fine. If not, redirty them
1661 * in process context.
1662 *
1663 * We special-case compound pages here: normally this means reads into hugetlb
1664 * pages. The logic in here doesn't really work right for compound pages
1665 * because the VM does not uniformly chase down the head page in all cases.
1666 * But dirtiness of compound pages is pretty meaningless anyway: the VM doesn't
1667 * handle them at all. So we skip compound pages here at an early stage.
1668 *
1669 * Note that this code is very hard to test under normal circumstances because
1670 * direct-io pins the pages with get_user_pages(). This makes
1671 * is_page_cache_freeable return false, and the VM will not clean the pages.
Artem Bityutskiy0d5c3eb2012-07-25 18:12:08 +03001672 * But other code (eg, flusher threads) could clean the pages if they are mapped
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673 * pagecache.
1674 *
1675 * Simply disabling the call to bio_set_pages_dirty() is a good way to test the
1676 * deferred bio dirtying paths.
1677 */
1678
1679/*
1680 * bio_set_pages_dirty() will mark all the bio's pages as dirty.
1681 */
1682void bio_set_pages_dirty(struct bio *bio)
1683{
Kent Overstreetcb34e052012-09-05 15:22:02 -07001684 struct bio_vec *bvec;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001685 int i;
Ming Lei6dc4f102019-02-15 19:13:19 +08001686 struct bvec_iter_all iter_all;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687
Ming Lei6dc4f102019-02-15 19:13:19 +08001688 bio_for_each_segment_all(bvec, bio, i, iter_all) {
Christoph Hellwig3bb50982018-07-24 14:04:13 +02001689 if (!PageCompound(bvec->bv_page))
1690 set_page_dirty_lock(bvec->bv_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001691 }
1692}
1693
Linus Torvalds1da177e2005-04-16 15:20:36 -07001694/*
1695 * bio_check_pages_dirty() will check that all the BIO's pages are still dirty.
1696 * If they are, then fine. If, however, some pages are clean then they must
1697 * have been written out during the direct-IO read. So we take another ref on
Christoph Hellwig24d54932018-07-24 14:04:12 +02001698 * the BIO and re-dirty the pages in process context.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001699 *
1700 * It is expected that bio_check_pages_dirty() will wholly own the BIO from
Kirill A. Shutemovea1754a2016-04-01 15:29:48 +03001701 * here on. It will run one put_page() against each page and will run one
1702 * bio_put() against the BIO.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001703 */
1704
David Howells65f27f32006-11-22 14:55:48 +00001705static void bio_dirty_fn(struct work_struct *work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706
David Howells65f27f32006-11-22 14:55:48 +00001707static DECLARE_WORK(bio_dirty_work, bio_dirty_fn);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001708static DEFINE_SPINLOCK(bio_dirty_lock);
1709static struct bio *bio_dirty_list;
1710
1711/*
1712 * This runs in process context
1713 */
David Howells65f27f32006-11-22 14:55:48 +00001714static void bio_dirty_fn(struct work_struct *work)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715{
Christoph Hellwig24d54932018-07-24 14:04:12 +02001716 struct bio *bio, *next;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001717
Christoph Hellwig24d54932018-07-24 14:04:12 +02001718 spin_lock_irq(&bio_dirty_lock);
1719 next = bio_dirty_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720 bio_dirty_list = NULL;
Christoph Hellwig24d54932018-07-24 14:04:12 +02001721 spin_unlock_irq(&bio_dirty_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722
Christoph Hellwig24d54932018-07-24 14:04:12 +02001723 while ((bio = next) != NULL) {
1724 next = bio->bi_private;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725
1726 bio_set_pages_dirty(bio);
Jens Axboe399254a2019-02-27 13:13:23 -07001727 if (!bio_flagged(bio, BIO_NO_PAGE_REF))
1728 bio_release_pages(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001729 bio_put(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001730 }
1731}
1732
1733void bio_check_pages_dirty(struct bio *bio)
1734{
Kent Overstreetcb34e052012-09-05 15:22:02 -07001735 struct bio_vec *bvec;
Christoph Hellwig24d54932018-07-24 14:04:12 +02001736 unsigned long flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001737 int i;
Ming Lei6dc4f102019-02-15 19:13:19 +08001738 struct bvec_iter_all iter_all;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739
Ming Lei6dc4f102019-02-15 19:13:19 +08001740 bio_for_each_segment_all(bvec, bio, i, iter_all) {
Christoph Hellwig24d54932018-07-24 14:04:12 +02001741 if (!PageDirty(bvec->bv_page) && !PageCompound(bvec->bv_page))
1742 goto defer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001743 }
1744
Jens Axboe399254a2019-02-27 13:13:23 -07001745 if (!bio_flagged(bio, BIO_NO_PAGE_REF))
1746 bio_release_pages(bio);
Christoph Hellwig24d54932018-07-24 14:04:12 +02001747 bio_put(bio);
1748 return;
1749defer:
1750 spin_lock_irqsave(&bio_dirty_lock, flags);
1751 bio->bi_private = bio_dirty_list;
1752 bio_dirty_list = bio;
1753 spin_unlock_irqrestore(&bio_dirty_lock, flags);
1754 schedule_work(&bio_dirty_work);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001755}
1756
Mikulas Patocka5b18b5a2018-12-06 11:41:19 -05001757void update_io_ticks(struct hd_struct *part, unsigned long now)
1758{
1759 unsigned long stamp;
1760again:
1761 stamp = READ_ONCE(part->stamp);
1762 if (unlikely(stamp != now)) {
1763 if (likely(cmpxchg(&part->stamp, stamp, now) == stamp)) {
1764 __part_stat_add(part, io_ticks, 1);
1765 }
1766 }
1767 if (part->partno) {
1768 part = &part_to_disk(part)->part0;
1769 goto again;
1770 }
1771}
Linus Torvalds1da177e2005-04-16 15:20:36 -07001772
Michael Callahanddcf35d2018-07-18 04:47:39 -07001773void generic_start_io_acct(struct request_queue *q, int op,
Jens Axboed62e26b2017-06-30 21:55:08 -06001774 unsigned long sectors, struct hd_struct *part)
Gu Zheng394ffa52014-11-24 11:05:22 +08001775{
Michael Callahanddcf35d2018-07-18 04:47:39 -07001776 const int sgrp = op_stat_group(op);
Gu Zheng394ffa52014-11-24 11:05:22 +08001777
Mike Snitzer112f1582018-12-06 11:41:18 -05001778 part_stat_lock();
1779
Mikulas Patocka5b18b5a2018-12-06 11:41:19 -05001780 update_io_ticks(part, jiffies);
Mike Snitzer112f1582018-12-06 11:41:18 -05001781 part_stat_inc(part, ios[sgrp]);
1782 part_stat_add(part, sectors[sgrp], sectors);
Michael Callahanddcf35d2018-07-18 04:47:39 -07001783 part_inc_in_flight(q, part, op_is_write(op));
Gu Zheng394ffa52014-11-24 11:05:22 +08001784
1785 part_stat_unlock();
1786}
1787EXPORT_SYMBOL(generic_start_io_acct);
1788
Michael Callahanddcf35d2018-07-18 04:47:39 -07001789void generic_end_io_acct(struct request_queue *q, int req_op,
Jens Axboed62e26b2017-06-30 21:55:08 -06001790 struct hd_struct *part, unsigned long start_time)
Gu Zheng394ffa52014-11-24 11:05:22 +08001791{
Mikulas Patocka5b18b5a2018-12-06 11:41:19 -05001792 unsigned long now = jiffies;
1793 unsigned long duration = now - start_time;
Michael Callahanddcf35d2018-07-18 04:47:39 -07001794 const int sgrp = op_stat_group(req_op);
Gu Zheng394ffa52014-11-24 11:05:22 +08001795
Mike Snitzer112f1582018-12-06 11:41:18 -05001796 part_stat_lock();
1797
Mikulas Patocka5b18b5a2018-12-06 11:41:19 -05001798 update_io_ticks(part, now);
Mike Snitzer112f1582018-12-06 11:41:18 -05001799 part_stat_add(part, nsecs[sgrp], jiffies_to_nsecs(duration));
Mikulas Patocka5b18b5a2018-12-06 11:41:19 -05001800 part_stat_add(part, time_in_queue, duration);
Michael Callahanddcf35d2018-07-18 04:47:39 -07001801 part_dec_in_flight(q, part, op_is_write(req_op));
Gu Zheng394ffa52014-11-24 11:05:22 +08001802
1803 part_stat_unlock();
1804}
1805EXPORT_SYMBOL(generic_end_io_acct);
1806
Ilya Loginov2d4dc892009-11-26 09:16:19 +01001807#if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
1808void bio_flush_dcache_pages(struct bio *bi)
1809{
Kent Overstreet79886132013-11-23 17:19:00 -08001810 struct bio_vec bvec;
1811 struct bvec_iter iter;
Ilya Loginov2d4dc892009-11-26 09:16:19 +01001812
Kent Overstreet79886132013-11-23 17:19:00 -08001813 bio_for_each_segment(bvec, bi, iter)
1814 flush_dcache_page(bvec.bv_page);
Ilya Loginov2d4dc892009-11-26 09:16:19 +01001815}
1816EXPORT_SYMBOL(bio_flush_dcache_pages);
1817#endif
1818
Jens Axboec4cf5262015-04-17 16:15:18 -06001819static inline bool bio_remaining_done(struct bio *bio)
1820{
1821 /*
1822 * If we're not chaining, then ->__bi_remaining is always 1 and
1823 * we always end io on the first invocation.
1824 */
1825 if (!bio_flagged(bio, BIO_CHAIN))
1826 return true;
1827
1828 BUG_ON(atomic_read(&bio->__bi_remaining) <= 0);
1829
Mike Snitzer326e1db2015-05-22 09:14:03 -04001830 if (atomic_dec_and_test(&bio->__bi_remaining)) {
Jens Axboeb7c44ed2015-07-24 12:37:59 -06001831 bio_clear_flag(bio, BIO_CHAIN);
Jens Axboec4cf5262015-04-17 16:15:18 -06001832 return true;
Mike Snitzer326e1db2015-05-22 09:14:03 -04001833 }
Jens Axboec4cf5262015-04-17 16:15:18 -06001834
1835 return false;
1836}
1837
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838/**
1839 * bio_endio - end I/O on a bio
1840 * @bio: bio
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841 *
1842 * Description:
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001843 * bio_endio() will end I/O on the whole bio. bio_endio() is the preferred
1844 * way to end I/O on a bio. No one should call bi_end_io() directly on a
1845 * bio unless they own it and thus know that it has an end_io function.
NeilBrownfbbaf702017-04-07 09:40:52 -06001846 *
1847 * bio_endio() can be called several times on a bio that has been chained
1848 * using bio_chain(). The ->bi_end_io() function will only be called the
1849 * last time. At this point the BLK_TA_COMPLETE tracing event will be
1850 * generated if BIO_TRACE_COMPLETION is set.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001851 **/
Christoph Hellwig4246a0b2015-07-20 15:29:37 +02001852void bio_endio(struct bio *bio)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853{
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001854again:
Christoph Hellwig2b885512016-03-11 17:34:53 +01001855 if (!bio_remaining_done(bio))
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001856 return;
Christoph Hellwig7c20f112017-07-03 16:58:43 -06001857 if (!bio_integrity_endio(bio))
1858 return;
Kent Overstreet196d38bc2013-11-23 18:34:15 -08001859
Josef Bacik67b42d02018-07-03 11:15:00 -04001860 if (bio->bi_disk)
1861 rq_qos_done_bio(bio->bi_disk->queue, bio);
1862
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001863 /*
1864 * Need to have a real endio function for chained bios, otherwise
1865 * various corner cases will break (like stacking block devices that
1866 * save/restore bi_end_io) - however, we want to avoid unbounded
1867 * recursion and blowing the stack. Tail call optimization would
1868 * handle this, but compiling with frame pointers also disables
1869 * gcc's sibling call optimization.
1870 */
1871 if (bio->bi_end_io == bio_chain_endio) {
1872 bio = __bio_chain_endio(bio);
1873 goto again;
Kent Overstreet196d38bc2013-11-23 18:34:15 -08001874 }
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001875
Christoph Hellwig74d46992017-08-23 19:10:32 +02001876 if (bio->bi_disk && bio_flagged(bio, BIO_TRACE_COMPLETION)) {
1877 trace_block_bio_complete(bio->bi_disk->queue, bio,
Bart Van Asschea462b952017-06-13 08:07:33 -07001878 blk_status_to_errno(bio->bi_status));
NeilBrownfbbaf702017-04-07 09:40:52 -06001879 bio_clear_flag(bio, BIO_TRACE_COMPLETION);
1880 }
1881
Shaohua Li9e234ee2017-03-27 10:51:41 -07001882 blk_throtl_bio_endio(bio);
Shaohua Lib222dd22017-07-10 11:40:17 -07001883 /* release cgroup info */
1884 bio_uninit(bio);
Christoph Hellwigba8c6962016-03-11 17:34:52 +01001885 if (bio->bi_end_io)
1886 bio->bi_end_io(bio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001887}
H Hartley Sweetena112a712009-09-26 16:19:21 +02001888EXPORT_SYMBOL(bio_endio);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001889
Kent Overstreet196d38bc2013-11-23 18:34:15 -08001890/**
Kent Overstreet20d01892013-11-23 18:21:01 -08001891 * bio_split - split a bio
1892 * @bio: bio to split
1893 * @sectors: number of sectors to split from the front of @bio
1894 * @gfp: gfp mask
1895 * @bs: bio set to allocate from
1896 *
1897 * Allocates and returns a new bio which represents @sectors from the start of
1898 * @bio, and updates @bio to represent the remaining sectors.
1899 *
Martin K. Petersenf3f5da62015-07-22 07:57:12 -04001900 * Unless this is a discard request the newly allocated bio will point
1901 * to @bio's bi_io_vec; it is the caller's responsibility to ensure that
1902 * @bio is not freed before the split.
Kent Overstreet20d01892013-11-23 18:21:01 -08001903 */
1904struct bio *bio_split(struct bio *bio, int sectors,
1905 gfp_t gfp, struct bio_set *bs)
1906{
Mikulas Patockaf341a4d2017-11-22 13:18:05 -05001907 struct bio *split;
Kent Overstreet20d01892013-11-23 18:21:01 -08001908
1909 BUG_ON(sectors <= 0);
1910 BUG_ON(sectors >= bio_sectors(bio));
1911
Christoph Hellwigf9d03f92016-12-08 15:20:32 -07001912 split = bio_clone_fast(bio, gfp, bs);
Kent Overstreet20d01892013-11-23 18:21:01 -08001913 if (!split)
1914 return NULL;
1915
1916 split->bi_iter.bi_size = sectors << 9;
1917
1918 if (bio_integrity(split))
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -07001919 bio_integrity_trim(split);
Kent Overstreet20d01892013-11-23 18:21:01 -08001920
1921 bio_advance(bio, split->bi_iter.bi_size);
1922
NeilBrownfbbaf702017-04-07 09:40:52 -06001923 if (bio_flagged(bio, BIO_TRACE_COMPLETION))
Goldwyn Rodrigues20d59022018-01-23 09:10:19 -07001924 bio_set_flag(split, BIO_TRACE_COMPLETION);
NeilBrownfbbaf702017-04-07 09:40:52 -06001925
Kent Overstreet20d01892013-11-23 18:21:01 -08001926 return split;
1927}
1928EXPORT_SYMBOL(bio_split);
1929
Martin K. Petersenad3316b2008-10-01 22:42:53 -04001930/**
Kent Overstreet6678d832013-08-07 11:14:32 -07001931 * bio_trim - trim a bio
1932 * @bio: bio to trim
1933 * @offset: number of sectors to trim from the front of @bio
1934 * @size: size we want to trim @bio to, in sectors
1935 */
1936void bio_trim(struct bio *bio, int offset, int size)
1937{
1938 /* 'bio' is a cloned bio which we need to trim to match
1939 * the given offset and size.
Kent Overstreet6678d832013-08-07 11:14:32 -07001940 */
Kent Overstreet6678d832013-08-07 11:14:32 -07001941
1942 size <<= 9;
Kent Overstreet4f024f32013-10-11 15:44:27 -07001943 if (offset == 0 && size == bio->bi_iter.bi_size)
Kent Overstreet6678d832013-08-07 11:14:32 -07001944 return;
1945
Jens Axboeb7c44ed2015-07-24 12:37:59 -06001946 bio_clear_flag(bio, BIO_SEG_VALID);
Kent Overstreet6678d832013-08-07 11:14:32 -07001947
1948 bio_advance(bio, offset << 9);
1949
Kent Overstreet4f024f32013-10-11 15:44:27 -07001950 bio->bi_iter.bi_size = size;
Dmitry Monakhov376a78a2017-06-29 11:31:08 -07001951
1952 if (bio_integrity(bio))
Dmitry Monakhovfbd08e72017-06-29 11:31:10 -07001953 bio_integrity_trim(bio);
Dmitry Monakhov376a78a2017-06-29 11:31:08 -07001954
Kent Overstreet6678d832013-08-07 11:14:32 -07001955}
1956EXPORT_SYMBOL_GPL(bio_trim);
1957
Linus Torvalds1da177e2005-04-16 15:20:36 -07001958/*
1959 * create memory pools for biovec's in a bio_set.
1960 * use the global biovec slabs created for general use.
1961 */
Kent Overstreet8aa6ba22018-05-08 21:33:50 -04001962int biovec_init_pool(mempool_t *pool, int pool_entries)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001963{
Christoph Hellwiged996a52016-07-19 11:28:42 +02001964 struct biovec_slab *bp = bvec_slabs + BVEC_POOL_MAX;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001965
Kent Overstreet8aa6ba22018-05-08 21:33:50 -04001966 return mempool_init_slab_pool(pool, pool_entries, bp->slab);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967}
1968
Kent Overstreet917a38c2018-05-08 21:33:51 -04001969/*
1970 * bioset_exit - exit a bioset initialized with bioset_init()
1971 *
1972 * May be called on a zeroed but uninitialized bioset (i.e. allocated with
1973 * kzalloc()).
1974 */
1975void bioset_exit(struct bio_set *bs)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001976{
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -07001977 if (bs->rescue_workqueue)
1978 destroy_workqueue(bs->rescue_workqueue);
Kent Overstreet917a38c2018-05-08 21:33:51 -04001979 bs->rescue_workqueue = NULL;
Kent Overstreetdf2cb6d2012-09-10 14:33:46 -07001980
Kent Overstreet8aa6ba22018-05-08 21:33:50 -04001981 mempool_exit(&bs->bio_pool);
1982 mempool_exit(&bs->bvec_pool);
Kent Overstreet9f060e22012-10-12 15:29:33 -07001983
Martin K. Petersen7878cba2009-06-26 15:37:49 +02001984 bioset_integrity_free(bs);
Kent Overstreet917a38c2018-05-08 21:33:51 -04001985 if (bs->bio_slab)
1986 bio_put_slab(bs);
1987 bs->bio_slab = NULL;
1988}
1989EXPORT_SYMBOL(bioset_exit);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001990
NeilBrown011067b2017-06-18 14:38:57 +10001991/**
Kent Overstreet917a38c2018-05-08 21:33:51 -04001992 * bioset_init - Initialize a bio_set
Kent Overstreetdad08522018-05-20 18:25:58 -04001993 * @bs: pool to initialize
Kent Overstreet917a38c2018-05-08 21:33:51 -04001994 * @pool_size: Number of bio and bio_vecs to cache in the mempool
1995 * @front_pad: Number of bytes to allocate in front of the returned bio
1996 * @flags: Flags to modify behavior, currently %BIOSET_NEED_BVECS
1997 * and %BIOSET_NEED_RESCUER
1998 *
Kent Overstreetdad08522018-05-20 18:25:58 -04001999 * Description:
2000 * Set up a bio_set to be used with @bio_alloc_bioset. Allows the caller
2001 * to ask for a number of bytes to be allocated in front of the bio.
2002 * Front pad allocation is useful for embedding the bio inside
2003 * another structure, to avoid allocating extra data to go with the bio.
2004 * Note that the bio must be embedded at the END of that structure always,
2005 * or things will break badly.
2006 * If %BIOSET_NEED_BVECS is set in @flags, a separate pool will be allocated
2007 * for allocating iovecs. This pool is not needed e.g. for bio_clone_fast().
2008 * If %BIOSET_NEED_RESCUER is set, a workqueue is created which can be used to
2009 * dispatch queued requests when the mempool runs out of space.
2010 *
Kent Overstreet917a38c2018-05-08 21:33:51 -04002011 */
2012int bioset_init(struct bio_set *bs,
2013 unsigned int pool_size,
2014 unsigned int front_pad,
2015 int flags)
2016{
2017 unsigned int back_pad = BIO_INLINE_VECS * sizeof(struct bio_vec);
2018
2019 bs->front_pad = front_pad;
2020
2021 spin_lock_init(&bs->rescue_lock);
2022 bio_list_init(&bs->rescue_list);
2023 INIT_WORK(&bs->rescue_work, bio_alloc_rescue);
2024
2025 bs->bio_slab = bio_find_or_create_slab(front_pad + back_pad);
2026 if (!bs->bio_slab)
2027 return -ENOMEM;
2028
2029 if (mempool_init_slab_pool(&bs->bio_pool, pool_size, bs->bio_slab))
2030 goto bad;
2031
2032 if ((flags & BIOSET_NEED_BVECS) &&
2033 biovec_init_pool(&bs->bvec_pool, pool_size))
2034 goto bad;
2035
2036 if (!(flags & BIOSET_NEED_RESCUER))
2037 return 0;
2038
2039 bs->rescue_workqueue = alloc_workqueue("bioset", WQ_MEM_RECLAIM, 0);
2040 if (!bs->rescue_workqueue)
2041 goto bad;
2042
2043 return 0;
2044bad:
2045 bioset_exit(bs);
2046 return -ENOMEM;
2047}
2048EXPORT_SYMBOL(bioset_init);
2049
Jens Axboe28e89fd92018-06-07 14:42:05 -06002050/*
2051 * Initialize and setup a new bio_set, based on the settings from
2052 * another bio_set.
2053 */
2054int bioset_init_from_src(struct bio_set *bs, struct bio_set *src)
2055{
2056 int flags;
2057
2058 flags = 0;
2059 if (src->bvec_pool.min_nr)
2060 flags |= BIOSET_NEED_BVECS;
2061 if (src->rescue_workqueue)
2062 flags |= BIOSET_NEED_RESCUER;
2063
2064 return bioset_init(bs, src->bio_pool.min_nr, src->front_pad, flags);
2065}
2066EXPORT_SYMBOL(bioset_init_from_src);
2067
Tejun Heo852c7882012-03-05 13:15:27 -08002068#ifdef CONFIG_BLK_CGROUP
Tejun Heo1d933cf2015-05-22 17:13:24 -04002069
2070/**
Dennis Zhou2268c0f2018-12-05 12:10:29 -05002071 * bio_disassociate_blkg - puts back the blkg reference if associated
Dennis Zhoub5f29542018-11-01 17:24:10 -04002072 * @bio: target bio
Dennis Zhoub5f29542018-11-01 17:24:10 -04002073 *
Dennis Zhou2268c0f2018-12-05 12:10:29 -05002074 * Helper to disassociate the blkg from @bio if a blkg is associated.
Dennis Zhoub5f29542018-11-01 17:24:10 -04002075 */
Dennis Zhou2268c0f2018-12-05 12:10:29 -05002076void bio_disassociate_blkg(struct bio *bio)
Dennis Zhoub5f29542018-11-01 17:24:10 -04002077{
Josef Bacik08e18ea2018-07-03 11:14:50 -04002078 if (bio->bi_blkg) {
2079 blkg_put(bio->bi_blkg);
2080 bio->bi_blkg = NULL;
2081 }
Tejun Heo852c7882012-03-05 13:15:27 -08002082}
Dennis Zhou892ad712018-12-05 12:10:30 -05002083EXPORT_SYMBOL_GPL(bio_disassociate_blkg);
Tejun Heo852c7882012-03-05 13:15:27 -08002084
Paolo Valente20bd7232016-07-27 07:22:05 +02002085/**
Dennis Zhou2268c0f2018-12-05 12:10:29 -05002086 * __bio_associate_blkg - associate a bio with the a blkg
Tejun Heo852c7882012-03-05 13:15:27 -08002087 * @bio: target bio
2088 * @blkg: the blkg to associate
2089 *
Dennis Zhoubeea9da2018-12-05 12:10:28 -05002090 * This tries to associate @bio with the specified @blkg. Association failure
2091 * is handled by walking up the blkg tree. Therefore, the blkg associated can
2092 * be anything between @blkg and the root_blkg. This situation only happens
2093 * when a cgroup is dying and then the remaining bios will spill to the closest
2094 * alive blkg.
2095 *
2096 * A reference will be taken on the @blkg and will be released when @bio is
2097 * freed.
Tejun Heo852c7882012-03-05 13:15:27 -08002098 */
Dennis Zhou2268c0f2018-12-05 12:10:29 -05002099static void __bio_associate_blkg(struct bio *bio, struct blkcg_gq *blkg)
Tejun Heo852c7882012-03-05 13:15:27 -08002100{
Dennis Zhou2268c0f2018-12-05 12:10:29 -05002101 bio_disassociate_blkg(bio);
2102
Dennis Zhou7754f662018-12-05 12:10:39 -05002103 bio->bi_blkg = blkg_tryget_closest(blkg);
Dennis Zhou2268c0f2018-12-05 12:10:29 -05002104}
2105
Dennis Zhoufd42df32018-12-05 12:10:34 -05002106/**
2107 * bio_associate_blkg_from_css - associate a bio with a specified css
2108 * @bio: target bio
2109 * @css: target css
2110 *
2111 * Associate @bio with the blkg found by combining the css's blkg and the
Dennis Zhoufc5a8282018-12-05 12:10:36 -05002112 * request_queue of the @bio. This falls back to the queue's root_blkg if
2113 * the association fails with the css.
Dennis Zhoufd42df32018-12-05 12:10:34 -05002114 */
2115void bio_associate_blkg_from_css(struct bio *bio,
2116 struct cgroup_subsys_state *css)
2117{
Dennis Zhoufc5a8282018-12-05 12:10:36 -05002118 struct request_queue *q = bio->bi_disk->queue;
2119 struct blkcg_gq *blkg;
2120
2121 rcu_read_lock();
2122
2123 if (!css || !css->parent)
2124 blkg = q->root_blkg;
2125 else
2126 blkg = blkg_lookup_create(css_to_blkcg(css), q);
2127
2128 __bio_associate_blkg(bio, blkg);
2129
2130 rcu_read_unlock();
Dennis Zhoufd42df32018-12-05 12:10:34 -05002131}
2132EXPORT_SYMBOL_GPL(bio_associate_blkg_from_css);
2133
Dennis Zhou6a7f6d82018-12-05 12:10:33 -05002134#ifdef CONFIG_MEMCG
2135/**
2136 * bio_associate_blkg_from_page - associate a bio with the page's blkg
2137 * @bio: target bio
2138 * @page: the page to lookup the blkcg from
2139 *
2140 * Associate @bio with the blkg from @page's owning memcg and the respective
Dennis Zhoufc5a8282018-12-05 12:10:36 -05002141 * request_queue. If cgroup_e_css returns %NULL, fall back to the queue's
2142 * root_blkg.
Dennis Zhou6a7f6d82018-12-05 12:10:33 -05002143 */
2144void bio_associate_blkg_from_page(struct bio *bio, struct page *page)
2145{
2146 struct cgroup_subsys_state *css;
2147
Dennis Zhou6a7f6d82018-12-05 12:10:33 -05002148 if (!page->mem_cgroup)
2149 return;
2150
Dennis Zhoufc5a8282018-12-05 12:10:36 -05002151 rcu_read_lock();
2152
2153 css = cgroup_e_css(page->mem_cgroup->css.cgroup, &io_cgrp_subsys);
2154 bio_associate_blkg_from_css(bio, css);
2155
2156 rcu_read_unlock();
Dennis Zhou6a7f6d82018-12-05 12:10:33 -05002157}
2158#endif /* CONFIG_MEMCG */
2159
Dennis Zhou2268c0f2018-12-05 12:10:29 -05002160/**
2161 * bio_associate_blkg - associate a bio with a blkg
2162 * @bio: target bio
2163 *
2164 * Associate @bio with the blkg found from the bio's css and request_queue.
2165 * If one is not found, bio_lookup_blkg() creates the blkg. If a blkg is
2166 * already associated, the css is reused and association redone as the
2167 * request_queue may have changed.
2168 */
2169void bio_associate_blkg(struct bio *bio)
2170{
Dennis Zhoufc5a8282018-12-05 12:10:36 -05002171 struct cgroup_subsys_state *css;
Dennis Zhou2268c0f2018-12-05 12:10:29 -05002172
2173 rcu_read_lock();
2174
Dennis Zhoudb6638d2018-12-05 12:10:35 -05002175 if (bio->bi_blkg)
Dennis Zhoufc5a8282018-12-05 12:10:36 -05002176 css = &bio_blkcg(bio)->css;
Dennis Zhoudb6638d2018-12-05 12:10:35 -05002177 else
Dennis Zhoufc5a8282018-12-05 12:10:36 -05002178 css = blkcg_css();
Dennis Zhou2268c0f2018-12-05 12:10:29 -05002179
Dennis Zhoufc5a8282018-12-05 12:10:36 -05002180 bio_associate_blkg_from_css(bio, css);
Dennis Zhou2268c0f2018-12-05 12:10:29 -05002181
2182 rcu_read_unlock();
Tejun Heo852c7882012-03-05 13:15:27 -08002183}
Dennis Zhou5cdf2e32018-12-05 12:10:31 -05002184EXPORT_SYMBOL_GPL(bio_associate_blkg);
Tejun Heo852c7882012-03-05 13:15:27 -08002185
Paolo Valente20bd7232016-07-27 07:22:05 +02002186/**
Dennis Zhoudb6638d2018-12-05 12:10:35 -05002187 * bio_clone_blkg_association - clone blkg association from src to dst bio
Paolo Valente20bd7232016-07-27 07:22:05 +02002188 * @dst: destination bio
2189 * @src: source bio
2190 */
Dennis Zhoudb6638d2018-12-05 12:10:35 -05002191void bio_clone_blkg_association(struct bio *dst, struct bio *src)
Paolo Valente20bd7232016-07-27 07:22:05 +02002192{
Dennis Zhou6ab21872018-12-19 16:43:21 -06002193 rcu_read_lock();
2194
Dennis Zhoufc5a8282018-12-05 12:10:36 -05002195 if (src->bi_blkg)
Dennis Zhou2268c0f2018-12-05 12:10:29 -05002196 __bio_associate_blkg(dst, src->bi_blkg);
Dennis Zhou6ab21872018-12-19 16:43:21 -06002197
2198 rcu_read_unlock();
Paolo Valente20bd7232016-07-27 07:22:05 +02002199}
Dennis Zhoudb6638d2018-12-05 12:10:35 -05002200EXPORT_SYMBOL_GPL(bio_clone_blkg_association);
Tejun Heo852c7882012-03-05 13:15:27 -08002201#endif /* CONFIG_BLK_CGROUP */
2202
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203static void __init biovec_init_slabs(void)
2204{
2205 int i;
2206
Christoph Hellwiged996a52016-07-19 11:28:42 +02002207 for (i = 0; i < BVEC_POOL_NR; i++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002208 int size;
2209 struct biovec_slab *bvs = bvec_slabs + i;
2210
Jens Axboea7fcd372008-12-05 16:10:29 +01002211 if (bvs->nr_vecs <= BIO_INLINE_VECS) {
2212 bvs->slab = NULL;
2213 continue;
2214 }
Jens Axboea7fcd372008-12-05 16:10:29 +01002215
Linus Torvalds1da177e2005-04-16 15:20:36 -07002216 size = bvs->nr_vecs * sizeof(struct bio_vec);
2217 bvs->slab = kmem_cache_create(bvs->name, size, 0,
Paul Mundt20c2df82007-07-20 10:11:58 +09002218 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002219 }
2220}
2221
2222static int __init init_bio(void)
2223{
Jens Axboebb799ca2008-12-10 15:35:05 +01002224 bio_slab_max = 2;
2225 bio_slab_nr = 0;
Kees Cook6396bb22018-06-12 14:03:40 -07002226 bio_slabs = kcalloc(bio_slab_max, sizeof(struct bio_slab),
2227 GFP_KERNEL);
Johannes Thumshirn2b24e6f2019-04-03 11:15:19 +02002228
2229 BUILD_BUG_ON(BIO_FLAG_LAST > BVEC_POOL_OFFSET);
2230
Jens Axboebb799ca2008-12-10 15:35:05 +01002231 if (!bio_slabs)
2232 panic("bio: can't allocate bios\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002233
Martin K. Petersen7878cba2009-06-26 15:37:49 +02002234 bio_integrity_init();
Linus Torvalds1da177e2005-04-16 15:20:36 -07002235 biovec_init_slabs();
2236
Kent Overstreetf4f81542018-05-08 21:33:52 -04002237 if (bioset_init(&fs_bio_set, BIO_POOL_SIZE, 0, BIOSET_NEED_BVECS))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002238 panic("bio: can't allocate bios\n");
2239
Kent Overstreetf4f81542018-05-08 21:33:52 -04002240 if (bioset_integrity_create(&fs_bio_set, BIO_POOL_SIZE))
Martin K. Petersena91a2782011-03-17 11:11:05 +01002241 panic("bio: can't create integrity pool\n");
2242
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243 return 0;
2244}
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245subsys_initcall(init_bio);