2 * Functions to sequence FLUSH and FUA writes.
4 * Copyright (C) 2011 Max Planck Institute for Gravitational Physics
5 * Copyright (C) 2011 Tejun Heo <tj@kernel.org>
7 * This file is released under the GPLv2.
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.
13 * If a request doesn't have data, only REQ_PREFLUSH makes sense, which
14 * indicates a simple flush request. If there is data, REQ_PREFLUSH 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
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.
23 * If the device has writeback cache and supports FUA, REQ_PREFLUSH is
24 * translated to PREFLUSH but REQ_FUA is passed down directly with DATA.
26 * If the device has writeback cache and doesn't support FUA, REQ_PREFLUSH
27 * is translated to PREFLUSH and REQ_FUA to POSTFLUSH.
29 * The actual execution of flush is double buffered. Whenever a request
30 * needs to execute PRE or POSTFLUSH, it queues at
31 * fq->flush_queue[fq->flush_pending_idx]. Once certain criteria are met, a
32 * REQ_OP_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
37 * Currently, the following conditions are used to determine when to issue
40 * C1. At any given time, only one flush shall be in progress. This makes
41 * double buffering sufficient.
43 * C2. Flush is deferred if any request is executing DATA of its sequence.
44 * This avoids issuing separate POSTFLUSHes for requests which shared
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.
52 * For devices which support FUA, it isn't clear whether C2 (and thus C3)
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 RQF_FLUSH_SEQ in
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.
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>
76 #include "blk-mq-tag.h"
78 /* FLUSH/FUA sequences */
80 REQ_FSEQ_PREFLUSH = (1 << 0), /* pre-flushing in progress */
81 REQ_FSEQ_DATA = (1 << 1), /* data write in progress */
82 REQ_FSEQ_POSTFLUSH = (1 << 2), /* post-flushing in progress */
83 REQ_FSEQ_DONE = (1 << 3),
85 REQ_FSEQ_ACTIONS = REQ_FSEQ_PREFLUSH | REQ_FSEQ_DATA |
89 * If flush has been pending longer than the following timeout,
90 * it's issued even if flush_data requests are still in flight.
92 FLUSH_PENDING_TIMEOUT = 5 * HZ,
95 static bool blk_kick_flush(struct request_queue *q,
96 struct blk_flush_queue *fq);
98 static unsigned int blk_flush_policy(unsigned long fflags, struct request *rq)
100 unsigned int policy = 0;
102 if (blk_rq_sectors(rq))
103 policy |= REQ_FSEQ_DATA;
105 if (fflags & (1UL << QUEUE_FLAG_WC)) {
106 if (rq->cmd_flags & REQ_PREFLUSH)
107 policy |= REQ_FSEQ_PREFLUSH;
108 if (!(fflags & (1UL << QUEUE_FLAG_FUA)) &&
109 (rq->cmd_flags & REQ_FUA))
110 policy |= REQ_FSEQ_POSTFLUSH;
115 static unsigned int blk_flush_cur_seq(struct request *rq)
117 return 1 << ffz(rq->flush.seq);
120 static void blk_flush_restore_request(struct request *rq)
123 * After flush data completion, @rq->bio is %NULL but we need to
124 * complete the bio again. @rq->biotail is guaranteed to equal the
125 * original @rq->bio. Restore it.
127 rq->bio = rq->biotail;
129 /* make @rq a normal request */
130 rq->rq_flags &= ~RQF_FLUSH_SEQ;
131 rq->end_io = rq->flush.saved_end_io;
134 static bool blk_flush_queue_rq(struct request *rq, bool add_front)
137 blk_mq_add_to_requeue_list(rq, add_front, true);
141 list_add(&rq->queuelist, &rq->q->queue_head);
143 list_add_tail(&rq->queuelist, &rq->q->queue_head);
149 * blk_flush_complete_seq - complete flush sequence
150 * @rq: FLUSH/FUA request being sequenced
152 * @seq: sequences to complete (mask of %REQ_FSEQ_*, can be zero)
153 * @error: whether an error occurred
155 * @rq just completed @seq part of its flush sequence, record the
156 * completion and trigger the next step.
159 * spin_lock_irq(q->queue_lock or fq->mq_flush_lock)
162 * %true if requests were added to the dispatch queue, %false otherwise.
164 static bool blk_flush_complete_seq(struct request *rq,
165 struct blk_flush_queue *fq,
166 unsigned int seq, int error)
168 struct request_queue *q = rq->q;
169 struct list_head *pending = &fq->flush_queue[fq->flush_pending_idx];
170 bool queued = false, kicked;
172 BUG_ON(rq->flush.seq & seq);
173 rq->flush.seq |= seq;
176 seq = blk_flush_cur_seq(rq);
181 case REQ_FSEQ_PREFLUSH:
182 case REQ_FSEQ_POSTFLUSH:
183 /* queue for flush */
184 if (list_empty(pending))
185 fq->flush_pending_since = jiffies;
186 list_move_tail(&rq->flush.list, pending);
190 list_move_tail(&rq->flush.list, &fq->flush_data_in_flight);
191 queued = blk_flush_queue_rq(rq, true);
196 * @rq was previously adjusted by blk_flush_issue() for
197 * flush sequencing and may already have gone through the
198 * flush data request completion path. Restore @rq for
199 * normal completion and end it.
201 BUG_ON(!list_empty(&rq->queuelist));
202 list_del_init(&rq->flush.list);
203 blk_flush_restore_request(rq);
205 blk_mq_end_request(rq, error);
207 __blk_end_request_all(rq, error);
214 kicked = blk_kick_flush(q, fq);
215 return kicked | queued;
218 static void flush_end_io(struct request *flush_rq, int error)
220 struct request_queue *q = flush_rq->q;
221 struct list_head *running;
223 struct request *rq, *n;
224 unsigned long flags = 0;
225 struct blk_flush_queue *fq = blk_get_flush_queue(q, flush_rq->mq_ctx);
228 struct blk_mq_hw_ctx *hctx;
230 /* release the tag's ownership to the req cloned from */
231 spin_lock_irqsave(&fq->mq_flush_lock, flags);
232 hctx = blk_mq_map_queue(q, flush_rq->mq_ctx->cpu);
233 blk_mq_tag_set_rq(hctx, flush_rq->tag, fq->orig_rq);
237 running = &fq->flush_queue[fq->flush_running_idx];
238 BUG_ON(fq->flush_pending_idx == fq->flush_running_idx);
240 /* account completion of the flush request */
241 fq->flush_running_idx ^= 1;
244 elv_completed_request(q, flush_rq);
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);
250 BUG_ON(seq != REQ_FSEQ_PREFLUSH && seq != REQ_FSEQ_POSTFLUSH);
251 queued |= blk_flush_complete_seq(rq, fq, seq, error);
255 * Kick the queue to avoid stall for two cases:
256 * 1. Moving a request silently to empty queue_head may stall the
258 * 2. When flush request is running in non-queueable queue, the
259 * queue is hold. Restart the queue after flush request is finished
261 * This function is called from request completion path and calling
262 * directly into request_fn may confuse the driver. Always use
265 if (queued || fq->flush_queue_delayed) {
267 blk_run_queue_async(q);
269 fq->flush_queue_delayed = 0;
271 spin_unlock_irqrestore(&fq->mq_flush_lock, flags);
275 * blk_kick_flush - consider issuing flush request
276 * @q: request_queue being kicked
279 * Flush related states of @q have changed, consider issuing flush request.
280 * Please read the comment at the top of this file for more info.
283 * spin_lock_irq(q->queue_lock or fq->mq_flush_lock)
286 * %true if flush was issued, %false otherwise.
288 static bool blk_kick_flush(struct request_queue *q, struct blk_flush_queue *fq)
290 struct list_head *pending = &fq->flush_queue[fq->flush_pending_idx];
291 struct request *first_rq =
292 list_first_entry(pending, struct request, flush.list);
293 struct request *flush_rq = fq->flush_rq;
295 /* C1 described at the top of this file */
296 if (fq->flush_pending_idx != fq->flush_running_idx || list_empty(pending))
300 if (!list_empty(&fq->flush_data_in_flight) &&
302 fq->flush_pending_since + FLUSH_PENDING_TIMEOUT))
306 * Issue flush and toggle pending_idx. This makes pending_idx
307 * different from running_idx, which means flush is in flight.
309 fq->flush_pending_idx ^= 1;
311 blk_rq_init(q, flush_rq);
314 * Borrow tag from the first request since they can't
315 * be in flight at the same time. And acquire the tag's
316 * ownership for flush req.
319 struct blk_mq_hw_ctx *hctx;
321 flush_rq->mq_ctx = first_rq->mq_ctx;
322 flush_rq->tag = first_rq->tag;
323 fq->orig_rq = first_rq;
325 hctx = blk_mq_map_queue(q, first_rq->mq_ctx->cpu);
326 blk_mq_tag_set_rq(hctx, first_rq->tag, flush_rq);
329 flush_rq->cmd_type = REQ_TYPE_FS;
330 flush_rq->cmd_flags = REQ_OP_FLUSH | REQ_PREFLUSH;
331 flush_rq->rq_flags |= RQF_FLUSH_SEQ;
332 flush_rq->rq_disk = first_rq->rq_disk;
333 flush_rq->end_io = flush_end_io;
335 return blk_flush_queue_rq(flush_rq, false);
338 static void flush_data_end_io(struct request *rq, int error)
340 struct request_queue *q = rq->q;
341 struct blk_flush_queue *fq = blk_get_flush_queue(q, NULL);
344 * After populating an empty queue, kick it to avoid stall. Read
345 * the comment in flush_end_io().
347 if (blk_flush_complete_seq(rq, fq, REQ_FSEQ_DATA, error))
348 blk_run_queue_async(q);
351 static void mq_flush_data_end_io(struct request *rq, int error)
353 struct request_queue *q = rq->q;
354 struct blk_mq_hw_ctx *hctx;
355 struct blk_mq_ctx *ctx = rq->mq_ctx;
357 struct blk_flush_queue *fq = blk_get_flush_queue(q, ctx);
359 hctx = blk_mq_map_queue(q, ctx->cpu);
362 * After populating an empty queue, kick it to avoid stall. Read
363 * the comment in flush_end_io().
365 spin_lock_irqsave(&fq->mq_flush_lock, flags);
366 if (blk_flush_complete_seq(rq, fq, REQ_FSEQ_DATA, error))
367 blk_mq_run_hw_queue(hctx, true);
368 spin_unlock_irqrestore(&fq->mq_flush_lock, flags);
372 * blk_insert_flush - insert a new FLUSH/FUA request
373 * @rq: request to insert
375 * To be called from __elv_add_request() for %ELEVATOR_INSERT_FLUSH insertions.
376 * or __blk_mq_run_hw_queue() to dispatch request.
377 * @rq is being submitted. Analyze what needs to be done and put it on the
381 * spin_lock_irq(q->queue_lock) in !mq case
383 void blk_insert_flush(struct request *rq)
385 struct request_queue *q = rq->q;
386 unsigned long fflags = q->queue_flags; /* may change, cache */
387 unsigned int policy = blk_flush_policy(fflags, rq);
388 struct blk_flush_queue *fq = blk_get_flush_queue(q, rq->mq_ctx);
391 * @policy now records what operations need to be done. Adjust
392 * REQ_PREFLUSH and FUA for the driver.
394 rq->cmd_flags &= ~REQ_PREFLUSH;
395 if (!(fflags & (1UL << QUEUE_FLAG_FUA)))
396 rq->cmd_flags &= ~REQ_FUA;
399 * An empty flush handed down from a stacking driver may
400 * translate into nothing if the underlying device does not
401 * advertise a write-back cache. In this case, simply
402 * complete the request.
406 blk_mq_end_request(rq, 0);
408 __blk_end_bidi_request(rq, 0, 0, 0);
412 BUG_ON(rq->bio != rq->biotail); /*assumes zero or single bio rq */
415 * If there's data but flush is not necessary, the request can be
416 * processed directly without going through flush machinery. Queue
417 * for normal execution.
419 if ((policy & REQ_FSEQ_DATA) &&
420 !(policy & (REQ_FSEQ_PREFLUSH | REQ_FSEQ_POSTFLUSH))) {
422 blk_mq_insert_request(rq, false, false, true);
424 list_add_tail(&rq->queuelist, &q->queue_head);
429 * @rq should go through flush machinery. Mark it part of flush
430 * sequence and submit for further processing.
432 memset(&rq->flush, 0, sizeof(rq->flush));
433 INIT_LIST_HEAD(&rq->flush.list);
434 rq->rq_flags |= RQF_FLUSH_SEQ;
435 rq->flush.saved_end_io = rq->end_io; /* Usually NULL */
437 rq->end_io = mq_flush_data_end_io;
439 spin_lock_irq(&fq->mq_flush_lock);
440 blk_flush_complete_seq(rq, fq, REQ_FSEQ_ACTIONS & ~policy, 0);
441 spin_unlock_irq(&fq->mq_flush_lock);
444 rq->end_io = flush_data_end_io;
446 blk_flush_complete_seq(rq, fq, REQ_FSEQ_ACTIONS & ~policy, 0);
450 * blkdev_issue_flush - queue a flush
451 * @bdev: blockdev to issue flush for
452 * @gfp_mask: memory allocation flags (for bio_alloc)
453 * @error_sector: error sector
456 * Issue a flush for the block device in question. Caller can supply
457 * room for storing the error offset in case of a flush error, if they
458 * wish to. If WAIT flag is not passed then caller may check only what
459 * request was pushed in some internal queue for later handling.
461 int blkdev_issue_flush(struct block_device *bdev, gfp_t gfp_mask,
462 sector_t *error_sector)
464 struct request_queue *q;
468 if (bdev->bd_disk == NULL)
471 q = bdev_get_queue(bdev);
476 * some block devices may not have their queue correctly set up here
477 * (e.g. loop device without a backing file) and so issuing a flush
478 * here will panic. Ensure there is a request function before issuing
481 if (!q->make_request_fn)
484 bio = bio_alloc(gfp_mask, 0);
486 bio->bi_opf = REQ_OP_WRITE | REQ_PREFLUSH;
488 ret = submit_bio_wait(bio);
491 * The driver must store the error location in ->bi_sector, if
492 * it supports it. For non-stacked drivers, this should be
493 * copied from blk_rq_pos(rq).
496 *error_sector = bio->bi_iter.bi_sector;
501 EXPORT_SYMBOL(blkdev_issue_flush);
503 struct blk_flush_queue *blk_alloc_flush_queue(struct request_queue *q,
504 int node, int cmd_size)
506 struct blk_flush_queue *fq;
507 int rq_sz = sizeof(struct request);
509 fq = kzalloc_node(sizeof(*fq), GFP_KERNEL, node);
514 spin_lock_init(&fq->mq_flush_lock);
515 rq_sz = round_up(rq_sz + cmd_size, cache_line_size());
518 fq->flush_rq = kzalloc_node(rq_sz, GFP_KERNEL, node);
522 INIT_LIST_HEAD(&fq->flush_queue[0]);
523 INIT_LIST_HEAD(&fq->flush_queue[1]);
524 INIT_LIST_HEAD(&fq->flush_data_in_flight);
534 void blk_free_flush_queue(struct blk_flush_queue *fq)
536 /* bio based request queue hasn't flush queue */