]> git.ipfire.org Git - thirdparty/kernel/stable.git/blob - block/bio.c
badblocks: fix wrong return value in badblocks_set if badblocks are disabled
[thirdparty/kernel/stable.git] / block / bio.c
1 /*
2 * Copyright (C) 2001 Jens Axboe <axboe@kernel.dk>
3 *
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>
22 #include <linux/uio.h>
23 #include <linux/iocontext.h>
24 #include <linux/slab.h>
25 #include <linux/init.h>
26 #include <linux/kernel.h>
27 #include <linux/export.h>
28 #include <linux/mempool.h>
29 #include <linux/workqueue.h>
30 #include <linux/cgroup.h>
31
32 #include <trace/events/block.h>
33 #include "blk.h"
34
35 /*
36 * Test patch to inline a certain number of bi_io_vec's inside the bio
37 * itself, to shrink a bio data allocation from two mempool calls to one
38 */
39 #define BIO_INLINE_VECS 4
40
41 /*
42 * if you change this list, also change bvec_alloc or things will
43 * break badly! cannot be bigger than what you can fit into an
44 * unsigned short
45 */
46 #define BV(x) { .nr_vecs = x, .name = "biovec-"__stringify(x) }
47 static struct biovec_slab bvec_slabs[BVEC_POOL_NR] __read_mostly = {
48 BV(1), BV(4), BV(16), BV(64), BV(128), BV(BIO_MAX_PAGES),
49 };
50 #undef BV
51
52 /*
53 * fs_bio_set is the bio_set containing bio and iovec memory pools used by
54 * IO code that does not need private memory pools.
55 */
56 struct bio_set *fs_bio_set;
57 EXPORT_SYMBOL(fs_bio_set);
58
59 /*
60 * Our slab pool management
61 */
62 struct bio_slab {
63 struct kmem_cache *slab;
64 unsigned int slab_ref;
65 unsigned int slab_size;
66 char name[8];
67 };
68 static DEFINE_MUTEX(bio_slab_lock);
69 static struct bio_slab *bio_slabs;
70 static unsigned int bio_slab_nr, bio_slab_max;
71
72 static struct kmem_cache *bio_find_or_create_slab(unsigned int extra_size)
73 {
74 unsigned int sz = sizeof(struct bio) + extra_size;
75 struct kmem_cache *slab = NULL;
76 struct bio_slab *bslab, *new_bio_slabs;
77 unsigned int new_bio_slab_max;
78 unsigned int i, entry = -1;
79
80 mutex_lock(&bio_slab_lock);
81
82 i = 0;
83 while (i < bio_slab_nr) {
84 bslab = &bio_slabs[i];
85
86 if (!bslab->slab && entry == -1)
87 entry = i;
88 else if (bslab->slab_size == sz) {
89 slab = bslab->slab;
90 bslab->slab_ref++;
91 break;
92 }
93 i++;
94 }
95
96 if (slab)
97 goto out_unlock;
98
99 if (bio_slab_nr == bio_slab_max && entry == -1) {
100 new_bio_slab_max = bio_slab_max << 1;
101 new_bio_slabs = krealloc(bio_slabs,
102 new_bio_slab_max * sizeof(struct bio_slab),
103 GFP_KERNEL);
104 if (!new_bio_slabs)
105 goto out_unlock;
106 bio_slab_max = new_bio_slab_max;
107 bio_slabs = new_bio_slabs;
108 }
109 if (entry == -1)
110 entry = bio_slab_nr++;
111
112 bslab = &bio_slabs[entry];
113
114 snprintf(bslab->name, sizeof(bslab->name), "bio-%d", entry);
115 slab = kmem_cache_create(bslab->name, sz, ARCH_KMALLOC_MINALIGN,
116 SLAB_HWCACHE_ALIGN, NULL);
117 if (!slab)
118 goto out_unlock;
119
120 bslab->slab = slab;
121 bslab->slab_ref = 1;
122 bslab->slab_size = sz;
123 out_unlock:
124 mutex_unlock(&bio_slab_lock);
125 return slab;
126 }
127
128 static void bio_put_slab(struct bio_set *bs)
129 {
130 struct bio_slab *bslab = NULL;
131 unsigned int i;
132
133 mutex_lock(&bio_slab_lock);
134
135 for (i = 0; i < bio_slab_nr; i++) {
136 if (bs->bio_slab == bio_slabs[i].slab) {
137 bslab = &bio_slabs[i];
138 break;
139 }
140 }
141
142 if (WARN(!bslab, KERN_ERR "bio: unable to find slab!\n"))
143 goto out;
144
145 WARN_ON(!bslab->slab_ref);
146
147 if (--bslab->slab_ref)
148 goto out;
149
150 kmem_cache_destroy(bslab->slab);
151 bslab->slab = NULL;
152
153 out:
154 mutex_unlock(&bio_slab_lock);
155 }
156
157 unsigned int bvec_nr_vecs(unsigned short idx)
158 {
159 return bvec_slabs[idx].nr_vecs;
160 }
161
162 void bvec_free(mempool_t *pool, struct bio_vec *bv, unsigned int idx)
163 {
164 if (!idx)
165 return;
166 idx--;
167
168 BIO_BUG_ON(idx >= BVEC_POOL_NR);
169
170 if (idx == BVEC_POOL_MAX) {
171 mempool_free(bv, pool);
172 } else {
173 struct biovec_slab *bvs = bvec_slabs + idx;
174
175 kmem_cache_free(bvs->slab, bv);
176 }
177 }
178
179 struct bio_vec *bvec_alloc(gfp_t gfp_mask, int nr, unsigned long *idx,
180 mempool_t *pool)
181 {
182 struct bio_vec *bvl;
183
184 /*
185 * see comment near bvec_array define!
186 */
187 switch (nr) {
188 case 1:
189 *idx = 0;
190 break;
191 case 2 ... 4:
192 *idx = 1;
193 break;
194 case 5 ... 16:
195 *idx = 2;
196 break;
197 case 17 ... 64:
198 *idx = 3;
199 break;
200 case 65 ... 128:
201 *idx = 4;
202 break;
203 case 129 ... BIO_MAX_PAGES:
204 *idx = 5;
205 break;
206 default:
207 return NULL;
208 }
209
210 /*
211 * idx now points to the pool we want to allocate from. only the
212 * 1-vec entry pool is mempool backed.
213 */
214 if (*idx == BVEC_POOL_MAX) {
215 fallback:
216 bvl = mempool_alloc(pool, gfp_mask);
217 } else {
218 struct biovec_slab *bvs = bvec_slabs + *idx;
219 gfp_t __gfp_mask = gfp_mask & ~(__GFP_DIRECT_RECLAIM | __GFP_IO);
220
221 /*
222 * Make this allocation restricted and don't dump info on
223 * allocation failures, since we'll fallback to the mempool
224 * in case of failure.
225 */
226 __gfp_mask |= __GFP_NOMEMALLOC | __GFP_NORETRY | __GFP_NOWARN;
227
228 /*
229 * Try a slab allocation. If this fails and __GFP_DIRECT_RECLAIM
230 * is set, retry with the 1-entry mempool
231 */
232 bvl = kmem_cache_alloc(bvs->slab, __gfp_mask);
233 if (unlikely(!bvl && (gfp_mask & __GFP_DIRECT_RECLAIM))) {
234 *idx = BVEC_POOL_MAX;
235 goto fallback;
236 }
237 }
238
239 (*idx)++;
240 return bvl;
241 }
242
243 void bio_uninit(struct bio *bio)
244 {
245 bio_disassociate_task(bio);
246 }
247 EXPORT_SYMBOL(bio_uninit);
248
249 static void bio_free(struct bio *bio)
250 {
251 struct bio_set *bs = bio->bi_pool;
252 void *p;
253
254 bio_uninit(bio);
255
256 if (bs) {
257 bvec_free(bs->bvec_pool, bio->bi_io_vec, BVEC_POOL_IDX(bio));
258
259 /*
260 * If we have front padding, adjust the bio pointer before freeing
261 */
262 p = bio;
263 p -= bs->front_pad;
264
265 mempool_free(p, bs->bio_pool);
266 } else {
267 /* Bio was allocated by bio_kmalloc() */
268 kfree(bio);
269 }
270 }
271
272 /*
273 * Users of this function have their own bio allocation. Subsequently,
274 * they must remember to pair any call to bio_init() with bio_uninit()
275 * when IO has completed, or when the bio is released.
276 */
277 void bio_init(struct bio *bio, struct bio_vec *table,
278 unsigned short max_vecs)
279 {
280 memset(bio, 0, sizeof(*bio));
281 atomic_set(&bio->__bi_remaining, 1);
282 atomic_set(&bio->__bi_cnt, 1);
283
284 bio->bi_io_vec = table;
285 bio->bi_max_vecs = max_vecs;
286 }
287 EXPORT_SYMBOL(bio_init);
288
289 /**
290 * bio_reset - reinitialize a bio
291 * @bio: bio to reset
292 *
293 * Description:
294 * After calling bio_reset(), @bio will be in the same state as a freshly
295 * allocated bio returned bio bio_alloc_bioset() - the only fields that are
296 * preserved are the ones that are initialized by bio_alloc_bioset(). See
297 * comment in struct bio.
298 */
299 void bio_reset(struct bio *bio)
300 {
301 unsigned long flags = bio->bi_flags & (~0UL << BIO_RESET_BITS);
302
303 bio_uninit(bio);
304
305 memset(bio, 0, BIO_RESET_BYTES);
306 bio->bi_flags = flags;
307 atomic_set(&bio->__bi_remaining, 1);
308 }
309 EXPORT_SYMBOL(bio_reset);
310
311 static struct bio *__bio_chain_endio(struct bio *bio)
312 {
313 struct bio *parent = bio->bi_private;
314
315 if (!parent->bi_status)
316 parent->bi_status = bio->bi_status;
317 bio_put(bio);
318 return parent;
319 }
320
321 static void bio_chain_endio(struct bio *bio)
322 {
323 bio_endio(__bio_chain_endio(bio));
324 }
325
326 /**
327 * bio_chain - chain bio completions
328 * @bio: the target bio
329 * @parent: the @bio's parent bio
330 *
331 * The caller won't have a bi_end_io called when @bio completes - instead,
332 * @parent's bi_end_io won't be called until both @parent and @bio have
333 * completed; the chained bio will also be freed when it completes.
334 *
335 * The caller must not set bi_private or bi_end_io in @bio.
336 */
337 void bio_chain(struct bio *bio, struct bio *parent)
338 {
339 BUG_ON(bio->bi_private || bio->bi_end_io);
340
341 bio->bi_private = parent;
342 bio->bi_end_io = bio_chain_endio;
343 bio_inc_remaining(parent);
344 }
345 EXPORT_SYMBOL(bio_chain);
346
347 static void bio_alloc_rescue(struct work_struct *work)
348 {
349 struct bio_set *bs = container_of(work, struct bio_set, rescue_work);
350 struct bio *bio;
351
352 while (1) {
353 spin_lock(&bs->rescue_lock);
354 bio = bio_list_pop(&bs->rescue_list);
355 spin_unlock(&bs->rescue_lock);
356
357 if (!bio)
358 break;
359
360 generic_make_request(bio);
361 }
362 }
363
364 static void punt_bios_to_rescuer(struct bio_set *bs)
365 {
366 struct bio_list punt, nopunt;
367 struct bio *bio;
368
369 if (WARN_ON_ONCE(!bs->rescue_workqueue))
370 return;
371 /*
372 * In order to guarantee forward progress we must punt only bios that
373 * were allocated from this bio_set; otherwise, if there was a bio on
374 * there for a stacking driver higher up in the stack, processing it
375 * could require allocating bios from this bio_set, and doing that from
376 * our own rescuer would be bad.
377 *
378 * Since bio lists are singly linked, pop them all instead of trying to
379 * remove from the middle of the list:
380 */
381
382 bio_list_init(&punt);
383 bio_list_init(&nopunt);
384
385 while ((bio = bio_list_pop(&current->bio_list[0])))
386 bio_list_add(bio->bi_pool == bs ? &punt : &nopunt, bio);
387 current->bio_list[0] = nopunt;
388
389 bio_list_init(&nopunt);
390 while ((bio = bio_list_pop(&current->bio_list[1])))
391 bio_list_add(bio->bi_pool == bs ? &punt : &nopunt, bio);
392 current->bio_list[1] = nopunt;
393
394 spin_lock(&bs->rescue_lock);
395 bio_list_merge(&bs->rescue_list, &punt);
396 spin_unlock(&bs->rescue_lock);
397
398 queue_work(bs->rescue_workqueue, &bs->rescue_work);
399 }
400
401 /**
402 * bio_alloc_bioset - allocate a bio for I/O
403 * @gfp_mask: the GFP_ mask given to the slab allocator
404 * @nr_iovecs: number of iovecs to pre-allocate
405 * @bs: the bio_set to allocate from.
406 *
407 * Description:
408 * If @bs is NULL, uses kmalloc() to allocate the bio; else the allocation is
409 * backed by the @bs's mempool.
410 *
411 * When @bs is not NULL, if %__GFP_DIRECT_RECLAIM is set then bio_alloc will
412 * always be able to allocate a bio. This is due to the mempool guarantees.
413 * To make this work, callers must never allocate more than 1 bio at a time
414 * from this pool. Callers that need to allocate more than 1 bio must always
415 * submit the previously allocated bio for IO before attempting to allocate
416 * a new one. Failure to do so can cause deadlocks under memory pressure.
417 *
418 * Note that when running under generic_make_request() (i.e. any block
419 * driver), bios are not submitted until after you return - see the code in
420 * generic_make_request() that converts recursion into iteration, to prevent
421 * stack overflows.
422 *
423 * This would normally mean allocating multiple bios under
424 * generic_make_request() would be susceptible to deadlocks, but we have
425 * deadlock avoidance code that resubmits any blocked bios from a rescuer
426 * thread.
427 *
428 * However, we do not guarantee forward progress for allocations from other
429 * mempools. Doing multiple allocations from the same mempool under
430 * generic_make_request() should be avoided - instead, use bio_set's front_pad
431 * for per bio allocations.
432 *
433 * RETURNS:
434 * Pointer to new bio on success, NULL on failure.
435 */
436 struct bio *bio_alloc_bioset(gfp_t gfp_mask, unsigned int nr_iovecs,
437 struct bio_set *bs)
438 {
439 gfp_t saved_gfp = gfp_mask;
440 unsigned front_pad;
441 unsigned inline_vecs;
442 struct bio_vec *bvl = NULL;
443 struct bio *bio;
444 void *p;
445
446 if (!bs) {
447 if (nr_iovecs > UIO_MAXIOV)
448 return NULL;
449
450 p = kmalloc(sizeof(struct bio) +
451 nr_iovecs * sizeof(struct bio_vec),
452 gfp_mask);
453 front_pad = 0;
454 inline_vecs = nr_iovecs;
455 } else {
456 /* should not use nobvec bioset for nr_iovecs > 0 */
457 if (WARN_ON_ONCE(!bs->bvec_pool && nr_iovecs > 0))
458 return NULL;
459 /*
460 * generic_make_request() converts recursion to iteration; this
461 * means if we're running beneath it, any bios we allocate and
462 * submit will not be submitted (and thus freed) until after we
463 * return.
464 *
465 * This exposes us to a potential deadlock if we allocate
466 * multiple bios from the same bio_set() while running
467 * underneath generic_make_request(). If we were to allocate
468 * multiple bios (say a stacking block driver that was splitting
469 * bios), we would deadlock if we exhausted the mempool's
470 * reserve.
471 *
472 * We solve this, and guarantee forward progress, with a rescuer
473 * workqueue per bio_set. If we go to allocate and there are
474 * bios on current->bio_list, we first try the allocation
475 * without __GFP_DIRECT_RECLAIM; if that fails, we punt those
476 * bios we would be blocking to the rescuer workqueue before
477 * we retry with the original gfp_flags.
478 */
479
480 if (current->bio_list &&
481 (!bio_list_empty(&current->bio_list[0]) ||
482 !bio_list_empty(&current->bio_list[1])) &&
483 bs->rescue_workqueue)
484 gfp_mask &= ~__GFP_DIRECT_RECLAIM;
485
486 p = mempool_alloc(bs->bio_pool, gfp_mask);
487 if (!p && gfp_mask != saved_gfp) {
488 punt_bios_to_rescuer(bs);
489 gfp_mask = saved_gfp;
490 p = mempool_alloc(bs->bio_pool, gfp_mask);
491 }
492
493 front_pad = bs->front_pad;
494 inline_vecs = BIO_INLINE_VECS;
495 }
496
497 if (unlikely(!p))
498 return NULL;
499
500 bio = p + front_pad;
501 bio_init(bio, NULL, 0);
502
503 if (nr_iovecs > inline_vecs) {
504 unsigned long idx = 0;
505
506 bvl = bvec_alloc(gfp_mask, nr_iovecs, &idx, bs->bvec_pool);
507 if (!bvl && gfp_mask != saved_gfp) {
508 punt_bios_to_rescuer(bs);
509 gfp_mask = saved_gfp;
510 bvl = bvec_alloc(gfp_mask, nr_iovecs, &idx, bs->bvec_pool);
511 }
512
513 if (unlikely(!bvl))
514 goto err_free;
515
516 bio->bi_flags |= idx << BVEC_POOL_OFFSET;
517 } else if (nr_iovecs) {
518 bvl = bio->bi_inline_vecs;
519 }
520
521 bio->bi_pool = bs;
522 bio->bi_max_vecs = nr_iovecs;
523 bio->bi_io_vec = bvl;
524 return bio;
525
526 err_free:
527 mempool_free(p, bs->bio_pool);
528 return NULL;
529 }
530 EXPORT_SYMBOL(bio_alloc_bioset);
531
532 void zero_fill_bio(struct bio *bio)
533 {
534 unsigned long flags;
535 struct bio_vec bv;
536 struct bvec_iter iter;
537
538 bio_for_each_segment(bv, bio, iter) {
539 char *data = bvec_kmap_irq(&bv, &flags);
540 memset(data, 0, bv.bv_len);
541 flush_dcache_page(bv.bv_page);
542 bvec_kunmap_irq(data, &flags);
543 }
544 }
545 EXPORT_SYMBOL(zero_fill_bio);
546
547 /**
548 * bio_put - release a reference to a bio
549 * @bio: bio to release reference to
550 *
551 * Description:
552 * Put a reference to a &struct bio, either one you have gotten with
553 * bio_alloc, bio_get or bio_clone_*. The last put of a bio will free it.
554 **/
555 void bio_put(struct bio *bio)
556 {
557 if (!bio_flagged(bio, BIO_REFFED))
558 bio_free(bio);
559 else {
560 BIO_BUG_ON(!atomic_read(&bio->__bi_cnt));
561
562 /*
563 * last put frees it
564 */
565 if (atomic_dec_and_test(&bio->__bi_cnt))
566 bio_free(bio);
567 }
568 }
569 EXPORT_SYMBOL(bio_put);
570
571 inline int bio_phys_segments(struct request_queue *q, struct bio *bio)
572 {
573 if (unlikely(!bio_flagged(bio, BIO_SEG_VALID)))
574 blk_recount_segments(q, bio);
575
576 return bio->bi_phys_segments;
577 }
578 EXPORT_SYMBOL(bio_phys_segments);
579
580 /**
581 * __bio_clone_fast - clone a bio that shares the original bio's biovec
582 * @bio: destination bio
583 * @bio_src: bio to clone
584 *
585 * Clone a &bio. Caller will own the returned bio, but not
586 * the actual data it points to. Reference count of returned
587 * bio will be one.
588 *
589 * Caller must ensure that @bio_src is not freed before @bio.
590 */
591 void __bio_clone_fast(struct bio *bio, struct bio *bio_src)
592 {
593 BUG_ON(bio->bi_pool && BVEC_POOL_IDX(bio));
594
595 /*
596 * most users will be overriding ->bi_disk with a new target,
597 * so we don't set nor calculate new physical/hw segment counts here
598 */
599 bio->bi_disk = bio_src->bi_disk;
600 bio->bi_partno = bio_src->bi_partno;
601 bio_set_flag(bio, BIO_CLONED);
602 bio->bi_opf = bio_src->bi_opf;
603 bio->bi_write_hint = bio_src->bi_write_hint;
604 bio->bi_iter = bio_src->bi_iter;
605 bio->bi_io_vec = bio_src->bi_io_vec;
606
607 bio_clone_blkcg_association(bio, bio_src);
608 }
609 EXPORT_SYMBOL(__bio_clone_fast);
610
611 /**
612 * bio_clone_fast - clone a bio that shares the original bio's biovec
613 * @bio: bio to clone
614 * @gfp_mask: allocation priority
615 * @bs: bio_set to allocate from
616 *
617 * Like __bio_clone_fast, only also allocates the returned bio
618 */
619 struct bio *bio_clone_fast(struct bio *bio, gfp_t gfp_mask, struct bio_set *bs)
620 {
621 struct bio *b;
622
623 b = bio_alloc_bioset(gfp_mask, 0, bs);
624 if (!b)
625 return NULL;
626
627 __bio_clone_fast(b, bio);
628
629 if (bio_integrity(bio)) {
630 int ret;
631
632 ret = bio_integrity_clone(b, bio, gfp_mask);
633
634 if (ret < 0) {
635 bio_put(b);
636 return NULL;
637 }
638 }
639
640 return b;
641 }
642 EXPORT_SYMBOL(bio_clone_fast);
643
644 /**
645 * bio_clone_bioset - clone a bio
646 * @bio_src: bio to clone
647 * @gfp_mask: allocation priority
648 * @bs: bio_set to allocate from
649 *
650 * Clone bio. Caller will own the returned bio, but not the actual data it
651 * points to. Reference count of returned bio will be one.
652 */
653 struct bio *bio_clone_bioset(struct bio *bio_src, gfp_t gfp_mask,
654 struct bio_set *bs)
655 {
656 struct bvec_iter iter;
657 struct bio_vec bv;
658 struct bio *bio;
659
660 /*
661 * Pre immutable biovecs, __bio_clone() used to just do a memcpy from
662 * bio_src->bi_io_vec to bio->bi_io_vec.
663 *
664 * We can't do that anymore, because:
665 *
666 * - The point of cloning the biovec is to produce a bio with a biovec
667 * the caller can modify: bi_idx and bi_bvec_done should be 0.
668 *
669 * - The original bio could've had more than BIO_MAX_PAGES biovecs; if
670 * we tried to clone the whole thing bio_alloc_bioset() would fail.
671 * But the clone should succeed as long as the number of biovecs we
672 * actually need to allocate is fewer than BIO_MAX_PAGES.
673 *
674 * - Lastly, bi_vcnt should not be looked at or relied upon by code
675 * that does not own the bio - reason being drivers don't use it for
676 * iterating over the biovec anymore, so expecting it to be kept up
677 * to date (i.e. for clones that share the parent biovec) is just
678 * asking for trouble and would force extra work on
679 * __bio_clone_fast() anyways.
680 */
681
682 bio = bio_alloc_bioset(gfp_mask, bio_segments(bio_src), bs);
683 if (!bio)
684 return NULL;
685 bio->bi_disk = bio_src->bi_disk;
686 bio->bi_opf = bio_src->bi_opf;
687 bio->bi_write_hint = bio_src->bi_write_hint;
688 bio->bi_iter.bi_sector = bio_src->bi_iter.bi_sector;
689 bio->bi_iter.bi_size = bio_src->bi_iter.bi_size;
690
691 switch (bio_op(bio)) {
692 case REQ_OP_DISCARD:
693 case REQ_OP_SECURE_ERASE:
694 case REQ_OP_WRITE_ZEROES:
695 break;
696 case REQ_OP_WRITE_SAME:
697 bio->bi_io_vec[bio->bi_vcnt++] = bio_src->bi_io_vec[0];
698 break;
699 default:
700 bio_for_each_segment(bv, bio_src, iter)
701 bio->bi_io_vec[bio->bi_vcnt++] = bv;
702 break;
703 }
704
705 if (bio_integrity(bio_src)) {
706 int ret;
707
708 ret = bio_integrity_clone(bio, bio_src, gfp_mask);
709 if (ret < 0) {
710 bio_put(bio);
711 return NULL;
712 }
713 }
714
715 bio_clone_blkcg_association(bio, bio_src);
716
717 return bio;
718 }
719 EXPORT_SYMBOL(bio_clone_bioset);
720
721 /**
722 * bio_add_pc_page - attempt to add page to bio
723 * @q: the target queue
724 * @bio: destination bio
725 * @page: page to add
726 * @len: vec entry length
727 * @offset: vec entry offset
728 *
729 * Attempt to add a page to the bio_vec maplist. This can fail for a
730 * number of reasons, such as the bio being full or target block device
731 * limitations. The target block device must allow bio's up to PAGE_SIZE,
732 * so it is always possible to add a single page to an empty bio.
733 *
734 * This should only be used by REQ_PC bios.
735 */
736 int bio_add_pc_page(struct request_queue *q, struct bio *bio, struct page
737 *page, unsigned int len, unsigned int offset)
738 {
739 int retried_segments = 0;
740 struct bio_vec *bvec;
741
742 /*
743 * cloned bio must not modify vec list
744 */
745 if (unlikely(bio_flagged(bio, BIO_CLONED)))
746 return 0;
747
748 if (((bio->bi_iter.bi_size + len) >> 9) > queue_max_hw_sectors(q))
749 return 0;
750
751 /*
752 * For filesystems with a blocksize smaller than the pagesize
753 * we will often be called with the same page as last time and
754 * a consecutive offset. Optimize this special case.
755 */
756 if (bio->bi_vcnt > 0) {
757 struct bio_vec *prev = &bio->bi_io_vec[bio->bi_vcnt - 1];
758
759 if (page == prev->bv_page &&
760 offset == prev->bv_offset + prev->bv_len) {
761 prev->bv_len += len;
762 bio->bi_iter.bi_size += len;
763 goto done;
764 }
765
766 /*
767 * If the queue doesn't support SG gaps and adding this
768 * offset would create a gap, disallow it.
769 */
770 if (bvec_gap_to_prev(q, prev, offset))
771 return 0;
772 }
773
774 if (bio->bi_vcnt >= bio->bi_max_vecs)
775 return 0;
776
777 /*
778 * setup the new entry, we might clear it again later if we
779 * cannot add the page
780 */
781 bvec = &bio->bi_io_vec[bio->bi_vcnt];
782 bvec->bv_page = page;
783 bvec->bv_len = len;
784 bvec->bv_offset = offset;
785 bio->bi_vcnt++;
786 bio->bi_phys_segments++;
787 bio->bi_iter.bi_size += len;
788
789 /*
790 * Perform a recount if the number of segments is greater
791 * than queue_max_segments(q).
792 */
793
794 while (bio->bi_phys_segments > queue_max_segments(q)) {
795
796 if (retried_segments)
797 goto failed;
798
799 retried_segments = 1;
800 blk_recount_segments(q, bio);
801 }
802
803 /* If we may be able to merge these biovecs, force a recount */
804 if (bio->bi_vcnt > 1 && (BIOVEC_PHYS_MERGEABLE(bvec-1, bvec)))
805 bio_clear_flag(bio, BIO_SEG_VALID);
806
807 done:
808 return len;
809
810 failed:
811 bvec->bv_page = NULL;
812 bvec->bv_len = 0;
813 bvec->bv_offset = 0;
814 bio->bi_vcnt--;
815 bio->bi_iter.bi_size -= len;
816 blk_recount_segments(q, bio);
817 return 0;
818 }
819 EXPORT_SYMBOL(bio_add_pc_page);
820
821 /**
822 * bio_add_page - attempt to add page to bio
823 * @bio: destination bio
824 * @page: page to add
825 * @len: vec entry length
826 * @offset: vec entry offset
827 *
828 * Attempt to add a page to the bio_vec maplist. This will only fail
829 * if either bio->bi_vcnt == bio->bi_max_vecs or it's a cloned bio.
830 */
831 int bio_add_page(struct bio *bio, struct page *page,
832 unsigned int len, unsigned int offset)
833 {
834 struct bio_vec *bv;
835
836 /*
837 * cloned bio must not modify vec list
838 */
839 if (WARN_ON_ONCE(bio_flagged(bio, BIO_CLONED)))
840 return 0;
841
842 /*
843 * For filesystems with a blocksize smaller than the pagesize
844 * we will often be called with the same page as last time and
845 * a consecutive offset. Optimize this special case.
846 */
847 if (bio->bi_vcnt > 0) {
848 bv = &bio->bi_io_vec[bio->bi_vcnt - 1];
849
850 if (page == bv->bv_page &&
851 offset == bv->bv_offset + bv->bv_len) {
852 bv->bv_len += len;
853 goto done;
854 }
855 }
856
857 if (bio->bi_vcnt >= bio->bi_max_vecs)
858 return 0;
859
860 bv = &bio->bi_io_vec[bio->bi_vcnt];
861 bv->bv_page = page;
862 bv->bv_len = len;
863 bv->bv_offset = offset;
864
865 bio->bi_vcnt++;
866 done:
867 bio->bi_iter.bi_size += len;
868 return len;
869 }
870 EXPORT_SYMBOL(bio_add_page);
871
872 /**
873 * bio_iov_iter_get_pages - pin user or kernel pages and add them to a bio
874 * @bio: bio to add pages to
875 * @iter: iov iterator describing the region to be mapped
876 *
877 * Pins as many pages from *iter and appends them to @bio's bvec array. The
878 * pages will have to be released using put_page() when done.
879 */
880 int bio_iov_iter_get_pages(struct bio *bio, struct iov_iter *iter)
881 {
882 unsigned short nr_pages = bio->bi_max_vecs - bio->bi_vcnt;
883 struct bio_vec *bv = bio->bi_io_vec + bio->bi_vcnt;
884 struct page **pages = (struct page **)bv;
885 size_t offset, diff;
886 ssize_t size;
887
888 size = iov_iter_get_pages(iter, pages, LONG_MAX, nr_pages, &offset);
889 if (unlikely(size <= 0))
890 return size ? size : -EFAULT;
891 nr_pages = (size + offset + PAGE_SIZE - 1) / PAGE_SIZE;
892
893 /*
894 * Deep magic below: We need to walk the pinned pages backwards
895 * because we are abusing the space allocated for the bio_vecs
896 * for the page array. Because the bio_vecs are larger than the
897 * page pointers by definition this will always work. But it also
898 * means we can't use bio_add_page, so any changes to it's semantics
899 * need to be reflected here as well.
900 */
901 bio->bi_iter.bi_size += size;
902 bio->bi_vcnt += nr_pages;
903
904 diff = (nr_pages * PAGE_SIZE - offset) - size;
905 while (nr_pages--) {
906 bv[nr_pages].bv_page = pages[nr_pages];
907 bv[nr_pages].bv_len = PAGE_SIZE;
908 bv[nr_pages].bv_offset = 0;
909 }
910
911 bv[0].bv_offset += offset;
912 bv[0].bv_len -= offset;
913 if (diff)
914 bv[bio->bi_vcnt - 1].bv_len -= diff;
915
916 iov_iter_advance(iter, size);
917 return 0;
918 }
919 EXPORT_SYMBOL_GPL(bio_iov_iter_get_pages);
920
921 struct submit_bio_ret {
922 struct completion event;
923 int error;
924 };
925
926 static void submit_bio_wait_endio(struct bio *bio)
927 {
928 struct submit_bio_ret *ret = bio->bi_private;
929
930 ret->error = blk_status_to_errno(bio->bi_status);
931 complete(&ret->event);
932 }
933
934 /**
935 * submit_bio_wait - submit a bio, and wait until it completes
936 * @bio: The &struct bio which describes the I/O
937 *
938 * Simple wrapper around submit_bio(). Returns 0 on success, or the error from
939 * bio_endio() on failure.
940 *
941 * WARNING: Unlike to how submit_bio() is usually used, this function does not
942 * result in bio reference to be consumed. The caller must drop the reference
943 * on his own.
944 */
945 int submit_bio_wait(struct bio *bio)
946 {
947 struct submit_bio_ret ret;
948
949 init_completion(&ret.event);
950 bio->bi_private = &ret;
951 bio->bi_end_io = submit_bio_wait_endio;
952 bio->bi_opf |= REQ_SYNC;
953 submit_bio(bio);
954 wait_for_completion_io(&ret.event);
955
956 return ret.error;
957 }
958 EXPORT_SYMBOL(submit_bio_wait);
959
960 /**
961 * bio_advance - increment/complete a bio by some number of bytes
962 * @bio: bio to advance
963 * @bytes: number of bytes to complete
964 *
965 * This updates bi_sector, bi_size and bi_idx; if the number of bytes to
966 * complete doesn't align with a bvec boundary, then bv_len and bv_offset will
967 * be updated on the last bvec as well.
968 *
969 * @bio will then represent the remaining, uncompleted portion of the io.
970 */
971 void bio_advance(struct bio *bio, unsigned bytes)
972 {
973 if (bio_integrity(bio))
974 bio_integrity_advance(bio, bytes);
975
976 bio_advance_iter(bio, &bio->bi_iter, bytes);
977 }
978 EXPORT_SYMBOL(bio_advance);
979
980 /**
981 * bio_alloc_pages - allocates a single page for each bvec in a bio
982 * @bio: bio to allocate pages for
983 * @gfp_mask: flags for allocation
984 *
985 * Allocates pages up to @bio->bi_vcnt.
986 *
987 * Returns 0 on success, -ENOMEM on failure. On failure, any allocated pages are
988 * freed.
989 */
990 int bio_alloc_pages(struct bio *bio, gfp_t gfp_mask)
991 {
992 int i;
993 struct bio_vec *bv;
994
995 bio_for_each_segment_all(bv, bio, i) {
996 bv->bv_page = alloc_page(gfp_mask);
997 if (!bv->bv_page) {
998 while (--bv >= bio->bi_io_vec)
999 __free_page(bv->bv_page);
1000 return -ENOMEM;
1001 }
1002 }
1003
1004 return 0;
1005 }
1006 EXPORT_SYMBOL(bio_alloc_pages);
1007
1008 /**
1009 * bio_copy_data - copy contents of data buffers from one chain of bios to
1010 * another
1011 * @src: source bio list
1012 * @dst: destination bio list
1013 *
1014 * If @src and @dst are single bios, bi_next must be NULL - otherwise, treats
1015 * @src and @dst as linked lists of bios.
1016 *
1017 * Stops when it reaches the end of either @src or @dst - that is, copies
1018 * min(src->bi_size, dst->bi_size) bytes (or the equivalent for lists of bios).
1019 */
1020 void bio_copy_data(struct bio *dst, struct bio *src)
1021 {
1022 struct bvec_iter src_iter, dst_iter;
1023 struct bio_vec src_bv, dst_bv;
1024 void *src_p, *dst_p;
1025 unsigned bytes;
1026
1027 src_iter = src->bi_iter;
1028 dst_iter = dst->bi_iter;
1029
1030 while (1) {
1031 if (!src_iter.bi_size) {
1032 src = src->bi_next;
1033 if (!src)
1034 break;
1035
1036 src_iter = src->bi_iter;
1037 }
1038
1039 if (!dst_iter.bi_size) {
1040 dst = dst->bi_next;
1041 if (!dst)
1042 break;
1043
1044 dst_iter = dst->bi_iter;
1045 }
1046
1047 src_bv = bio_iter_iovec(src, src_iter);
1048 dst_bv = bio_iter_iovec(dst, dst_iter);
1049
1050 bytes = min(src_bv.bv_len, dst_bv.bv_len);
1051
1052 src_p = kmap_atomic(src_bv.bv_page);
1053 dst_p = kmap_atomic(dst_bv.bv_page);
1054
1055 memcpy(dst_p + dst_bv.bv_offset,
1056 src_p + src_bv.bv_offset,
1057 bytes);
1058
1059 kunmap_atomic(dst_p);
1060 kunmap_atomic(src_p);
1061
1062 bio_advance_iter(src, &src_iter, bytes);
1063 bio_advance_iter(dst, &dst_iter, bytes);
1064 }
1065 }
1066 EXPORT_SYMBOL(bio_copy_data);
1067
1068 struct bio_map_data {
1069 int is_our_pages;
1070 struct iov_iter iter;
1071 struct iovec iov[];
1072 };
1073
1074 static struct bio_map_data *bio_alloc_map_data(unsigned int iov_count,
1075 gfp_t gfp_mask)
1076 {
1077 if (iov_count > UIO_MAXIOV)
1078 return NULL;
1079
1080 return kmalloc(sizeof(struct bio_map_data) +
1081 sizeof(struct iovec) * iov_count, gfp_mask);
1082 }
1083
1084 /**
1085 * bio_copy_from_iter - copy all pages from iov_iter to bio
1086 * @bio: The &struct bio which describes the I/O as destination
1087 * @iter: iov_iter as source
1088 *
1089 * Copy all pages from iov_iter to bio.
1090 * Returns 0 on success, or error on failure.
1091 */
1092 static int bio_copy_from_iter(struct bio *bio, struct iov_iter iter)
1093 {
1094 int i;
1095 struct bio_vec *bvec;
1096
1097 bio_for_each_segment_all(bvec, bio, i) {
1098 ssize_t ret;
1099
1100 ret = copy_page_from_iter(bvec->bv_page,
1101 bvec->bv_offset,
1102 bvec->bv_len,
1103 &iter);
1104
1105 if (!iov_iter_count(&iter))
1106 break;
1107
1108 if (ret < bvec->bv_len)
1109 return -EFAULT;
1110 }
1111
1112 return 0;
1113 }
1114
1115 /**
1116 * bio_copy_to_iter - copy all pages from bio to iov_iter
1117 * @bio: The &struct bio which describes the I/O as source
1118 * @iter: iov_iter as destination
1119 *
1120 * Copy all pages from bio to iov_iter.
1121 * Returns 0 on success, or error on failure.
1122 */
1123 static int bio_copy_to_iter(struct bio *bio, struct iov_iter iter)
1124 {
1125 int i;
1126 struct bio_vec *bvec;
1127
1128 bio_for_each_segment_all(bvec, bio, i) {
1129 ssize_t ret;
1130
1131 ret = copy_page_to_iter(bvec->bv_page,
1132 bvec->bv_offset,
1133 bvec->bv_len,
1134 &iter);
1135
1136 if (!iov_iter_count(&iter))
1137 break;
1138
1139 if (ret < bvec->bv_len)
1140 return -EFAULT;
1141 }
1142
1143 return 0;
1144 }
1145
1146 void bio_free_pages(struct bio *bio)
1147 {
1148 struct bio_vec *bvec;
1149 int i;
1150
1151 bio_for_each_segment_all(bvec, bio, i)
1152 __free_page(bvec->bv_page);
1153 }
1154 EXPORT_SYMBOL(bio_free_pages);
1155
1156 /**
1157 * bio_uncopy_user - finish previously mapped bio
1158 * @bio: bio being terminated
1159 *
1160 * Free pages allocated from bio_copy_user_iov() and write back data
1161 * to user space in case of a read.
1162 */
1163 int bio_uncopy_user(struct bio *bio)
1164 {
1165 struct bio_map_data *bmd = bio->bi_private;
1166 int ret = 0;
1167
1168 if (!bio_flagged(bio, BIO_NULL_MAPPED)) {
1169 /*
1170 * if we're in a workqueue, the request is orphaned, so
1171 * don't copy into a random user address space, just free
1172 * and return -EINTR so user space doesn't expect any data.
1173 */
1174 if (!current->mm)
1175 ret = -EINTR;
1176 else if (bio_data_dir(bio) == READ)
1177 ret = bio_copy_to_iter(bio, bmd->iter);
1178 if (bmd->is_our_pages)
1179 bio_free_pages(bio);
1180 }
1181 kfree(bmd);
1182 bio_put(bio);
1183 return ret;
1184 }
1185
1186 /**
1187 * bio_copy_user_iov - copy user data to bio
1188 * @q: destination block queue
1189 * @map_data: pointer to the rq_map_data holding pages (if necessary)
1190 * @iter: iovec iterator
1191 * @gfp_mask: memory allocation flags
1192 *
1193 * Prepares and returns a bio for indirect user io, bouncing data
1194 * to/from kernel pages as necessary. Must be paired with
1195 * call bio_uncopy_user() on io completion.
1196 */
1197 struct bio *bio_copy_user_iov(struct request_queue *q,
1198 struct rq_map_data *map_data,
1199 const struct iov_iter *iter,
1200 gfp_t gfp_mask)
1201 {
1202 struct bio_map_data *bmd;
1203 struct page *page;
1204 struct bio *bio;
1205 int i, ret;
1206 int nr_pages = 0;
1207 unsigned int len = iter->count;
1208 unsigned int offset = map_data ? offset_in_page(map_data->offset) : 0;
1209
1210 for (i = 0; i < iter->nr_segs; i++) {
1211 unsigned long uaddr;
1212 unsigned long end;
1213 unsigned long start;
1214
1215 uaddr = (unsigned long) iter->iov[i].iov_base;
1216 end = (uaddr + iter->iov[i].iov_len + PAGE_SIZE - 1)
1217 >> PAGE_SHIFT;
1218 start = uaddr >> PAGE_SHIFT;
1219
1220 /*
1221 * Overflow, abort
1222 */
1223 if (end < start)
1224 return ERR_PTR(-EINVAL);
1225
1226 nr_pages += end - start;
1227 }
1228
1229 if (offset)
1230 nr_pages++;
1231
1232 bmd = bio_alloc_map_data(iter->nr_segs, gfp_mask);
1233 if (!bmd)
1234 return ERR_PTR(-ENOMEM);
1235
1236 /*
1237 * We need to do a deep copy of the iov_iter including the iovecs.
1238 * The caller provided iov might point to an on-stack or otherwise
1239 * shortlived one.
1240 */
1241 bmd->is_our_pages = map_data ? 0 : 1;
1242 memcpy(bmd->iov, iter->iov, sizeof(struct iovec) * iter->nr_segs);
1243 bmd->iter = *iter;
1244 bmd->iter.iov = bmd->iov;
1245
1246 ret = -ENOMEM;
1247 bio = bio_kmalloc(gfp_mask, nr_pages);
1248 if (!bio)
1249 goto out_bmd;
1250
1251 ret = 0;
1252
1253 if (map_data) {
1254 nr_pages = 1 << map_data->page_order;
1255 i = map_data->offset / PAGE_SIZE;
1256 }
1257 while (len) {
1258 unsigned int bytes = PAGE_SIZE;
1259
1260 bytes -= offset;
1261
1262 if (bytes > len)
1263 bytes = len;
1264
1265 if (map_data) {
1266 if (i == map_data->nr_entries * nr_pages) {
1267 ret = -ENOMEM;
1268 break;
1269 }
1270
1271 page = map_data->pages[i / nr_pages];
1272 page += (i % nr_pages);
1273
1274 i++;
1275 } else {
1276 page = alloc_page(q->bounce_gfp | gfp_mask);
1277 if (!page) {
1278 ret = -ENOMEM;
1279 break;
1280 }
1281 }
1282
1283 if (bio_add_pc_page(q, bio, page, bytes, offset) < bytes)
1284 break;
1285
1286 len -= bytes;
1287 offset = 0;
1288 }
1289
1290 if (ret)
1291 goto cleanup;
1292
1293 /*
1294 * success
1295 */
1296 if (((iter->type & WRITE) && (!map_data || !map_data->null_mapped)) ||
1297 (map_data && map_data->from_user)) {
1298 ret = bio_copy_from_iter(bio, *iter);
1299 if (ret)
1300 goto cleanup;
1301 }
1302
1303 bio->bi_private = bmd;
1304 return bio;
1305 cleanup:
1306 if (!map_data)
1307 bio_free_pages(bio);
1308 bio_put(bio);
1309 out_bmd:
1310 kfree(bmd);
1311 return ERR_PTR(ret);
1312 }
1313
1314 /**
1315 * bio_map_user_iov - map user iovec into bio
1316 * @q: the struct request_queue for the bio
1317 * @iter: iovec iterator
1318 * @gfp_mask: memory allocation flags
1319 *
1320 * Map the user space address into a bio suitable for io to a block
1321 * device. Returns an error pointer in case of error.
1322 */
1323 struct bio *bio_map_user_iov(struct request_queue *q,
1324 const struct iov_iter *iter,
1325 gfp_t gfp_mask)
1326 {
1327 int j;
1328 int nr_pages = 0;
1329 struct page **pages;
1330 struct bio *bio;
1331 int cur_page = 0;
1332 int ret, offset;
1333 struct iov_iter i;
1334 struct iovec iov;
1335 struct bio_vec *bvec;
1336
1337 iov_for_each(iov, i, *iter) {
1338 unsigned long uaddr = (unsigned long) iov.iov_base;
1339 unsigned long len = iov.iov_len;
1340 unsigned long end = (uaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1341 unsigned long start = uaddr >> PAGE_SHIFT;
1342
1343 /*
1344 * Overflow, abort
1345 */
1346 if (end < start)
1347 return ERR_PTR(-EINVAL);
1348
1349 nr_pages += end - start;
1350 /*
1351 * buffer must be aligned to at least logical block size for now
1352 */
1353 if (uaddr & queue_dma_alignment(q))
1354 return ERR_PTR(-EINVAL);
1355 }
1356
1357 if (!nr_pages)
1358 return ERR_PTR(-EINVAL);
1359
1360 bio = bio_kmalloc(gfp_mask, nr_pages);
1361 if (!bio)
1362 return ERR_PTR(-ENOMEM);
1363
1364 ret = -ENOMEM;
1365 pages = kcalloc(nr_pages, sizeof(struct page *), gfp_mask);
1366 if (!pages)
1367 goto out;
1368
1369 iov_for_each(iov, i, *iter) {
1370 unsigned long uaddr = (unsigned long) iov.iov_base;
1371 unsigned long len = iov.iov_len;
1372 unsigned long end = (uaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1373 unsigned long start = uaddr >> PAGE_SHIFT;
1374 const int local_nr_pages = end - start;
1375 const int page_limit = cur_page + local_nr_pages;
1376
1377 ret = get_user_pages_fast(uaddr, local_nr_pages,
1378 (iter->type & WRITE) != WRITE,
1379 &pages[cur_page]);
1380 if (unlikely(ret < local_nr_pages)) {
1381 for (j = cur_page; j < page_limit; j++) {
1382 if (!pages[j])
1383 break;
1384 put_page(pages[j]);
1385 }
1386 ret = -EFAULT;
1387 goto out_unmap;
1388 }
1389
1390 offset = offset_in_page(uaddr);
1391 for (j = cur_page; j < page_limit; j++) {
1392 unsigned int bytes = PAGE_SIZE - offset;
1393 unsigned short prev_bi_vcnt = bio->bi_vcnt;
1394
1395 if (len <= 0)
1396 break;
1397
1398 if (bytes > len)
1399 bytes = len;
1400
1401 /*
1402 * sorry...
1403 */
1404 if (bio_add_pc_page(q, bio, pages[j], bytes, offset) <
1405 bytes)
1406 break;
1407
1408 /*
1409 * check if vector was merged with previous
1410 * drop page reference if needed
1411 */
1412 if (bio->bi_vcnt == prev_bi_vcnt)
1413 put_page(pages[j]);
1414
1415 len -= bytes;
1416 offset = 0;
1417 }
1418
1419 cur_page = j;
1420 /*
1421 * release the pages we didn't map into the bio, if any
1422 */
1423 while (j < page_limit)
1424 put_page(pages[j++]);
1425 }
1426
1427 kfree(pages);
1428
1429 bio_set_flag(bio, BIO_USER_MAPPED);
1430
1431 /*
1432 * subtle -- if bio_map_user_iov() ended up bouncing a bio,
1433 * it would normally disappear when its bi_end_io is run.
1434 * however, we need it for the unmap, so grab an extra
1435 * reference to it
1436 */
1437 bio_get(bio);
1438 return bio;
1439
1440 out_unmap:
1441 bio_for_each_segment_all(bvec, bio, j) {
1442 put_page(bvec->bv_page);
1443 }
1444 out:
1445 kfree(pages);
1446 bio_put(bio);
1447 return ERR_PTR(ret);
1448 }
1449
1450 static void __bio_unmap_user(struct bio *bio)
1451 {
1452 struct bio_vec *bvec;
1453 int i;
1454
1455 /*
1456 * make sure we dirty pages we wrote to
1457 */
1458 bio_for_each_segment_all(bvec, bio, i) {
1459 if (bio_data_dir(bio) == READ)
1460 set_page_dirty_lock(bvec->bv_page);
1461
1462 put_page(bvec->bv_page);
1463 }
1464
1465 bio_put(bio);
1466 }
1467
1468 /**
1469 * bio_unmap_user - unmap a bio
1470 * @bio: the bio being unmapped
1471 *
1472 * Unmap a bio previously mapped by bio_map_user_iov(). Must be called from
1473 * process context.
1474 *
1475 * bio_unmap_user() may sleep.
1476 */
1477 void bio_unmap_user(struct bio *bio)
1478 {
1479 __bio_unmap_user(bio);
1480 bio_put(bio);
1481 }
1482
1483 static void bio_map_kern_endio(struct bio *bio)
1484 {
1485 bio_put(bio);
1486 }
1487
1488 /**
1489 * bio_map_kern - map kernel address into bio
1490 * @q: the struct request_queue for the bio
1491 * @data: pointer to buffer to map
1492 * @len: length in bytes
1493 * @gfp_mask: allocation flags for bio allocation
1494 *
1495 * Map the kernel address into a bio suitable for io to a block
1496 * device. Returns an error pointer in case of error.
1497 */
1498 struct bio *bio_map_kern(struct request_queue *q, void *data, unsigned int len,
1499 gfp_t gfp_mask)
1500 {
1501 unsigned long kaddr = (unsigned long)data;
1502 unsigned long end = (kaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1503 unsigned long start = kaddr >> PAGE_SHIFT;
1504 const int nr_pages = end - start;
1505 int offset, i;
1506 struct bio *bio;
1507
1508 bio = bio_kmalloc(gfp_mask, nr_pages);
1509 if (!bio)
1510 return ERR_PTR(-ENOMEM);
1511
1512 offset = offset_in_page(kaddr);
1513 for (i = 0; i < nr_pages; i++) {
1514 unsigned int bytes = PAGE_SIZE - offset;
1515
1516 if (len <= 0)
1517 break;
1518
1519 if (bytes > len)
1520 bytes = len;
1521
1522 if (bio_add_pc_page(q, bio, virt_to_page(data), bytes,
1523 offset) < bytes) {
1524 /* we don't support partial mappings */
1525 bio_put(bio);
1526 return ERR_PTR(-EINVAL);
1527 }
1528
1529 data += bytes;
1530 len -= bytes;
1531 offset = 0;
1532 }
1533
1534 bio->bi_end_io = bio_map_kern_endio;
1535 return bio;
1536 }
1537 EXPORT_SYMBOL(bio_map_kern);
1538
1539 static void bio_copy_kern_endio(struct bio *bio)
1540 {
1541 bio_free_pages(bio);
1542 bio_put(bio);
1543 }
1544
1545 static void bio_copy_kern_endio_read(struct bio *bio)
1546 {
1547 char *p = bio->bi_private;
1548 struct bio_vec *bvec;
1549 int i;
1550
1551 bio_for_each_segment_all(bvec, bio, i) {
1552 memcpy(p, page_address(bvec->bv_page), bvec->bv_len);
1553 p += bvec->bv_len;
1554 }
1555
1556 bio_copy_kern_endio(bio);
1557 }
1558
1559 /**
1560 * bio_copy_kern - copy kernel address into bio
1561 * @q: the struct request_queue for the bio
1562 * @data: pointer to buffer to copy
1563 * @len: length in bytes
1564 * @gfp_mask: allocation flags for bio and page allocation
1565 * @reading: data direction is READ
1566 *
1567 * copy the kernel address into a bio suitable for io to a block
1568 * device. Returns an error pointer in case of error.
1569 */
1570 struct bio *bio_copy_kern(struct request_queue *q, void *data, unsigned int len,
1571 gfp_t gfp_mask, int reading)
1572 {
1573 unsigned long kaddr = (unsigned long)data;
1574 unsigned long end = (kaddr + len + PAGE_SIZE - 1) >> PAGE_SHIFT;
1575 unsigned long start = kaddr >> PAGE_SHIFT;
1576 struct bio *bio;
1577 void *p = data;
1578 int nr_pages = 0;
1579
1580 /*
1581 * Overflow, abort
1582 */
1583 if (end < start)
1584 return ERR_PTR(-EINVAL);
1585
1586 nr_pages = end - start;
1587 bio = bio_kmalloc(gfp_mask, nr_pages);
1588 if (!bio)
1589 return ERR_PTR(-ENOMEM);
1590
1591 while (len) {
1592 struct page *page;
1593 unsigned int bytes = PAGE_SIZE;
1594
1595 if (bytes > len)
1596 bytes = len;
1597
1598 page = alloc_page(q->bounce_gfp | gfp_mask);
1599 if (!page)
1600 goto cleanup;
1601
1602 if (!reading)
1603 memcpy(page_address(page), p, bytes);
1604
1605 if (bio_add_pc_page(q, bio, page, bytes, 0) < bytes)
1606 break;
1607
1608 len -= bytes;
1609 p += bytes;
1610 }
1611
1612 if (reading) {
1613 bio->bi_end_io = bio_copy_kern_endio_read;
1614 bio->bi_private = data;
1615 } else {
1616 bio->bi_end_io = bio_copy_kern_endio;
1617 }
1618
1619 return bio;
1620
1621 cleanup:
1622 bio_free_pages(bio);
1623 bio_put(bio);
1624 return ERR_PTR(-ENOMEM);
1625 }
1626
1627 /*
1628 * bio_set_pages_dirty() and bio_check_pages_dirty() are support functions
1629 * for performing direct-IO in BIOs.
1630 *
1631 * The problem is that we cannot run set_page_dirty() from interrupt context
1632 * because the required locks are not interrupt-safe. So what we can do is to
1633 * mark the pages dirty _before_ performing IO. And in interrupt context,
1634 * check that the pages are still dirty. If so, fine. If not, redirty them
1635 * in process context.
1636 *
1637 * We special-case compound pages here: normally this means reads into hugetlb
1638 * pages. The logic in here doesn't really work right for compound pages
1639 * because the VM does not uniformly chase down the head page in all cases.
1640 * But dirtiness of compound pages is pretty meaningless anyway: the VM doesn't
1641 * handle them at all. So we skip compound pages here at an early stage.
1642 *
1643 * Note that this code is very hard to test under normal circumstances because
1644 * direct-io pins the pages with get_user_pages(). This makes
1645 * is_page_cache_freeable return false, and the VM will not clean the pages.
1646 * But other code (eg, flusher threads) could clean the pages if they are mapped
1647 * pagecache.
1648 *
1649 * Simply disabling the call to bio_set_pages_dirty() is a good way to test the
1650 * deferred bio dirtying paths.
1651 */
1652
1653 /*
1654 * bio_set_pages_dirty() will mark all the bio's pages as dirty.
1655 */
1656 void bio_set_pages_dirty(struct bio *bio)
1657 {
1658 struct bio_vec *bvec;
1659 int i;
1660
1661 bio_for_each_segment_all(bvec, bio, i) {
1662 struct page *page = bvec->bv_page;
1663
1664 if (page && !PageCompound(page))
1665 set_page_dirty_lock(page);
1666 }
1667 }
1668
1669 static void bio_release_pages(struct bio *bio)
1670 {
1671 struct bio_vec *bvec;
1672 int i;
1673
1674 bio_for_each_segment_all(bvec, bio, i) {
1675 struct page *page = bvec->bv_page;
1676
1677 if (page)
1678 put_page(page);
1679 }
1680 }
1681
1682 /*
1683 * bio_check_pages_dirty() will check that all the BIO's pages are still dirty.
1684 * If they are, then fine. If, however, some pages are clean then they must
1685 * have been written out during the direct-IO read. So we take another ref on
1686 * the BIO and the offending pages and re-dirty the pages in process context.
1687 *
1688 * It is expected that bio_check_pages_dirty() will wholly own the BIO from
1689 * here on. It will run one put_page() against each page and will run one
1690 * bio_put() against the BIO.
1691 */
1692
1693 static void bio_dirty_fn(struct work_struct *work);
1694
1695 static DECLARE_WORK(bio_dirty_work, bio_dirty_fn);
1696 static DEFINE_SPINLOCK(bio_dirty_lock);
1697 static struct bio *bio_dirty_list;
1698
1699 /*
1700 * This runs in process context
1701 */
1702 static void bio_dirty_fn(struct work_struct *work)
1703 {
1704 unsigned long flags;
1705 struct bio *bio;
1706
1707 spin_lock_irqsave(&bio_dirty_lock, flags);
1708 bio = bio_dirty_list;
1709 bio_dirty_list = NULL;
1710 spin_unlock_irqrestore(&bio_dirty_lock, flags);
1711
1712 while (bio) {
1713 struct bio *next = bio->bi_private;
1714
1715 bio_set_pages_dirty(bio);
1716 bio_release_pages(bio);
1717 bio_put(bio);
1718 bio = next;
1719 }
1720 }
1721
1722 void bio_check_pages_dirty(struct bio *bio)
1723 {
1724 struct bio_vec *bvec;
1725 int nr_clean_pages = 0;
1726 int i;
1727
1728 bio_for_each_segment_all(bvec, bio, i) {
1729 struct page *page = bvec->bv_page;
1730
1731 if (PageDirty(page) || PageCompound(page)) {
1732 put_page(page);
1733 bvec->bv_page = NULL;
1734 } else {
1735 nr_clean_pages++;
1736 }
1737 }
1738
1739 if (nr_clean_pages) {
1740 unsigned long flags;
1741
1742 spin_lock_irqsave(&bio_dirty_lock, flags);
1743 bio->bi_private = bio_dirty_list;
1744 bio_dirty_list = bio;
1745 spin_unlock_irqrestore(&bio_dirty_lock, flags);
1746 schedule_work(&bio_dirty_work);
1747 } else {
1748 bio_put(bio);
1749 }
1750 }
1751
1752 void generic_start_io_acct(struct request_queue *q, int rw,
1753 unsigned long sectors, struct hd_struct *part)
1754 {
1755 int cpu = part_stat_lock();
1756
1757 part_round_stats(q, cpu, part);
1758 part_stat_inc(cpu, part, ios[rw]);
1759 part_stat_add(cpu, part, sectors[rw], sectors);
1760 part_inc_in_flight(q, part, rw);
1761
1762 part_stat_unlock();
1763 }
1764 EXPORT_SYMBOL(generic_start_io_acct);
1765
1766 void generic_end_io_acct(struct request_queue *q, int rw,
1767 struct hd_struct *part, unsigned long start_time)
1768 {
1769 unsigned long duration = jiffies - start_time;
1770 int cpu = part_stat_lock();
1771
1772 part_stat_add(cpu, part, ticks[rw], duration);
1773 part_round_stats(q, cpu, part);
1774 part_dec_in_flight(q, part, rw);
1775
1776 part_stat_unlock();
1777 }
1778 EXPORT_SYMBOL(generic_end_io_acct);
1779
1780 #if ARCH_IMPLEMENTS_FLUSH_DCACHE_PAGE
1781 void bio_flush_dcache_pages(struct bio *bi)
1782 {
1783 struct bio_vec bvec;
1784 struct bvec_iter iter;
1785
1786 bio_for_each_segment(bvec, bi, iter)
1787 flush_dcache_page(bvec.bv_page);
1788 }
1789 EXPORT_SYMBOL(bio_flush_dcache_pages);
1790 #endif
1791
1792 static inline bool bio_remaining_done(struct bio *bio)
1793 {
1794 /*
1795 * If we're not chaining, then ->__bi_remaining is always 1 and
1796 * we always end io on the first invocation.
1797 */
1798 if (!bio_flagged(bio, BIO_CHAIN))
1799 return true;
1800
1801 BUG_ON(atomic_read(&bio->__bi_remaining) <= 0);
1802
1803 if (atomic_dec_and_test(&bio->__bi_remaining)) {
1804 bio_clear_flag(bio, BIO_CHAIN);
1805 return true;
1806 }
1807
1808 return false;
1809 }
1810
1811 /**
1812 * bio_endio - end I/O on a bio
1813 * @bio: bio
1814 *
1815 * Description:
1816 * bio_endio() will end I/O on the whole bio. bio_endio() is the preferred
1817 * way to end I/O on a bio. No one should call bi_end_io() directly on a
1818 * bio unless they own it and thus know that it has an end_io function.
1819 *
1820 * bio_endio() can be called several times on a bio that has been chained
1821 * using bio_chain(). The ->bi_end_io() function will only be called the
1822 * last time. At this point the BLK_TA_COMPLETE tracing event will be
1823 * generated if BIO_TRACE_COMPLETION is set.
1824 **/
1825 void bio_endio(struct bio *bio)
1826 {
1827 again:
1828 if (!bio_remaining_done(bio))
1829 return;
1830 if (!bio_integrity_endio(bio))
1831 return;
1832
1833 /*
1834 * Need to have a real endio function for chained bios, otherwise
1835 * various corner cases will break (like stacking block devices that
1836 * save/restore bi_end_io) - however, we want to avoid unbounded
1837 * recursion and blowing the stack. Tail call optimization would
1838 * handle this, but compiling with frame pointers also disables
1839 * gcc's sibling call optimization.
1840 */
1841 if (bio->bi_end_io == bio_chain_endio) {
1842 bio = __bio_chain_endio(bio);
1843 goto again;
1844 }
1845
1846 if (bio->bi_disk && bio_flagged(bio, BIO_TRACE_COMPLETION)) {
1847 trace_block_bio_complete(bio->bi_disk->queue, bio,
1848 blk_status_to_errno(bio->bi_status));
1849 bio_clear_flag(bio, BIO_TRACE_COMPLETION);
1850 }
1851
1852 blk_throtl_bio_endio(bio);
1853 /* release cgroup info */
1854 bio_uninit(bio);
1855 if (bio->bi_end_io)
1856 bio->bi_end_io(bio);
1857 }
1858 EXPORT_SYMBOL(bio_endio);
1859
1860 /**
1861 * bio_split - split a bio
1862 * @bio: bio to split
1863 * @sectors: number of sectors to split from the front of @bio
1864 * @gfp: gfp mask
1865 * @bs: bio set to allocate from
1866 *
1867 * Allocates and returns a new bio which represents @sectors from the start of
1868 * @bio, and updates @bio to represent the remaining sectors.
1869 *
1870 * Unless this is a discard request the newly allocated bio will point
1871 * to @bio's bi_io_vec; it is the caller's responsibility to ensure that
1872 * @bio is not freed before the split.
1873 */
1874 struct bio *bio_split(struct bio *bio, int sectors,
1875 gfp_t gfp, struct bio_set *bs)
1876 {
1877 struct bio *split = NULL;
1878
1879 BUG_ON(sectors <= 0);
1880 BUG_ON(sectors >= bio_sectors(bio));
1881
1882 split = bio_clone_fast(bio, gfp, bs);
1883 if (!split)
1884 return NULL;
1885
1886 split->bi_iter.bi_size = sectors << 9;
1887
1888 if (bio_integrity(split))
1889 bio_integrity_trim(split);
1890
1891 bio_advance(bio, split->bi_iter.bi_size);
1892
1893 if (bio_flagged(bio, BIO_TRACE_COMPLETION))
1894 bio_set_flag(bio, BIO_TRACE_COMPLETION);
1895
1896 return split;
1897 }
1898 EXPORT_SYMBOL(bio_split);
1899
1900 /**
1901 * bio_trim - trim a bio
1902 * @bio: bio to trim
1903 * @offset: number of sectors to trim from the front of @bio
1904 * @size: size we want to trim @bio to, in sectors
1905 */
1906 void bio_trim(struct bio *bio, int offset, int size)
1907 {
1908 /* 'bio' is a cloned bio which we need to trim to match
1909 * the given offset and size.
1910 */
1911
1912 size <<= 9;
1913 if (offset == 0 && size == bio->bi_iter.bi_size)
1914 return;
1915
1916 bio_clear_flag(bio, BIO_SEG_VALID);
1917
1918 bio_advance(bio, offset << 9);
1919
1920 bio->bi_iter.bi_size = size;
1921
1922 if (bio_integrity(bio))
1923 bio_integrity_trim(bio);
1924
1925 }
1926 EXPORT_SYMBOL_GPL(bio_trim);
1927
1928 /*
1929 * create memory pools for biovec's in a bio_set.
1930 * use the global biovec slabs created for general use.
1931 */
1932 mempool_t *biovec_create_pool(int pool_entries)
1933 {
1934 struct biovec_slab *bp = bvec_slabs + BVEC_POOL_MAX;
1935
1936 return mempool_create_slab_pool(pool_entries, bp->slab);
1937 }
1938
1939 void bioset_free(struct bio_set *bs)
1940 {
1941 if (bs->rescue_workqueue)
1942 destroy_workqueue(bs->rescue_workqueue);
1943
1944 if (bs->bio_pool)
1945 mempool_destroy(bs->bio_pool);
1946
1947 if (bs->bvec_pool)
1948 mempool_destroy(bs->bvec_pool);
1949
1950 bioset_integrity_free(bs);
1951 bio_put_slab(bs);
1952
1953 kfree(bs);
1954 }
1955 EXPORT_SYMBOL(bioset_free);
1956
1957 /**
1958 * bioset_create - Create a bio_set
1959 * @pool_size: Number of bio and bio_vecs to cache in the mempool
1960 * @front_pad: Number of bytes to allocate in front of the returned bio
1961 * @flags: Flags to modify behavior, currently %BIOSET_NEED_BVECS
1962 * and %BIOSET_NEED_RESCUER
1963 *
1964 * Description:
1965 * Set up a bio_set to be used with @bio_alloc_bioset. Allows the caller
1966 * to ask for a number of bytes to be allocated in front of the bio.
1967 * Front pad allocation is useful for embedding the bio inside
1968 * another structure, to avoid allocating extra data to go with the bio.
1969 * Note that the bio must be embedded at the END of that structure always,
1970 * or things will break badly.
1971 * If %BIOSET_NEED_BVECS is set in @flags, a separate pool will be allocated
1972 * for allocating iovecs. This pool is not needed e.g. for bio_clone_fast().
1973 * If %BIOSET_NEED_RESCUER is set, a workqueue is created which can be used to
1974 * dispatch queued requests when the mempool runs out of space.
1975 *
1976 */
1977 struct bio_set *bioset_create(unsigned int pool_size,
1978 unsigned int front_pad,
1979 int flags)
1980 {
1981 unsigned int back_pad = BIO_INLINE_VECS * sizeof(struct bio_vec);
1982 struct bio_set *bs;
1983
1984 bs = kzalloc(sizeof(*bs), GFP_KERNEL);
1985 if (!bs)
1986 return NULL;
1987
1988 bs->front_pad = front_pad;
1989
1990 spin_lock_init(&bs->rescue_lock);
1991 bio_list_init(&bs->rescue_list);
1992 INIT_WORK(&bs->rescue_work, bio_alloc_rescue);
1993
1994 bs->bio_slab = bio_find_or_create_slab(front_pad + back_pad);
1995 if (!bs->bio_slab) {
1996 kfree(bs);
1997 return NULL;
1998 }
1999
2000 bs->bio_pool = mempool_create_slab_pool(pool_size, bs->bio_slab);
2001 if (!bs->bio_pool)
2002 goto bad;
2003
2004 if (flags & BIOSET_NEED_BVECS) {
2005 bs->bvec_pool = biovec_create_pool(pool_size);
2006 if (!bs->bvec_pool)
2007 goto bad;
2008 }
2009
2010 if (!(flags & BIOSET_NEED_RESCUER))
2011 return bs;
2012
2013 bs->rescue_workqueue = alloc_workqueue("bioset", WQ_MEM_RECLAIM, 0);
2014 if (!bs->rescue_workqueue)
2015 goto bad;
2016
2017 return bs;
2018 bad:
2019 bioset_free(bs);
2020 return NULL;
2021 }
2022 EXPORT_SYMBOL(bioset_create);
2023
2024 #ifdef CONFIG_BLK_CGROUP
2025
2026 /**
2027 * bio_associate_blkcg - associate a bio with the specified blkcg
2028 * @bio: target bio
2029 * @blkcg_css: css of the blkcg to associate
2030 *
2031 * Associate @bio with the blkcg specified by @blkcg_css. Block layer will
2032 * treat @bio as if it were issued by a task which belongs to the blkcg.
2033 *
2034 * This function takes an extra reference of @blkcg_css which will be put
2035 * when @bio is released. The caller must own @bio and is responsible for
2036 * synchronizing calls to this function.
2037 */
2038 int bio_associate_blkcg(struct bio *bio, struct cgroup_subsys_state *blkcg_css)
2039 {
2040 if (unlikely(bio->bi_css))
2041 return -EBUSY;
2042 css_get(blkcg_css);
2043 bio->bi_css = blkcg_css;
2044 return 0;
2045 }
2046 EXPORT_SYMBOL_GPL(bio_associate_blkcg);
2047
2048 /**
2049 * bio_associate_current - associate a bio with %current
2050 * @bio: target bio
2051 *
2052 * Associate @bio with %current if it hasn't been associated yet. Block
2053 * layer will treat @bio as if it were issued by %current no matter which
2054 * task actually issues it.
2055 *
2056 * This function takes an extra reference of @task's io_context and blkcg
2057 * which will be put when @bio is released. The caller must own @bio,
2058 * ensure %current->io_context exists, and is responsible for synchronizing
2059 * calls to this function.
2060 */
2061 int bio_associate_current(struct bio *bio)
2062 {
2063 struct io_context *ioc;
2064
2065 if (bio->bi_css)
2066 return -EBUSY;
2067
2068 ioc = current->io_context;
2069 if (!ioc)
2070 return -ENOENT;
2071
2072 get_io_context_active(ioc);
2073 bio->bi_ioc = ioc;
2074 bio->bi_css = task_get_css(current, io_cgrp_id);
2075 return 0;
2076 }
2077 EXPORT_SYMBOL_GPL(bio_associate_current);
2078
2079 /**
2080 * bio_disassociate_task - undo bio_associate_current()
2081 * @bio: target bio
2082 */
2083 void bio_disassociate_task(struct bio *bio)
2084 {
2085 if (bio->bi_ioc) {
2086 put_io_context(bio->bi_ioc);
2087 bio->bi_ioc = NULL;
2088 }
2089 if (bio->bi_css) {
2090 css_put(bio->bi_css);
2091 bio->bi_css = NULL;
2092 }
2093 }
2094
2095 /**
2096 * bio_clone_blkcg_association - clone blkcg association from src to dst bio
2097 * @dst: destination bio
2098 * @src: source bio
2099 */
2100 void bio_clone_blkcg_association(struct bio *dst, struct bio *src)
2101 {
2102 if (src->bi_css)
2103 WARN_ON(bio_associate_blkcg(dst, src->bi_css));
2104 }
2105 EXPORT_SYMBOL_GPL(bio_clone_blkcg_association);
2106 #endif /* CONFIG_BLK_CGROUP */
2107
2108 static void __init biovec_init_slabs(void)
2109 {
2110 int i;
2111
2112 for (i = 0; i < BVEC_POOL_NR; i++) {
2113 int size;
2114 struct biovec_slab *bvs = bvec_slabs + i;
2115
2116 if (bvs->nr_vecs <= BIO_INLINE_VECS) {
2117 bvs->slab = NULL;
2118 continue;
2119 }
2120
2121 size = bvs->nr_vecs * sizeof(struct bio_vec);
2122 bvs->slab = kmem_cache_create(bvs->name, size, 0,
2123 SLAB_HWCACHE_ALIGN|SLAB_PANIC, NULL);
2124 }
2125 }
2126
2127 static int __init init_bio(void)
2128 {
2129 bio_slab_max = 2;
2130 bio_slab_nr = 0;
2131 bio_slabs = kzalloc(bio_slab_max * sizeof(struct bio_slab), GFP_KERNEL);
2132 if (!bio_slabs)
2133 panic("bio: can't allocate bios\n");
2134
2135 bio_integrity_init();
2136 biovec_init_slabs();
2137
2138 fs_bio_set = bioset_create(BIO_POOL_SIZE, 0, BIOSET_NEED_BVECS);
2139 if (!fs_bio_set)
2140 panic("bio: can't allocate bios\n");
2141
2142 if (bioset_integrity_create(fs_bio_set, BIO_POOL_SIZE))
2143 panic("bio: can't create integrity pool\n");
2144
2145 return 0;
2146 }
2147 subsys_initcall(init_bio);