virtio_blk: stop using q->prepare_flush_fn
[linux-2.6.git] / drivers / block / virtio_blk.c
1 //#define DEBUG
2 #include <linux/spinlock.h>
3 #include <linux/slab.h>
4 #include <linux/blkdev.h>
5 #include <linux/hdreg.h>
6 #include <linux/virtio.h>
7 #include <linux/virtio_blk.h>
8 #include <linux/scatterlist.h>
9
10 #define PART_BITS 4
11
12 static int major, index;
13
14 struct virtio_blk
15 {
16         spinlock_t lock;
17
18         struct virtio_device *vdev;
19         struct virtqueue *vq;
20
21         /* The disk structure for the kernel. */
22         struct gendisk *disk;
23
24         /* Request tracking. */
25         struct list_head reqs;
26
27         mempool_t *pool;
28
29         /* What host tells us, plus 2 for header & tailer. */
30         unsigned int sg_elems;
31
32         /* Scatterlist: can be too big for stack. */
33         struct scatterlist sg[/*sg_elems*/];
34 };
35
36 struct virtblk_req
37 {
38         struct list_head list;
39         struct request *req;
40         struct virtio_blk_outhdr out_hdr;
41         struct virtio_scsi_inhdr in_hdr;
42         u8 status;
43 };
44
45 static void blk_done(struct virtqueue *vq)
46 {
47         struct virtio_blk *vblk = vq->vdev->priv;
48         struct virtblk_req *vbr;
49         unsigned int len;
50         unsigned long flags;
51
52         spin_lock_irqsave(&vblk->lock, flags);
53         while ((vbr = virtqueue_get_buf(vblk->vq, &len)) != NULL) {
54                 int error;
55
56                 switch (vbr->status) {
57                 case VIRTIO_BLK_S_OK:
58                         error = 0;
59                         break;
60                 case VIRTIO_BLK_S_UNSUPP:
61                         error = -ENOTTY;
62                         break;
63                 default:
64                         error = -EIO;
65                         break;
66                 }
67
68                 switch (vbr->req->cmd_type) {
69                 case REQ_TYPE_BLOCK_PC:
70                         vbr->req->resid_len = vbr->in_hdr.residual;
71                         vbr->req->sense_len = vbr->in_hdr.sense_len;
72                         vbr->req->errors = vbr->in_hdr.errors;
73                         break;
74                 case REQ_TYPE_SPECIAL:
75                         vbr->req->errors = (error != 0);
76                         break;
77                 default:
78                         break;
79                 }
80
81                 __blk_end_request_all(vbr->req, error);
82                 list_del(&vbr->list);
83                 mempool_free(vbr, vblk->pool);
84         }
85         /* In case queue is stopped waiting for more buffers. */
86         blk_start_queue(vblk->disk->queue);
87         spin_unlock_irqrestore(&vblk->lock, flags);
88 }
89
90 static bool do_req(struct request_queue *q, struct virtio_blk *vblk,
91                    struct request *req)
92 {
93         unsigned long num, out = 0, in = 0;
94         struct virtblk_req *vbr;
95
96         vbr = mempool_alloc(vblk->pool, GFP_ATOMIC);
97         if (!vbr)
98                 /* When another request finishes we'll try again. */
99                 return false;
100
101         vbr->req = req;
102
103         if (req->cmd_flags & REQ_FLUSH) {
104                 vbr->out_hdr.type = VIRTIO_BLK_T_FLUSH;
105                 vbr->out_hdr.sector = 0;
106                 vbr->out_hdr.ioprio = req_get_ioprio(vbr->req);
107         } else {
108                 switch (req->cmd_type) {
109                 case REQ_TYPE_FS:
110                         vbr->out_hdr.type = 0;
111                         vbr->out_hdr.sector = blk_rq_pos(vbr->req);
112                         vbr->out_hdr.ioprio = req_get_ioprio(vbr->req);
113                         break;
114                 case REQ_TYPE_BLOCK_PC:
115                         vbr->out_hdr.type = VIRTIO_BLK_T_SCSI_CMD;
116                         vbr->out_hdr.sector = 0;
117                         vbr->out_hdr.ioprio = req_get_ioprio(vbr->req);
118                         break;
119                 case REQ_TYPE_SPECIAL:
120                         vbr->out_hdr.type = VIRTIO_BLK_T_GET_ID;
121                         vbr->out_hdr.sector = 0;
122                         vbr->out_hdr.ioprio = req_get_ioprio(vbr->req);
123                         break;
124                 default:
125                         /* We don't put anything else in the queue. */
126                         BUG();
127                 }
128         }
129
130         if (vbr->req->cmd_flags & REQ_HARDBARRIER)
131                 vbr->out_hdr.type |= VIRTIO_BLK_T_BARRIER;
132
133         sg_set_buf(&vblk->sg[out++], &vbr->out_hdr, sizeof(vbr->out_hdr));
134
135         /*
136          * If this is a packet command we need a couple of additional headers.
137          * Behind the normal outhdr we put a segment with the scsi command
138          * block, and before the normal inhdr we put the sense data and the
139          * inhdr with additional status information before the normal inhdr.
140          */
141         if (vbr->req->cmd_type == REQ_TYPE_BLOCK_PC)
142                 sg_set_buf(&vblk->sg[out++], vbr->req->cmd, vbr->req->cmd_len);
143
144         num = blk_rq_map_sg(q, vbr->req, vblk->sg + out);
145
146         if (vbr->req->cmd_type == REQ_TYPE_BLOCK_PC) {
147                 sg_set_buf(&vblk->sg[num + out + in++], vbr->req->sense, 96);
148                 sg_set_buf(&vblk->sg[num + out + in++], &vbr->in_hdr,
149                            sizeof(vbr->in_hdr));
150         }
151
152         sg_set_buf(&vblk->sg[num + out + in++], &vbr->status,
153                    sizeof(vbr->status));
154
155         if (num) {
156                 if (rq_data_dir(vbr->req) == WRITE) {
157                         vbr->out_hdr.type |= VIRTIO_BLK_T_OUT;
158                         out += num;
159                 } else {
160                         vbr->out_hdr.type |= VIRTIO_BLK_T_IN;
161                         in += num;
162                 }
163         }
164
165         if (virtqueue_add_buf(vblk->vq, vblk->sg, out, in, vbr) < 0) {
166                 mempool_free(vbr, vblk->pool);
167                 return false;
168         }
169
170         list_add_tail(&vbr->list, &vblk->reqs);
171         return true;
172 }
173
174 static void do_virtblk_request(struct request_queue *q)
175 {
176         struct virtio_blk *vblk = q->queuedata;
177         struct request *req;
178         unsigned int issued = 0;
179
180         while ((req = blk_peek_request(q)) != NULL) {
181                 BUG_ON(req->nr_phys_segments + 2 > vblk->sg_elems);
182
183                 /* If this request fails, stop queue and wait for something to
184                    finish to restart it. */
185                 if (!do_req(q, vblk, req)) {
186                         blk_stop_queue(q);
187                         break;
188                 }
189                 blk_start_request(req);
190                 issued++;
191         }
192
193         if (issued)
194                 virtqueue_kick(vblk->vq);
195 }
196
197 /* return id (s/n) string for *disk to *id_str
198  */
199 static int virtblk_get_id(struct gendisk *disk, char *id_str)
200 {
201         struct virtio_blk *vblk = disk->private_data;
202         struct request *req;
203         struct bio *bio;
204
205         bio = bio_map_kern(vblk->disk->queue, id_str, VIRTIO_BLK_ID_BYTES,
206                            GFP_KERNEL);
207         if (IS_ERR(bio))
208                 return PTR_ERR(bio);
209
210         req = blk_make_request(vblk->disk->queue, bio, GFP_KERNEL);
211         if (IS_ERR(req)) {
212                 bio_put(bio);
213                 return PTR_ERR(req);
214         }
215
216         req->cmd_type = REQ_TYPE_SPECIAL;
217         return blk_execute_rq(vblk->disk->queue, vblk->disk, req, false);
218 }
219
220 static int virtblk_ioctl(struct block_device *bdev, fmode_t mode,
221                          unsigned cmd, unsigned long data)
222 {
223         struct gendisk *disk = bdev->bd_disk;
224         struct virtio_blk *vblk = disk->private_data;
225
226         if (cmd == 0x56424944) { /* 'VBID' */
227                 void __user *usr_data = (void __user *)data;
228                 char id_str[VIRTIO_BLK_ID_BYTES];
229                 int err;
230
231                 err = virtblk_get_id(disk, id_str);
232                 if (!err && copy_to_user(usr_data, id_str, VIRTIO_BLK_ID_BYTES))
233                         err = -EFAULT;
234                 return err;
235         }
236         /*
237          * Only allow the generic SCSI ioctls if the host can support it.
238          */
239         if (!virtio_has_feature(vblk->vdev, VIRTIO_BLK_F_SCSI))
240                 return -ENOTTY;
241
242         return scsi_cmd_ioctl(disk->queue, disk, mode, cmd,
243                               (void __user *)data);
244 }
245
246 /* We provide getgeo only to please some old bootloader/partitioning tools */
247 static int virtblk_getgeo(struct block_device *bd, struct hd_geometry *geo)
248 {
249         struct virtio_blk *vblk = bd->bd_disk->private_data;
250         struct virtio_blk_geometry vgeo;
251         int err;
252
253         /* see if the host passed in geometry config */
254         err = virtio_config_val(vblk->vdev, VIRTIO_BLK_F_GEOMETRY,
255                                 offsetof(struct virtio_blk_config, geometry),
256                                 &vgeo);
257
258         if (!err) {
259                 geo->heads = vgeo.heads;
260                 geo->sectors = vgeo.sectors;
261                 geo->cylinders = vgeo.cylinders;
262         } else {
263                 /* some standard values, similar to sd */
264                 geo->heads = 1 << 6;
265                 geo->sectors = 1 << 5;
266                 geo->cylinders = get_capacity(bd->bd_disk) >> 11;
267         }
268         return 0;
269 }
270
271 static const struct block_device_operations virtblk_fops = {
272         .locked_ioctl = virtblk_ioctl,
273         .owner  = THIS_MODULE,
274         .getgeo = virtblk_getgeo,
275 };
276
277 static int index_to_minor(int index)
278 {
279         return index << PART_BITS;
280 }
281
282 static int __devinit virtblk_probe(struct virtio_device *vdev)
283 {
284         struct virtio_blk *vblk;
285         struct request_queue *q;
286         int err;
287         u64 cap;
288         u32 v, blk_size, sg_elems, opt_io_size;
289         u16 min_io_size;
290         u8 physical_block_exp, alignment_offset;
291
292         if (index_to_minor(index) >= 1 << MINORBITS)
293                 return -ENOSPC;
294
295         /* We need to know how many segments before we allocate. */
296         err = virtio_config_val(vdev, VIRTIO_BLK_F_SEG_MAX,
297                                 offsetof(struct virtio_blk_config, seg_max),
298                                 &sg_elems);
299
300         /* We need at least one SG element, whatever they say. */
301         if (err || !sg_elems)
302                 sg_elems = 1;
303
304         /* We need an extra sg elements at head and tail. */
305         sg_elems += 2;
306         vdev->priv = vblk = kmalloc(sizeof(*vblk) +
307                                     sizeof(vblk->sg[0]) * sg_elems, GFP_KERNEL);
308         if (!vblk) {
309                 err = -ENOMEM;
310                 goto out;
311         }
312
313         INIT_LIST_HEAD(&vblk->reqs);
314         spin_lock_init(&vblk->lock);
315         vblk->vdev = vdev;
316         vblk->sg_elems = sg_elems;
317         sg_init_table(vblk->sg, vblk->sg_elems);
318
319         /* We expect one virtqueue, for output. */
320         vblk->vq = virtio_find_single_vq(vdev, blk_done, "requests");
321         if (IS_ERR(vblk->vq)) {
322                 err = PTR_ERR(vblk->vq);
323                 goto out_free_vblk;
324         }
325
326         vblk->pool = mempool_create_kmalloc_pool(1,sizeof(struct virtblk_req));
327         if (!vblk->pool) {
328                 err = -ENOMEM;
329                 goto out_free_vq;
330         }
331
332         /* FIXME: How many partitions?  How long is a piece of string? */
333         vblk->disk = alloc_disk(1 << PART_BITS);
334         if (!vblk->disk) {
335                 err = -ENOMEM;
336                 goto out_mempool;
337         }
338
339         q = vblk->disk->queue = blk_init_queue(do_virtblk_request, &vblk->lock);
340         if (!q) {
341                 err = -ENOMEM;
342                 goto out_put_disk;
343         }
344
345         q->queuedata = vblk;
346
347         if (index < 26) {
348                 sprintf(vblk->disk->disk_name, "vd%c", 'a' + index % 26);
349         } else if (index < (26 + 1) * 26) {
350                 sprintf(vblk->disk->disk_name, "vd%c%c",
351                         'a' + index / 26 - 1, 'a' + index % 26);
352         } else {
353                 const unsigned int m1 = (index / 26 - 1) / 26 - 1;
354                 const unsigned int m2 = (index / 26 - 1) % 26;
355                 const unsigned int m3 =  index % 26;
356                 sprintf(vblk->disk->disk_name, "vd%c%c%c",
357                         'a' + m1, 'a' + m2, 'a' + m3);
358         }
359
360         vblk->disk->major = major;
361         vblk->disk->first_minor = index_to_minor(index);
362         vblk->disk->private_data = vblk;
363         vblk->disk->fops = &virtblk_fops;
364         vblk->disk->driverfs_dev = &vdev->dev;
365         index++;
366
367         /* If barriers are supported, tell block layer that queue is ordered */
368         if (virtio_has_feature(vdev, VIRTIO_BLK_F_FLUSH))
369                 blk_queue_ordered(q, QUEUE_ORDERED_DRAIN_FLUSH, NULL);
370         else if (virtio_has_feature(vdev, VIRTIO_BLK_F_BARRIER))
371                 blk_queue_ordered(q, QUEUE_ORDERED_TAG, NULL);
372
373         /* If disk is read-only in the host, the guest should obey */
374         if (virtio_has_feature(vdev, VIRTIO_BLK_F_RO))
375                 set_disk_ro(vblk->disk, 1);
376
377         /* Host must always specify the capacity. */
378         vdev->config->get(vdev, offsetof(struct virtio_blk_config, capacity),
379                           &cap, sizeof(cap));
380
381         /* If capacity is too big, truncate with warning. */
382         if ((sector_t)cap != cap) {
383                 dev_warn(&vdev->dev, "Capacity %llu too large: truncating\n",
384                          (unsigned long long)cap);
385                 cap = (sector_t)-1;
386         }
387         set_capacity(vblk->disk, cap);
388
389         /* We can handle whatever the host told us to handle. */
390         blk_queue_max_segments(q, vblk->sg_elems-2);
391
392         /* No need to bounce any requests */
393         blk_queue_bounce_limit(q, BLK_BOUNCE_ANY);
394
395         /* No real sector limit. */
396         blk_queue_max_hw_sectors(q, -1U);
397
398         /* Host can optionally specify maximum segment size and number of
399          * segments. */
400         err = virtio_config_val(vdev, VIRTIO_BLK_F_SIZE_MAX,
401                                 offsetof(struct virtio_blk_config, size_max),
402                                 &v);
403         if (!err)
404                 blk_queue_max_segment_size(q, v);
405         else
406                 blk_queue_max_segment_size(q, -1U);
407
408         /* Host can optionally specify the block size of the device */
409         err = virtio_config_val(vdev, VIRTIO_BLK_F_BLK_SIZE,
410                                 offsetof(struct virtio_blk_config, blk_size),
411                                 &blk_size);
412         if (!err)
413                 blk_queue_logical_block_size(q, blk_size);
414         else
415                 blk_size = queue_logical_block_size(q);
416
417         /* Use topology information if available */
418         err = virtio_config_val(vdev, VIRTIO_BLK_F_TOPOLOGY,
419                         offsetof(struct virtio_blk_config, physical_block_exp),
420                         &physical_block_exp);
421         if (!err && physical_block_exp)
422                 blk_queue_physical_block_size(q,
423                                 blk_size * (1 << physical_block_exp));
424
425         err = virtio_config_val(vdev, VIRTIO_BLK_F_TOPOLOGY,
426                         offsetof(struct virtio_blk_config, alignment_offset),
427                         &alignment_offset);
428         if (!err && alignment_offset)
429                 blk_queue_alignment_offset(q, blk_size * alignment_offset);
430
431         err = virtio_config_val(vdev, VIRTIO_BLK_F_TOPOLOGY,
432                         offsetof(struct virtio_blk_config, min_io_size),
433                         &min_io_size);
434         if (!err && min_io_size)
435                 blk_queue_io_min(q, blk_size * min_io_size);
436
437         err = virtio_config_val(vdev, VIRTIO_BLK_F_TOPOLOGY,
438                         offsetof(struct virtio_blk_config, opt_io_size),
439                         &opt_io_size);
440         if (!err && opt_io_size)
441                 blk_queue_io_opt(q, blk_size * opt_io_size);
442
443
444         add_disk(vblk->disk);
445         return 0;
446
447 out_put_disk:
448         put_disk(vblk->disk);
449 out_mempool:
450         mempool_destroy(vblk->pool);
451 out_free_vq:
452         vdev->config->del_vqs(vdev);
453 out_free_vblk:
454         kfree(vblk);
455 out:
456         return err;
457 }
458
459 static void __devexit virtblk_remove(struct virtio_device *vdev)
460 {
461         struct virtio_blk *vblk = vdev->priv;
462
463         /* Nothing should be pending. */
464         BUG_ON(!list_empty(&vblk->reqs));
465
466         /* Stop all the virtqueues. */
467         vdev->config->reset(vdev);
468
469         del_gendisk(vblk->disk);
470         blk_cleanup_queue(vblk->disk->queue);
471         put_disk(vblk->disk);
472         mempool_destroy(vblk->pool);
473         vdev->config->del_vqs(vdev);
474         kfree(vblk);
475 }
476
477 static const struct virtio_device_id id_table[] = {
478         { VIRTIO_ID_BLOCK, VIRTIO_DEV_ANY_ID },
479         { 0 },
480 };
481
482 static unsigned int features[] = {
483         VIRTIO_BLK_F_BARRIER, VIRTIO_BLK_F_SEG_MAX, VIRTIO_BLK_F_SIZE_MAX,
484         VIRTIO_BLK_F_GEOMETRY, VIRTIO_BLK_F_RO, VIRTIO_BLK_F_BLK_SIZE,
485         VIRTIO_BLK_F_SCSI, VIRTIO_BLK_F_FLUSH, VIRTIO_BLK_F_TOPOLOGY
486 };
487
488 /*
489  * virtio_blk causes spurious section mismatch warning by
490  * simultaneously referring to a __devinit and a __devexit function.
491  * Use __refdata to avoid this warning.
492  */
493 static struct virtio_driver __refdata virtio_blk = {
494         .feature_table = features,
495         .feature_table_size = ARRAY_SIZE(features),
496         .driver.name =  KBUILD_MODNAME,
497         .driver.owner = THIS_MODULE,
498         .id_table =     id_table,
499         .probe =        virtblk_probe,
500         .remove =       __devexit_p(virtblk_remove),
501 };
502
503 static int __init init(void)
504 {
505         major = register_blkdev(0, "virtblk");
506         if (major < 0)
507                 return major;
508         return register_virtio_driver(&virtio_blk);
509 }
510
511 static void __exit fini(void)
512 {
513         unregister_blkdev(major, "virtblk");
514         unregister_virtio_driver(&virtio_blk);
515 }
516 module_init(init);
517 module_exit(fini);
518
519 MODULE_DEVICE_TABLE(virtio, id_table);
520 MODULE_DESCRIPTION("Virtio block driver");
521 MODULE_LICENSE("GPL");