1 // SPDX-License-Identifier: GPL-2.0
3 * Functions related to segment and merge handling
5 #include <linux/kernel.h>
6 #include <linux/module.h>
8 #include <linux/blkdev.h>
9 #include <linux/scatterlist.h>
10 #include <linux/blkdev.h>
11 #include <linux/blk-cgroup.h>
13 #include <trace/events/block.h>
17 static struct bio *blk_bio_discard_split(struct request_queue *q,
22 unsigned int max_discard_sectors, granularity;
25 unsigned split_sectors;
29 /* Zero-sector (unknown) and one-sector granularities are the same. */
30 granularity = max(q->limits.discard_granularity >> 9, 1U);
32 max_discard_sectors = min(q->limits.max_discard_sectors,
33 bio_allowed_max_sectors(q));
34 max_discard_sectors -= max_discard_sectors % granularity;
36 if (unlikely(!max_discard_sectors)) {
41 if (bio_sectors(bio) <= max_discard_sectors)
44 split_sectors = max_discard_sectors;
47 * If the next starting sector would be misaligned, stop the discard at
48 * the previous aligned sector.
50 alignment = (q->limits.discard_alignment >> 9) % granularity;
52 tmp = bio->bi_iter.bi_sector + split_sectors - alignment;
53 tmp = sector_div(tmp, granularity);
55 if (split_sectors > tmp)
58 return bio_split(bio, split_sectors, GFP_NOIO, bs);
61 static struct bio *blk_bio_write_zeroes_split(struct request_queue *q,
62 struct bio *bio, struct bio_set *bs, unsigned *nsegs)
66 if (!q->limits.max_write_zeroes_sectors)
69 if (bio_sectors(bio) <= q->limits.max_write_zeroes_sectors)
72 return bio_split(bio, q->limits.max_write_zeroes_sectors, GFP_NOIO, bs);
75 static struct bio *blk_bio_write_same_split(struct request_queue *q,
82 if (!q->limits.max_write_same_sectors)
85 if (bio_sectors(bio) <= q->limits.max_write_same_sectors)
88 return bio_split(bio, q->limits.max_write_same_sectors, GFP_NOIO, bs);
91 static inline unsigned get_max_io_size(struct request_queue *q,
94 unsigned sectors = blk_max_size_offset(q, bio->bi_iter.bi_sector);
95 unsigned mask = queue_logical_block_size(q) - 1;
97 /* aligned to logical block size */
98 sectors &= ~(mask >> 9);
103 static struct bio *blk_bio_segment_split(struct request_queue *q,
108 struct bio_vec bv, bvprv, *bvprvp = NULL;
109 struct bvec_iter iter;
110 unsigned seg_size = 0, nsegs = 0, sectors = 0;
111 unsigned front_seg_size = bio->bi_seg_front_size;
112 bool do_split = true;
113 struct bio *new = NULL;
114 const unsigned max_sectors = get_max_io_size(q, bio);
116 bio_for_each_segment(bv, bio, iter) {
118 * If the queue doesn't support SG gaps and adding this
119 * offset would create a gap, disallow it.
121 if (bvprvp && bvec_gap_to_prev(q, bvprvp, bv.bv_offset))
124 if (sectors + (bv.bv_len >> 9) > max_sectors) {
126 * Consider this a new segment if we're splitting in
127 * the middle of this vector.
129 if (nsegs < queue_max_segments(q) &&
130 sectors < max_sectors) {
132 sectors = max_sectors;
137 if (bvprvp && blk_queue_cluster(q)) {
138 if (seg_size + bv.bv_len > queue_max_segment_size(q))
140 if (!BIOVEC_PHYS_MERGEABLE(bvprvp, &bv))
142 if (!BIOVEC_SEG_BOUNDARY(q, bvprvp, &bv))
145 seg_size += bv.bv_len;
148 sectors += bv.bv_len >> 9;
153 if (nsegs == queue_max_segments(q))
156 if (nsegs == 1 && seg_size > front_seg_size)
157 front_seg_size = seg_size;
162 seg_size = bv.bv_len;
163 sectors += bv.bv_len >> 9;
172 new = bio_split(bio, sectors, GFP_NOIO, bs);
177 if (nsegs == 1 && seg_size > front_seg_size)
178 front_seg_size = seg_size;
179 bio->bi_seg_front_size = front_seg_size;
180 if (seg_size > bio->bi_seg_back_size)
181 bio->bi_seg_back_size = seg_size;
183 return do_split ? new : NULL;
186 void blk_queue_split(struct request_queue *q, struct bio **bio)
188 struct bio *split, *res;
191 switch (bio_op(*bio)) {
193 case REQ_OP_SECURE_ERASE:
194 split = blk_bio_discard_split(q, *bio, &q->bio_split, &nsegs);
196 case REQ_OP_WRITE_ZEROES:
197 split = blk_bio_write_zeroes_split(q, *bio, &q->bio_split, &nsegs);
199 case REQ_OP_WRITE_SAME:
200 split = blk_bio_write_same_split(q, *bio, &q->bio_split, &nsegs);
203 split = blk_bio_segment_split(q, *bio, &q->bio_split, &nsegs);
207 /* physical segments can be figured out during splitting */
208 res = split ? split : *bio;
209 res->bi_phys_segments = nsegs;
210 bio_set_flag(res, BIO_SEG_VALID);
213 /* there isn't chance to merge the splitted bio */
214 split->bi_opf |= REQ_NOMERGE;
217 * Since we're recursing into make_request here, ensure
218 * that we mark this bio as already having entered the queue.
219 * If not, and the queue is going away, we can get stuck
220 * forever on waiting for the queue reference to drop. But
221 * that will never happen, as we're already holding a
224 bio_set_flag(*bio, BIO_QUEUE_ENTERED);
226 bio_chain(split, *bio);
227 trace_block_split(q, split, (*bio)->bi_iter.bi_sector);
228 generic_make_request(*bio);
232 EXPORT_SYMBOL(blk_queue_split);
234 static unsigned int __blk_recalc_rq_segments(struct request_queue *q,
238 struct bio_vec bv, bvprv = { NULL };
239 int cluster, prev = 0;
240 unsigned int seg_size, nr_phys_segs;
241 struct bio *fbio, *bbio;
242 struct bvec_iter iter;
247 switch (bio_op(bio)) {
249 case REQ_OP_SECURE_ERASE:
250 case REQ_OP_WRITE_ZEROES:
252 case REQ_OP_WRITE_SAME:
257 cluster = blk_queue_cluster(q);
261 bio_for_each_segment(bv, bio, iter) {
263 * If SG merging is disabled, each bio vector is
269 if (prev && cluster) {
270 if (seg_size + bv.bv_len
271 > queue_max_segment_size(q))
273 if (!BIOVEC_PHYS_MERGEABLE(&bvprv, &bv))
275 if (!BIOVEC_SEG_BOUNDARY(q, &bvprv, &bv))
278 seg_size += bv.bv_len;
283 if (nr_phys_segs == 1 && seg_size >
284 fbio->bi_seg_front_size)
285 fbio->bi_seg_front_size = seg_size;
290 seg_size = bv.bv_len;
295 if (nr_phys_segs == 1 && seg_size > fbio->bi_seg_front_size)
296 fbio->bi_seg_front_size = seg_size;
297 if (seg_size > bbio->bi_seg_back_size)
298 bbio->bi_seg_back_size = seg_size;
303 void blk_recalc_rq_segments(struct request *rq)
305 bool no_sg_merge = !!test_bit(QUEUE_FLAG_NO_SG_MERGE,
306 &rq->q->queue_flags);
308 rq->nr_phys_segments = __blk_recalc_rq_segments(rq->q, rq->bio,
312 void blk_recount_segments(struct request_queue *q, struct bio *bio)
314 unsigned short seg_cnt = bio_segments(bio);
316 if (test_bit(QUEUE_FLAG_NO_SG_MERGE, &q->queue_flags) &&
317 (seg_cnt < queue_max_segments(q)))
318 bio->bi_phys_segments = seg_cnt;
320 struct bio *nxt = bio->bi_next;
323 bio->bi_phys_segments = __blk_recalc_rq_segments(q, bio, false);
327 bio_set_flag(bio, BIO_SEG_VALID);
329 EXPORT_SYMBOL(blk_recount_segments);
331 static int blk_phys_contig_segment(struct request_queue *q, struct bio *bio,
334 struct bio_vec end_bv = { NULL }, nxt_bv;
336 if (!blk_queue_cluster(q))
339 if (bio->bi_seg_back_size + nxt->bi_seg_front_size >
340 queue_max_segment_size(q))
343 if (!bio_has_data(bio))
346 bio_get_last_bvec(bio, &end_bv);
347 bio_get_first_bvec(nxt, &nxt_bv);
349 if (!BIOVEC_PHYS_MERGEABLE(&end_bv, &nxt_bv))
353 * bio and nxt are contiguous in memory; check if the queue allows
354 * these two to be merged into one
356 if (BIOVEC_SEG_BOUNDARY(q, &end_bv, &nxt_bv))
363 __blk_segment_map_sg(struct request_queue *q, struct bio_vec *bvec,
364 struct scatterlist *sglist, struct bio_vec *bvprv,
365 struct scatterlist **sg, int *nsegs, int *cluster)
368 int nbytes = bvec->bv_len;
370 if (*sg && *cluster) {
371 if ((*sg)->length + nbytes > queue_max_segment_size(q))
374 if (!BIOVEC_PHYS_MERGEABLE(bvprv, bvec))
376 if (!BIOVEC_SEG_BOUNDARY(q, bvprv, bvec))
379 (*sg)->length += nbytes;
386 * If the driver previously mapped a shorter
387 * list, we could see a termination bit
388 * prematurely unless it fully inits the sg
389 * table on each mapping. We KNOW that there
390 * must be more entries here or the driver
391 * would be buggy, so force clear the
392 * termination bit to avoid doing a full
393 * sg_init_table() in drivers for each command.
399 sg_set_page(*sg, bvec->bv_page, nbytes, bvec->bv_offset);
405 static inline int __blk_bvec_map_sg(struct request_queue *q, struct bio_vec bv,
406 struct scatterlist *sglist, struct scatterlist **sg)
409 sg_set_page(*sg, bv.bv_page, bv.bv_len, bv.bv_offset);
413 static int __blk_bios_map_sg(struct request_queue *q, struct bio *bio,
414 struct scatterlist *sglist,
415 struct scatterlist **sg)
417 struct bio_vec bvec, bvprv = { NULL };
418 struct bvec_iter iter;
419 int cluster = blk_queue_cluster(q), nsegs = 0;
422 bio_for_each_segment(bvec, bio, iter)
423 __blk_segment_map_sg(q, &bvec, sglist, &bvprv, sg,
430 * map a request to scatterlist, return number of sg entries setup. Caller
431 * must make sure sg can hold rq->nr_phys_segments entries
433 int blk_rq_map_sg(struct request_queue *q, struct request *rq,
434 struct scatterlist *sglist)
436 struct scatterlist *sg = NULL;
439 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
440 nsegs = __blk_bvec_map_sg(q, rq->special_vec, sglist, &sg);
441 else if (rq->bio && bio_op(rq->bio) == REQ_OP_WRITE_SAME)
442 nsegs = __blk_bvec_map_sg(q, bio_iovec(rq->bio), sglist, &sg);
444 nsegs = __blk_bios_map_sg(q, rq->bio, sglist, &sg);
446 if (unlikely(rq->rq_flags & RQF_COPY_USER) &&
447 (blk_rq_bytes(rq) & q->dma_pad_mask)) {
448 unsigned int pad_len =
449 (q->dma_pad_mask & ~blk_rq_bytes(rq)) + 1;
451 sg->length += pad_len;
452 rq->extra_len += pad_len;
455 if (q->dma_drain_size && q->dma_drain_needed(rq)) {
456 if (op_is_write(req_op(rq)))
457 memset(q->dma_drain_buffer, 0, q->dma_drain_size);
461 sg_set_page(sg, virt_to_page(q->dma_drain_buffer),
463 ((unsigned long)q->dma_drain_buffer) &
466 rq->extra_len += q->dma_drain_size;
473 * Something must have been wrong if the figured number of
474 * segment is bigger than number of req's physical segments
476 WARN_ON(nsegs > blk_rq_nr_phys_segments(rq));
480 EXPORT_SYMBOL(blk_rq_map_sg);
482 static inline int ll_new_hw_segment(struct request_queue *q,
486 int nr_phys_segs = bio_phys_segments(q, bio);
488 if (req->nr_phys_segments + nr_phys_segs > queue_max_segments(q))
491 if (!blk_cgroup_mergeable(req, bio))
494 if (blk_integrity_merge_bio(q, req, bio) == false)
498 * This will form the start of a new hw segment. Bump both
501 req->nr_phys_segments += nr_phys_segs;
505 req_set_nomerge(q, req);
509 int ll_back_merge_fn(struct request_queue *q, struct request *req,
512 if (req_gap_back_merge(req, bio))
514 if (blk_integrity_rq(req) &&
515 integrity_req_gap_back_merge(req, bio))
517 if (blk_rq_sectors(req) + bio_sectors(bio) >
518 blk_rq_get_max_sectors(req, blk_rq_pos(req))) {
519 req_set_nomerge(q, req);
522 if (!bio_flagged(req->biotail, BIO_SEG_VALID))
523 blk_recount_segments(q, req->biotail);
524 if (!bio_flagged(bio, BIO_SEG_VALID))
525 blk_recount_segments(q, bio);
527 return ll_new_hw_segment(q, req, bio);
530 int ll_front_merge_fn(struct request_queue *q, struct request *req,
534 if (req_gap_front_merge(req, bio))
536 if (blk_integrity_rq(req) &&
537 integrity_req_gap_front_merge(req, bio))
539 if (blk_rq_sectors(req) + bio_sectors(bio) >
540 blk_rq_get_max_sectors(req, bio->bi_iter.bi_sector)) {
541 req_set_nomerge(q, req);
544 if (!bio_flagged(bio, BIO_SEG_VALID))
545 blk_recount_segments(q, bio);
546 if (!bio_flagged(req->bio, BIO_SEG_VALID))
547 blk_recount_segments(q, req->bio);
549 return ll_new_hw_segment(q, req, bio);
553 * blk-mq uses req->special to carry normal driver per-request payload, it
554 * does not indicate a prepared command that we cannot merge with.
556 static bool req_no_special_merge(struct request *req)
558 struct request_queue *q = req->q;
560 return !q->mq_ops && req->special;
563 static bool req_attempt_discard_merge(struct request_queue *q, struct request *req,
564 struct request *next)
566 unsigned short segments = blk_rq_nr_discard_segments(req);
568 if (segments >= queue_max_discard_segments(q))
570 if (blk_rq_sectors(req) + bio_sectors(next->bio) >
571 blk_rq_get_max_sectors(req, blk_rq_pos(req)))
574 req->nr_phys_segments = segments + blk_rq_nr_discard_segments(next);
577 req_set_nomerge(q, req);
581 static int ll_merge_requests_fn(struct request_queue *q, struct request *req,
582 struct request *next)
584 int total_phys_segments;
585 unsigned int seg_size =
586 req->biotail->bi_seg_back_size + next->bio->bi_seg_front_size;
589 * First check if the either of the requests are re-queued
590 * requests. Can't merge them if they are.
592 if (req_no_special_merge(req) || req_no_special_merge(next))
595 if (req_gap_back_merge(req, next->bio))
599 * Will it become too large?
601 if ((blk_rq_sectors(req) + blk_rq_sectors(next)) >
602 blk_rq_get_max_sectors(req, blk_rq_pos(req)))
605 total_phys_segments = req->nr_phys_segments + next->nr_phys_segments;
606 if (blk_phys_contig_segment(q, req->biotail, next->bio)) {
607 if (req->nr_phys_segments == 1)
608 req->bio->bi_seg_front_size = seg_size;
609 if (next->nr_phys_segments == 1)
610 next->biotail->bi_seg_back_size = seg_size;
611 total_phys_segments--;
614 if (total_phys_segments > queue_max_segments(q))
617 if (!blk_cgroup_mergeable(req, next->bio))
620 if (blk_integrity_merge_rq(q, req, next) == false)
624 req->nr_phys_segments = total_phys_segments;
629 * blk_rq_set_mixed_merge - mark a request as mixed merge
630 * @rq: request to mark as mixed merge
633 * @rq is about to be mixed merged. Make sure the attributes
634 * which can be mixed are set in each bio and mark @rq as mixed
637 void blk_rq_set_mixed_merge(struct request *rq)
639 unsigned int ff = rq->cmd_flags & REQ_FAILFAST_MASK;
642 if (rq->rq_flags & RQF_MIXED_MERGE)
646 * @rq will no longer represent mixable attributes for all the
647 * contained bios. It will just track those of the first one.
648 * Distributes the attributs to each bio.
650 for (bio = rq->bio; bio; bio = bio->bi_next) {
651 WARN_ON_ONCE((bio->bi_opf & REQ_FAILFAST_MASK) &&
652 (bio->bi_opf & REQ_FAILFAST_MASK) != ff);
655 rq->rq_flags |= RQF_MIXED_MERGE;
658 static void blk_account_io_merge(struct request *req)
660 if (blk_do_io_stat(req)) {
661 struct hd_struct *part;
664 cpu = part_stat_lock();
667 part_round_stats(req->q, cpu, part);
668 part_dec_in_flight(req->q, part, rq_data_dir(req));
675 * Two cases of handling DISCARD merge:
676 * If max_discard_segments > 1, the driver takes every bio
677 * as a range and send them to controller together. The ranges
678 * needn't to be contiguous.
679 * Otherwise, the bios/requests will be handled as same as
680 * others which should be contiguous.
682 static inline bool blk_discard_mergable(struct request *req)
684 if (req_op(req) == REQ_OP_DISCARD &&
685 queue_max_discard_segments(req->q) > 1)
690 enum elv_merge blk_try_req_merge(struct request *req, struct request *next)
692 if (blk_discard_mergable(req))
693 return ELEVATOR_DISCARD_MERGE;
694 else if (blk_rq_pos(req) + blk_rq_sectors(req) == blk_rq_pos(next))
695 return ELEVATOR_BACK_MERGE;
697 return ELEVATOR_NO_MERGE;
701 * For non-mq, this has to be called with the request spinlock acquired.
702 * For mq with scheduling, the appropriate queue wide lock should be held.
704 static struct request *attempt_merge(struct request_queue *q,
705 struct request *req, struct request *next)
708 lockdep_assert_held(q->queue_lock);
710 if (!rq_mergeable(req) || !rq_mergeable(next))
713 if (req_op(req) != req_op(next))
716 if (rq_data_dir(req) != rq_data_dir(next)
717 || req->rq_disk != next->rq_disk
718 || req_no_special_merge(next))
721 if (req_op(req) == REQ_OP_WRITE_SAME &&
722 !blk_write_same_mergeable(req->bio, next->bio))
726 * Don't allow merge of different write hints, or for a hint with
729 if (req->write_hint != next->write_hint)
733 * If we are allowed to merge, then append bio list
734 * from next to rq and release next. merge_requests_fn
735 * will have updated segment counts, update sector
736 * counts here. Handle DISCARDs separately, as they
737 * have separate settings.
740 switch (blk_try_req_merge(req, next)) {
741 case ELEVATOR_DISCARD_MERGE:
742 if (!req_attempt_discard_merge(q, req, next))
745 case ELEVATOR_BACK_MERGE:
746 if (!ll_merge_requests_fn(q, req, next))
754 * If failfast settings disagree or any of the two is already
755 * a mixed merge, mark both as mixed before proceeding. This
756 * makes sure that all involved bios have mixable attributes
759 if (((req->rq_flags | next->rq_flags) & RQF_MIXED_MERGE) ||
760 (req->cmd_flags & REQ_FAILFAST_MASK) !=
761 (next->cmd_flags & REQ_FAILFAST_MASK)) {
762 blk_rq_set_mixed_merge(req);
763 blk_rq_set_mixed_merge(next);
767 * At this point we have either done a back merge or front merge. We
768 * need the smaller start_time_ns of the merged requests to be the
769 * current request for accounting purposes.
771 if (next->start_time_ns < req->start_time_ns)
772 req->start_time_ns = next->start_time_ns;
774 req->biotail->bi_next = next->bio;
775 req->biotail = next->biotail;
777 req->__data_len += blk_rq_bytes(next);
779 if (!blk_discard_mergable(req))
780 elv_merge_requests(q, req, next);
783 * 'next' is going away, so update stats accordingly
785 blk_account_io_merge(next);
787 req->ioprio = ioprio_best(req->ioprio, next->ioprio);
788 if (blk_rq_cpu_valid(next))
789 req->cpu = next->cpu;
792 * ownership of bio passed from next to req, return 'next' for
799 struct request *attempt_back_merge(struct request_queue *q, struct request *rq)
801 struct request *next = elv_latter_request(q, rq);
804 return attempt_merge(q, rq, next);
809 struct request *attempt_front_merge(struct request_queue *q, struct request *rq)
811 struct request *prev = elv_former_request(q, rq);
814 return attempt_merge(q, prev, rq);
819 int blk_attempt_req_merge(struct request_queue *q, struct request *rq,
820 struct request *next)
822 struct elevator_queue *e = q->elevator;
823 struct request *free;
825 if (!e->uses_mq && e->type->ops.sq.elevator_allow_rq_merge_fn)
826 if (!e->type->ops.sq.elevator_allow_rq_merge_fn(q, rq, next))
829 free = attempt_merge(q, rq, next);
831 __blk_put_request(q, free);
838 bool blk_rq_merge_ok(struct request *rq, struct bio *bio)
840 if (!rq_mergeable(rq) || !bio_mergeable(bio))
843 if (req_op(rq) != bio_op(bio))
846 /* different data direction or already started, don't merge */
847 if (bio_data_dir(bio) != rq_data_dir(rq))
850 /* must be same device and not a special request */
851 if (rq->rq_disk != bio->bi_disk || req_no_special_merge(rq))
854 /* don't merge across cgroup boundaries */
855 if (!blk_cgroup_mergeable(rq, bio))
858 /* only merge integrity protected bio into ditto rq */
859 if (blk_integrity_merge_bio(rq->q, rq, bio) == false)
862 /* must be using the same buffer */
863 if (req_op(rq) == REQ_OP_WRITE_SAME &&
864 !blk_write_same_mergeable(rq->bio, bio))
868 * Don't allow merge of different write hints, or for a hint with
871 if (rq->write_hint != bio->bi_write_hint)
877 enum elv_merge blk_try_merge(struct request *rq, struct bio *bio)
879 if (blk_discard_mergable(rq))
880 return ELEVATOR_DISCARD_MERGE;
881 else if (blk_rq_pos(rq) + blk_rq_sectors(rq) == bio->bi_iter.bi_sector)
882 return ELEVATOR_BACK_MERGE;
883 else if (blk_rq_pos(rq) - bio_sectors(bio) == bio->bi_iter.bi_sector)
884 return ELEVATOR_FRONT_MERGE;
885 return ELEVATOR_NO_MERGE;