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