GNU Linux-libre 4.19.295-gnu1
[releases.git] / block / blk-flush.c
1 /*
2  * Functions to sequence PREFLUSH 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_{PREFLUSH|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_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
17  * completion.
18  *
19  * If the device doesn't have writeback cache, PREFLUSH and FUA don't make any
20  * difference.  The requests are either completed immediately if there's no data
21  * or executed as normal requests otherwise.
22  *
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.
25  *
26  * If the device has writeback cache and doesn't support FUA, REQ_PREFLUSH
27  * is 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  * 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 PREFLUSH/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 PREFLUSH) 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 PREFLUSH/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
60  * req_bio_endio().
61  *
62  * The above peculiarity requires that each PREFLUSH/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 #include "blk-mq-tag.h"
77 #include "blk-mq-sched.h"
78
79 /* PREFLUSH/FUA sequences */
80 enum {
81         REQ_FSEQ_PREFLUSH       = (1 << 0), /* pre-flushing in progress */
82         REQ_FSEQ_DATA           = (1 << 1), /* data write in progress */
83         REQ_FSEQ_POSTFLUSH      = (1 << 2), /* post-flushing in progress */
84         REQ_FSEQ_DONE           = (1 << 3),
85
86         REQ_FSEQ_ACTIONS        = REQ_FSEQ_PREFLUSH | REQ_FSEQ_DATA |
87                                   REQ_FSEQ_POSTFLUSH,
88
89         /*
90          * If flush has been pending longer than the following timeout,
91          * it's issued even if flush_data requests are still in flight.
92          */
93         FLUSH_PENDING_TIMEOUT   = 5 * HZ,
94 };
95
96 static bool blk_kick_flush(struct request_queue *q,
97                            struct blk_flush_queue *fq, unsigned int flags);
98
99 static unsigned int blk_flush_policy(unsigned long fflags, struct request *rq)
100 {
101         unsigned int policy = 0;
102
103         if (blk_rq_sectors(rq))
104                 policy |= REQ_FSEQ_DATA;
105
106         if (fflags & (1UL << QUEUE_FLAG_WC)) {
107                 if (rq->cmd_flags & REQ_PREFLUSH)
108                         policy |= REQ_FSEQ_PREFLUSH;
109                 if (!(fflags & (1UL << QUEUE_FLAG_FUA)) &&
110                     (rq->cmd_flags & REQ_FUA))
111                         policy |= REQ_FSEQ_POSTFLUSH;
112         }
113         return policy;
114 }
115
116 static unsigned int blk_flush_cur_seq(struct request *rq)
117 {
118         return 1 << ffz(rq->flush.seq);
119 }
120
121 static void blk_flush_restore_request(struct request *rq)
122 {
123         /*
124          * After flush data completion, @rq->bio is %NULL but we need to
125          * complete the bio again.  @rq->biotail is guaranteed to equal the
126          * original @rq->bio.  Restore it.
127          */
128         rq->bio = rq->biotail;
129
130         /* make @rq a normal request */
131         rq->rq_flags &= ~RQF_FLUSH_SEQ;
132         rq->end_io = rq->flush.saved_end_io;
133 }
134
135 static bool blk_flush_queue_rq(struct request *rq, bool add_front)
136 {
137         if (rq->q->mq_ops) {
138                 blk_mq_add_to_requeue_list(rq, add_front, true);
139                 return false;
140         } else {
141                 if (add_front)
142                         list_add(&rq->queuelist, &rq->q->queue_head);
143                 else
144                         list_add_tail(&rq->queuelist, &rq->q->queue_head);
145                 return true;
146         }
147 }
148
149 /**
150  * blk_flush_complete_seq - complete flush sequence
151  * @rq: PREFLUSH/FUA request being sequenced
152  * @fq: flush queue
153  * @seq: sequences to complete (mask of %REQ_FSEQ_*, can be zero)
154  * @error: whether an error occurred
155  *
156  * @rq just completed @seq part of its flush sequence, record the
157  * completion and trigger the next step.
158  *
159  * CONTEXT:
160  * spin_lock_irq(q->queue_lock or fq->mq_flush_lock)
161  *
162  * RETURNS:
163  * %true if requests were added to the dispatch queue, %false otherwise.
164  */
165 static bool blk_flush_complete_seq(struct request *rq,
166                                    struct blk_flush_queue *fq,
167                                    unsigned int seq, blk_status_t error)
168 {
169         struct request_queue *q = rq->q;
170         struct list_head *pending = &fq->flush_queue[fq->flush_pending_idx];
171         bool queued = false, kicked;
172         unsigned int cmd_flags;
173
174         BUG_ON(rq->flush.seq & seq);
175         rq->flush.seq |= seq;
176         cmd_flags = rq->cmd_flags;
177
178         if (likely(!error))
179                 seq = blk_flush_cur_seq(rq);
180         else
181                 seq = REQ_FSEQ_DONE;
182
183         switch (seq) {
184         case REQ_FSEQ_PREFLUSH:
185         case REQ_FSEQ_POSTFLUSH:
186                 /* queue for flush */
187                 if (list_empty(pending))
188                         fq->flush_pending_since = jiffies;
189                 list_move_tail(&rq->flush.list, pending);
190                 break;
191
192         case REQ_FSEQ_DATA:
193                 list_move_tail(&rq->flush.list, &fq->flush_data_in_flight);
194                 queued = blk_flush_queue_rq(rq, true);
195                 break;
196
197         case REQ_FSEQ_DONE:
198                 /*
199                  * @rq was previously adjusted by blk_flush_issue() for
200                  * flush sequencing and may already have gone through the
201                  * flush data request completion path.  Restore @rq for
202                  * normal completion and end it.
203                  */
204                 BUG_ON(!list_empty(&rq->queuelist));
205                 list_del_init(&rq->flush.list);
206                 blk_flush_restore_request(rq);
207                 if (q->mq_ops)
208                         blk_mq_end_request(rq, error);
209                 else
210                         __blk_end_request_all(rq, error);
211                 break;
212
213         default:
214                 BUG();
215         }
216
217         kicked = blk_kick_flush(q, fq, cmd_flags);
218         return kicked | queued;
219 }
220
221 static void flush_end_io(struct request *flush_rq, blk_status_t error)
222 {
223         struct request_queue *q = flush_rq->q;
224         struct list_head *running;
225         bool queued = false;
226         struct request *rq, *n;
227         unsigned long flags = 0;
228         struct blk_flush_queue *fq = blk_get_flush_queue(q, flush_rq->mq_ctx);
229
230         if (q->mq_ops) {
231                 struct blk_mq_hw_ctx *hctx;
232
233                 /* release the tag's ownership to the req cloned from */
234                 spin_lock_irqsave(&fq->mq_flush_lock, flags);
235
236                 if (!refcount_dec_and_test(&flush_rq->ref)) {
237                         fq->rq_status = error;
238                         spin_unlock_irqrestore(&fq->mq_flush_lock, flags);
239                         return;
240                 }
241
242                 if (fq->rq_status != BLK_STS_OK) {
243                         error = fq->rq_status;
244                         fq->rq_status = BLK_STS_OK;
245                 }
246
247                 hctx = blk_mq_map_queue(q, flush_rq->mq_ctx->cpu);
248                 if (!q->elevator) {
249                         blk_mq_tag_set_rq(hctx, flush_rq->tag, fq->orig_rq);
250                         flush_rq->tag = -1;
251                 } else {
252                         blk_mq_put_driver_tag_hctx(hctx, flush_rq);
253                         flush_rq->internal_tag = -1;
254                 }
255         }
256
257         running = &fq->flush_queue[fq->flush_running_idx];
258         BUG_ON(fq->flush_pending_idx == fq->flush_running_idx);
259
260         /* account completion of the flush request */
261         fq->flush_running_idx ^= 1;
262
263         if (!q->mq_ops)
264                 elv_completed_request(q, flush_rq);
265
266         /* and push the waiting requests to the next stage */
267         list_for_each_entry_safe(rq, n, running, flush.list) {
268                 unsigned int seq = blk_flush_cur_seq(rq);
269
270                 BUG_ON(seq != REQ_FSEQ_PREFLUSH && seq != REQ_FSEQ_POSTFLUSH);
271                 queued |= blk_flush_complete_seq(rq, fq, seq, error);
272         }
273
274         /*
275          * Kick the queue to avoid stall for two cases:
276          * 1. Moving a request silently to empty queue_head may stall the
277          * queue.
278          * 2. When flush request is running in non-queueable queue, the
279          * queue is hold. Restart the queue after flush request is finished
280          * to avoid stall.
281          * This function is called from request completion path and calling
282          * directly into request_fn may confuse the driver.  Always use
283          * kblockd.
284          */
285         if (queued || fq->flush_queue_delayed) {
286                 WARN_ON(q->mq_ops);
287                 blk_run_queue_async(q);
288         }
289         fq->flush_queue_delayed = 0;
290         if (q->mq_ops)
291                 spin_unlock_irqrestore(&fq->mq_flush_lock, flags);
292 }
293
294 /**
295  * blk_kick_flush - consider issuing flush request
296  * @q: request_queue being kicked
297  * @fq: flush queue
298  * @flags: cmd_flags of the original request
299  *
300  * Flush related states of @q have changed, consider issuing flush request.
301  * Please read the comment at the top of this file for more info.
302  *
303  * CONTEXT:
304  * spin_lock_irq(q->queue_lock or fq->mq_flush_lock)
305  *
306  * RETURNS:
307  * %true if flush was issued, %false otherwise.
308  */
309 static bool blk_kick_flush(struct request_queue *q, struct blk_flush_queue *fq,
310                            unsigned int flags)
311 {
312         struct list_head *pending = &fq->flush_queue[fq->flush_pending_idx];
313         struct request *first_rq =
314                 list_first_entry(pending, struct request, flush.list);
315         struct request *flush_rq = fq->flush_rq;
316
317         /* C1 described at the top of this file */
318         if (fq->flush_pending_idx != fq->flush_running_idx || list_empty(pending))
319                 return false;
320
321         /* C2 and C3
322          *
323          * For blk-mq + scheduling, we can risk having all driver tags
324          * assigned to empty flushes, and we deadlock if we are expecting
325          * other requests to make progress. Don't defer for that case.
326          */
327         if (!list_empty(&fq->flush_data_in_flight) &&
328             !(q->mq_ops && q->elevator) &&
329             time_before(jiffies,
330                         fq->flush_pending_since + FLUSH_PENDING_TIMEOUT))
331                 return false;
332
333         /*
334          * Issue flush and toggle pending_idx.  This makes pending_idx
335          * different from running_idx, which means flush is in flight.
336          */
337         fq->flush_pending_idx ^= 1;
338
339         blk_rq_init(q, flush_rq);
340
341         /*
342          * In case of none scheduler, borrow tag from the first request
343          * since they can't be in flight at the same time. And acquire
344          * the tag's ownership for flush req.
345          *
346          * In case of IO scheduler, flush rq need to borrow scheduler tag
347          * just for cheating put/get driver tag.
348          */
349         if (q->mq_ops) {
350                 struct blk_mq_hw_ctx *hctx;
351
352                 flush_rq->mq_ctx = first_rq->mq_ctx;
353
354                 if (!q->elevator) {
355                         fq->orig_rq = first_rq;
356                         flush_rq->tag = first_rq->tag;
357                         hctx = blk_mq_map_queue(q, first_rq->mq_ctx->cpu);
358                         blk_mq_tag_set_rq(hctx, first_rq->tag, flush_rq);
359                 } else {
360                         flush_rq->internal_tag = first_rq->internal_tag;
361                 }
362         }
363
364         flush_rq->cmd_flags = REQ_OP_FLUSH | REQ_PREFLUSH;
365         flush_rq->cmd_flags |= (flags & REQ_DRV) | (flags & REQ_FAILFAST_MASK);
366         flush_rq->rq_flags |= RQF_FLUSH_SEQ;
367         flush_rq->rq_disk = first_rq->rq_disk;
368         flush_rq->end_io = flush_end_io;
369
370         return blk_flush_queue_rq(flush_rq, false);
371 }
372
373 static void flush_data_end_io(struct request *rq, blk_status_t error)
374 {
375         struct request_queue *q = rq->q;
376         struct blk_flush_queue *fq = blk_get_flush_queue(q, NULL);
377
378         lockdep_assert_held(q->queue_lock);
379
380         /*
381          * Updating q->in_flight[] here for making this tag usable
382          * early. Because in blk_queue_start_tag(),
383          * q->in_flight[BLK_RW_ASYNC] is used to limit async I/O and
384          * reserve tags for sync I/O.
385          *
386          * More importantly this way can avoid the following I/O
387          * deadlock:
388          *
389          * - suppose there are 40 fua requests comming to flush queue
390          *   and queue depth is 31
391          * - 30 rqs are scheduled then blk_queue_start_tag() can't alloc
392          *   tag for async I/O any more
393          * - all the 30 rqs are completed before FLUSH_PENDING_TIMEOUT
394          *   and flush_data_end_io() is called
395          * - the other rqs still can't go ahead if not updating
396          *   q->in_flight[BLK_RW_ASYNC] here, meantime these rqs
397          *   are held in flush data queue and make no progress of
398          *   handling post flush rq
399          * - only after the post flush rq is handled, all these rqs
400          *   can be completed
401          */
402
403         elv_completed_request(q, rq);
404
405         /* for avoiding double accounting */
406         rq->rq_flags &= ~RQF_STARTED;
407
408         /*
409          * After populating an empty queue, kick it to avoid stall.  Read
410          * the comment in flush_end_io().
411          */
412         if (blk_flush_complete_seq(rq, fq, REQ_FSEQ_DATA, error))
413                 blk_run_queue_async(q);
414 }
415
416 static void mq_flush_data_end_io(struct request *rq, blk_status_t error)
417 {
418         struct request_queue *q = rq->q;
419         struct blk_mq_hw_ctx *hctx;
420         struct blk_mq_ctx *ctx = rq->mq_ctx;
421         unsigned long flags;
422         struct blk_flush_queue *fq = blk_get_flush_queue(q, ctx);
423
424         hctx = blk_mq_map_queue(q, ctx->cpu);
425
426         if (q->elevator) {
427                 WARN_ON(rq->tag < 0);
428                 blk_mq_put_driver_tag_hctx(hctx, rq);
429         }
430
431         /*
432          * After populating an empty queue, kick it to avoid stall.  Read
433          * the comment in flush_end_io().
434          */
435         spin_lock_irqsave(&fq->mq_flush_lock, flags);
436         blk_flush_complete_seq(rq, fq, REQ_FSEQ_DATA, error);
437         spin_unlock_irqrestore(&fq->mq_flush_lock, flags);
438
439         blk_mq_sched_restart(hctx);
440 }
441
442 /**
443  * blk_insert_flush - insert a new PREFLUSH/FUA request
444  * @rq: request to insert
445  *
446  * To be called from __elv_add_request() for %ELEVATOR_INSERT_FLUSH insertions.
447  * or __blk_mq_run_hw_queue() to dispatch request.
448  * @rq is being submitted.  Analyze what needs to be done and put it on the
449  * right queue.
450  */
451 void blk_insert_flush(struct request *rq)
452 {
453         struct request_queue *q = rq->q;
454         unsigned long fflags = q->queue_flags;  /* may change, cache */
455         unsigned int policy = blk_flush_policy(fflags, rq);
456         struct blk_flush_queue *fq = blk_get_flush_queue(q, rq->mq_ctx);
457
458         if (!q->mq_ops)
459                 lockdep_assert_held(q->queue_lock);
460
461         /*
462          * @policy now records what operations need to be done.  Adjust
463          * REQ_PREFLUSH and FUA for the driver.
464          */
465         rq->cmd_flags &= ~REQ_PREFLUSH;
466         if (!(fflags & (1UL << QUEUE_FLAG_FUA)))
467                 rq->cmd_flags &= ~REQ_FUA;
468
469         /*
470          * REQ_PREFLUSH|REQ_FUA implies REQ_SYNC, so if we clear any
471          * of those flags, we have to set REQ_SYNC to avoid skewing
472          * the request accounting.
473          */
474         rq->cmd_flags |= REQ_SYNC;
475
476         /*
477          * An empty flush handed down from a stacking driver may
478          * translate into nothing if the underlying device does not
479          * advertise a write-back cache.  In this case, simply
480          * complete the request.
481          */
482         if (!policy) {
483                 if (q->mq_ops)
484                         blk_mq_end_request(rq, 0);
485                 else
486                         __blk_end_request(rq, 0, 0);
487                 return;
488         }
489
490         BUG_ON(rq->bio != rq->biotail); /*assumes zero or single bio rq */
491
492         /*
493          * If there's data but flush is not necessary, the request can be
494          * processed directly without going through flush machinery.  Queue
495          * for normal execution.
496          */
497         if ((policy & REQ_FSEQ_DATA) &&
498             !(policy & (REQ_FSEQ_PREFLUSH | REQ_FSEQ_POSTFLUSH))) {
499                 if (q->mq_ops)
500                         blk_mq_request_bypass_insert(rq, false);
501                 else
502                         list_add_tail(&rq->queuelist, &q->queue_head);
503                 return;
504         }
505
506         /*
507          * @rq should go through flush machinery.  Mark it part of flush
508          * sequence and submit for further processing.
509          */
510         memset(&rq->flush, 0, sizeof(rq->flush));
511         INIT_LIST_HEAD(&rq->flush.list);
512         rq->rq_flags |= RQF_FLUSH_SEQ;
513         rq->flush.saved_end_io = rq->end_io; /* Usually NULL */
514         if (q->mq_ops) {
515                 rq->end_io = mq_flush_data_end_io;
516
517                 spin_lock_irq(&fq->mq_flush_lock);
518                 blk_flush_complete_seq(rq, fq, REQ_FSEQ_ACTIONS & ~policy, 0);
519                 spin_unlock_irq(&fq->mq_flush_lock);
520                 return;
521         }
522         rq->end_io = flush_data_end_io;
523
524         blk_flush_complete_seq(rq, fq, REQ_FSEQ_ACTIONS & ~policy, 0);
525 }
526
527 /**
528  * blkdev_issue_flush - queue a flush
529  * @bdev:       blockdev to issue flush for
530  * @gfp_mask:   memory allocation flags (for bio_alloc)
531  * @error_sector:       error sector
532  *
533  * Description:
534  *    Issue a flush for the block device in question. Caller can supply
535  *    room for storing the error offset in case of a flush error, if they
536  *    wish to.
537  */
538 int blkdev_issue_flush(struct block_device *bdev, gfp_t gfp_mask,
539                 sector_t *error_sector)
540 {
541         struct request_queue *q;
542         struct bio *bio;
543         int ret = 0;
544
545         if (bdev->bd_disk == NULL)
546                 return -ENXIO;
547
548         q = bdev_get_queue(bdev);
549         if (!q)
550                 return -ENXIO;
551
552         /*
553          * some block devices may not have their queue correctly set up here
554          * (e.g. loop device without a backing file) and so issuing a flush
555          * here will panic. Ensure there is a request function before issuing
556          * the flush.
557          */
558         if (!q->make_request_fn)
559                 return -ENXIO;
560
561         bio = bio_alloc(gfp_mask, 0);
562         bio_set_dev(bio, bdev);
563         bio->bi_opf = REQ_OP_WRITE | REQ_PREFLUSH;
564
565         ret = submit_bio_wait(bio);
566
567         /*
568          * The driver must store the error location in ->bi_sector, if
569          * it supports it. For non-stacked drivers, this should be
570          * copied from blk_rq_pos(rq).
571          */
572         if (error_sector)
573                 *error_sector = bio->bi_iter.bi_sector;
574
575         bio_put(bio);
576         return ret;
577 }
578 EXPORT_SYMBOL(blkdev_issue_flush);
579
580 struct blk_flush_queue *blk_alloc_flush_queue(struct request_queue *q,
581                 int node, int cmd_size, gfp_t flags)
582 {
583         struct blk_flush_queue *fq;
584         int rq_sz = sizeof(struct request);
585
586         fq = kzalloc_node(sizeof(*fq), flags, node);
587         if (!fq)
588                 goto fail;
589
590         if (q->mq_ops)
591                 spin_lock_init(&fq->mq_flush_lock);
592
593         rq_sz = round_up(rq_sz + cmd_size, cache_line_size());
594         fq->flush_rq = kzalloc_node(rq_sz, flags, node);
595         if (!fq->flush_rq)
596                 goto fail_rq;
597
598         INIT_LIST_HEAD(&fq->flush_queue[0]);
599         INIT_LIST_HEAD(&fq->flush_queue[1]);
600         INIT_LIST_HEAD(&fq->flush_data_in_flight);
601
602         return fq;
603
604  fail_rq:
605         kfree(fq);
606  fail:
607         return NULL;
608 }
609
610 void blk_free_flush_queue(struct blk_flush_queue *fq)
611 {
612         /* bio based request queue hasn't flush queue */
613         if (!fq)
614                 return;
615
616         kfree(fq->flush_rq);
617         kfree(fq);
618 }