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>
11 #include <trace/events/block.h>
15 static struct bio *blk_bio_discard_split(struct request_queue *q,
20 unsigned int max_discard_sectors, granularity;
23 unsigned split_sectors;
27 /* Zero-sector (unknown) and one-sector granularities are the same. */
28 granularity = max(q->limits.discard_granularity >> 9, 1U);
30 max_discard_sectors = min(q->limits.max_discard_sectors,
31 bio_allowed_max_sectors(q));
32 max_discard_sectors -= max_discard_sectors % granularity;
34 if (unlikely(!max_discard_sectors)) {
39 if (bio_sectors(bio) <= max_discard_sectors)
42 split_sectors = max_discard_sectors;
45 * If the next starting sector would be misaligned, stop the discard at
46 * the previous aligned sector.
48 alignment = (q->limits.discard_alignment >> 9) % granularity;
50 tmp = bio->bi_iter.bi_sector + split_sectors - alignment;
51 tmp = sector_div(tmp, granularity);
53 if (split_sectors > tmp)
56 return bio_split(bio, split_sectors, GFP_NOIO, bs);
59 static struct bio *blk_bio_write_zeroes_split(struct request_queue *q,
60 struct bio *bio, struct bio_set *bs, unsigned *nsegs)
64 if (!q->limits.max_write_zeroes_sectors)
67 if (bio_sectors(bio) <= q->limits.max_write_zeroes_sectors)
70 return bio_split(bio, q->limits.max_write_zeroes_sectors, GFP_NOIO, bs);
73 static struct bio *blk_bio_write_same_split(struct request_queue *q,
80 if (!q->limits.max_write_same_sectors)
83 if (bio_sectors(bio) <= q->limits.max_write_same_sectors)
86 return bio_split(bio, q->limits.max_write_same_sectors, GFP_NOIO, bs);
89 static inline unsigned get_max_io_size(struct request_queue *q,
92 unsigned sectors = blk_max_size_offset(q, bio->bi_iter.bi_sector);
93 unsigned mask = queue_logical_block_size(q) - 1;
95 /* aligned to logical block size */
96 sectors &= ~(mask >> 9);
101 static struct bio *blk_bio_segment_split(struct request_queue *q,
106 struct bio_vec bv, bvprv, *bvprvp = NULL;
107 struct bvec_iter iter;
108 unsigned seg_size = 0, nsegs = 0, sectors = 0;
109 unsigned front_seg_size = bio->bi_seg_front_size;
110 bool do_split = true;
111 struct bio *new = NULL;
112 const unsigned max_sectors = get_max_io_size(q, bio);
114 bio_for_each_segment(bv, bio, iter) {
116 * If the queue doesn't support SG gaps and adding this
117 * offset would create a gap, disallow it.
119 if (bvprvp && bvec_gap_to_prev(q, bvprvp, bv.bv_offset))
122 if (sectors + (bv.bv_len >> 9) > max_sectors) {
124 * Consider this a new segment if we're splitting in
125 * the middle of this vector.
127 if (nsegs < queue_max_segments(q) &&
128 sectors < max_sectors) {
130 sectors = max_sectors;
135 if (bvprvp && blk_queue_cluster(q)) {
136 if (seg_size + bv.bv_len > queue_max_segment_size(q))
138 if (!BIOVEC_PHYS_MERGEABLE(bvprvp, &bv))
140 if (!BIOVEC_SEG_BOUNDARY(q, bvprvp, &bv))
143 seg_size += bv.bv_len;
146 sectors += bv.bv_len >> 9;
151 if (nsegs == queue_max_segments(q))
154 if (nsegs == 1 && seg_size > front_seg_size)
155 front_seg_size = seg_size;
160 seg_size = bv.bv_len;
161 sectors += bv.bv_len >> 9;
170 new = bio_split(bio, sectors, GFP_NOIO, bs);
175 if (nsegs == 1 && seg_size > front_seg_size)
176 front_seg_size = seg_size;
177 bio->bi_seg_front_size = front_seg_size;
178 if (seg_size > bio->bi_seg_back_size)
179 bio->bi_seg_back_size = seg_size;
181 return do_split ? new : NULL;
184 void blk_queue_split(struct request_queue *q, struct bio **bio)
186 struct bio *split, *res;
189 switch (bio_op(*bio)) {
191 case REQ_OP_SECURE_ERASE:
192 split = blk_bio_discard_split(q, *bio, &q->bio_split, &nsegs);
194 case REQ_OP_WRITE_ZEROES:
195 split = blk_bio_write_zeroes_split(q, *bio, &q->bio_split, &nsegs);
197 case REQ_OP_WRITE_SAME:
198 split = blk_bio_write_same_split(q, *bio, &q->bio_split, &nsegs);
201 split = blk_bio_segment_split(q, *bio, &q->bio_split, &nsegs);
205 /* physical segments can be figured out during splitting */
206 res = split ? split : *bio;
207 res->bi_phys_segments = nsegs;
208 bio_set_flag(res, BIO_SEG_VALID);
211 /* there isn't chance to merge the splitted bio */
212 split->bi_opf |= REQ_NOMERGE;
215 * Since we're recursing into make_request here, ensure
216 * that we mark this bio as already having entered the queue.
217 * If not, and the queue is going away, we can get stuck
218 * forever on waiting for the queue reference to drop. But
219 * that will never happen, as we're already holding a
222 bio_set_flag(*bio, BIO_QUEUE_ENTERED);
224 bio_chain(split, *bio);
225 trace_block_split(q, split, (*bio)->bi_iter.bi_sector);
226 generic_make_request(*bio);
230 EXPORT_SYMBOL(blk_queue_split);
232 static unsigned int __blk_recalc_rq_segments(struct request_queue *q,
236 struct bio_vec bv, bvprv = { NULL };
237 int cluster, prev = 0;
238 unsigned int seg_size, nr_phys_segs;
239 struct bio *fbio, *bbio;
240 struct bvec_iter iter;
245 switch (bio_op(bio)) {
247 case REQ_OP_SECURE_ERASE:
248 case REQ_OP_WRITE_ZEROES:
250 case REQ_OP_WRITE_SAME:
255 cluster = blk_queue_cluster(q);
259 bio_for_each_segment(bv, bio, iter) {
261 * If SG merging is disabled, each bio vector is
267 if (prev && cluster) {
268 if (seg_size + bv.bv_len
269 > queue_max_segment_size(q))
271 if (!BIOVEC_PHYS_MERGEABLE(&bvprv, &bv))
273 if (!BIOVEC_SEG_BOUNDARY(q, &bvprv, &bv))
276 seg_size += bv.bv_len;
281 if (nr_phys_segs == 1 && seg_size >
282 fbio->bi_seg_front_size)
283 fbio->bi_seg_front_size = seg_size;
288 seg_size = bv.bv_len;
293 if (nr_phys_segs == 1 && seg_size > fbio->bi_seg_front_size)
294 fbio->bi_seg_front_size = seg_size;
295 if (seg_size > bbio->bi_seg_back_size)
296 bbio->bi_seg_back_size = seg_size;
301 void blk_recalc_rq_segments(struct request *rq)
303 bool no_sg_merge = !!test_bit(QUEUE_FLAG_NO_SG_MERGE,
304 &rq->q->queue_flags);
306 rq->nr_phys_segments = __blk_recalc_rq_segments(rq->q, rq->bio,
310 void blk_recount_segments(struct request_queue *q, struct bio *bio)
312 unsigned short seg_cnt = bio_segments(bio);
314 if (test_bit(QUEUE_FLAG_NO_SG_MERGE, &q->queue_flags) &&
315 (seg_cnt < queue_max_segments(q)))
316 bio->bi_phys_segments = seg_cnt;
318 struct bio *nxt = bio->bi_next;
321 bio->bi_phys_segments = __blk_recalc_rq_segments(q, bio, false);
325 bio_set_flag(bio, BIO_SEG_VALID);
327 EXPORT_SYMBOL(blk_recount_segments);
329 static int blk_phys_contig_segment(struct request_queue *q, struct bio *bio,
332 struct bio_vec end_bv = { NULL }, nxt_bv;
334 if (!blk_queue_cluster(q))
337 if (bio->bi_seg_back_size + nxt->bi_seg_front_size >
338 queue_max_segment_size(q))
341 if (!bio_has_data(bio))
344 bio_get_last_bvec(bio, &end_bv);
345 bio_get_first_bvec(nxt, &nxt_bv);
347 if (!BIOVEC_PHYS_MERGEABLE(&end_bv, &nxt_bv))
351 * bio and nxt are contiguous in memory; check if the queue allows
352 * these two to be merged into one
354 if (BIOVEC_SEG_BOUNDARY(q, &end_bv, &nxt_bv))
361 __blk_segment_map_sg(struct request_queue *q, struct bio_vec *bvec,
362 struct scatterlist *sglist, struct bio_vec *bvprv,
363 struct scatterlist **sg, int *nsegs, int *cluster)
366 int nbytes = bvec->bv_len;
368 if (*sg && *cluster) {
369 if ((*sg)->length + nbytes > queue_max_segment_size(q))
372 if (!BIOVEC_PHYS_MERGEABLE(bvprv, bvec))
374 if (!BIOVEC_SEG_BOUNDARY(q, bvprv, bvec))
377 (*sg)->length += nbytes;
384 * If the driver previously mapped a shorter
385 * list, we could see a termination bit
386 * prematurely unless it fully inits the sg
387 * table on each mapping. We KNOW that there
388 * must be more entries here or the driver
389 * would be buggy, so force clear the
390 * termination bit to avoid doing a full
391 * sg_init_table() in drivers for each command.
397 sg_set_page(*sg, bvec->bv_page, nbytes, bvec->bv_offset);
403 static inline int __blk_bvec_map_sg(struct request_queue *q, struct bio_vec bv,
404 struct scatterlist *sglist, struct scatterlist **sg)
407 sg_set_page(*sg, bv.bv_page, bv.bv_len, bv.bv_offset);
411 static int __blk_bios_map_sg(struct request_queue *q, struct bio *bio,
412 struct scatterlist *sglist,
413 struct scatterlist **sg)
415 struct bio_vec bvec, bvprv = { NULL };
416 struct bvec_iter iter;
417 int cluster = blk_queue_cluster(q), nsegs = 0;
420 bio_for_each_segment(bvec, bio, iter)
421 __blk_segment_map_sg(q, &bvec, sglist, &bvprv, sg,
428 * map a request to scatterlist, return number of sg entries setup. Caller
429 * must make sure sg can hold rq->nr_phys_segments entries
431 int blk_rq_map_sg(struct request_queue *q, struct request *rq,
432 struct scatterlist *sglist)
434 struct scatterlist *sg = NULL;
437 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
438 nsegs = __blk_bvec_map_sg(q, rq->special_vec, sglist, &sg);
439 else if (rq->bio && bio_op(rq->bio) == REQ_OP_WRITE_SAME)
440 nsegs = __blk_bvec_map_sg(q, bio_iovec(rq->bio), sglist, &sg);
442 nsegs = __blk_bios_map_sg(q, rq->bio, sglist, &sg);
444 if (unlikely(rq->rq_flags & RQF_COPY_USER) &&
445 (blk_rq_bytes(rq) & q->dma_pad_mask)) {
446 unsigned int pad_len =
447 (q->dma_pad_mask & ~blk_rq_bytes(rq)) + 1;
449 sg->length += pad_len;
450 rq->extra_len += pad_len;
453 if (q->dma_drain_size && q->dma_drain_needed(rq)) {
454 if (op_is_write(req_op(rq)))
455 memset(q->dma_drain_buffer, 0, q->dma_drain_size);
459 sg_set_page(sg, virt_to_page(q->dma_drain_buffer),
461 ((unsigned long)q->dma_drain_buffer) &
464 rq->extra_len += q->dma_drain_size;
471 * Something must have been wrong if the figured number of
472 * segment is bigger than number of req's physical segments
474 WARN_ON(nsegs > blk_rq_nr_phys_segments(rq));
478 EXPORT_SYMBOL(blk_rq_map_sg);
480 static inline int ll_new_hw_segment(struct request_queue *q,
484 int nr_phys_segs = bio_phys_segments(q, bio);
486 if (req->nr_phys_segments + nr_phys_segs > queue_max_segments(q))
489 if (blk_integrity_merge_bio(q, req, bio) == false)
493 * This will form the start of a new hw segment. Bump both
496 req->nr_phys_segments += nr_phys_segs;
500 req_set_nomerge(q, req);
504 int ll_back_merge_fn(struct request_queue *q, struct request *req,
507 if (req_gap_back_merge(req, bio))
509 if (blk_integrity_rq(req) &&
510 integrity_req_gap_back_merge(req, bio))
512 if (blk_rq_sectors(req) + bio_sectors(bio) >
513 blk_rq_get_max_sectors(req, blk_rq_pos(req))) {
514 req_set_nomerge(q, req);
517 if (!bio_flagged(req->biotail, BIO_SEG_VALID))
518 blk_recount_segments(q, req->biotail);
519 if (!bio_flagged(bio, BIO_SEG_VALID))
520 blk_recount_segments(q, bio);
522 return ll_new_hw_segment(q, req, bio);
525 int ll_front_merge_fn(struct request_queue *q, struct request *req,
529 if (req_gap_front_merge(req, bio))
531 if (blk_integrity_rq(req) &&
532 integrity_req_gap_front_merge(req, bio))
534 if (blk_rq_sectors(req) + bio_sectors(bio) >
535 blk_rq_get_max_sectors(req, bio->bi_iter.bi_sector)) {
536 req_set_nomerge(q, req);
539 if (!bio_flagged(bio, BIO_SEG_VALID))
540 blk_recount_segments(q, bio);
541 if (!bio_flagged(req->bio, BIO_SEG_VALID))
542 blk_recount_segments(q, req->bio);
544 return ll_new_hw_segment(q, req, bio);
548 * blk-mq uses req->special to carry normal driver per-request payload, it
549 * does not indicate a prepared command that we cannot merge with.
551 static bool req_no_special_merge(struct request *req)
553 struct request_queue *q = req->q;
555 return !q->mq_ops && req->special;
558 static bool req_attempt_discard_merge(struct request_queue *q, struct request *req,
559 struct request *next)
561 unsigned short segments = blk_rq_nr_discard_segments(req);
563 if (segments >= queue_max_discard_segments(q))
565 if (blk_rq_sectors(req) + bio_sectors(next->bio) >
566 blk_rq_get_max_sectors(req, blk_rq_pos(req)))
569 req->nr_phys_segments = segments + blk_rq_nr_discard_segments(next);
572 req_set_nomerge(q, req);
576 static int ll_merge_requests_fn(struct request_queue *q, struct request *req,
577 struct request *next)
579 int total_phys_segments;
580 unsigned int seg_size =
581 req->biotail->bi_seg_back_size + next->bio->bi_seg_front_size;
584 * First check if the either of the requests are re-queued
585 * requests. Can't merge them if they are.
587 if (req_no_special_merge(req) || req_no_special_merge(next))
590 if (req_gap_back_merge(req, next->bio))
594 * Will it become too large?
596 if ((blk_rq_sectors(req) + blk_rq_sectors(next)) >
597 blk_rq_get_max_sectors(req, blk_rq_pos(req)))
600 total_phys_segments = req->nr_phys_segments + next->nr_phys_segments;
601 if (blk_phys_contig_segment(q, req->biotail, next->bio)) {
602 if (req->nr_phys_segments == 1)
603 req->bio->bi_seg_front_size = seg_size;
604 if (next->nr_phys_segments == 1)
605 next->biotail->bi_seg_back_size = seg_size;
606 total_phys_segments--;
609 if (total_phys_segments > queue_max_segments(q))
612 if (blk_integrity_merge_rq(q, req, next) == false)
616 req->nr_phys_segments = total_phys_segments;
621 * blk_rq_set_mixed_merge - mark a request as mixed merge
622 * @rq: request to mark as mixed merge
625 * @rq is about to be mixed merged. Make sure the attributes
626 * which can be mixed are set in each bio and mark @rq as mixed
629 void blk_rq_set_mixed_merge(struct request *rq)
631 unsigned int ff = rq->cmd_flags & REQ_FAILFAST_MASK;
634 if (rq->rq_flags & RQF_MIXED_MERGE)
638 * @rq will no longer represent mixable attributes for all the
639 * contained bios. It will just track those of the first one.
640 * Distributes the attributs to each bio.
642 for (bio = rq->bio; bio; bio = bio->bi_next) {
643 WARN_ON_ONCE((bio->bi_opf & REQ_FAILFAST_MASK) &&
644 (bio->bi_opf & REQ_FAILFAST_MASK) != ff);
647 rq->rq_flags |= RQF_MIXED_MERGE;
650 static void blk_account_io_merge(struct request *req)
652 if (blk_do_io_stat(req)) {
653 struct hd_struct *part;
656 cpu = part_stat_lock();
659 part_round_stats(req->q, cpu, part);
660 part_dec_in_flight(req->q, part, rq_data_dir(req));
667 * Two cases of handling DISCARD merge:
668 * If max_discard_segments > 1, the driver takes every bio
669 * as a range and send them to controller together. The ranges
670 * needn't to be contiguous.
671 * Otherwise, the bios/requests will be handled as same as
672 * others which should be contiguous.
674 static inline bool blk_discard_mergable(struct request *req)
676 if (req_op(req) == REQ_OP_DISCARD &&
677 queue_max_discard_segments(req->q) > 1)
682 enum elv_merge blk_try_req_merge(struct request *req, struct request *next)
684 if (blk_discard_mergable(req))
685 return ELEVATOR_DISCARD_MERGE;
686 else if (blk_rq_pos(req) + blk_rq_sectors(req) == blk_rq_pos(next))
687 return ELEVATOR_BACK_MERGE;
689 return ELEVATOR_NO_MERGE;
693 * For non-mq, this has to be called with the request spinlock acquired.
694 * For mq with scheduling, the appropriate queue wide lock should be held.
696 static struct request *attempt_merge(struct request_queue *q,
697 struct request *req, struct request *next)
700 lockdep_assert_held(q->queue_lock);
702 if (!rq_mergeable(req) || !rq_mergeable(next))
705 if (req_op(req) != req_op(next))
708 if (rq_data_dir(req) != rq_data_dir(next)
709 || req->rq_disk != next->rq_disk
710 || req_no_special_merge(next))
713 if (req_op(req) == REQ_OP_WRITE_SAME &&
714 !blk_write_same_mergeable(req->bio, next->bio))
718 * Don't allow merge of different write hints, or for a hint with
721 if (req->write_hint != next->write_hint)
725 * If we are allowed to merge, then append bio list
726 * from next to rq and release next. merge_requests_fn
727 * will have updated segment counts, update sector
728 * counts here. Handle DISCARDs separately, as they
729 * have separate settings.
732 switch (blk_try_req_merge(req, next)) {
733 case ELEVATOR_DISCARD_MERGE:
734 if (!req_attempt_discard_merge(q, req, next))
737 case ELEVATOR_BACK_MERGE:
738 if (!ll_merge_requests_fn(q, req, next))
746 * If failfast settings disagree or any of the two is already
747 * a mixed merge, mark both as mixed before proceeding. This
748 * makes sure that all involved bios have mixable attributes
751 if (((req->rq_flags | next->rq_flags) & RQF_MIXED_MERGE) ||
752 (req->cmd_flags & REQ_FAILFAST_MASK) !=
753 (next->cmd_flags & REQ_FAILFAST_MASK)) {
754 blk_rq_set_mixed_merge(req);
755 blk_rq_set_mixed_merge(next);
759 * At this point we have either done a back merge or front merge. We
760 * need the smaller start_time_ns of the merged requests to be the
761 * current request for accounting purposes.
763 if (next->start_time_ns < req->start_time_ns)
764 req->start_time_ns = next->start_time_ns;
766 req->biotail->bi_next = next->bio;
767 req->biotail = next->biotail;
769 req->__data_len += blk_rq_bytes(next);
771 if (!blk_discard_mergable(req))
772 elv_merge_requests(q, req, next);
775 * 'next' is going away, so update stats accordingly
777 blk_account_io_merge(next);
779 req->ioprio = ioprio_best(req->ioprio, next->ioprio);
780 if (blk_rq_cpu_valid(next))
781 req->cpu = next->cpu;
784 * ownership of bio passed from next to req, return 'next' for
791 struct request *attempt_back_merge(struct request_queue *q, struct request *rq)
793 struct request *next = elv_latter_request(q, rq);
796 return attempt_merge(q, rq, next);
801 struct request *attempt_front_merge(struct request_queue *q, struct request *rq)
803 struct request *prev = elv_former_request(q, rq);
806 return attempt_merge(q, prev, rq);
811 int blk_attempt_req_merge(struct request_queue *q, struct request *rq,
812 struct request *next)
814 struct elevator_queue *e = q->elevator;
815 struct request *free;
817 if (!e->uses_mq && e->type->ops.sq.elevator_allow_rq_merge_fn)
818 if (!e->type->ops.sq.elevator_allow_rq_merge_fn(q, rq, next))
821 free = attempt_merge(q, rq, next);
823 __blk_put_request(q, free);
830 bool blk_rq_merge_ok(struct request *rq, struct bio *bio)
832 if (!rq_mergeable(rq) || !bio_mergeable(bio))
835 if (req_op(rq) != bio_op(bio))
838 /* different data direction or already started, don't merge */
839 if (bio_data_dir(bio) != rq_data_dir(rq))
842 /* must be same device and not a special request */
843 if (rq->rq_disk != bio->bi_disk || req_no_special_merge(rq))
846 /* only merge integrity protected bio into ditto rq */
847 if (blk_integrity_merge_bio(rq->q, rq, bio) == false)
850 /* must be using the same buffer */
851 if (req_op(rq) == REQ_OP_WRITE_SAME &&
852 !blk_write_same_mergeable(rq->bio, bio))
856 * Don't allow merge of different write hints, or for a hint with
859 if (rq->write_hint != bio->bi_write_hint)
865 enum elv_merge blk_try_merge(struct request *rq, struct bio *bio)
867 if (blk_discard_mergable(rq))
868 return ELEVATOR_DISCARD_MERGE;
869 else if (blk_rq_pos(rq) + blk_rq_sectors(rq) == bio->bi_iter.bi_sector)
870 return ELEVATOR_BACK_MERGE;
871 else if (blk_rq_pos(rq) - bio_sectors(bio) == bio->bi_iter.bi_sector)
872 return ELEVATOR_FRONT_MERGE;
873 return ELEVATOR_NO_MERGE;