8592869bcbe73425da91bdc393d7f2b50c25853f
[linux-2.6.git] / block / blk-flush.c
1 /*
2  * Functions to sequence FLUSH and FUA writes.
3  */
4 #include <linux/kernel.h>
5 #include <linux/module.h>
6 #include <linux/bio.h>
7 #include <linux/blkdev.h>
8 #include <linux/gfp.h>
9
10 #include "blk.h"
11
12 /* FLUSH/FUA sequences */
13 enum {
14         QUEUE_FSEQ_STARTED      = (1 << 0), /* flushing in progress */
15         QUEUE_FSEQ_PREFLUSH     = (1 << 1), /* pre-flushing in progress */
16         QUEUE_FSEQ_DATA         = (1 << 2), /* data write in progress */
17         QUEUE_FSEQ_POSTFLUSH    = (1 << 3), /* post-flushing in progress */
18         QUEUE_FSEQ_DONE         = (1 << 4),
19 };
20
21 static struct request *queue_next_fseq(struct request_queue *q);
22
23 unsigned blk_flush_cur_seq(struct request_queue *q)
24 {
25         if (!q->flush_seq)
26                 return 0;
27         return 1 << ffz(q->flush_seq);
28 }
29
30 static struct request *blk_flush_complete_seq(struct request_queue *q,
31                                               unsigned seq, int error)
32 {
33         struct request *next_rq = NULL;
34
35         if (error && !q->flush_err)
36                 q->flush_err = error;
37
38         BUG_ON(q->flush_seq & seq);
39         q->flush_seq |= seq;
40
41         if (blk_flush_cur_seq(q) != QUEUE_FSEQ_DONE) {
42                 /* not complete yet, queue the next flush sequence */
43                 next_rq = queue_next_fseq(q);
44         } else {
45                 /* complete this flush request */
46                 __blk_end_request_all(q->orig_flush_rq, q->flush_err);
47                 q->orig_flush_rq = NULL;
48                 q->flush_seq = 0;
49
50                 /* dispatch the next flush if there's one */
51                 if (!list_empty(&q->pending_flushes)) {
52                         next_rq = list_entry_rq(q->pending_flushes.next);
53                         list_move(&next_rq->queuelist, &q->queue_head);
54                 }
55         }
56         return next_rq;
57 }
58
59 static void blk_flush_complete_seq_end_io(struct request_queue *q,
60                                           unsigned seq, int error)
61 {
62         bool was_empty = elv_queue_empty(q);
63         struct request *next_rq;
64
65         next_rq = blk_flush_complete_seq(q, seq, error);
66
67         /*
68          * Moving a request silently to empty queue_head may stall the
69          * queue.  Kick the queue in those cases.
70          */
71         if (was_empty && next_rq)
72                 __blk_run_queue(q);
73 }
74
75 static void pre_flush_end_io(struct request *rq, int error)
76 {
77         elv_completed_request(rq->q, rq);
78         blk_flush_complete_seq_end_io(rq->q, QUEUE_FSEQ_PREFLUSH, error);
79 }
80
81 static void flush_data_end_io(struct request *rq, int error)
82 {
83         elv_completed_request(rq->q, rq);
84         blk_flush_complete_seq_end_io(rq->q, QUEUE_FSEQ_DATA, error);
85 }
86
87 static void post_flush_end_io(struct request *rq, int error)
88 {
89         elv_completed_request(rq->q, rq);
90         blk_flush_complete_seq_end_io(rq->q, QUEUE_FSEQ_POSTFLUSH, error);
91 }
92
93 static void init_flush_request(struct request *rq, struct gendisk *disk)
94 {
95         rq->cmd_type = REQ_TYPE_FS;
96         rq->cmd_flags = WRITE_FLUSH;
97         rq->rq_disk = disk;
98 }
99
100 static struct request *queue_next_fseq(struct request_queue *q)
101 {
102         struct request *orig_rq = q->orig_flush_rq;
103         struct request *rq = &q->flush_rq;
104
105         blk_rq_init(q, rq);
106
107         switch (blk_flush_cur_seq(q)) {
108         case QUEUE_FSEQ_PREFLUSH:
109                 init_flush_request(rq, orig_rq->rq_disk);
110                 rq->end_io = pre_flush_end_io;
111                 break;
112         case QUEUE_FSEQ_DATA:
113                 init_request_from_bio(rq, orig_rq->bio);
114                 /*
115                  * orig_rq->rq_disk may be different from
116                  * bio->bi_bdev->bd_disk if orig_rq got here through
117                  * remapping drivers.  Make sure rq->rq_disk points
118                  * to the same one as orig_rq.
119                  */
120                 rq->rq_disk = orig_rq->rq_disk;
121                 rq->cmd_flags &= ~(REQ_FLUSH | REQ_FUA);
122                 rq->cmd_flags |= orig_rq->cmd_flags & (REQ_FLUSH | REQ_FUA);
123                 rq->end_io = flush_data_end_io;
124                 break;
125         case QUEUE_FSEQ_POSTFLUSH:
126                 init_flush_request(rq, orig_rq->rq_disk);
127                 rq->end_io = post_flush_end_io;
128                 break;
129         default:
130                 BUG();
131         }
132
133         rq->cmd_flags |= REQ_FLUSH_SEQ;
134         elv_insert(q, rq, ELEVATOR_INSERT_FRONT);
135         return rq;
136 }
137
138 struct request *blk_do_flush(struct request_queue *q, struct request *rq)
139 {
140         unsigned int fflags = q->flush_flags; /* may change, cache it */
141         bool has_flush = fflags & REQ_FLUSH, has_fua = fflags & REQ_FUA;
142         bool do_preflush = has_flush && (rq->cmd_flags & REQ_FLUSH);
143         bool do_postflush = has_flush && !has_fua && (rq->cmd_flags & REQ_FUA);
144         unsigned skip = 0;
145
146         /*
147          * Special case.  If there's data but flush is not necessary,
148          * the request can be issued directly.
149          *
150          * Flush w/o data should be able to be issued directly too but
151          * currently some drivers assume that rq->bio contains
152          * non-zero data if it isn't NULL and empty FLUSH requests
153          * getting here usually have bio's without data.
154          */
155         if (blk_rq_sectors(rq) && !do_preflush && !do_postflush) {
156                 rq->cmd_flags &= ~REQ_FLUSH;
157                 if (!has_fua)
158                         rq->cmd_flags &= ~REQ_FUA;
159                 return rq;
160         }
161
162         /*
163          * Sequenced flushes can't be processed in parallel.  If
164          * another one is already in progress, queue for later
165          * processing.
166          */
167         if (q->flush_seq) {
168                 list_move_tail(&rq->queuelist, &q->pending_flushes);
169                 return NULL;
170         }
171
172         /*
173          * Start a new flush sequence
174          */
175         q->flush_err = 0;
176         q->flush_seq |= QUEUE_FSEQ_STARTED;
177
178         /* adjust FLUSH/FUA of the original request and stash it away */
179         rq->cmd_flags &= ~REQ_FLUSH;
180         if (!has_fua)
181                 rq->cmd_flags &= ~REQ_FUA;
182         blk_dequeue_request(rq);
183         q->orig_flush_rq = rq;
184
185         /* skip unneded sequences and return the first one */
186         if (!do_preflush)
187                 skip |= QUEUE_FSEQ_PREFLUSH;
188         if (!blk_rq_sectors(rq))
189                 skip |= QUEUE_FSEQ_DATA;
190         if (!do_postflush)
191                 skip |= QUEUE_FSEQ_POSTFLUSH;
192         return blk_flush_complete_seq(q, skip, 0);
193 }
194
195 static void bio_end_flush(struct bio *bio, int err)
196 {
197         if (err)
198                 clear_bit(BIO_UPTODATE, &bio->bi_flags);
199         if (bio->bi_private)
200                 complete(bio->bi_private);
201         bio_put(bio);
202 }
203
204 /**
205  * blkdev_issue_flush - queue a flush
206  * @bdev:       blockdev to issue flush for
207  * @gfp_mask:   memory allocation flags (for bio_alloc)
208  * @error_sector:       error sector
209  *
210  * Description:
211  *    Issue a flush for the block device in question. Caller can supply
212  *    room for storing the error offset in case of a flush error, if they
213  *    wish to. If WAIT flag is not passed then caller may check only what
214  *    request was pushed in some internal queue for later handling.
215  */
216 int blkdev_issue_flush(struct block_device *bdev, gfp_t gfp_mask,
217                 sector_t *error_sector)
218 {
219         DECLARE_COMPLETION_ONSTACK(wait);
220         struct request_queue *q;
221         struct bio *bio;
222         int ret = 0;
223
224         if (bdev->bd_disk == NULL)
225                 return -ENXIO;
226
227         q = bdev_get_queue(bdev);
228         if (!q)
229                 return -ENXIO;
230
231         /*
232          * some block devices may not have their queue correctly set up here
233          * (e.g. loop device without a backing file) and so issuing a flush
234          * here will panic. Ensure there is a request function before issuing
235          * the flush.
236          */
237         if (!q->make_request_fn)
238                 return -ENXIO;
239
240         bio = bio_alloc(gfp_mask, 0);
241         bio->bi_end_io = bio_end_flush;
242         bio->bi_bdev = bdev;
243         bio->bi_private = &wait;
244
245         bio_get(bio);
246         submit_bio(WRITE_FLUSH, bio);
247         wait_for_completion(&wait);
248
249         /*
250          * The driver must store the error location in ->bi_sector, if
251          * it supports it. For non-stacked drivers, this should be
252          * copied from blk_rq_pos(rq).
253          */
254         if (error_sector)
255                *error_sector = bio->bi_sector;
256
257         if (!bio_flagged(bio, BIO_UPTODATE))
258                 ret = -EIO;
259
260         bio_put(bio);
261         return ret;
262 }
263 EXPORT_SYMBOL(blkdev_issue_flush);