blk-mq: enforce op-specific segment limits in blk_insert_cloned_request
[platform/kernel/linux-starfive.git] / block / blk-merge.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Functions related to segment and merge handling
4  */
5 #include <linux/kernel.h>
6 #include <linux/module.h>
7 #include <linux/bio.h>
8 #include <linux/blkdev.h>
9 #include <linux/blk-integrity.h>
10 #include <linux/scatterlist.h>
11 #include <linux/part_stat.h>
12 #include <linux/blk-cgroup.h>
13
14 #include <trace/events/block.h>
15
16 #include "blk.h"
17 #include "blk-mq-sched.h"
18 #include "blk-rq-qos.h"
19 #include "blk-throttle.h"
20
21 static inline void bio_get_first_bvec(struct bio *bio, struct bio_vec *bv)
22 {
23         *bv = mp_bvec_iter_bvec(bio->bi_io_vec, bio->bi_iter);
24 }
25
26 static inline void bio_get_last_bvec(struct bio *bio, struct bio_vec *bv)
27 {
28         struct bvec_iter iter = bio->bi_iter;
29         int idx;
30
31         bio_get_first_bvec(bio, bv);
32         if (bv->bv_len == bio->bi_iter.bi_size)
33                 return;         /* this bio only has a single bvec */
34
35         bio_advance_iter(bio, &iter, iter.bi_size);
36
37         if (!iter.bi_bvec_done)
38                 idx = iter.bi_idx - 1;
39         else    /* in the middle of bvec */
40                 idx = iter.bi_idx;
41
42         *bv = bio->bi_io_vec[idx];
43
44         /*
45          * iter.bi_bvec_done records actual length of the last bvec
46          * if this bio ends in the middle of one io vector
47          */
48         if (iter.bi_bvec_done)
49                 bv->bv_len = iter.bi_bvec_done;
50 }
51
52 static inline bool bio_will_gap(struct request_queue *q,
53                 struct request *prev_rq, struct bio *prev, struct bio *next)
54 {
55         struct bio_vec pb, nb;
56
57         if (!bio_has_data(prev) || !queue_virt_boundary(q))
58                 return false;
59
60         /*
61          * Don't merge if the 1st bio starts with non-zero offset, otherwise it
62          * is quite difficult to respect the sg gap limit.  We work hard to
63          * merge a huge number of small single bios in case of mkfs.
64          */
65         if (prev_rq)
66                 bio_get_first_bvec(prev_rq->bio, &pb);
67         else
68                 bio_get_first_bvec(prev, &pb);
69         if (pb.bv_offset & queue_virt_boundary(q))
70                 return true;
71
72         /*
73          * We don't need to worry about the situation that the merged segment
74          * ends in unaligned virt boundary:
75          *
76          * - if 'pb' ends aligned, the merged segment ends aligned
77          * - if 'pb' ends unaligned, the next bio must include
78          *   one single bvec of 'nb', otherwise the 'nb' can't
79          *   merge with 'pb'
80          */
81         bio_get_last_bvec(prev, &pb);
82         bio_get_first_bvec(next, &nb);
83         if (biovec_phys_mergeable(q, &pb, &nb))
84                 return false;
85         return __bvec_gap_to_prev(&q->limits, &pb, nb.bv_offset);
86 }
87
88 static inline bool req_gap_back_merge(struct request *req, struct bio *bio)
89 {
90         return bio_will_gap(req->q, req, req->biotail, bio);
91 }
92
93 static inline bool req_gap_front_merge(struct request *req, struct bio *bio)
94 {
95         return bio_will_gap(req->q, NULL, bio, req->bio);
96 }
97
98 /*
99  * The max size one bio can handle is UINT_MAX becasue bvec_iter.bi_size
100  * is defined as 'unsigned int', meantime it has to be aligned to with the
101  * logical block size, which is the minimum accepted unit by hardware.
102  */
103 static unsigned int bio_allowed_max_sectors(const struct queue_limits *lim)
104 {
105         return round_down(UINT_MAX, lim->logical_block_size) >> SECTOR_SHIFT;
106 }
107
108 static struct bio *bio_split_discard(struct bio *bio,
109                                      const struct queue_limits *lim,
110                                      unsigned *nsegs, struct bio_set *bs)
111 {
112         unsigned int max_discard_sectors, granularity;
113         sector_t tmp;
114         unsigned split_sectors;
115
116         *nsegs = 1;
117
118         /* Zero-sector (unknown) and one-sector granularities are the same.  */
119         granularity = max(lim->discard_granularity >> 9, 1U);
120
121         max_discard_sectors =
122                 min(lim->max_discard_sectors, bio_allowed_max_sectors(lim));
123         max_discard_sectors -= max_discard_sectors % granularity;
124
125         if (unlikely(!max_discard_sectors)) {
126                 /* XXX: warn */
127                 return NULL;
128         }
129
130         if (bio_sectors(bio) <= max_discard_sectors)
131                 return NULL;
132
133         split_sectors = max_discard_sectors;
134
135         /*
136          * If the next starting sector would be misaligned, stop the discard at
137          * the previous aligned sector.
138          */
139         tmp = bio->bi_iter.bi_sector + split_sectors -
140                 ((lim->discard_alignment >> 9) % granularity);
141         tmp = sector_div(tmp, granularity);
142
143         if (split_sectors > tmp)
144                 split_sectors -= tmp;
145
146         return bio_split(bio, split_sectors, GFP_NOIO, bs);
147 }
148
149 static struct bio *bio_split_write_zeroes(struct bio *bio,
150                                           const struct queue_limits *lim,
151                                           unsigned *nsegs, struct bio_set *bs)
152 {
153         *nsegs = 0;
154         if (!lim->max_write_zeroes_sectors)
155                 return NULL;
156         if (bio_sectors(bio) <= lim->max_write_zeroes_sectors)
157                 return NULL;
158         return bio_split(bio, lim->max_write_zeroes_sectors, GFP_NOIO, bs);
159 }
160
161 /*
162  * Return the maximum number of sectors from the start of a bio that may be
163  * submitted as a single request to a block device. If enough sectors remain,
164  * align the end to the physical block size. Otherwise align the end to the
165  * logical block size. This approach minimizes the number of non-aligned
166  * requests that are submitted to a block device if the start of a bio is not
167  * aligned to a physical block boundary.
168  */
169 static inline unsigned get_max_io_size(struct bio *bio,
170                                        const struct queue_limits *lim)
171 {
172         unsigned pbs = lim->physical_block_size >> SECTOR_SHIFT;
173         unsigned lbs = lim->logical_block_size >> SECTOR_SHIFT;
174         unsigned max_sectors = lim->max_sectors, start, end;
175
176         if (lim->chunk_sectors) {
177                 max_sectors = min(max_sectors,
178                         blk_chunk_sectors_left(bio->bi_iter.bi_sector,
179                                                lim->chunk_sectors));
180         }
181
182         start = bio->bi_iter.bi_sector & (pbs - 1);
183         end = (start + max_sectors) & ~(pbs - 1);
184         if (end > start)
185                 return end - start;
186         return max_sectors & ~(lbs - 1);
187 }
188
189 /**
190  * get_max_segment_size() - maximum number of bytes to add as a single segment
191  * @lim: Request queue limits.
192  * @start_page: See below.
193  * @offset: Offset from @start_page where to add a segment.
194  *
195  * Returns the maximum number of bytes that can be added as a single segment.
196  */
197 static inline unsigned get_max_segment_size(const struct queue_limits *lim,
198                 struct page *start_page, unsigned long offset)
199 {
200         unsigned long mask = lim->seg_boundary_mask;
201
202         offset = mask & (page_to_phys(start_page) + offset);
203
204         /*
205          * Prevent an overflow if mask = ULONG_MAX and offset = 0 by adding 1
206          * after having calculated the minimum.
207          */
208         return min(mask - offset, (unsigned long)lim->max_segment_size - 1) + 1;
209 }
210
211 /**
212  * bvec_split_segs - verify whether or not a bvec should be split in the middle
213  * @lim:      [in] queue limits to split based on
214  * @bv:       [in] bvec to examine
215  * @nsegs:    [in,out] Number of segments in the bio being built. Incremented
216  *            by the number of segments from @bv that may be appended to that
217  *            bio without exceeding @max_segs
218  * @bytes:    [in,out] Number of bytes in the bio being built. Incremented
219  *            by the number of bytes from @bv that may be appended to that
220  *            bio without exceeding @max_bytes
221  * @max_segs: [in] upper bound for *@nsegs
222  * @max_bytes: [in] upper bound for *@bytes
223  *
224  * When splitting a bio, it can happen that a bvec is encountered that is too
225  * big to fit in a single segment and hence that it has to be split in the
226  * middle. This function verifies whether or not that should happen. The value
227  * %true is returned if and only if appending the entire @bv to a bio with
228  * *@nsegs segments and *@sectors sectors would make that bio unacceptable for
229  * the block driver.
230  */
231 static bool bvec_split_segs(const struct queue_limits *lim,
232                 const struct bio_vec *bv, unsigned *nsegs, unsigned *bytes,
233                 unsigned max_segs, unsigned max_bytes)
234 {
235         unsigned max_len = min(max_bytes, UINT_MAX) - *bytes;
236         unsigned len = min(bv->bv_len, max_len);
237         unsigned total_len = 0;
238         unsigned seg_size = 0;
239
240         while (len && *nsegs < max_segs) {
241                 seg_size = get_max_segment_size(lim, bv->bv_page,
242                                                 bv->bv_offset + total_len);
243                 seg_size = min(seg_size, len);
244
245                 (*nsegs)++;
246                 total_len += seg_size;
247                 len -= seg_size;
248
249                 if ((bv->bv_offset + total_len) & lim->virt_boundary_mask)
250                         break;
251         }
252
253         *bytes += total_len;
254
255         /* tell the caller to split the bvec if it is too big to fit */
256         return len > 0 || bv->bv_len > max_len;
257 }
258
259 /**
260  * bio_split_rw - split a bio in two bios
261  * @bio:  [in] bio to be split
262  * @lim:  [in] queue limits to split based on
263  * @segs: [out] number of segments in the bio with the first half of the sectors
264  * @bs:   [in] bio set to allocate the clone from
265  * @max_bytes: [in] maximum number of bytes per bio
266  *
267  * Clone @bio, update the bi_iter of the clone to represent the first sectors
268  * of @bio and update @bio->bi_iter to represent the remaining sectors. The
269  * following is guaranteed for the cloned bio:
270  * - That it has at most @max_bytes worth of data
271  * - That it has at most queue_max_segments(@q) segments.
272  *
273  * Except for discard requests the cloned bio will point at the bi_io_vec of
274  * the original bio. It is the responsibility of the caller to ensure that the
275  * original bio is not freed before the cloned bio. The caller is also
276  * responsible for ensuring that @bs is only destroyed after processing of the
277  * split bio has finished.
278  */
279 static struct bio *bio_split_rw(struct bio *bio, const struct queue_limits *lim,
280                 unsigned *segs, struct bio_set *bs, unsigned max_bytes)
281 {
282         struct bio_vec bv, bvprv, *bvprvp = NULL;
283         struct bvec_iter iter;
284         unsigned nsegs = 0, bytes = 0;
285
286         bio_for_each_bvec(bv, bio, iter) {
287                 /*
288                  * If the queue doesn't support SG gaps and adding this
289                  * offset would create a gap, disallow it.
290                  */
291                 if (bvprvp && bvec_gap_to_prev(lim, bvprvp, bv.bv_offset))
292                         goto split;
293
294                 if (nsegs < lim->max_segments &&
295                     bytes + bv.bv_len <= max_bytes &&
296                     bv.bv_offset + bv.bv_len <= PAGE_SIZE) {
297                         nsegs++;
298                         bytes += bv.bv_len;
299                 } else {
300                         if (bvec_split_segs(lim, &bv, &nsegs, &bytes,
301                                         lim->max_segments, max_bytes))
302                                 goto split;
303                 }
304
305                 bvprv = bv;
306                 bvprvp = &bvprv;
307         }
308
309         *segs = nsegs;
310         return NULL;
311 split:
312         /*
313          * We can't sanely support splitting for a REQ_NOWAIT bio. End it
314          * with EAGAIN if splitting is required and return an error pointer.
315          */
316         if (bio->bi_opf & REQ_NOWAIT) {
317                 bio->bi_status = BLK_STS_AGAIN;
318                 bio_endio(bio);
319                 return ERR_PTR(-EAGAIN);
320         }
321
322         *segs = nsegs;
323
324         /*
325          * Individual bvecs might not be logical block aligned. Round down the
326          * split size so that each bio is properly block size aligned, even if
327          * we do not use the full hardware limits.
328          */
329         bytes = ALIGN_DOWN(bytes, lim->logical_block_size);
330
331         /*
332          * Bio splitting may cause subtle trouble such as hang when doing sync
333          * iopoll in direct IO routine. Given performance gain of iopoll for
334          * big IO can be trival, disable iopoll when split needed.
335          */
336         bio_clear_polled(bio);
337         return bio_split(bio, bytes >> SECTOR_SHIFT, GFP_NOIO, bs);
338 }
339
340 /**
341  * __bio_split_to_limits - split a bio to fit the queue limits
342  * @bio:     bio to be split
343  * @lim:     queue limits to split based on
344  * @nr_segs: returns the number of segments in the returned bio
345  *
346  * Check if @bio needs splitting based on the queue limits, and if so split off
347  * a bio fitting the limits from the beginning of @bio and return it.  @bio is
348  * shortened to the remainder and re-submitted.
349  *
350  * The split bio is allocated from @q->bio_split, which is provided by the
351  * block layer.
352  */
353 struct bio *__bio_split_to_limits(struct bio *bio,
354                                   const struct queue_limits *lim,
355                                   unsigned int *nr_segs)
356 {
357         struct bio_set *bs = &bio->bi_bdev->bd_disk->bio_split;
358         struct bio *split;
359
360         switch (bio_op(bio)) {
361         case REQ_OP_DISCARD:
362         case REQ_OP_SECURE_ERASE:
363                 split = bio_split_discard(bio, lim, nr_segs, bs);
364                 break;
365         case REQ_OP_WRITE_ZEROES:
366                 split = bio_split_write_zeroes(bio, lim, nr_segs, bs);
367                 break;
368         default:
369                 split = bio_split_rw(bio, lim, nr_segs, bs,
370                                 get_max_io_size(bio, lim) << SECTOR_SHIFT);
371                 if (IS_ERR(split))
372                         return NULL;
373                 break;
374         }
375
376         if (split) {
377                 /* there isn't chance to merge the split bio */
378                 split->bi_opf |= REQ_NOMERGE;
379
380                 blkcg_bio_issue_init(split);
381                 bio_chain(split, bio);
382                 trace_block_split(split, bio->bi_iter.bi_sector);
383                 submit_bio_noacct(bio);
384                 return split;
385         }
386         return bio;
387 }
388
389 /**
390  * bio_split_to_limits - split a bio to fit the queue limits
391  * @bio:     bio to be split
392  *
393  * Check if @bio needs splitting based on the queue limits of @bio->bi_bdev, and
394  * if so split off a bio fitting the limits from the beginning of @bio and
395  * return it.  @bio is shortened to the remainder and re-submitted.
396  *
397  * The split bio is allocated from @q->bio_split, which is provided by the
398  * block layer.
399  */
400 struct bio *bio_split_to_limits(struct bio *bio)
401 {
402         const struct queue_limits *lim = &bdev_get_queue(bio->bi_bdev)->limits;
403         unsigned int nr_segs;
404
405         if (bio_may_exceed_limits(bio, lim))
406                 return __bio_split_to_limits(bio, lim, &nr_segs);
407         return bio;
408 }
409 EXPORT_SYMBOL(bio_split_to_limits);
410
411 unsigned int blk_recalc_rq_segments(struct request *rq)
412 {
413         unsigned int nr_phys_segs = 0;
414         unsigned int bytes = 0;
415         struct req_iterator iter;
416         struct bio_vec bv;
417
418         if (!rq->bio)
419                 return 0;
420
421         switch (bio_op(rq->bio)) {
422         case REQ_OP_DISCARD:
423         case REQ_OP_SECURE_ERASE:
424                 if (queue_max_discard_segments(rq->q) > 1) {
425                         struct bio *bio = rq->bio;
426
427                         for_each_bio(bio)
428                                 nr_phys_segs++;
429                         return nr_phys_segs;
430                 }
431                 return 1;
432         case REQ_OP_WRITE_ZEROES:
433                 return 0;
434         default:
435                 break;
436         }
437
438         rq_for_each_bvec(bv, rq, iter)
439                 bvec_split_segs(&rq->q->limits, &bv, &nr_phys_segs, &bytes,
440                                 UINT_MAX, UINT_MAX);
441         return nr_phys_segs;
442 }
443
444 static inline struct scatterlist *blk_next_sg(struct scatterlist **sg,
445                 struct scatterlist *sglist)
446 {
447         if (!*sg)
448                 return sglist;
449
450         /*
451          * If the driver previously mapped a shorter list, we could see a
452          * termination bit prematurely unless it fully inits the sg table
453          * on each mapping. We KNOW that there must be more entries here
454          * or the driver would be buggy, so force clear the termination bit
455          * to avoid doing a full sg_init_table() in drivers for each command.
456          */
457         sg_unmark_end(*sg);
458         return sg_next(*sg);
459 }
460
461 static unsigned blk_bvec_map_sg(struct request_queue *q,
462                 struct bio_vec *bvec, struct scatterlist *sglist,
463                 struct scatterlist **sg)
464 {
465         unsigned nbytes = bvec->bv_len;
466         unsigned nsegs = 0, total = 0;
467
468         while (nbytes > 0) {
469                 unsigned offset = bvec->bv_offset + total;
470                 unsigned len = min(get_max_segment_size(&q->limits,
471                                    bvec->bv_page, offset), nbytes);
472                 struct page *page = bvec->bv_page;
473
474                 /*
475                  * Unfortunately a fair number of drivers barf on scatterlists
476                  * that have an offset larger than PAGE_SIZE, despite other
477                  * subsystems dealing with that invariant just fine.  For now
478                  * stick to the legacy format where we never present those from
479                  * the block layer, but the code below should be removed once
480                  * these offenders (mostly MMC/SD drivers) are fixed.
481                  */
482                 page += (offset >> PAGE_SHIFT);
483                 offset &= ~PAGE_MASK;
484
485                 *sg = blk_next_sg(sg, sglist);
486                 sg_set_page(*sg, page, len, offset);
487
488                 total += len;
489                 nbytes -= len;
490                 nsegs++;
491         }
492
493         return nsegs;
494 }
495
496 static inline int __blk_bvec_map_sg(struct bio_vec bv,
497                 struct scatterlist *sglist, struct scatterlist **sg)
498 {
499         *sg = blk_next_sg(sg, sglist);
500         sg_set_page(*sg, bv.bv_page, bv.bv_len, bv.bv_offset);
501         return 1;
502 }
503
504 /* only try to merge bvecs into one sg if they are from two bios */
505 static inline bool
506 __blk_segment_map_sg_merge(struct request_queue *q, struct bio_vec *bvec,
507                            struct bio_vec *bvprv, struct scatterlist **sg)
508 {
509
510         int nbytes = bvec->bv_len;
511
512         if (!*sg)
513                 return false;
514
515         if ((*sg)->length + nbytes > queue_max_segment_size(q))
516                 return false;
517
518         if (!biovec_phys_mergeable(q, bvprv, bvec))
519                 return false;
520
521         (*sg)->length += nbytes;
522
523         return true;
524 }
525
526 static int __blk_bios_map_sg(struct request_queue *q, struct bio *bio,
527                              struct scatterlist *sglist,
528                              struct scatterlist **sg)
529 {
530         struct bio_vec bvec, bvprv = { NULL };
531         struct bvec_iter iter;
532         int nsegs = 0;
533         bool new_bio = false;
534
535         for_each_bio(bio) {
536                 bio_for_each_bvec(bvec, bio, iter) {
537                         /*
538                          * Only try to merge bvecs from two bios given we
539                          * have done bio internal merge when adding pages
540                          * to bio
541                          */
542                         if (new_bio &&
543                             __blk_segment_map_sg_merge(q, &bvec, &bvprv, sg))
544                                 goto next_bvec;
545
546                         if (bvec.bv_offset + bvec.bv_len <= PAGE_SIZE)
547                                 nsegs += __blk_bvec_map_sg(bvec, sglist, sg);
548                         else
549                                 nsegs += blk_bvec_map_sg(q, &bvec, sglist, sg);
550  next_bvec:
551                         new_bio = false;
552                 }
553                 if (likely(bio->bi_iter.bi_size)) {
554                         bvprv = bvec;
555                         new_bio = true;
556                 }
557         }
558
559         return nsegs;
560 }
561
562 /*
563  * map a request to scatterlist, return number of sg entries setup. Caller
564  * must make sure sg can hold rq->nr_phys_segments entries
565  */
566 int __blk_rq_map_sg(struct request_queue *q, struct request *rq,
567                 struct scatterlist *sglist, struct scatterlist **last_sg)
568 {
569         int nsegs = 0;
570
571         if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
572                 nsegs = __blk_bvec_map_sg(rq->special_vec, sglist, last_sg);
573         else if (rq->bio)
574                 nsegs = __blk_bios_map_sg(q, rq->bio, sglist, last_sg);
575
576         if (*last_sg)
577                 sg_mark_end(*last_sg);
578
579         /*
580          * Something must have been wrong if the figured number of
581          * segment is bigger than number of req's physical segments
582          */
583         WARN_ON(nsegs > blk_rq_nr_phys_segments(rq));
584
585         return nsegs;
586 }
587 EXPORT_SYMBOL(__blk_rq_map_sg);
588
589 static inline unsigned int blk_rq_get_max_sectors(struct request *rq,
590                                                   sector_t offset)
591 {
592         struct request_queue *q = rq->q;
593         unsigned int max_sectors;
594
595         if (blk_rq_is_passthrough(rq))
596                 return q->limits.max_hw_sectors;
597
598         max_sectors = blk_queue_get_max_sectors(q, req_op(rq));
599         if (!q->limits.chunk_sectors ||
600             req_op(rq) == REQ_OP_DISCARD ||
601             req_op(rq) == REQ_OP_SECURE_ERASE)
602                 return max_sectors;
603         return min(max_sectors,
604                    blk_chunk_sectors_left(offset, q->limits.chunk_sectors));
605 }
606
607 static inline int ll_new_hw_segment(struct request *req, struct bio *bio,
608                 unsigned int nr_phys_segs)
609 {
610         if (!blk_cgroup_mergeable(req, bio))
611                 goto no_merge;
612
613         if (blk_integrity_merge_bio(req->q, req, bio) == false)
614                 goto no_merge;
615
616         /* discard request merge won't add new segment */
617         if (req_op(req) == REQ_OP_DISCARD)
618                 return 1;
619
620         if (req->nr_phys_segments + nr_phys_segs > blk_rq_get_max_segments(req))
621                 goto no_merge;
622
623         /*
624          * This will form the start of a new hw segment.  Bump both
625          * counters.
626          */
627         req->nr_phys_segments += nr_phys_segs;
628         return 1;
629
630 no_merge:
631         req_set_nomerge(req->q, req);
632         return 0;
633 }
634
635 int ll_back_merge_fn(struct request *req, struct bio *bio, unsigned int nr_segs)
636 {
637         if (req_gap_back_merge(req, bio))
638                 return 0;
639         if (blk_integrity_rq(req) &&
640             integrity_req_gap_back_merge(req, bio))
641                 return 0;
642         if (!bio_crypt_ctx_back_mergeable(req, bio))
643                 return 0;
644         if (blk_rq_sectors(req) + bio_sectors(bio) >
645             blk_rq_get_max_sectors(req, blk_rq_pos(req))) {
646                 req_set_nomerge(req->q, req);
647                 return 0;
648         }
649
650         return ll_new_hw_segment(req, bio, nr_segs);
651 }
652
653 static int ll_front_merge_fn(struct request *req, struct bio *bio,
654                 unsigned int nr_segs)
655 {
656         if (req_gap_front_merge(req, bio))
657                 return 0;
658         if (blk_integrity_rq(req) &&
659             integrity_req_gap_front_merge(req, bio))
660                 return 0;
661         if (!bio_crypt_ctx_front_mergeable(req, bio))
662                 return 0;
663         if (blk_rq_sectors(req) + bio_sectors(bio) >
664             blk_rq_get_max_sectors(req, bio->bi_iter.bi_sector)) {
665                 req_set_nomerge(req->q, req);
666                 return 0;
667         }
668
669         return ll_new_hw_segment(req, bio, nr_segs);
670 }
671
672 static bool req_attempt_discard_merge(struct request_queue *q, struct request *req,
673                 struct request *next)
674 {
675         unsigned short segments = blk_rq_nr_discard_segments(req);
676
677         if (segments >= queue_max_discard_segments(q))
678                 goto no_merge;
679         if (blk_rq_sectors(req) + bio_sectors(next->bio) >
680             blk_rq_get_max_sectors(req, blk_rq_pos(req)))
681                 goto no_merge;
682
683         req->nr_phys_segments = segments + blk_rq_nr_discard_segments(next);
684         return true;
685 no_merge:
686         req_set_nomerge(q, req);
687         return false;
688 }
689
690 static int ll_merge_requests_fn(struct request_queue *q, struct request *req,
691                                 struct request *next)
692 {
693         int total_phys_segments;
694
695         if (req_gap_back_merge(req, next->bio))
696                 return 0;
697
698         /*
699          * Will it become too large?
700          */
701         if ((blk_rq_sectors(req) + blk_rq_sectors(next)) >
702             blk_rq_get_max_sectors(req, blk_rq_pos(req)))
703                 return 0;
704
705         total_phys_segments = req->nr_phys_segments + next->nr_phys_segments;
706         if (total_phys_segments > blk_rq_get_max_segments(req))
707                 return 0;
708
709         if (!blk_cgroup_mergeable(req, next->bio))
710                 return 0;
711
712         if (blk_integrity_merge_rq(q, req, next) == false)
713                 return 0;
714
715         if (!bio_crypt_ctx_merge_rq(req, next))
716                 return 0;
717
718         /* Merge is OK... */
719         req->nr_phys_segments = total_phys_segments;
720         return 1;
721 }
722
723 /**
724  * blk_rq_set_mixed_merge - mark a request as mixed merge
725  * @rq: request to mark as mixed merge
726  *
727  * Description:
728  *     @rq is about to be mixed merged.  Make sure the attributes
729  *     which can be mixed are set in each bio and mark @rq as mixed
730  *     merged.
731  */
732 void blk_rq_set_mixed_merge(struct request *rq)
733 {
734         blk_opf_t ff = rq->cmd_flags & REQ_FAILFAST_MASK;
735         struct bio *bio;
736
737         if (rq->rq_flags & RQF_MIXED_MERGE)
738                 return;
739
740         /*
741          * @rq will no longer represent mixable attributes for all the
742          * contained bios.  It will just track those of the first one.
743          * Distributes the attributs to each bio.
744          */
745         for (bio = rq->bio; bio; bio = bio->bi_next) {
746                 WARN_ON_ONCE((bio->bi_opf & REQ_FAILFAST_MASK) &&
747                              (bio->bi_opf & REQ_FAILFAST_MASK) != ff);
748                 bio->bi_opf |= ff;
749         }
750         rq->rq_flags |= RQF_MIXED_MERGE;
751 }
752
753 static inline blk_opf_t bio_failfast(const struct bio *bio)
754 {
755         if (bio->bi_opf & REQ_RAHEAD)
756                 return REQ_FAILFAST_MASK;
757
758         return bio->bi_opf & REQ_FAILFAST_MASK;
759 }
760
761 /*
762  * After we are marked as MIXED_MERGE, any new RA bio has to be updated
763  * as failfast, and request's failfast has to be updated in case of
764  * front merge.
765  */
766 static inline void blk_update_mixed_merge(struct request *req,
767                 struct bio *bio, bool front_merge)
768 {
769         if (req->rq_flags & RQF_MIXED_MERGE) {
770                 if (bio->bi_opf & REQ_RAHEAD)
771                         bio->bi_opf |= REQ_FAILFAST_MASK;
772
773                 if (front_merge) {
774                         req->cmd_flags &= ~REQ_FAILFAST_MASK;
775                         req->cmd_flags |= bio->bi_opf & REQ_FAILFAST_MASK;
776                 }
777         }
778 }
779
780 static void blk_account_io_merge_request(struct request *req)
781 {
782         if (blk_do_io_stat(req)) {
783                 part_stat_lock();
784                 part_stat_inc(req->part, merges[op_stat_group(req_op(req))]);
785                 part_stat_unlock();
786         }
787 }
788
789 static enum elv_merge blk_try_req_merge(struct request *req,
790                                         struct request *next)
791 {
792         if (blk_discard_mergable(req))
793                 return ELEVATOR_DISCARD_MERGE;
794         else if (blk_rq_pos(req) + blk_rq_sectors(req) == blk_rq_pos(next))
795                 return ELEVATOR_BACK_MERGE;
796
797         return ELEVATOR_NO_MERGE;
798 }
799
800 /*
801  * For non-mq, this has to be called with the request spinlock acquired.
802  * For mq with scheduling, the appropriate queue wide lock should be held.
803  */
804 static struct request *attempt_merge(struct request_queue *q,
805                                      struct request *req, struct request *next)
806 {
807         if (!rq_mergeable(req) || !rq_mergeable(next))
808                 return NULL;
809
810         if (req_op(req) != req_op(next))
811                 return NULL;
812
813         if (rq_data_dir(req) != rq_data_dir(next))
814                 return NULL;
815
816         if (req->ioprio != next->ioprio)
817                 return NULL;
818
819         /*
820          * If we are allowed to merge, then append bio list
821          * from next to rq and release next. merge_requests_fn
822          * will have updated segment counts, update sector
823          * counts here. Handle DISCARDs separately, as they
824          * have separate settings.
825          */
826
827         switch (blk_try_req_merge(req, next)) {
828         case ELEVATOR_DISCARD_MERGE:
829                 if (!req_attempt_discard_merge(q, req, next))
830                         return NULL;
831                 break;
832         case ELEVATOR_BACK_MERGE:
833                 if (!ll_merge_requests_fn(q, req, next))
834                         return NULL;
835                 break;
836         default:
837                 return NULL;
838         }
839
840         /*
841          * If failfast settings disagree or any of the two is already
842          * a mixed merge, mark both as mixed before proceeding.  This
843          * makes sure that all involved bios have mixable attributes
844          * set properly.
845          */
846         if (((req->rq_flags | next->rq_flags) & RQF_MIXED_MERGE) ||
847             (req->cmd_flags & REQ_FAILFAST_MASK) !=
848             (next->cmd_flags & REQ_FAILFAST_MASK)) {
849                 blk_rq_set_mixed_merge(req);
850                 blk_rq_set_mixed_merge(next);
851         }
852
853         /*
854          * At this point we have either done a back merge or front merge. We
855          * need the smaller start_time_ns of the merged requests to be the
856          * current request for accounting purposes.
857          */
858         if (next->start_time_ns < req->start_time_ns)
859                 req->start_time_ns = next->start_time_ns;
860
861         req->biotail->bi_next = next->bio;
862         req->biotail = next->biotail;
863
864         req->__data_len += blk_rq_bytes(next);
865
866         if (!blk_discard_mergable(req))
867                 elv_merge_requests(q, req, next);
868
869         /*
870          * 'next' is going away, so update stats accordingly
871          */
872         blk_account_io_merge_request(next);
873
874         trace_block_rq_merge(next);
875
876         /*
877          * ownership of bio passed from next to req, return 'next' for
878          * the caller to free
879          */
880         next->bio = NULL;
881         return next;
882 }
883
884 static struct request *attempt_back_merge(struct request_queue *q,
885                 struct request *rq)
886 {
887         struct request *next = elv_latter_request(q, rq);
888
889         if (next)
890                 return attempt_merge(q, rq, next);
891
892         return NULL;
893 }
894
895 static struct request *attempt_front_merge(struct request_queue *q,
896                 struct request *rq)
897 {
898         struct request *prev = elv_former_request(q, rq);
899
900         if (prev)
901                 return attempt_merge(q, prev, rq);
902
903         return NULL;
904 }
905
906 /*
907  * Try to merge 'next' into 'rq'. Return true if the merge happened, false
908  * otherwise. The caller is responsible for freeing 'next' if the merge
909  * happened.
910  */
911 bool blk_attempt_req_merge(struct request_queue *q, struct request *rq,
912                            struct request *next)
913 {
914         return attempt_merge(q, rq, next);
915 }
916
917 bool blk_rq_merge_ok(struct request *rq, struct bio *bio)
918 {
919         if (!rq_mergeable(rq) || !bio_mergeable(bio))
920                 return false;
921
922         if (req_op(rq) != bio_op(bio))
923                 return false;
924
925         /* different data direction or already started, don't merge */
926         if (bio_data_dir(bio) != rq_data_dir(rq))
927                 return false;
928
929         /* don't merge across cgroup boundaries */
930         if (!blk_cgroup_mergeable(rq, bio))
931                 return false;
932
933         /* only merge integrity protected bio into ditto rq */
934         if (blk_integrity_merge_bio(rq->q, rq, bio) == false)
935                 return false;
936
937         /* Only merge if the crypt contexts are compatible */
938         if (!bio_crypt_rq_ctx_compatible(rq, bio))
939                 return false;
940
941         if (rq->ioprio != bio_prio(bio))
942                 return false;
943
944         return true;
945 }
946
947 enum elv_merge blk_try_merge(struct request *rq, struct bio *bio)
948 {
949         if (blk_discard_mergable(rq))
950                 return ELEVATOR_DISCARD_MERGE;
951         else if (blk_rq_pos(rq) + blk_rq_sectors(rq) == bio->bi_iter.bi_sector)
952                 return ELEVATOR_BACK_MERGE;
953         else if (blk_rq_pos(rq) - bio_sectors(bio) == bio->bi_iter.bi_sector)
954                 return ELEVATOR_FRONT_MERGE;
955         return ELEVATOR_NO_MERGE;
956 }
957
958 static void blk_account_io_merge_bio(struct request *req)
959 {
960         if (!blk_do_io_stat(req))
961                 return;
962
963         part_stat_lock();
964         part_stat_inc(req->part, merges[op_stat_group(req_op(req))]);
965         part_stat_unlock();
966 }
967
968 enum bio_merge_status {
969         BIO_MERGE_OK,
970         BIO_MERGE_NONE,
971         BIO_MERGE_FAILED,
972 };
973
974 static enum bio_merge_status bio_attempt_back_merge(struct request *req,
975                 struct bio *bio, unsigned int nr_segs)
976 {
977         const blk_opf_t ff = bio_failfast(bio);
978
979         if (!ll_back_merge_fn(req, bio, nr_segs))
980                 return BIO_MERGE_FAILED;
981
982         trace_block_bio_backmerge(bio);
983         rq_qos_merge(req->q, req, bio);
984
985         if ((req->cmd_flags & REQ_FAILFAST_MASK) != ff)
986                 blk_rq_set_mixed_merge(req);
987
988         blk_update_mixed_merge(req, bio, false);
989
990         req->biotail->bi_next = bio;
991         req->biotail = bio;
992         req->__data_len += bio->bi_iter.bi_size;
993
994         bio_crypt_free_ctx(bio);
995
996         blk_account_io_merge_bio(req);
997         return BIO_MERGE_OK;
998 }
999
1000 static enum bio_merge_status bio_attempt_front_merge(struct request *req,
1001                 struct bio *bio, unsigned int nr_segs)
1002 {
1003         const blk_opf_t ff = bio_failfast(bio);
1004
1005         if (!ll_front_merge_fn(req, bio, nr_segs))
1006                 return BIO_MERGE_FAILED;
1007
1008         trace_block_bio_frontmerge(bio);
1009         rq_qos_merge(req->q, req, bio);
1010
1011         if ((req->cmd_flags & REQ_FAILFAST_MASK) != ff)
1012                 blk_rq_set_mixed_merge(req);
1013
1014         blk_update_mixed_merge(req, bio, true);
1015
1016         bio->bi_next = req->bio;
1017         req->bio = bio;
1018
1019         req->__sector = bio->bi_iter.bi_sector;
1020         req->__data_len += bio->bi_iter.bi_size;
1021
1022         bio_crypt_do_front_merge(req, bio);
1023
1024         blk_account_io_merge_bio(req);
1025         return BIO_MERGE_OK;
1026 }
1027
1028 static enum bio_merge_status bio_attempt_discard_merge(struct request_queue *q,
1029                 struct request *req, struct bio *bio)
1030 {
1031         unsigned short segments = blk_rq_nr_discard_segments(req);
1032
1033         if (segments >= queue_max_discard_segments(q))
1034                 goto no_merge;
1035         if (blk_rq_sectors(req) + bio_sectors(bio) >
1036             blk_rq_get_max_sectors(req, blk_rq_pos(req)))
1037                 goto no_merge;
1038
1039         rq_qos_merge(q, req, bio);
1040
1041         req->biotail->bi_next = bio;
1042         req->biotail = bio;
1043         req->__data_len += bio->bi_iter.bi_size;
1044         req->nr_phys_segments = segments + 1;
1045
1046         blk_account_io_merge_bio(req);
1047         return BIO_MERGE_OK;
1048 no_merge:
1049         req_set_nomerge(q, req);
1050         return BIO_MERGE_FAILED;
1051 }
1052
1053 static enum bio_merge_status blk_attempt_bio_merge(struct request_queue *q,
1054                                                    struct request *rq,
1055                                                    struct bio *bio,
1056                                                    unsigned int nr_segs,
1057                                                    bool sched_allow_merge)
1058 {
1059         if (!blk_rq_merge_ok(rq, bio))
1060                 return BIO_MERGE_NONE;
1061
1062         switch (blk_try_merge(rq, bio)) {
1063         case ELEVATOR_BACK_MERGE:
1064                 if (!sched_allow_merge || blk_mq_sched_allow_merge(q, rq, bio))
1065                         return bio_attempt_back_merge(rq, bio, nr_segs);
1066                 break;
1067         case ELEVATOR_FRONT_MERGE:
1068                 if (!sched_allow_merge || blk_mq_sched_allow_merge(q, rq, bio))
1069                         return bio_attempt_front_merge(rq, bio, nr_segs);
1070                 break;
1071         case ELEVATOR_DISCARD_MERGE:
1072                 return bio_attempt_discard_merge(q, rq, bio);
1073         default:
1074                 return BIO_MERGE_NONE;
1075         }
1076
1077         return BIO_MERGE_FAILED;
1078 }
1079
1080 /**
1081  * blk_attempt_plug_merge - try to merge with %current's plugged list
1082  * @q: request_queue new bio is being queued at
1083  * @bio: new bio being queued
1084  * @nr_segs: number of segments in @bio
1085  * from the passed in @q already in the plug list
1086  *
1087  * Determine whether @bio being queued on @q can be merged with the previous
1088  * request on %current's plugged list.  Returns %true if merge was successful,
1089  * otherwise %false.
1090  *
1091  * Plugging coalesces IOs from the same issuer for the same purpose without
1092  * going through @q->queue_lock.  As such it's more of an issuing mechanism
1093  * than scheduling, and the request, while may have elvpriv data, is not
1094  * added on the elevator at this point.  In addition, we don't have
1095  * reliable access to the elevator outside queue lock.  Only check basic
1096  * merging parameters without querying the elevator.
1097  *
1098  * Caller must ensure !blk_queue_nomerges(q) beforehand.
1099  */
1100 bool blk_attempt_plug_merge(struct request_queue *q, struct bio *bio,
1101                 unsigned int nr_segs)
1102 {
1103         struct blk_plug *plug;
1104         struct request *rq;
1105
1106         plug = blk_mq_plug(bio);
1107         if (!plug || rq_list_empty(plug->mq_list))
1108                 return false;
1109
1110         rq_list_for_each(&plug->mq_list, rq) {
1111                 if (rq->q == q) {
1112                         if (blk_attempt_bio_merge(q, rq, bio, nr_segs, false) ==
1113                             BIO_MERGE_OK)
1114                                 return true;
1115                         break;
1116                 }
1117
1118                 /*
1119                  * Only keep iterating plug list for merges if we have multiple
1120                  * queues
1121                  */
1122                 if (!plug->multiple_queues)
1123                         break;
1124         }
1125         return false;
1126 }
1127
1128 /*
1129  * Iterate list of requests and see if we can merge this bio with any
1130  * of them.
1131  */
1132 bool blk_bio_list_merge(struct request_queue *q, struct list_head *list,
1133                         struct bio *bio, unsigned int nr_segs)
1134 {
1135         struct request *rq;
1136         int checked = 8;
1137
1138         list_for_each_entry_reverse(rq, list, queuelist) {
1139                 if (!checked--)
1140                         break;
1141
1142                 switch (blk_attempt_bio_merge(q, rq, bio, nr_segs, true)) {
1143                 case BIO_MERGE_NONE:
1144                         continue;
1145                 case BIO_MERGE_OK:
1146                         return true;
1147                 case BIO_MERGE_FAILED:
1148                         return false;
1149                 }
1150
1151         }
1152
1153         return false;
1154 }
1155 EXPORT_SYMBOL_GPL(blk_bio_list_merge);
1156
1157 bool blk_mq_sched_try_merge(struct request_queue *q, struct bio *bio,
1158                 unsigned int nr_segs, struct request **merged_request)
1159 {
1160         struct request *rq;
1161
1162         switch (elv_merge(q, &rq, bio)) {
1163         case ELEVATOR_BACK_MERGE:
1164                 if (!blk_mq_sched_allow_merge(q, rq, bio))
1165                         return false;
1166                 if (bio_attempt_back_merge(rq, bio, nr_segs) != BIO_MERGE_OK)
1167                         return false;
1168                 *merged_request = attempt_back_merge(q, rq);
1169                 if (!*merged_request)
1170                         elv_merged_request(q, rq, ELEVATOR_BACK_MERGE);
1171                 return true;
1172         case ELEVATOR_FRONT_MERGE:
1173                 if (!blk_mq_sched_allow_merge(q, rq, bio))
1174                         return false;
1175                 if (bio_attempt_front_merge(rq, bio, nr_segs) != BIO_MERGE_OK)
1176                         return false;
1177                 *merged_request = attempt_front_merge(q, rq);
1178                 if (!*merged_request)
1179                         elv_merged_request(q, rq, ELEVATOR_FRONT_MERGE);
1180                 return true;
1181         case ELEVATOR_DISCARD_MERGE:
1182                 return bio_attempt_discard_merge(q, rq, bio) == BIO_MERGE_OK;
1183         default:
1184                 return false;
1185         }
1186 }
1187 EXPORT_SYMBOL_GPL(blk_mq_sched_try_merge);