166cb368334822be537d154ba539ac94696e21af
[pandora-kernel.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/module.h>
7 #include <linux/mutex.h>
8 #include <linux/virtio.h>
9 #include <linux/virtio_blk.h>
10 #include <linux/scatterlist.h>
11 #include <linux/string_helpers.h>
12 #include <scsi/scsi_cmnd.h>
13 #include <linux/idr.h>
14
15 #define PART_BITS 4
16
17 static int major;
18 static DEFINE_IDA(vd_index_ida);
19
20 struct workqueue_struct *virtblk_wq;
21
22 struct virtio_blk
23 {
24         struct virtio_device *vdev;
25         struct virtqueue *vq;
26
27         /* The disk structure for the kernel. */
28         struct gendisk *disk;
29
30         mempool_t *pool;
31
32         /* Process context for config space updates */
33         struct work_struct config_work;
34
35         /* Lock for config space updates */
36         struct mutex config_lock;
37
38         /* enable config space updates */
39         bool config_enable;
40
41         /* What host tells us, plus 2 for header & tailer. */
42         unsigned int sg_elems;
43
44         /* Ida index - used to track minor number allocations. */
45         int index;
46
47         /* Scatterlist: can be too big for stack. */
48         struct scatterlist sg[/*sg_elems*/];
49 };
50
51 struct virtblk_req
52 {
53         struct request *req;
54         struct virtio_blk_outhdr out_hdr;
55         struct virtio_scsi_inhdr in_hdr;
56         u8 status;
57 };
58
59 static void blk_done(struct virtqueue *vq)
60 {
61         struct virtio_blk *vblk = vq->vdev->priv;
62         struct virtblk_req *vbr;
63         unsigned int len;
64         unsigned long flags;
65
66         spin_lock_irqsave(vblk->disk->queue->queue_lock, flags);
67         while ((vbr = virtqueue_get_buf(vblk->vq, &len)) != NULL) {
68                 int error;
69
70                 switch (vbr->status) {
71                 case VIRTIO_BLK_S_OK:
72                         error = 0;
73                         break;
74                 case VIRTIO_BLK_S_UNSUPP:
75                         error = -ENOTTY;
76                         break;
77                 default:
78                         error = -EIO;
79                         break;
80                 }
81
82                 switch (vbr->req->cmd_type) {
83                 case REQ_TYPE_BLOCK_PC:
84                         vbr->req->resid_len = vbr->in_hdr.residual;
85                         vbr->req->sense_len = vbr->in_hdr.sense_len;
86                         vbr->req->errors = vbr->in_hdr.errors;
87                         break;
88                 case REQ_TYPE_SPECIAL:
89                         vbr->req->errors = (error != 0);
90                         break;
91                 default:
92                         break;
93                 }
94
95                 __blk_end_request_all(vbr->req, error);
96                 mempool_free(vbr, vblk->pool);
97         }
98         /* In case queue is stopped waiting for more buffers. */
99         blk_start_queue(vblk->disk->queue);
100         spin_unlock_irqrestore(vblk->disk->queue->queue_lock, flags);
101 }
102
103 static bool do_req(struct request_queue *q, struct virtio_blk *vblk,
104                    struct request *req)
105 {
106         unsigned long num, out = 0, in = 0;
107         struct virtblk_req *vbr;
108
109         vbr = mempool_alloc(vblk->pool, GFP_ATOMIC);
110         if (!vbr)
111                 /* When another request finishes we'll try again. */
112                 return false;
113
114         vbr->req = req;
115
116         if (req->cmd_flags & REQ_FLUSH) {
117                 vbr->out_hdr.type = VIRTIO_BLK_T_FLUSH;
118                 vbr->out_hdr.sector = 0;
119                 vbr->out_hdr.ioprio = req_get_ioprio(vbr->req);
120         } else {
121                 switch (req->cmd_type) {
122                 case REQ_TYPE_FS:
123                         vbr->out_hdr.type = 0;
124                         vbr->out_hdr.sector = blk_rq_pos(vbr->req);
125                         vbr->out_hdr.ioprio = req_get_ioprio(vbr->req);
126                         break;
127                 case REQ_TYPE_BLOCK_PC:
128                         vbr->out_hdr.type = VIRTIO_BLK_T_SCSI_CMD;
129                         vbr->out_hdr.sector = 0;
130                         vbr->out_hdr.ioprio = req_get_ioprio(vbr->req);
131                         break;
132                 case REQ_TYPE_SPECIAL:
133                         vbr->out_hdr.type = VIRTIO_BLK_T_GET_ID;
134                         vbr->out_hdr.sector = 0;
135                         vbr->out_hdr.ioprio = req_get_ioprio(vbr->req);
136                         break;
137                 default:
138                         /* We don't put anything else in the queue. */
139                         BUG();
140                 }
141         }
142
143         sg_set_buf(&vblk->sg[out++], &vbr->out_hdr, sizeof(vbr->out_hdr));
144
145         /*
146          * If this is a packet command we need a couple of additional headers.
147          * Behind the normal outhdr we put a segment with the scsi command
148          * block, and before the normal inhdr we put the sense data and the
149          * inhdr with additional status information before the normal inhdr.
150          */
151         if (vbr->req->cmd_type == REQ_TYPE_BLOCK_PC)
152                 sg_set_buf(&vblk->sg[out++], vbr->req->cmd, vbr->req->cmd_len);
153
154         num = blk_rq_map_sg(q, vbr->req, vblk->sg + out);
155
156         if (vbr->req->cmd_type == REQ_TYPE_BLOCK_PC) {
157                 sg_set_buf(&vblk->sg[num + out + in++], vbr->req->sense, SCSI_SENSE_BUFFERSIZE);
158                 sg_set_buf(&vblk->sg[num + out + in++], &vbr->in_hdr,
159                            sizeof(vbr->in_hdr));
160         }
161
162         sg_set_buf(&vblk->sg[num + out + in++], &vbr->status,
163                    sizeof(vbr->status));
164
165         if (num) {
166                 if (rq_data_dir(vbr->req) == WRITE) {
167                         vbr->out_hdr.type |= VIRTIO_BLK_T_OUT;
168                         out += num;
169                 } else {
170                         vbr->out_hdr.type |= VIRTIO_BLK_T_IN;
171                         in += num;
172                 }
173         }
174
175         if (virtqueue_add_buf(vblk->vq, vblk->sg, out, in, vbr) < 0) {
176                 mempool_free(vbr, vblk->pool);
177                 return false;
178         }
179
180         return true;
181 }
182
183 static void do_virtblk_request(struct request_queue *q)
184 {
185         struct virtio_blk *vblk = q->queuedata;
186         struct request *req;
187         unsigned int issued = 0;
188
189         while ((req = blk_peek_request(q)) != NULL) {
190                 BUG_ON(req->nr_phys_segments + 2 > vblk->sg_elems);
191
192                 /* If this request fails, stop queue and wait for something to
193                    finish to restart it. */
194                 if (!do_req(q, vblk, req)) {
195                         blk_stop_queue(q);
196                         break;
197                 }
198                 blk_start_request(req);
199                 issued++;
200         }
201
202         if (issued)
203                 virtqueue_kick(vblk->vq);
204 }
205
206 /* return id (s/n) string for *disk to *id_str
207  */
208 static int virtblk_get_id(struct gendisk *disk, char *id_str)
209 {
210         struct virtio_blk *vblk = disk->private_data;
211         struct request *req;
212         struct bio *bio;
213         int err;
214
215         bio = bio_map_kern(vblk->disk->queue, id_str, VIRTIO_BLK_ID_BYTES,
216                            GFP_KERNEL);
217         if (IS_ERR(bio))
218                 return PTR_ERR(bio);
219
220         req = blk_make_request(vblk->disk->queue, bio, GFP_KERNEL);
221         if (IS_ERR(req)) {
222                 bio_put(bio);
223                 return PTR_ERR(req);
224         }
225
226         req->cmd_type = REQ_TYPE_SPECIAL;
227         err = blk_execute_rq(vblk->disk->queue, vblk->disk, req, false);
228         blk_put_request(req);
229
230         return err;
231 }
232
233 static int virtblk_ioctl(struct block_device *bdev, fmode_t mode,
234                              unsigned int cmd, unsigned long data)
235 {
236         struct gendisk *disk = bdev->bd_disk;
237         struct virtio_blk *vblk = disk->private_data;
238
239         /*
240          * Only allow the generic SCSI ioctls if the host can support it.
241          */
242         if (!virtio_has_feature(vblk->vdev, VIRTIO_BLK_F_SCSI))
243                 return -ENOTTY;
244
245         return scsi_cmd_blk_ioctl(bdev, mode, cmd,
246                                   (void __user *)data);
247 }
248
249 /* We provide getgeo only to please some old bootloader/partitioning tools */
250 static int virtblk_getgeo(struct block_device *bd, struct hd_geometry *geo)
251 {
252         struct virtio_blk *vblk = bd->bd_disk->private_data;
253         struct virtio_blk_geometry vgeo;
254         int err;
255
256         /* see if the host passed in geometry config */
257         err = virtio_config_val(vblk->vdev, VIRTIO_BLK_F_GEOMETRY,
258                                 offsetof(struct virtio_blk_config, geometry),
259                                 &vgeo);
260
261         if (!err) {
262                 geo->heads = vgeo.heads;
263                 geo->sectors = vgeo.sectors;
264                 geo->cylinders = vgeo.cylinders;
265         } else {
266                 /* some standard values, similar to sd */
267                 geo->heads = 1 << 6;
268                 geo->sectors = 1 << 5;
269                 geo->cylinders = get_capacity(bd->bd_disk) >> 11;
270         }
271         return 0;
272 }
273
274 static const struct block_device_operations virtblk_fops = {
275         .ioctl  = virtblk_ioctl,
276         .owner  = THIS_MODULE,
277         .getgeo = virtblk_getgeo,
278 };
279
280 static int index_to_minor(int index)
281 {
282         return index << PART_BITS;
283 }
284
285 static int minor_to_index(int minor)
286 {
287         return minor >> PART_BITS;
288 }
289
290 static ssize_t virtblk_serial_show(struct device *dev,
291                                 struct device_attribute *attr, char *buf)
292 {
293         struct gendisk *disk = dev_to_disk(dev);
294         int err;
295
296         /* sysfs gives us a PAGE_SIZE buffer */
297         BUILD_BUG_ON(PAGE_SIZE < VIRTIO_BLK_ID_BYTES);
298
299         buf[VIRTIO_BLK_ID_BYTES] = '\0';
300         err = virtblk_get_id(disk, buf);
301         if (!err)
302                 return strlen(buf);
303
304         if (err == -EIO) /* Unsupported? Make it empty. */
305                 return 0;
306
307         return err;
308 }
309 DEVICE_ATTR(serial, S_IRUGO, virtblk_serial_show, NULL);
310
311 static void virtblk_config_changed_work(struct work_struct *work)
312 {
313         struct virtio_blk *vblk =
314                 container_of(work, struct virtio_blk, config_work);
315         struct virtio_device *vdev = vblk->vdev;
316         struct request_queue *q = vblk->disk->queue;
317         char cap_str_2[10], cap_str_10[10];
318         u64 capacity, size;
319
320         mutex_lock(&vblk->config_lock);
321         if (!vblk->config_enable)
322                 goto done;
323
324         /* Host must always specify the capacity. */
325         vdev->config->get(vdev, offsetof(struct virtio_blk_config, capacity),
326                           &capacity, sizeof(capacity));
327
328         /* If capacity is too big, truncate with warning. */
329         if ((sector_t)capacity != capacity) {
330                 dev_warn(&vdev->dev, "Capacity %llu too large: truncating\n",
331                          (unsigned long long)capacity);
332                 capacity = (sector_t)-1;
333         }
334
335         size = capacity * queue_logical_block_size(q);
336         string_get_size(size, STRING_UNITS_2, cap_str_2, sizeof(cap_str_2));
337         string_get_size(size, STRING_UNITS_10, cap_str_10, sizeof(cap_str_10));
338
339         dev_notice(&vdev->dev,
340                   "new size: %llu %d-byte logical blocks (%s/%s)\n",
341                   (unsigned long long)capacity,
342                   queue_logical_block_size(q),
343                   cap_str_10, cap_str_2);
344
345         set_capacity(vblk->disk, capacity);
346 done:
347         mutex_unlock(&vblk->config_lock);
348 }
349
350 static void virtblk_config_changed(struct virtio_device *vdev)
351 {
352         struct virtio_blk *vblk = vdev->priv;
353
354         queue_work(virtblk_wq, &vblk->config_work);
355 }
356
357 static int __devinit virtblk_probe(struct virtio_device *vdev)
358 {
359         struct virtio_blk *vblk;
360         struct request_queue *q;
361         int err, index;
362         u64 cap;
363         u32 v, blk_size, sg_elems, opt_io_size;
364         u16 min_io_size;
365         u8 physical_block_exp, alignment_offset;
366
367         err = ida_simple_get(&vd_index_ida, 0, minor_to_index(1 << MINORBITS),
368                              GFP_KERNEL);
369         if (err < 0)
370                 goto out;
371         index = err;
372
373         /* We need to know how many segments before we allocate. */
374         err = virtio_config_val(vdev, VIRTIO_BLK_F_SEG_MAX,
375                                 offsetof(struct virtio_blk_config, seg_max),
376                                 &sg_elems);
377
378         /* We need at least one SG element, whatever they say. */
379         if (err || !sg_elems)
380                 sg_elems = 1;
381
382         /* We need an extra sg elements at head and tail. */
383         sg_elems += 2;
384         vdev->priv = vblk = kmalloc(sizeof(*vblk) +
385                                     sizeof(vblk->sg[0]) * sg_elems, GFP_KERNEL);
386         if (!vblk) {
387                 err = -ENOMEM;
388                 goto out_free_index;
389         }
390
391         vblk->vdev = vdev;
392         vblk->sg_elems = sg_elems;
393         sg_init_table(vblk->sg, vblk->sg_elems);
394         mutex_init(&vblk->config_lock);
395         INIT_WORK(&vblk->config_work, virtblk_config_changed_work);
396         vblk->config_enable = true;
397
398         /* We expect one virtqueue, for output. */
399         vblk->vq = virtio_find_single_vq(vdev, blk_done, "requests");
400         if (IS_ERR(vblk->vq)) {
401                 err = PTR_ERR(vblk->vq);
402                 goto out_free_vblk;
403         }
404
405         vblk->pool = mempool_create_kmalloc_pool(1,sizeof(struct virtblk_req));
406         if (!vblk->pool) {
407                 err = -ENOMEM;
408                 goto out_free_vq;
409         }
410
411         /* FIXME: How many partitions?  How long is a piece of string? */
412         vblk->disk = alloc_disk(1 << PART_BITS);
413         if (!vblk->disk) {
414                 err = -ENOMEM;
415                 goto out_mempool;
416         }
417
418         q = vblk->disk->queue = blk_init_queue(do_virtblk_request, NULL);
419         if (!q) {
420                 err = -ENOMEM;
421                 goto out_put_disk;
422         }
423
424         q->queuedata = vblk;
425
426         if (index < 26) {
427                 sprintf(vblk->disk->disk_name, "vd%c", 'a' + index % 26);
428         } else if (index < (26 + 1) * 26) {
429                 sprintf(vblk->disk->disk_name, "vd%c%c",
430                         'a' + index / 26 - 1, 'a' + index % 26);
431         } else {
432                 const unsigned int m1 = (index / 26 - 1) / 26 - 1;
433                 const unsigned int m2 = (index / 26 - 1) % 26;
434                 const unsigned int m3 =  index % 26;
435                 sprintf(vblk->disk->disk_name, "vd%c%c%c",
436                         'a' + m1, 'a' + m2, 'a' + m3);
437         }
438
439         vblk->disk->major = major;
440         vblk->disk->first_minor = index_to_minor(index);
441         vblk->disk->private_data = vblk;
442         vblk->disk->fops = &virtblk_fops;
443         vblk->disk->driverfs_dev = &vdev->dev;
444         vblk->index = index;
445
446         /* configure queue flush support */
447         if (virtio_has_feature(vdev, VIRTIO_BLK_F_FLUSH))
448                 blk_queue_flush(q, REQ_FLUSH);
449
450         /* If disk is read-only in the host, the guest should obey */
451         if (virtio_has_feature(vdev, VIRTIO_BLK_F_RO))
452                 set_disk_ro(vblk->disk, 1);
453
454         /* Host must always specify the capacity. */
455         vdev->config->get(vdev, offsetof(struct virtio_blk_config, capacity),
456                           &cap, sizeof(cap));
457
458         /* If capacity is too big, truncate with warning. */
459         if ((sector_t)cap != cap) {
460                 dev_warn(&vdev->dev, "Capacity %llu too large: truncating\n",
461                          (unsigned long long)cap);
462                 cap = (sector_t)-1;
463         }
464         set_capacity(vblk->disk, cap);
465
466         /* We can handle whatever the host told us to handle. */
467         blk_queue_max_segments(q, vblk->sg_elems-2);
468
469         /* No need to bounce any requests */
470         blk_queue_bounce_limit(q, BLK_BOUNCE_ANY);
471
472         /* No real sector limit. */
473         blk_queue_max_hw_sectors(q, -1U);
474
475         /* Host can optionally specify maximum segment size and number of
476          * segments. */
477         err = virtio_config_val(vdev, VIRTIO_BLK_F_SIZE_MAX,
478                                 offsetof(struct virtio_blk_config, size_max),
479                                 &v);
480         if (!err)
481                 blk_queue_max_segment_size(q, v);
482         else
483                 blk_queue_max_segment_size(q, -1U);
484
485         /* Host can optionally specify the block size of the device */
486         err = virtio_config_val(vdev, VIRTIO_BLK_F_BLK_SIZE,
487                                 offsetof(struct virtio_blk_config, blk_size),
488                                 &blk_size);
489         if (!err)
490                 blk_queue_logical_block_size(q, blk_size);
491         else
492                 blk_size = queue_logical_block_size(q);
493
494         /* Use topology information if available */
495         err = virtio_config_val(vdev, VIRTIO_BLK_F_TOPOLOGY,
496                         offsetof(struct virtio_blk_config, physical_block_exp),
497                         &physical_block_exp);
498         if (!err && physical_block_exp)
499                 blk_queue_physical_block_size(q,
500                                 blk_size * (1 << physical_block_exp));
501
502         err = virtio_config_val(vdev, VIRTIO_BLK_F_TOPOLOGY,
503                         offsetof(struct virtio_blk_config, alignment_offset),
504                         &alignment_offset);
505         if (!err && alignment_offset)
506                 blk_queue_alignment_offset(q, blk_size * alignment_offset);
507
508         err = virtio_config_val(vdev, VIRTIO_BLK_F_TOPOLOGY,
509                         offsetof(struct virtio_blk_config, min_io_size),
510                         &min_io_size);
511         if (!err && min_io_size)
512                 blk_queue_io_min(q, blk_size * min_io_size);
513
514         err = virtio_config_val(vdev, VIRTIO_BLK_F_TOPOLOGY,
515                         offsetof(struct virtio_blk_config, opt_io_size),
516                         &opt_io_size);
517         if (!err && opt_io_size)
518                 blk_queue_io_opt(q, blk_size * opt_io_size);
519
520
521         add_disk(vblk->disk);
522         err = device_create_file(disk_to_dev(vblk->disk), &dev_attr_serial);
523         if (err)
524                 goto out_del_disk;
525
526         return 0;
527
528 out_del_disk:
529         del_gendisk(vblk->disk);
530         blk_cleanup_queue(vblk->disk->queue);
531 out_put_disk:
532         put_disk(vblk->disk);
533 out_mempool:
534         mempool_destroy(vblk->pool);
535 out_free_vq:
536         vdev->config->del_vqs(vdev);
537 out_free_vblk:
538         kfree(vblk);
539 out_free_index:
540         ida_simple_remove(&vd_index_ida, index);
541 out:
542         return err;
543 }
544
545 static void __devexit virtblk_remove(struct virtio_device *vdev)
546 {
547         struct virtio_blk *vblk = vdev->priv;
548         int index = vblk->index;
549         int refc;
550
551         /* Prevent config work handler from accessing the device. */
552         mutex_lock(&vblk->config_lock);
553         vblk->config_enable = false;
554         mutex_unlock(&vblk->config_lock);
555
556         del_gendisk(vblk->disk);
557         blk_cleanup_queue(vblk->disk->queue);
558
559         /* Stop all the virtqueues. */
560         vdev->config->reset(vdev);
561
562         flush_work(&vblk->config_work);
563
564         refc = atomic_read(&disk_to_dev(vblk->disk)->kobj.kref.refcount);
565         put_disk(vblk->disk);
566         mempool_destroy(vblk->pool);
567         vdev->config->del_vqs(vdev);
568         kfree(vblk);
569
570         /* Only free device id if we don't have any users */
571         if (refc == 1)
572                 ida_simple_remove(&vd_index_ida, index);
573 }
574
575 static const struct virtio_device_id id_table[] = {
576         { VIRTIO_ID_BLOCK, VIRTIO_DEV_ANY_ID },
577         { 0 },
578 };
579
580 static unsigned int features[] = {
581         VIRTIO_BLK_F_SEG_MAX, VIRTIO_BLK_F_SIZE_MAX, VIRTIO_BLK_F_GEOMETRY,
582         VIRTIO_BLK_F_RO, VIRTIO_BLK_F_BLK_SIZE, VIRTIO_BLK_F_SCSI,
583         VIRTIO_BLK_F_FLUSH, VIRTIO_BLK_F_TOPOLOGY
584 };
585
586 /*
587  * virtio_blk causes spurious section mismatch warning by
588  * simultaneously referring to a __devinit and a __devexit function.
589  * Use __refdata to avoid this warning.
590  */
591 static struct virtio_driver __refdata virtio_blk = {
592         .feature_table          = features,
593         .feature_table_size     = ARRAY_SIZE(features),
594         .driver.name            = KBUILD_MODNAME,
595         .driver.owner           = THIS_MODULE,
596         .id_table               = id_table,
597         .probe                  = virtblk_probe,
598         .remove                 = __devexit_p(virtblk_remove),
599         .config_changed         = virtblk_config_changed,
600 };
601
602 static int __init init(void)
603 {
604         int error;
605
606         virtblk_wq = alloc_workqueue("virtio-blk", 0, 0);
607         if (!virtblk_wq)
608                 return -ENOMEM;
609
610         major = register_blkdev(0, "virtblk");
611         if (major < 0) {
612                 error = major;
613                 goto out_destroy_workqueue;
614         }
615
616         error = register_virtio_driver(&virtio_blk);
617         if (error)
618                 goto out_unregister_blkdev;
619         return 0;
620
621 out_unregister_blkdev:
622         unregister_blkdev(major, "virtblk");
623 out_destroy_workqueue:
624         destroy_workqueue(virtblk_wq);
625         return error;
626 }
627
628 static void __exit fini(void)
629 {
630         unregister_blkdev(major, "virtblk");
631         unregister_virtio_driver(&virtio_blk);
632         destroy_workqueue(virtblk_wq);
633 }
634 module_init(init);
635 module_exit(fini);
636
637 MODULE_DEVICE_TABLE(virtio, id_table);
638 MODULE_DESCRIPTION("Virtio block driver");
639 MODULE_LICENSE("GPL");