block/blk-flush.c

   1 /*
   2  * Functions to sequence FLUSH and FUA writes.
   3  *
   4  * Copyright (C) 2011           Max Planck Institute for Gravitational Physics
   5  * Copyright (C) 2011           Tejun Heo <tj@kernel.org>
   6  *
   7  * This file is released under the GPLv2.
   8  *
   9  * REQ_{FLUSH|FUA} requests are decomposed to sequences consisted of three
  10  * optional steps - PREFLUSH, DATA and POSTFLUSH - according to the request
  11  * properties and hardware capability.
  12  *
  13  * If a request doesn't have data, only REQ_FLUSH makes sense, which
  14  * indicates a simple flush request.  If there is data, REQ_FLUSH indicates
  15  * that the device cache should be flushed before the data is executed, and
  16  * REQ_FUA means that the data must be on non-volatile media on request
  17  * completion.
  18  *
  19  * If the device doesn't have writeback cache, FLUSH and FUA don't make any
  20  * difference.  The requests are either completed immediately if there's no
  21  * data or executed as normal requests otherwise.
  22  *
  23  * If the device has writeback cache and supports FUA, REQ_FLUSH is
  24  * translated to PREFLUSH but REQ_FUA is passed down directly with DATA.
  25  *
  26  * If the device has writeback cache and doesn't support FUA, REQ_FLUSH is
  27  * translated to PREFLUSH and REQ_FUA to POSTFLUSH.
  28  *
  29  * The actual execution of flush is double buffered.  Whenever a request
  30  * needs to execute PRE or POSTFLUSH, it queues at
  31  * q->flush_queue[q->flush_pending_idx].  Once certain criteria are met, a
  32  * flush is issued and the pending_idx is toggled.  When the flush
  33  * completes, all the requests which were pending are proceeded to the next
  34  * step.  This allows arbitrary merging of different types of FLUSH/FUA
  35  * requests.
  36  *
  37  * Currently, the following conditions are used to determine when to issue
  38  * flush.
  39  *
  40  * C1. At any given time, only one flush shall be in progress.  This makes
  41  *     double buffering sufficient.
  42  *
  43  * C2. Flush is deferred if any request is executing DATA of its sequence.
  44  *     This avoids issuing separate POSTFLUSHes for requests which shared
  45  *     PREFLUSH.
  46  *
  47  * C3. The second condition is ignored if there is a request which has
  48  *     waited longer than FLUSH_PENDING_TIMEOUT.  This is to avoid
  49  *     starvation in the unlikely case where there are continuous stream of
  50  *     FUA (without FLUSH) requests.
  51  *
  52  * For devices which support FUA, it isn't clear whether C2 (and thus C3)
  53  * is beneficial.
  54  *
  55  * Note that a sequenced FLUSH/FUA request with DATA is completed twice.
  56  * Once while executing DATA and again after the whole sequence is
  57  * complete.  The first completion updates the contained bio but doesn't
  58  * finish it so that the bio submitter is notified only after the whole
  59  * sequence is complete.  This is implemented by testing REQ_FLUSH_SEQ in
  60  * req_bio_endio().
  61  *
  62  * The above peculiarity requires that each FLUSH/FUA request has only one
  63  * bio attached to it, which is guaranteed as they aren't allowed to be
  64  * merged in the usual way.
  65  */
  66
  67 #include <linux/kernel.h>
  68 #include <linux/module.h>
  69 #include <linux/bio.h>
  70 #include <linux/blkdev.h>
  71 #include <linux/gfp.h>
  72 #include <linux/blk-mq.h>
  73
  74 #include "blk.h"
  75 #include "blk-mq.h"
  76
  77 /* FLUSH/FUA sequences */
  78 enum {
  79         REQ_FSEQ_PREFLUSH       = (1 << 0), /* pre-flushing in progress */
  80         REQ_FSEQ_DATA           = (1 << 1), /* data write in progress */
  81         REQ_FSEQ_POSTFLUSH      = (1 << 2), /* post-flushing in progress */
  82         REQ_FSEQ_DONE           = (1 << 3),
  83
  84         REQ_FSEQ_ACTIONS        = REQ_FSEQ_PREFLUSH | REQ_FSEQ_DATA |
  85                                   REQ_FSEQ_POSTFLUSH,
  86
  87         /*
  88          * If flush has been pending longer than the following timeout,
  89          * it's issued even if flush_data requests are still in flight.
  90          */
  91         FLUSH_PENDING_TIMEOUT   = 5 * HZ,
  92 };
  93
  94 static bool blk_kick_flush(struct request_queue *q);
  95
  96 static unsigned int blk_flush_policy(unsigned int fflags, struct request *rq)
  97 {
  98         unsigned int policy = 0;
  99
 100         if (blk_rq_sectors(rq))
 101                 policy |= REQ_FSEQ_DATA;
 102
 103         if (fflags & REQ_FLUSH) {
 104                 if (rq->cmd_flags & REQ_FLUSH)
 105                         policy |= REQ_FSEQ_PREFLUSH;
 106                 if (!(fflags & REQ_FUA) && (rq->cmd_flags & REQ_FUA))
 107                         policy |= REQ_FSEQ_POSTFLUSH;
 108         }
 109         return policy;
 110 }
 111
 112 static unsigned int blk_flush_cur_seq(struct request *rq)
 113 {
 114         return 1 << ffz(rq->flush.seq);
 115 }
 116
 117 static void blk_flush_restore_request(struct request *rq)
 118 {
 119         /*
 120          * After flush data completion, @rq->bio is %NULL but we need to
 121          * complete the bio again.  @rq->biotail is guaranteed to equal the
 122          * original @rq->bio.  Restore it.
 123          */
 124         rq->bio = rq->biotail;
 125
 126         /* make @rq a normal request */
 127         rq->cmd_flags &= ~REQ_FLUSH_SEQ;
 128         rq->end_io = rq->flush.saved_end_io;
 129
 130         blk_clear_rq_complete(rq);
 131 }
 132
 133 static void mq_flush_data_run(struct work_struct *work)
 134 {
 135         struct request *rq;
 136
 137         rq = container_of(work, struct request, mq_flush_data);
 138
 139         memset(&rq->csd, 0, sizeof(rq->csd));
 140         blk_mq_run_request(rq, true, false);
 141 }
 142
 143 static void blk_mq_flush_data_insert(struct request *rq)
 144 {
 145         INIT_WORK(&rq->mq_flush_data, mq_flush_data_run);
 146         kblockd_schedule_work(rq->q, &rq->mq_flush_data);
 147 }
 148
 149 /**
 150  * blk_flush_complete_seq - complete flush sequence
 151  * @rq: FLUSH/FUA request being sequenced
 152  * @seq: sequences to complete (mask of %REQ_FSEQ_*, can be zero)
 153  * @error: whether an error occurred
 154  *
 155  * @rq just completed @seq part of its flush sequence, record the
 156  * completion and trigger the next step.
 157  *
 158  * CONTEXT:
 159  * spin_lock_irq(q->queue_lock or q->mq_flush_lock)
 160  *
 161  * RETURNS:
 162  * %true if requests were added to the dispatch queue, %false otherwise.
 163  */
 164 static bool blk_flush_complete_seq(struct request *rq, unsigned int seq,
 165                                    int error)
 166 {
 167         struct request_queue *q = rq->q;
 168         struct list_head *pending = &q->flush_queue[q->flush_pending_idx];
 169         bool queued = false, kicked;
 170
 171         BUG_ON(rq->flush.seq & seq);
 172         rq->flush.seq |= seq;
 173
 174         if (likely(!error))
 175                 seq = blk_flush_cur_seq(rq);
 176         else
 177                 seq = REQ_FSEQ_DONE;
 178
 179         switch (seq) {
 180         case REQ_FSEQ_PREFLUSH:
 181         case REQ_FSEQ_POSTFLUSH:
 182                 /* queue for flush */
 183                 if (list_empty(pending))
 184                         q->flush_pending_since = jiffies;
 185                 list_move_tail(&rq->flush.list, pending);
 186                 break;
 187
 188         case REQ_FSEQ_DATA:
 189                 list_move_tail(&rq->flush.list, &q->flush_data_in_flight);
 190                 if (q->mq_ops)
 191                         blk_mq_flush_data_insert(rq);
 192                 else {
 193                         list_add(&rq->queuelist, &q->queue_head);
 194                         queued = true;
 195                 }
 196                 break;
 197
 198         case REQ_FSEQ_DONE:
 199                 /*
 200                  * @rq was previously adjusted by blk_flush_issue() for
 201                  * flush sequencing and may already have gone through the
 202                  * flush data request completion path.  Restore @rq for
 203                  * normal completion and end it.
 204                  */
 205                 BUG_ON(!list_empty(&rq->queuelist));
 206                 list_del_init(&rq->flush.list);
 207                 blk_flush_restore_request(rq);
 208                 if (q->mq_ops)
 209                         blk_mq_end_io(rq, error);
 210                 else
 211                         __blk_end_request_all(rq, error);
 212                 break;
 213
 214         default:
 215                 BUG();
 216         }
 217
 218         kicked = blk_kick_flush(q);
 219         /* blk_mq_run_flush will run queue */
 220         if (q->mq_ops)
 221                 return queued;
 222         return kicked | queued;
 223 }
 224
 225 static void flush_end_io(struct request *flush_rq, int error)
 226 {
 227         struct request_queue *q = flush_rq->q;
 228         struct list_head *running;
 229         bool queued = false;
 230         struct request *rq, *n;
 231         unsigned long flags = 0;
 232
 233         if (q->mq_ops) {
 234                 blk_mq_free_request(flush_rq);
 235                 spin_lock_irqsave(&q->mq_flush_lock, flags);
 236         }
 237         running = &q->flush_queue[q->flush_running_idx];
 238         BUG_ON(q->flush_pending_idx == q->flush_running_idx);
 239
 240         /* account completion of the flush request */
 241         q->flush_running_idx ^= 1;
 242
 243         if (!q->mq_ops)
 244                 elv_completed_request(q, flush_rq);
 245
 246         /* and push the waiting requests to the next stage */
 247         list_for_each_entry_safe(rq, n, running, flush.list) {
 248                 unsigned int seq = blk_flush_cur_seq(rq);
 249
 250                 BUG_ON(seq != REQ_FSEQ_PREFLUSH && seq != REQ_FSEQ_POSTFLUSH);
 251                 queued |= blk_flush_complete_seq(rq, seq, error);
 252         }
 253
 254         /*
 255          * Kick the queue to avoid stall for two cases:
 256          * 1. Moving a request silently to empty queue_head may stall the
 257          * queue.
 258          * 2. When flush request is running in non-queueable queue, the
 259          * queue is hold. Restart the queue after flush request is finished
 260          * to avoid stall.
 261          * This function is called from request completion path and calling
 262          * directly into request_fn may confuse the driver.  Always use
 263          * kblockd.
 264          */
 265         if (queued || q->flush_queue_delayed) {
 266                 if (!q->mq_ops)
 267                         blk_run_queue_async(q);
 268                 else
 269                 /*
 270                  * This can be optimized to only run queues with requests
 271                  * queued if necessary.
 272                  */
 273                         blk_mq_run_queues(q, true);
 274         }
 275         q->flush_queue_delayed = 0;
 276         if (q->mq_ops)
 277                 spin_unlock_irqrestore(&q->mq_flush_lock, flags);
 278 }
 279
 280 static void mq_flush_work(struct work_struct *work)
 281 {
 282         struct request_queue *q;
 283         struct request *rq;
 284
 285         q = container_of(work, struct request_queue, mq_flush_work);
 286
 287         rq = blk_mq_alloc_request(q, WRITE_FLUSH|REQ_FLUSH_SEQ,
 288                 __GFP_WAIT|GFP_ATOMIC, false);
 289         rq->cmd_type = REQ_TYPE_FS;
 290         rq->end_io = flush_end_io;
 291
 292         blk_mq_run_request(rq, true, false);
 293 }
 294
 295 /*
 296  * We can't directly use q->flush_rq, because it doesn't have tag and is not in
 297  * hctx->rqs[]. so we must allocate a new request, since we can't sleep here,
 298  * so offload the work to workqueue.
 299  *
 300  * Note: we assume a flush request finished in any hardware queue will flush
 301  * the whole disk cache.
 302  */
 303 static void mq_run_flush(struct request_queue *q)
 304 {
 305         kblockd_schedule_work(q, &q->mq_flush_work);
 306 }
 307
 308 /**
 309  * blk_kick_flush - consider issuing flush request
 310  * @q: request_queue being kicked
 311  *
 312  * Flush related states of @q have changed, consider issuing flush request.
 313  * Please read the comment at the top of this file for more info.
 314  *
 315  * CONTEXT:
 316  * spin_lock_irq(q->queue_lock or q->mq_flush_lock)
 317  *
 318  * RETURNS:
 319  * %true if flush was issued, %false otherwise.
 320  */
 321 static bool blk_kick_flush(struct request_queue *q)
 322 {
 323         struct list_head *pending = &q->flush_queue[q->flush_pending_idx];
 324         struct request *first_rq =
 325                 list_first_entry(pending, struct request, flush.list);
 326
 327         /* C1 described at the top of this file */
 328         if (q->flush_pending_idx != q->flush_running_idx || list_empty(pending))
 329                 return false;
 330
 331         /* C2 and C3 */
 332         if (!list_empty(&q->flush_data_in_flight) &&
 333             time_before(jiffies,
 334                         q->flush_pending_since + FLUSH_PENDING_TIMEOUT))
 335                 return false;
 336
 337         /*
 338          * Issue flush and toggle pending_idx.  This makes pending_idx
 339          * different from running_idx, which means flush is in flight.
 340          */
 341         q->flush_pending_idx ^= 1;
 342         if (q->mq_ops) {
 343                 mq_run_flush(q);
 344                 return true;
 345         }
 346
 347         blk_rq_init(q, &q->flush_rq);
 348         q->flush_rq.cmd_type = REQ_TYPE_FS;
 349         q->flush_rq.cmd_flags = WRITE_FLUSH | REQ_FLUSH_SEQ;
 350         q->flush_rq.rq_disk = first_rq->rq_disk;
 351         q->flush_rq.end_io = flush_end_io;
 352
 353         list_add_tail(&q->flush_rq.queuelist, &q->queue_head);
 354         return true;
 355 }
 356
 357 static void flush_data_end_io(struct request *rq, int error)
 358 {
 359         struct request_queue *q = rq->q;
 360
 361         /*
 362          * After populating an empty queue, kick it to avoid stall.  Read
 363          * the comment in flush_end_io().
 364          */
 365         if (blk_flush_complete_seq(rq, REQ_FSEQ_DATA, error))
 366                 blk_run_queue_async(q);
 367 }
 368
 369 static void mq_flush_data_end_io(struct request *rq, int error)
 370 {
 371         struct request_queue *q = rq->q;
 372         struct blk_mq_hw_ctx *hctx;
 373         struct blk_mq_ctx *ctx;
 374         unsigned long flags;
 375
 376         ctx = rq->mq_ctx;
 377         hctx = q->mq_ops->map_queue(q, ctx->cpu);
 378
 379         /*
 380          * After populating an empty queue, kick it to avoid stall.  Read
 381          * the comment in flush_end_io().
 382          */
 383         spin_lock_irqsave(&q->mq_flush_lock, flags);
 384         if (blk_flush_complete_seq(rq, REQ_FSEQ_DATA, error))
 385                 blk_mq_run_hw_queue(hctx, true);
 386         spin_unlock_irqrestore(&q->mq_flush_lock, flags);
 387 }
 388
 389 /**
 390  * blk_insert_flush - insert a new FLUSH/FUA request
 391  * @rq: request to insert
 392  *
 393  * To be called from __elv_add_request() for %ELEVATOR_INSERT_FLUSH insertions.
 394  * or __blk_mq_run_hw_queue() to dispatch request.
 395  * @rq is being submitted.  Analyze what needs to be done and put it on the
 396  * right queue.
 397  *
 398  * CONTEXT:
 399  * spin_lock_irq(q->queue_lock) in !mq case
 400  */
 401 void blk_insert_flush(struct request *rq)
 402 {
 403         struct request_queue *q = rq->q;
 404         unsigned int fflags = q->flush_flags;   /* may change, cache */
 405         unsigned int policy = blk_flush_policy(fflags, rq);
 406
 407         /*
 408          * @policy now records what operations need to be done.  Adjust
 409          * REQ_FLUSH and FUA for the driver.
 410          * We keep REQ_FLUSH for mq to track flush requests. For !FUA,
 411          * we never dispatch the request directly.
 412          */
 413         if (rq->cmd_flags & REQ_FUA)
 414                 rq->cmd_flags &= ~REQ_FLUSH;
 415         if (!(fflags & REQ_FUA))
 416                 rq->cmd_flags &= ~REQ_FUA;
 417
 418         /*
 419          * An empty flush handed down from a stacking driver may
 420          * translate into nothing if the underlying device does not
 421          * advertise a write-back cache.  In this case, simply
 422          * complete the request.
 423          */
 424         if (!policy) {
 425                 if (q->mq_ops)
 426                         blk_mq_end_io(rq, 0);
 427                 else
 428                         __blk_end_bidi_request(rq, 0, 0, 0);
 429                 return;
 430         }
 431
 432         BUG_ON(rq->bio != rq->biotail); /*assumes zero or single bio rq */
 433
 434         /*
 435          * If there's data but flush is not necessary, the request can be
 436          * processed directly without going through flush machinery.  Queue
 437          * for normal execution.
 438          */
 439         if ((policy & REQ_FSEQ_DATA) &&
 440             !(policy & (REQ_FSEQ_PREFLUSH | REQ_FSEQ_POSTFLUSH))) {
 441                 if (q->mq_ops) {
 442                         blk_mq_run_request(rq, false, true);
 443                 } else
 444                         list_add_tail(&rq->queuelist, &q->queue_head);
 445                 return;
 446         }
 447
 448         /*
 449          * @rq should go through flush machinery.  Mark it part of flush
 450          * sequence and submit for further processing.
 451          */
 452         memset(&rq->flush, 0, sizeof(rq->flush));
 453         INIT_LIST_HEAD(&rq->flush.list);
 454         rq->cmd_flags |= REQ_FLUSH_SEQ;
 455         rq->flush.saved_end_io = rq->end_io; /* Usually NULL */
 456         if (q->mq_ops) {
 457                 rq->end_io = mq_flush_data_end_io;
 458
 459                 spin_lock_irq(&q->mq_flush_lock);
 460                 blk_flush_complete_seq(rq, REQ_FSEQ_ACTIONS & ~policy, 0);
 461                 spin_unlock_irq(&q->mq_flush_lock);
 462                 return;
 463         }
 464         rq->end_io = flush_data_end_io;
 465
 466         blk_flush_complete_seq(rq, REQ_FSEQ_ACTIONS & ~policy, 0);
 467 }
 468
 469 /**
 470  * blk_abort_flushes - @q is being aborted, abort flush requests
 471  * @q: request_queue being aborted
 472  *
 473  * To be called from elv_abort_queue().  @q is being aborted.  Prepare all
 474  * FLUSH/FUA requests for abortion.
 475  *
 476  * CONTEXT:
 477  * spin_lock_irq(q->queue_lock)
 478  */
 479 void blk_abort_flushes(struct request_queue *q)
 480 {
 481         struct request *rq, *n;
 482         int i;
 483
 484         /*
 485          * Requests in flight for data are already owned by the dispatch
 486          * queue or the device driver.  Just restore for normal completion.
 487          */
 488         list_for_each_entry_safe(rq, n, &q->flush_data_in_flight, flush.list) {
 489                 list_del_init(&rq->flush.list);
 490                 blk_flush_restore_request(rq);
 491         }
 492
 493         /*
 494          * We need to give away requests on flush queues.  Restore for
 495          * normal completion and put them on the dispatch queue.
 496          */
 497         for (i = 0; i < ARRAY_SIZE(q->flush_queue); i++) {
 498                 list_for_each_entry_safe(rq, n, &q->flush_queue[i],
 499                                          flush.list) {
 500                         list_del_init(&rq->flush.list);
 501                         blk_flush_restore_request(rq);
 502                         list_add_tail(&rq->queuelist, &q->queue_head);
 503                 }
 504         }
 505 }
 506
 507 /**
 508  * blkdev_issue_flush - queue a flush
 509  * @bdev:       blockdev to issue flush for
 510  * @gfp_mask:   memory allocation flags (for bio_alloc)
 511  * @error_sector:       error sector
 512  *
 513  * Description:
 514  *    Issue a flush for the block device in question. Caller can supply
 515  *    room for storing the error offset in case of a flush error, if they
 516  *    wish to. If WAIT flag is not passed then caller may check only what
 517  *    request was pushed in some internal queue for later handling.
 518  */
 519 int blkdev_issue_flush(struct block_device *bdev, gfp_t gfp_mask,
 520                 sector_t *error_sector)
 521 {
 522         struct request_queue *q;
 523         struct bio *bio;
 524         int ret = 0;
 525
 526         if (bdev->bd_disk == NULL)
 527                 return -ENXIO;
 528
 529         q = bdev_get_queue(bdev);
 530         if (!q)
 531                 return -ENXIO;
 532
 533         /*
 534          * some block devices may not have their queue correctly set up here
 535          * (e.g. loop device without a backing file) and so issuing a flush
 536          * here will panic. Ensure there is a request function before issuing
 537          * the flush.
 538          */
 539         if (!q->make_request_fn)
 540                 return -ENXIO;
 541
 542         bio = bio_alloc(gfp_mask, 0);
 543         bio->bi_bdev = bdev;
 544
 545         ret = submit_bio_wait(WRITE_FLUSH, bio);
 546
 547         /*
 548          * The driver must store the error location in ->bi_sector, if
 549          * it supports it. For non-stacked drivers, this should be
 550          * copied from blk_rq_pos(rq).
 551          */
 552         if (error_sector)
 553                 *error_sector = bio->bi_iter.bi_sector;
 554
 555         bio_put(bio);
 556         return ret;
 557 }
 558 EXPORT_SYMBOL(blkdev_issue_flush);
 559
 560 void blk_mq_init_flush(struct request_queue *q)
 561 {
 562         spin_lock_init(&q->mq_flush_lock);
 563         INIT_WORK(&q->mq_flush_work, mq_flush_work);
 564 }