2 * Functions related to segment and merge handling
4 #include <linux/kernel.h>
5 #include <linux/module.h>
7 #include <linux/blkdev.h>
8 #include <linux/scatterlist.h>
10 #include <linux/pft.h>
14 static struct bio *blk_bio_discard_split(struct request_queue *q,
19 unsigned int max_discard_sectors, granularity;
22 unsigned split_sectors;
26 /* Zero-sector (unknown) and one-sector granularities are the same. */
27 granularity = max(q->limits.discard_granularity >> 9, 1U);
29 max_discard_sectors = min(q->limits.max_discard_sectors, UINT_MAX >> 9);
30 max_discard_sectors -= max_discard_sectors % granularity;
32 if (unlikely(!max_discard_sectors)) {
37 if (bio_sectors(bio) <= max_discard_sectors)
40 split_sectors = max_discard_sectors;
43 * If the next starting sector would be misaligned, stop the discard at
44 * the previous aligned sector.
46 alignment = (q->limits.discard_alignment >> 9) % granularity;
48 tmp = bio->bi_iter.bi_sector + split_sectors - alignment;
49 tmp = sector_div(tmp, granularity);
51 if (split_sectors > tmp)
54 return bio_split(bio, split_sectors, GFP_NOIO, bs);
57 static struct bio *blk_bio_write_same_split(struct request_queue *q,
64 if (!q->limits.max_write_same_sectors)
67 if (bio_sectors(bio) <= q->limits.max_write_same_sectors)
70 return bio_split(bio, q->limits.max_write_same_sectors, GFP_NOIO, bs);
73 static inline unsigned get_max_io_size(struct request_queue *q,
76 unsigned sectors = blk_max_size_offset(q, bio->bi_iter.bi_sector);
77 unsigned mask = queue_logical_block_size(q) - 1;
79 /* aligned to logical block size */
80 sectors &= ~(mask >> 9);
85 static struct bio *blk_bio_segment_split(struct request_queue *q,
90 struct bio_vec bv, bvprv, *bvprvp = NULL;
91 struct bvec_iter iter;
92 unsigned seg_size = 0, nsegs = 0, sectors = 0;
93 unsigned front_seg_size = bio->bi_seg_front_size;
95 struct bio *new = NULL;
96 const unsigned max_sectors = get_max_io_size(q, bio);
99 bio_for_each_segment(bv, bio, iter) {
101 * With arbitrary bio size, the incoming bio may be very
102 * big. We have to split the bio into small bios so that
103 * each holds at most BIO_MAX_PAGES bvecs because
104 * bio_clone() can fail to allocate big bvecs.
106 * It should have been better to apply the limit per
107 * request queue in which bio_clone() is involved,
108 * instead of globally. The biggest blocker is the
109 * bio_clone() in bio bounce.
111 * If bio is splitted by this reason, we should have
112 * allowed to continue bios merging, but don't do
113 * that now for making the change simple.
115 * TODO: deal with bio bounce's bio_clone() gracefully
116 * and convert the global limit into per-queue limit.
118 if (bvecs++ >= BIO_MAX_PAGES)
122 * If the queue doesn't support SG gaps and adding this
123 * offset would create a gap, disallow it.
125 if (bvprvp && bvec_gap_to_prev(q, bvprvp, bv.bv_offset))
128 if (sectors + (bv.bv_len >> 9) > max_sectors) {
130 * Consider this a new segment if we're splitting in
131 * the middle of this vector.
133 if (nsegs < queue_max_segments(q) &&
134 sectors < max_sectors) {
136 sectors = max_sectors;
140 /* Make this single bvec as the 1st segment */
143 if (bvprvp && blk_queue_cluster(q)) {
144 if (seg_size + bv.bv_len > queue_max_segment_size(q))
146 if (!BIOVEC_PHYS_MERGEABLE(bvprvp, &bv))
148 if (!BIOVEC_SEG_BOUNDARY(q, bvprvp, &bv))
151 seg_size += bv.bv_len;
154 sectors += bv.bv_len >> 9;
156 if (nsegs == 1 && seg_size > front_seg_size)
157 front_seg_size = seg_size;
161 if (nsegs == queue_max_segments(q))
167 seg_size = bv.bv_len;
168 sectors += bv.bv_len >> 9;
170 if (nsegs == 1 && seg_size > front_seg_size)
171 front_seg_size = seg_size;
179 new = bio_split(bio, sectors, GFP_NOIO, bs);
184 bio->bi_seg_front_size = front_seg_size;
185 if (seg_size > bio->bi_seg_back_size)
186 bio->bi_seg_back_size = seg_size;
188 return do_split ? new : NULL;
191 void blk_queue_split(struct request_queue *q, struct bio **bio,
194 struct bio *split, *res;
197 if ((*bio)->bi_rw & REQ_DISCARD)
198 split = blk_bio_discard_split(q, *bio, bs, &nsegs);
199 else if ((*bio)->bi_rw & REQ_WRITE_SAME)
200 split = blk_bio_write_same_split(q, *bio, bs, &nsegs);
202 split = blk_bio_segment_split(q, *bio, q->bio_split, &nsegs);
204 /* physical segments can be figured out during splitting */
205 res = split ? split : *bio;
206 res->bi_phys_segments = nsegs;
207 bio_set_flag(res, BIO_SEG_VALID);
210 /* there isn't chance to merge the splitted bio */
211 split->bi_rw |= REQ_NOMERGE;
213 bio_chain(split, *bio);
214 generic_make_request(*bio);
218 EXPORT_SYMBOL(blk_queue_split);
220 static unsigned int __blk_recalc_rq_segments(struct request_queue *q,
224 struct bio_vec bv, bvprv = { NULL };
225 int cluster, prev = 0;
226 unsigned int seg_size, nr_phys_segs;
227 struct bio *fbio, *bbio;
228 struct bvec_iter iter;
234 * This should probably be returning 0, but blk_add_request_payload()
237 if (bio->bi_rw & REQ_DISCARD)
240 if (bio->bi_rw & REQ_WRITE_SAME)
244 cluster = blk_queue_cluster(q);
248 bio_for_each_segment(bv, bio, iter) {
250 * If SG merging is disabled, each bio vector is
256 if (prev && cluster) {
257 if (seg_size + bv.bv_len
258 > queue_max_segment_size(q))
260 if (!BIOVEC_PHYS_MERGEABLE(&bvprv, &bv))
262 if (!BIOVEC_SEG_BOUNDARY(q, &bvprv, &bv))
265 seg_size += bv.bv_len;
270 if (nr_phys_segs == 1 && seg_size >
271 fbio->bi_seg_front_size)
272 fbio->bi_seg_front_size = seg_size;
277 seg_size = bv.bv_len;
282 if (nr_phys_segs == 1 && seg_size > fbio->bi_seg_front_size)
283 fbio->bi_seg_front_size = seg_size;
284 if (seg_size > bbio->bi_seg_back_size)
285 bbio->bi_seg_back_size = seg_size;
290 void blk_recalc_rq_segments(struct request *rq)
292 bool no_sg_merge = !!test_bit(QUEUE_FLAG_NO_SG_MERGE,
293 &rq->q->queue_flags);
295 rq->nr_phys_segments = __blk_recalc_rq_segments(rq->q, rq->bio,
299 void blk_recount_segments(struct request_queue *q, struct bio *bio)
301 unsigned short seg_cnt;
303 /* estimate segment number by bi_vcnt for non-cloned bio */
304 if (bio_flagged(bio, BIO_CLONED))
305 seg_cnt = bio_segments(bio);
307 seg_cnt = bio->bi_vcnt;
309 if (test_bit(QUEUE_FLAG_NO_SG_MERGE, &q->queue_flags) &&
310 (seg_cnt < queue_max_segments(q)))
311 bio->bi_phys_segments = seg_cnt;
313 struct bio *nxt = bio->bi_next;
316 bio->bi_phys_segments = __blk_recalc_rq_segments(q, bio, false);
320 bio_set_flag(bio, BIO_SEG_VALID);
322 EXPORT_SYMBOL(blk_recount_segments);
324 static int blk_phys_contig_segment(struct request_queue *q, struct bio *bio,
327 struct bio_vec end_bv = { NULL }, nxt_bv;
328 struct bvec_iter iter;
330 if (!blk_queue_cluster(q))
333 if (bio->bi_seg_back_size + nxt->bi_seg_front_size >
334 queue_max_segment_size(q))
337 if (!bio_has_data(bio))
340 bio_for_each_segment(end_bv, bio, iter)
341 if (end_bv.bv_len == iter.bi_size)
344 nxt_bv = bio_iovec(nxt);
346 if (!BIOVEC_PHYS_MERGEABLE(&end_bv, &nxt_bv))
350 * bio and nxt are contiguous in memory; check if the queue allows
351 * these two to be merged into one
353 if (BIOVEC_SEG_BOUNDARY(q, &end_bv, &nxt_bv))
360 __blk_segment_map_sg(struct request_queue *q, struct bio_vec *bvec,
361 struct scatterlist *sglist, struct bio_vec *bvprv,
362 struct scatterlist **sg, int *nsegs, int *cluster)
365 int nbytes = bvec->bv_len;
367 if (*sg && *cluster) {
368 if ((*sg)->length + nbytes > queue_max_segment_size(q))
371 if (!BIOVEC_PHYS_MERGEABLE(bvprv, bvec))
373 if (!BIOVEC_SEG_BOUNDARY(q, bvprv, bvec))
376 (*sg)->length += nbytes;
383 * If the driver previously mapped a shorter
384 * list, we could see a termination bit
385 * prematurely unless it fully inits the sg
386 * table on each mapping. We KNOW that there
387 * must be more entries here or the driver
388 * would be buggy, so force clear the
389 * termination bit to avoid doing a full
390 * sg_init_table() in drivers for each command.
396 sg_set_page(*sg, bvec->bv_page, nbytes, bvec->bv_offset);
402 static int __blk_bios_map_sg(struct request_queue *q, struct bio *bio,
403 struct scatterlist *sglist,
404 struct scatterlist **sg)
406 struct bio_vec bvec, bvprv = { NULL };
407 struct bvec_iter iter;
411 cluster = blk_queue_cluster(q);
413 if (bio->bi_rw & REQ_DISCARD) {
415 * This is a hack - drivers should be neither modifying the
416 * biovec, nor relying on bi_vcnt - but because of
417 * blk_add_request_payload(), a discard bio may or may not have
418 * a payload we need to set up here (thank you Christoph) and
419 * bi_vcnt is really the only way of telling if we need to.
428 if (bio->bi_rw & REQ_WRITE_SAME) {
431 bvec = bio_iovec(bio);
432 sg_set_page(*sg, bvec.bv_page, bvec.bv_len, bvec.bv_offset);
437 bio_for_each_segment(bvec, bio, iter)
438 __blk_segment_map_sg(q, &bvec, sglist, &bvprv, sg,
445 * map a request to scatterlist, return number of sg entries setup. Caller
446 * must make sure sg can hold rq->nr_phys_segments entries
448 int blk_rq_map_sg(struct request_queue *q, struct request *rq,
449 struct scatterlist *sglist)
451 struct scatterlist *sg = NULL;
455 nsegs = __blk_bios_map_sg(q, rq->bio, sglist, &sg);
457 if (unlikely(rq->cmd_flags & REQ_COPY_USER) &&
458 (blk_rq_bytes(rq) & q->dma_pad_mask)) {
459 unsigned int pad_len =
460 (q->dma_pad_mask & ~blk_rq_bytes(rq)) + 1;
462 sg->length += pad_len;
463 rq->extra_len += pad_len;
466 if (q->dma_drain_size && q->dma_drain_needed(rq)) {
467 if (rq->cmd_flags & REQ_WRITE)
468 memset(q->dma_drain_buffer, 0, q->dma_drain_size);
472 sg_set_page(sg, virt_to_page(q->dma_drain_buffer),
474 ((unsigned long)q->dma_drain_buffer) &
477 rq->extra_len += q->dma_drain_size;
484 * Something must have been wrong if the figured number of
485 * segment is bigger than number of req's physical segments
487 WARN_ON(nsegs > rq->nr_phys_segments);
491 EXPORT_SYMBOL(blk_rq_map_sg);
494 * map a request to scatterlist without combining PHY CONT
495 * blocks, return number of sg entries setup. Caller
496 * must make sure sg can hold rq->nr_phys_segments entries
498 int blk_rq_map_sg_no_cluster(struct request_queue *q, struct request *rq,
499 struct scatterlist *sglist)
501 struct bio_vec bvec, bvprv = { NULL };
502 struct req_iterator iter;
503 struct scatterlist *sg;
504 int nsegs, cluster = 0;
512 rq_for_each_segment(bvec, rq, iter) {
513 __blk_segment_map_sg(q, &bvec, sglist, &bvprv, &sg,
515 } /* segments in rq */
521 if (unlikely(rq->cmd_flags & REQ_COPY_USER) &&
522 (blk_rq_bytes(rq) & q->dma_pad_mask)) {
523 unsigned int pad_len =
524 (q->dma_pad_mask & ~blk_rq_bytes(rq)) + 1;
526 sg->length += pad_len;
527 rq->extra_len += pad_len;
530 if (q->dma_drain_size && q->dma_drain_needed(rq)) {
531 if (rq->cmd_flags & REQ_WRITE)
532 memset(q->dma_drain_buffer, 0, q->dma_drain_size);
534 sg->page_link &= ~0x02;
536 sg_set_page(sg, virt_to_page(q->dma_drain_buffer),
538 ((unsigned long)q->dma_drain_buffer) &
541 rq->extra_len += q->dma_drain_size;
549 EXPORT_SYMBOL(blk_rq_map_sg_no_cluster);
552 * blk_bio_map_sg - map a bio to a scatterlist
553 * @q: request_queue in question
554 * @bio: bio being mapped
555 * @sglist: scatterlist being mapped
558 * Caller must make sure sg can hold bio->bi_phys_segments entries
560 * Will return the number of sg entries setup
562 int blk_bio_map_sg(struct request_queue *q, struct bio *bio,
563 struct scatterlist *sglist)
565 struct scatterlist *sg = NULL;
567 struct bio *next = bio->bi_next;
570 nsegs = __blk_bios_map_sg(q, bio, sglist, &sg);
575 WARN_ON(bio->bi_phys_segments && nsegs > bio->bi_phys_segments);
578 EXPORT_SYMBOL(blk_bio_map_sg);
580 static inline int ll_new_hw_segment(struct request_queue *q,
584 int nr_phys_segs = bio_phys_segments(q, bio);
586 if (req->nr_phys_segments + nr_phys_segs > queue_max_segments(q))
589 if (blk_integrity_merge_bio(q, req, bio) == false)
593 * This will form the start of a new hw segment. Bump both
596 req->nr_phys_segments += nr_phys_segs;
600 req->cmd_flags |= REQ_NOMERGE;
601 if (req == q->last_merge)
602 q->last_merge = NULL;
606 int ll_back_merge_fn(struct request_queue *q, struct request *req,
609 if (req_gap_back_merge(req, bio))
611 if (blk_integrity_rq(req) &&
612 integrity_req_gap_back_merge(req, bio))
614 if (blk_rq_sectors(req) + bio_sectors(bio) >
615 blk_rq_get_max_sectors(req)) {
616 req->cmd_flags |= REQ_NOMERGE;
617 if (req == q->last_merge)
618 q->last_merge = NULL;
621 if (!bio_flagged(req->biotail, BIO_SEG_VALID))
622 blk_recount_segments(q, req->biotail);
623 if (!bio_flagged(bio, BIO_SEG_VALID))
624 blk_recount_segments(q, bio);
626 return ll_new_hw_segment(q, req, bio);
629 int ll_front_merge_fn(struct request_queue *q, struct request *req,
633 if (req_gap_front_merge(req, bio))
635 if (blk_integrity_rq(req) &&
636 integrity_req_gap_front_merge(req, bio))
638 if (blk_rq_sectors(req) + bio_sectors(bio) >
639 blk_rq_get_max_sectors(req)) {
640 req->cmd_flags |= REQ_NOMERGE;
641 if (req == q->last_merge)
642 q->last_merge = NULL;
645 if (!bio_flagged(bio, BIO_SEG_VALID))
646 blk_recount_segments(q, bio);
647 if (!bio_flagged(req->bio, BIO_SEG_VALID))
648 blk_recount_segments(q, req->bio);
650 return ll_new_hw_segment(q, req, bio);
654 * blk-mq uses req->special to carry normal driver per-request payload, it
655 * does not indicate a prepared command that we cannot merge with.
657 static bool req_no_special_merge(struct request *req)
659 struct request_queue *q = req->q;
661 return !q->mq_ops && req->special;
664 static int ll_merge_requests_fn(struct request_queue *q, struct request *req,
665 struct request *next)
667 int total_phys_segments;
668 unsigned int seg_size =
669 req->biotail->bi_seg_back_size + next->bio->bi_seg_front_size;
672 * First check if the either of the requests are re-queued
673 * requests. Can't merge them if they are.
675 if (req_no_special_merge(req) || req_no_special_merge(next))
678 if (req_gap_back_merge(req, next->bio))
682 * Will it become too large?
684 if ((blk_rq_sectors(req) + blk_rq_sectors(next)) >
685 blk_rq_get_max_sectors(req))
688 total_phys_segments = req->nr_phys_segments + next->nr_phys_segments;
689 if (blk_phys_contig_segment(q, req->biotail, next->bio)) {
690 if (req->nr_phys_segments == 1)
691 req->bio->bi_seg_front_size = seg_size;
692 if (next->nr_phys_segments == 1)
693 next->biotail->bi_seg_back_size = seg_size;
694 total_phys_segments--;
697 if (total_phys_segments > queue_max_segments(q))
700 if (blk_integrity_merge_rq(q, req, next) == false)
704 req->nr_phys_segments = total_phys_segments;
709 * blk_rq_set_mixed_merge - mark a request as mixed merge
710 * @rq: request to mark as mixed merge
713 * @rq is about to be mixed merged. Make sure the attributes
714 * which can be mixed are set in each bio and mark @rq as mixed
717 void blk_rq_set_mixed_merge(struct request *rq)
719 unsigned int ff = rq->cmd_flags & REQ_FAILFAST_MASK;
722 if (rq->cmd_flags & REQ_MIXED_MERGE)
726 * @rq will no longer represent mixable attributes for all the
727 * contained bios. It will just track those of the first one.
728 * Distributes the attributs to each bio.
730 for (bio = rq->bio; bio; bio = bio->bi_next) {
731 WARN_ON_ONCE((bio->bi_rw & REQ_FAILFAST_MASK) &&
732 (bio->bi_rw & REQ_FAILFAST_MASK) != ff);
735 rq->cmd_flags |= REQ_MIXED_MERGE;
738 static void blk_account_io_merge(struct request *req)
740 if (blk_do_io_stat(req)) {
741 struct hd_struct *part;
744 cpu = part_stat_lock();
747 part_round_stats(cpu, part);
748 part_dec_in_flight(part, rq_data_dir(req));
755 static bool crypto_not_mergeable(const struct bio *bio, const struct bio *nxt)
757 return (!pft_allow_merge_bio(bio, nxt) ||
758 !pfk_allow_merge_bio(bio, nxt));
762 * Has to be called with the request spinlock acquired
764 static int attempt_merge(struct request_queue *q, struct request *req,
765 struct request *next)
767 if (!rq_mergeable(req) || !rq_mergeable(next))
770 if (!blk_check_merge_flags(req->cmd_flags, next->cmd_flags))
776 if (blk_rq_pos(req) + blk_rq_sectors(req) != blk_rq_pos(next))
779 if (rq_data_dir(req) != rq_data_dir(next)
780 || req->rq_disk != next->rq_disk
781 || req_no_special_merge(next))
784 if (req->cmd_flags & REQ_WRITE_SAME &&
785 !blk_write_same_mergeable(req->bio, next->bio))
788 if (crypto_not_mergeable(req->bio, next->bio))
792 * If we are allowed to merge, then append bio list
793 * from next to rq and release next. merge_requests_fn
794 * will have updated segment counts, update sector
797 if (!ll_merge_requests_fn(q, req, next))
801 * If failfast settings disagree or any of the two is already
802 * a mixed merge, mark both as mixed before proceeding. This
803 * makes sure that all involved bios have mixable attributes
806 if ((req->cmd_flags | next->cmd_flags) & REQ_MIXED_MERGE ||
807 (req->cmd_flags & REQ_FAILFAST_MASK) !=
808 (next->cmd_flags & REQ_FAILFAST_MASK)) {
809 blk_rq_set_mixed_merge(req);
810 blk_rq_set_mixed_merge(next);
814 * At this point we have either done a back merge
815 * or front merge. We need the smaller start_time of
816 * the merged requests to be the current request
817 * for accounting purposes.
819 if (time_after(req->start_time, next->start_time))
820 req->start_time = next->start_time;
822 req->biotail->bi_next = next->bio;
823 req->biotail = next->biotail;
825 req->__data_len += blk_rq_bytes(next);
827 elv_merge_requests(q, req, next);
830 * 'next' is going away, so update stats accordingly
832 blk_account_io_merge(next);
834 req->ioprio = ioprio_best(req->ioprio, next->ioprio);
835 if (blk_rq_cpu_valid(next))
836 req->cpu = next->cpu;
838 /* owner-ship of bio passed from next to req */
840 __blk_put_request(q, next);
844 int attempt_back_merge(struct request_queue *q, struct request *rq)
846 struct request *next = elv_latter_request(q, rq);
849 return attempt_merge(q, rq, next);
854 int attempt_front_merge(struct request_queue *q, struct request *rq)
856 struct request *prev = elv_former_request(q, rq);
859 return attempt_merge(q, prev, rq);
864 int blk_attempt_req_merge(struct request_queue *q, struct request *rq,
865 struct request *next)
867 return attempt_merge(q, rq, next);
870 bool blk_rq_merge_ok(struct request *rq, struct bio *bio)
872 if (!rq_mergeable(rq) || !bio_mergeable(bio))
875 if (!blk_check_merge_flags(rq->cmd_flags, bio->bi_rw))
878 /* different data direction or already started, don't merge */
879 if (bio_data_dir(bio) != rq_data_dir(rq))
882 /* must be same device and not a special request */
883 if (rq->rq_disk != bio->bi_bdev->bd_disk || req_no_special_merge(rq))
886 /* only merge integrity protected bio into ditto rq */
887 if (blk_integrity_merge_bio(rq->q, rq, bio) == false)
890 /* must be using the same buffer */
891 if (rq->cmd_flags & REQ_WRITE_SAME &&
892 !blk_write_same_mergeable(rq->bio, bio))
895 if (crypto_not_mergeable(rq->bio, bio))
901 int blk_try_merge(struct request *rq, struct bio *bio)
903 if (blk_rq_pos(rq) + blk_rq_sectors(rq) == bio->bi_iter.bi_sector)
904 return ELEVATOR_BACK_MERGE;
905 else if (blk_rq_pos(rq) - bio_sectors(bio) == bio->bi_iter.bi_sector)
906 return ELEVATOR_FRONT_MERGE;
907 return ELEVATOR_NO_MERGE;