blob: 6a680d4de7f1c3dcfa7999e45efc98b4b14d99fc [file] [log] [blame]
Rusty Russelle467cde2007-10-22 11:03:38 +10001//#define DEBUG
2#include <linux/spinlock.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +09003#include <linux/slab.h>
Rusty Russelle467cde2007-10-22 11:03:38 +10004#include <linux/blkdev.h>
5#include <linux/hdreg.h>
Paul Gortmaker0c8d44f2011-07-01 15:56:05 -04006#include <linux/module.h>
Michael S. Tsirkin4678d6f2012-01-12 15:44:44 +10307#include <linux/mutex.h>
Rusty Russelle467cde2007-10-22 11:03:38 +10008#include <linux/virtio.h>
9#include <linux/virtio_blk.h>
Jens Axboe3d1266c2007-10-24 13:21:21 +020010#include <linux/scatterlist.h>
Christoph Hellwig7a7c9242011-02-01 21:43:48 +010011#include <linux/string_helpers.h>
Liu Yuan6917f832011-04-24 02:49:26 +080012#include <scsi/scsi_cmnd.h>
Michael S. Tsirkin5087a502011-10-30 21:29:59 +020013#include <linux/idr.h>
Jens Axboe1cf7e9c2013-11-01 10:52:52 -060014#include <linux/blk-mq.h>
15#include <linux/numa.h>
Jens Axboe3d1266c2007-10-24 13:21:21 +020016
Christian Borntraeger4f3bf192008-01-31 15:53:53 +010017#define PART_BITS 4
Rusty Russelle467cde2007-10-22 11:03:38 +100018
Michael S. Tsirkin5087a502011-10-30 21:29:59 +020019static int major;
20static DEFINE_IDA(vd_index_ida);
21
Jonghwan Choi2a647bf2013-05-20 10:25:39 +093022static struct workqueue_struct *virtblk_wq;
Christian Borntraeger4f3bf192008-01-31 15:53:53 +010023
Rusty Russelle467cde2007-10-22 11:03:38 +100024struct virtio_blk
25{
Rusty Russelle467cde2007-10-22 11:03:38 +100026 struct virtio_device *vdev;
27 struct virtqueue *vq;
Jens Axboe1cf7e9c2013-11-01 10:52:52 -060028 spinlock_t vq_lock;
Rusty Russelle467cde2007-10-22 11:03:38 +100029
30 /* The disk structure for the kernel. */
31 struct gendisk *disk;
32
Christoph Hellwig7a7c9242011-02-01 21:43:48 +010033 /* Process context for config space updates */
34 struct work_struct config_work;
35
Michael S. Tsirkin4678d6f2012-01-12 15:44:44 +103036 /* Lock for config space updates */
37 struct mutex config_lock;
38
39 /* enable config space updates */
40 bool config_enable;
41
Rusty Russell0864b792008-12-30 09:26:05 -060042 /* What host tells us, plus 2 for header & tailer. */
43 unsigned int sg_elems;
44
Michael S. Tsirkin5087a502011-10-30 21:29:59 +020045 /* Ida index - used to track minor number allocations. */
46 int index;
Rusty Russelle467cde2007-10-22 11:03:38 +100047};
48
49struct virtblk_req
50{
Rusty Russelle467cde2007-10-22 11:03:38 +100051 struct request *req;
52 struct virtio_blk_outhdr out_hdr;
Hannes Reinecke1cde26f2009-05-18 14:41:30 +020053 struct virtio_scsi_inhdr in_hdr;
Rusty Russellcb38fa22008-05-02 21:50:45 -050054 u8 status;
Asias Hea98755c2012-08-08 16:07:04 +080055 struct scatterlist sg[];
Rusty Russelle467cde2007-10-22 11:03:38 +100056};
57
Asias Hea98755c2012-08-08 16:07:04 +080058static inline int virtblk_result(struct virtblk_req *vbr)
59{
60 switch (vbr->status) {
61 case VIRTIO_BLK_S_OK:
62 return 0;
63 case VIRTIO_BLK_S_UNSUPP:
64 return -ENOTTY;
65 default:
66 return -EIO;
67 }
68}
69
Paolo Bonzini8f39db92013-03-20 15:44:27 +103070static int __virtblk_add_req(struct virtqueue *vq,
Paolo Bonzini20af3cf2013-03-20 15:44:27 +103071 struct virtblk_req *vbr,
72 struct scatterlist *data_sg,
Rusty Russell0a11cc32013-03-20 15:44:27 +103073 bool have_data)
Asias Hec85a1f92012-08-08 16:07:05 +080074{
Paolo Bonzini20af3cf2013-03-20 15:44:27 +103075 struct scatterlist hdr, status, cmd, sense, inhdr, *sgs[6];
Paolo Bonzini8f39db92013-03-20 15:44:27 +103076 unsigned int num_out = 0, num_in = 0;
Paolo Bonzini20af3cf2013-03-20 15:44:27 +103077 int type = vbr->out_hdr.type & ~VIRTIO_BLK_T_OUT;
Paolo Bonzini8f39db92013-03-20 15:44:27 +103078
79 sg_init_one(&hdr, &vbr->out_hdr, sizeof(vbr->out_hdr));
80 sgs[num_out++] = &hdr;
81
Paolo Bonzini20af3cf2013-03-20 15:44:27 +103082 /*
83 * If this is a packet command we need a couple of additional headers.
84 * Behind the normal outhdr we put a segment with the scsi command
85 * block, and before the normal inhdr we put the sense data and the
86 * inhdr with additional status information.
87 */
88 if (type == VIRTIO_BLK_T_SCSI_CMD) {
89 sg_init_one(&cmd, vbr->req->cmd, vbr->req->cmd_len);
90 sgs[num_out++] = &cmd;
91 }
92
Rusty Russell0a11cc32013-03-20 15:44:27 +103093 if (have_data) {
Paolo Bonzini8f39db92013-03-20 15:44:27 +103094 if (vbr->out_hdr.type & VIRTIO_BLK_T_OUT)
Paolo Bonzini20af3cf2013-03-20 15:44:27 +103095 sgs[num_out++] = data_sg;
Paolo Bonzini8f39db92013-03-20 15:44:27 +103096 else
Paolo Bonzini20af3cf2013-03-20 15:44:27 +103097 sgs[num_out + num_in++] = data_sg;
98 }
99
100 if (type == VIRTIO_BLK_T_SCSI_CMD) {
101 sg_init_one(&sense, vbr->req->sense, SCSI_SENSE_BUFFERSIZE);
102 sgs[num_out + num_in++] = &sense;
103 sg_init_one(&inhdr, &vbr->in_hdr, sizeof(vbr->in_hdr));
104 sgs[num_out + num_in++] = &inhdr;
Paolo Bonzini8f39db92013-03-20 15:44:27 +1030105 }
106
107 sg_init_one(&status, &vbr->status, sizeof(vbr->status));
108 sgs[num_out + num_in++] = &status;
109
110 return virtqueue_add_sgs(vq, sgs, num_out, num_in, vbr, GFP_ATOMIC);
Paolo Bonzini5ee21a52013-03-20 15:44:27 +1030111}
Asias Hec85a1f92012-08-08 16:07:05 +0800112
Asias Hec85a1f92012-08-08 16:07:05 +0800113static inline void virtblk_request_done(struct virtblk_req *vbr)
114{
Asias Hea98755c2012-08-08 16:07:04 +0800115 struct request *req = vbr->req;
116 int error = virtblk_result(vbr);
117
118 if (req->cmd_type == REQ_TYPE_BLOCK_PC) {
119 req->resid_len = vbr->in_hdr.residual;
120 req->sense_len = vbr->in_hdr.sense_len;
121 req->errors = vbr->in_hdr.errors;
122 } else if (req->cmd_type == REQ_TYPE_SPECIAL) {
123 req->errors = (error != 0);
124 }
125
Jens Axboe1cf7e9c2013-11-01 10:52:52 -0600126 blk_mq_end_io(req, error);
Asias Hea98755c2012-08-08 16:07:04 +0800127}
128
129static void virtblk_done(struct virtqueue *vq)
Rusty Russelle467cde2007-10-22 11:03:38 +1000130{
131 struct virtio_blk *vblk = vq->vdev->priv;
Jens Axboe1cf7e9c2013-11-01 10:52:52 -0600132 bool req_done = false;
Rusty Russelle467cde2007-10-22 11:03:38 +1000133 struct virtblk_req *vbr;
Rusty Russelle467cde2007-10-22 11:03:38 +1000134 unsigned long flags;
Asias Hea98755c2012-08-08 16:07:04 +0800135 unsigned int len;
Rusty Russelle467cde2007-10-22 11:03:38 +1000136
Jens Axboe1cf7e9c2013-11-01 10:52:52 -0600137 spin_lock_irqsave(&vblk->vq_lock, flags);
Asias Hebb811102012-09-25 10:36:17 +0800138 do {
139 virtqueue_disable_cb(vq);
140 while ((vbr = virtqueue_get_buf(vblk->vq, &len)) != NULL) {
Jens Axboe1cf7e9c2013-11-01 10:52:52 -0600141 virtblk_request_done(vbr);
142 req_done = true;
Rusty Russelle467cde2007-10-22 11:03:38 +1000143 }
Heinz Graalfs7f03b172013-10-29 09:40:30 +1030144 if (unlikely(virtqueue_is_broken(vq)))
145 break;
Asias Hebb811102012-09-25 10:36:17 +0800146 } while (!virtqueue_enable_cb(vq));
Jens Axboe1cf7e9c2013-11-01 10:52:52 -0600147 spin_unlock_irqrestore(&vblk->vq_lock, flags);
148
Rusty Russelle467cde2007-10-22 11:03:38 +1000149 /* In case queue is stopped waiting for more buffers. */
Asias Hea98755c2012-08-08 16:07:04 +0800150 if (req_done)
Jens Axboe1cf7e9c2013-11-01 10:52:52 -0600151 blk_mq_start_stopped_hw_queues(vblk->disk->queue);
Asias Hea98755c2012-08-08 16:07:04 +0800152}
153
Jens Axboe1cf7e9c2013-11-01 10:52:52 -0600154static int virtio_queue_rq(struct blk_mq_hw_ctx *hctx, struct request *req)
Rusty Russelle467cde2007-10-22 11:03:38 +1000155{
Jens Axboe1cf7e9c2013-11-01 10:52:52 -0600156 struct virtio_blk *vblk = hctx->queue->queuedata;
157 struct virtblk_req *vbr = req->special;
158 unsigned long flags;
Paolo Bonzini20af3cf2013-03-20 15:44:27 +1030159 unsigned int num;
Jens Axboe1cf7e9c2013-11-01 10:52:52 -0600160 const bool last = (req->cmd_flags & REQ_END) != 0;
Rusty Russelle467cde2007-10-22 11:03:38 +1000161
Jens Axboe1cf7e9c2013-11-01 10:52:52 -0600162 BUG_ON(req->nr_phys_segments + 2 > vblk->sg_elems);
Rusty Russelle467cde2007-10-22 11:03:38 +1000163
164 vbr->req = req;
FUJITA Tomonoridd40e452010-07-03 17:45:38 +0900165 if (req->cmd_flags & REQ_FLUSH) {
166 vbr->out_hdr.type = VIRTIO_BLK_T_FLUSH;
Rusty Russelle467cde2007-10-22 11:03:38 +1000167 vbr->out_hdr.sector = 0;
Fernando Luis Vázquez Cao766ca442008-08-14 09:59:13 +0200168 vbr->out_hdr.ioprio = req_get_ioprio(vbr->req);
FUJITA Tomonoridd40e452010-07-03 17:45:38 +0900169 } else {
170 switch (req->cmd_type) {
171 case REQ_TYPE_FS:
172 vbr->out_hdr.type = 0;
173 vbr->out_hdr.sector = blk_rq_pos(vbr->req);
174 vbr->out_hdr.ioprio = req_get_ioprio(vbr->req);
175 break;
176 case REQ_TYPE_BLOCK_PC:
177 vbr->out_hdr.type = VIRTIO_BLK_T_SCSI_CMD;
Christoph Hellwigf1b0ef062009-09-17 19:57:42 +0200178 vbr->out_hdr.sector = 0;
179 vbr->out_hdr.ioprio = req_get_ioprio(vbr->req);
180 break;
FUJITA Tomonoridd40e452010-07-03 17:45:38 +0900181 case REQ_TYPE_SPECIAL:
182 vbr->out_hdr.type = VIRTIO_BLK_T_GET_ID;
183 vbr->out_hdr.sector = 0;
184 vbr->out_hdr.ioprio = req_get_ioprio(vbr->req);
185 break;
186 default:
187 /* We don't put anything else in the queue. */
188 BUG();
Christoph Hellwigf1b0ef062009-09-17 19:57:42 +0200189 }
Rusty Russelle467cde2007-10-22 11:03:38 +1000190 }
191
Jens Axboe1cf7e9c2013-11-01 10:52:52 -0600192 num = blk_rq_map_sg(hctx->queue, vbr->req, vbr->sg);
Hannes Reinecke1cde26f2009-05-18 14:41:30 +0200193 if (num) {
Paolo Bonzini20af3cf2013-03-20 15:44:27 +1030194 if (rq_data_dir(vbr->req) == WRITE)
Hannes Reinecke1cde26f2009-05-18 14:41:30 +0200195 vbr->out_hdr.type |= VIRTIO_BLK_T_OUT;
Paolo Bonzini20af3cf2013-03-20 15:44:27 +1030196 else
Hannes Reinecke1cde26f2009-05-18 14:41:30 +0200197 vbr->out_hdr.type |= VIRTIO_BLK_T_IN;
Rusty Russelle467cde2007-10-22 11:03:38 +1000198 }
199
Jens Axboe1cf7e9c2013-11-01 10:52:52 -0600200 spin_lock_irqsave(&vblk->vq_lock, flags);
201 if (__virtblk_add_req(vblk->vq, vbr, vbr->sg, num) < 0) {
Shaohua Lif02b9ac2013-11-19 18:57:24 -0700202 virtqueue_kick(vblk->vq);
Jens Axboe1cf7e9c2013-11-01 10:52:52 -0600203 spin_unlock_irqrestore(&vblk->vq_lock, flags);
204 blk_mq_stop_hw_queue(hctx);
Jens Axboe1cf7e9c2013-11-01 10:52:52 -0600205 return BLK_MQ_RQ_QUEUE_BUSY;
Asias Hea98755c2012-08-08 16:07:04 +0800206 }
207
Jens Axboe1cf7e9c2013-11-01 10:52:52 -0600208 if (last)
209 virtqueue_kick(vblk->vq);
Shaohua Lif02b9ac2013-11-19 18:57:24 -0700210
211 spin_unlock_irqrestore(&vblk->vq_lock, flags);
Jens Axboe1cf7e9c2013-11-01 10:52:52 -0600212 return BLK_MQ_RQ_QUEUE_OK;
Asias Hea98755c2012-08-08 16:07:04 +0800213}
214
john cooper4cb2ea22010-03-25 01:33:33 -0400215/* return id (s/n) string for *disk to *id_str
216 */
217static int virtblk_get_id(struct gendisk *disk, char *id_str)
218{
219 struct virtio_blk *vblk = disk->private_data;
220 struct request *req;
221 struct bio *bio;
Mike Snitzere4c47762010-10-09 12:12:13 +1030222 int err;
john cooper4cb2ea22010-03-25 01:33:33 -0400223
224 bio = bio_map_kern(vblk->disk->queue, id_str, VIRTIO_BLK_ID_BYTES,
225 GFP_KERNEL);
226 if (IS_ERR(bio))
227 return PTR_ERR(bio);
228
229 req = blk_make_request(vblk->disk->queue, bio, GFP_KERNEL);
230 if (IS_ERR(req)) {
231 bio_put(bio);
232 return PTR_ERR(req);
233 }
234
235 req->cmd_type = REQ_TYPE_SPECIAL;
Mike Snitzere4c47762010-10-09 12:12:13 +1030236 err = blk_execute_rq(vblk->disk->queue, vblk->disk, req, false);
237 blk_put_request(req);
238
239 return err;
john cooper4cb2ea22010-03-25 01:33:33 -0400240}
241
Christoph Hellwigfe5a50a2010-09-15 01:27:23 +0200242static int virtblk_ioctl(struct block_device *bdev, fmode_t mode,
243 unsigned int cmd, unsigned long data)
Rusty Russelle467cde2007-10-22 11:03:38 +1000244{
Hannes Reinecke1cde26f2009-05-18 14:41:30 +0200245 struct gendisk *disk = bdev->bd_disk;
246 struct virtio_blk *vblk = disk->private_data;
247
248 /*
249 * Only allow the generic SCSI ioctls if the host can support it.
250 */
251 if (!virtio_has_feature(vblk->vdev, VIRTIO_BLK_F_SCSI))
Christoph Hellwigd9ecdea2009-06-20 21:29:41 +0200252 return -ENOTTY;
Hannes Reinecke1cde26f2009-05-18 14:41:30 +0200253
Paolo Bonzini577ebb32012-01-12 16:01:27 +0100254 return scsi_cmd_blk_ioctl(bdev, mode, cmd,
255 (void __user *)data);
Rusty Russelle467cde2007-10-22 11:03:38 +1000256}
257
Christian Borntraeger135da0b2008-01-23 17:56:50 +0100258/* We provide getgeo only to please some old bootloader/partitioning tools */
259static int virtblk_getgeo(struct block_device *bd, struct hd_geometry *geo)
260{
Ryan Harper48e40432008-04-16 13:56:37 -0500261 struct virtio_blk *vblk = bd->bd_disk->private_data;
Ryan Harper48e40432008-04-16 13:56:37 -0500262
263 /* see if the host passed in geometry config */
Rusty Russell855e0c52013-10-14 18:11:51 +1030264 if (virtio_has_feature(vblk->vdev, VIRTIO_BLK_F_GEOMETRY)) {
265 virtio_cread(vblk->vdev, struct virtio_blk_config,
266 geometry.cylinders, &geo->cylinders);
267 virtio_cread(vblk->vdev, struct virtio_blk_config,
268 geometry.heads, &geo->heads);
269 virtio_cread(vblk->vdev, struct virtio_blk_config,
270 geometry.sectors, &geo->sectors);
Ryan Harper48e40432008-04-16 13:56:37 -0500271 } else {
272 /* some standard values, similar to sd */
273 geo->heads = 1 << 6;
274 geo->sectors = 1 << 5;
275 geo->cylinders = get_capacity(bd->bd_disk) >> 11;
276 }
Christian Borntraeger135da0b2008-01-23 17:56:50 +0100277 return 0;
278}
279
Alexey Dobriyan83d5cde2009-09-21 17:01:13 -0700280static const struct block_device_operations virtblk_fops = {
Arnd Bergmann8a6cfeb2010-07-08 10:18:46 +0200281 .ioctl = virtblk_ioctl,
Christian Borntraeger135da0b2008-01-23 17:56:50 +0100282 .owner = THIS_MODULE,
283 .getgeo = virtblk_getgeo,
Rusty Russelle467cde2007-10-22 11:03:38 +1000284};
285
Christian Borntraegerd50ed902008-02-01 09:05:00 +0100286static int index_to_minor(int index)
287{
288 return index << PART_BITS;
289}
290
Michael S. Tsirkin5087a502011-10-30 21:29:59 +0200291static int minor_to_index(int minor)
292{
293 return minor >> PART_BITS;
294}
295
Ryan Harpera5eb9e42010-06-23 22:19:57 -0500296static ssize_t virtblk_serial_show(struct device *dev,
297 struct device_attribute *attr, char *buf)
298{
299 struct gendisk *disk = dev_to_disk(dev);
300 int err;
301
302 /* sysfs gives us a PAGE_SIZE buffer */
303 BUILD_BUG_ON(PAGE_SIZE < VIRTIO_BLK_ID_BYTES);
304
305 buf[VIRTIO_BLK_ID_BYTES] = '\0';
306 err = virtblk_get_id(disk, buf);
307 if (!err)
308 return strlen(buf);
309
310 if (err == -EIO) /* Unsupported? Make it empty. */
311 return 0;
312
313 return err;
314}
315DEVICE_ATTR(serial, S_IRUGO, virtblk_serial_show, NULL);
316
Christoph Hellwig7a7c9242011-02-01 21:43:48 +0100317static void virtblk_config_changed_work(struct work_struct *work)
318{
319 struct virtio_blk *vblk =
320 container_of(work, struct virtio_blk, config_work);
321 struct virtio_device *vdev = vblk->vdev;
322 struct request_queue *q = vblk->disk->queue;
323 char cap_str_2[10], cap_str_10[10];
Milos Vyletel9d9598b2013-03-12 15:34:40 +1030324 char *envp[] = { "RESIZE=1", NULL };
Christoph Hellwig7a7c9242011-02-01 21:43:48 +0100325 u64 capacity, size;
326
Michael S. Tsirkin4678d6f2012-01-12 15:44:44 +1030327 mutex_lock(&vblk->config_lock);
328 if (!vblk->config_enable)
329 goto done;
330
Christoph Hellwig7a7c9242011-02-01 21:43:48 +0100331 /* Host must always specify the capacity. */
Rusty Russell855e0c52013-10-14 18:11:51 +1030332 virtio_cread(vdev, struct virtio_blk_config, capacity, &capacity);
Christoph Hellwig7a7c9242011-02-01 21:43:48 +0100333
334 /* If capacity is too big, truncate with warning. */
335 if ((sector_t)capacity != capacity) {
336 dev_warn(&vdev->dev, "Capacity %llu too large: truncating\n",
337 (unsigned long long)capacity);
338 capacity = (sector_t)-1;
339 }
340
341 size = capacity * queue_logical_block_size(q);
342 string_get_size(size, STRING_UNITS_2, cap_str_2, sizeof(cap_str_2));
343 string_get_size(size, STRING_UNITS_10, cap_str_10, sizeof(cap_str_10));
344
345 dev_notice(&vdev->dev,
346 "new size: %llu %d-byte logical blocks (%s/%s)\n",
347 (unsigned long long)capacity,
348 queue_logical_block_size(q),
349 cap_str_10, cap_str_2);
350
351 set_capacity(vblk->disk, capacity);
Vivek Goyale9986f32012-03-29 10:09:44 +0200352 revalidate_disk(vblk->disk);
Milos Vyletel9d9598b2013-03-12 15:34:40 +1030353 kobject_uevent_env(&disk_to_dev(vblk->disk)->kobj, KOBJ_CHANGE, envp);
Michael S. Tsirkin4678d6f2012-01-12 15:44:44 +1030354done:
355 mutex_unlock(&vblk->config_lock);
Christoph Hellwig7a7c9242011-02-01 21:43:48 +0100356}
357
358static void virtblk_config_changed(struct virtio_device *vdev)
359{
360 struct virtio_blk *vblk = vdev->priv;
361
362 queue_work(virtblk_wq, &vblk->config_work);
363}
364
Amit Shah6abd6e52011-12-22 16:58:29 +0530365static int init_vq(struct virtio_blk *vblk)
366{
367 int err = 0;
368
369 /* We expect one virtqueue, for output. */
Asias Hea98755c2012-08-08 16:07:04 +0800370 vblk->vq = virtio_find_single_vq(vblk->vdev, virtblk_done, "requests");
Amit Shah6abd6e52011-12-22 16:58:29 +0530371 if (IS_ERR(vblk->vq))
372 err = PTR_ERR(vblk->vq);
373
374 return err;
375}
376
Ren Mingxinc0aa3e02012-04-10 15:28:05 +0800377/*
378 * Legacy naming scheme used for virtio devices. We are stuck with it for
379 * virtio blk but don't ever use it for any new driver.
380 */
381static int virtblk_name_format(char *prefix, int index, char *buf, int buflen)
382{
383 const int base = 'z' - 'a' + 1;
384 char *begin = buf + strlen(prefix);
385 char *end = buf + buflen;
386 char *p;
387 int unit;
388
389 p = end - 1;
390 *p = '\0';
391 unit = base;
392 do {
393 if (p == begin)
394 return -EINVAL;
395 *--p = 'a' + (index % unit);
396 index = (index / unit) - 1;
397 } while (index >= 0);
398
399 memmove(begin, p, end - p);
400 memcpy(buf, prefix, strlen(prefix));
401
402 return 0;
403}
404
Paolo Bonzinicd5d5032012-07-03 15:19:37 +0200405static int virtblk_get_cache_mode(struct virtio_device *vdev)
406{
407 u8 writeback;
408 int err;
409
Rusty Russell855e0c52013-10-14 18:11:51 +1030410 err = virtio_cread_feature(vdev, VIRTIO_BLK_F_CONFIG_WCE,
411 struct virtio_blk_config, wce,
412 &writeback);
Paolo Bonzinicd5d5032012-07-03 15:19:37 +0200413 if (err)
414 writeback = virtio_has_feature(vdev, VIRTIO_BLK_F_WCE);
415
416 return writeback;
417}
418
419static void virtblk_update_cache_mode(struct virtio_device *vdev)
420{
421 u8 writeback = virtblk_get_cache_mode(vdev);
422 struct virtio_blk *vblk = vdev->priv;
423
Asias Hec85a1f92012-08-08 16:07:05 +0800424 if (writeback)
Paolo Bonzinicd5d5032012-07-03 15:19:37 +0200425 blk_queue_flush(vblk->disk->queue, REQ_FLUSH);
426 else
427 blk_queue_flush(vblk->disk->queue, 0);
428
429 revalidate_disk(vblk->disk);
430}
431
432static const char *const virtblk_cache_types[] = {
433 "write through", "write back"
434};
435
436static ssize_t
437virtblk_cache_type_store(struct device *dev, struct device_attribute *attr,
438 const char *buf, size_t count)
439{
440 struct gendisk *disk = dev_to_disk(dev);
441 struct virtio_blk *vblk = disk->private_data;
442 struct virtio_device *vdev = vblk->vdev;
443 int i;
Paolo Bonzinicd5d5032012-07-03 15:19:37 +0200444
445 BUG_ON(!virtio_has_feature(vblk->vdev, VIRTIO_BLK_F_CONFIG_WCE));
446 for (i = ARRAY_SIZE(virtblk_cache_types); --i >= 0; )
447 if (sysfs_streq(buf, virtblk_cache_types[i]))
448 break;
449
450 if (i < 0)
451 return -EINVAL;
452
Rusty Russell855e0c52013-10-14 18:11:51 +1030453 virtio_cwrite8(vdev, offsetof(struct virtio_blk_config, wce), i);
Paolo Bonzinicd5d5032012-07-03 15:19:37 +0200454 virtblk_update_cache_mode(vdev);
455 return count;
456}
457
458static ssize_t
459virtblk_cache_type_show(struct device *dev, struct device_attribute *attr,
460 char *buf)
461{
462 struct gendisk *disk = dev_to_disk(dev);
463 struct virtio_blk *vblk = disk->private_data;
464 u8 writeback = virtblk_get_cache_mode(vblk->vdev);
465
466 BUG_ON(writeback >= ARRAY_SIZE(virtblk_cache_types));
467 return snprintf(buf, 40, "%s\n", virtblk_cache_types[writeback]);
468}
469
470static const struct device_attribute dev_attr_cache_type_ro =
471 __ATTR(cache_type, S_IRUGO,
472 virtblk_cache_type_show, NULL);
473static const struct device_attribute dev_attr_cache_type_rw =
474 __ATTR(cache_type, S_IRUGO|S_IWUSR,
475 virtblk_cache_type_show, virtblk_cache_type_store);
476
Jens Axboe1cf7e9c2013-11-01 10:52:52 -0600477static struct blk_mq_ops virtio_mq_ops = {
478 .queue_rq = virtio_queue_rq,
479 .map_queue = blk_mq_map_queue,
480 .alloc_hctx = blk_mq_alloc_single_hw_queue,
481 .free_hctx = blk_mq_free_single_hw_queue,
482};
483
484static struct blk_mq_reg virtio_mq_reg = {
485 .ops = &virtio_mq_ops,
486 .nr_hw_queues = 1,
487 .queue_depth = 64,
488 .numa_node = NUMA_NO_NODE,
489 .flags = BLK_MQ_F_SHOULD_MERGE,
490};
491
492static void virtblk_init_vbr(void *data, struct blk_mq_hw_ctx *hctx,
493 struct request *rq, unsigned int nr)
494{
495 struct virtio_blk *vblk = data;
496 struct virtblk_req *vbr = rq->special;
497
498 sg_init_table(vbr->sg, vblk->sg_elems);
499}
500
Greg Kroah-Hartman8d85fce2012-12-21 15:13:49 -0800501static int virtblk_probe(struct virtio_device *vdev)
Rusty Russelle467cde2007-10-22 11:03:38 +1000502{
503 struct virtio_blk *vblk;
Christoph Hellwig69740c82010-02-24 14:22:25 -0600504 struct request_queue *q;
Michael S. Tsirkin5087a502011-10-30 21:29:59 +0200505 int err, index;
Asias Hea98755c2012-08-08 16:07:04 +0800506
Rusty Russelle467cde2007-10-22 11:03:38 +1000507 u64 cap;
Christoph Hellwig69740c82010-02-24 14:22:25 -0600508 u32 v, blk_size, sg_elems, opt_io_size;
509 u16 min_io_size;
510 u8 physical_block_exp, alignment_offset;
Rusty Russelle467cde2007-10-22 11:03:38 +1000511
Michael S. Tsirkin5087a502011-10-30 21:29:59 +0200512 err = ida_simple_get(&vd_index_ida, 0, minor_to_index(1 << MINORBITS),
513 GFP_KERNEL);
514 if (err < 0)
515 goto out;
516 index = err;
Christian Borntraeger4f3bf192008-01-31 15:53:53 +0100517
Rusty Russell0864b792008-12-30 09:26:05 -0600518 /* We need to know how many segments before we allocate. */
Rusty Russell855e0c52013-10-14 18:11:51 +1030519 err = virtio_cread_feature(vdev, VIRTIO_BLK_F_SEG_MAX,
520 struct virtio_blk_config, seg_max,
521 &sg_elems);
Christoph Hellwiga5b365a2010-05-25 14:17:54 +0200522
523 /* We need at least one SG element, whatever they say. */
524 if (err || !sg_elems)
Rusty Russell0864b792008-12-30 09:26:05 -0600525 sg_elems = 1;
526
527 /* We need an extra sg elements at head and tail. */
528 sg_elems += 2;
Jens Axboe1cf7e9c2013-11-01 10:52:52 -0600529 vdev->priv = vblk = kmalloc(sizeof(*vblk), GFP_KERNEL);
Rusty Russelle467cde2007-10-22 11:03:38 +1000530 if (!vblk) {
531 err = -ENOMEM;
Michael S. Tsirkin5087a502011-10-30 21:29:59 +0200532 goto out_free_index;
Rusty Russelle467cde2007-10-22 11:03:38 +1000533 }
534
Rusty Russelle467cde2007-10-22 11:03:38 +1000535 vblk->vdev = vdev;
Rusty Russell0864b792008-12-30 09:26:05 -0600536 vblk->sg_elems = sg_elems;
Michael S. Tsirkin4678d6f2012-01-12 15:44:44 +1030537 mutex_init(&vblk->config_lock);
Asias Hea98755c2012-08-08 16:07:04 +0800538
Christoph Hellwig7a7c9242011-02-01 21:43:48 +0100539 INIT_WORK(&vblk->config_work, virtblk_config_changed_work);
Michael S. Tsirkin4678d6f2012-01-12 15:44:44 +1030540 vblk->config_enable = true;
Rusty Russelle467cde2007-10-22 11:03:38 +1000541
Amit Shah6abd6e52011-12-22 16:58:29 +0530542 err = init_vq(vblk);
543 if (err)
Rusty Russelle467cde2007-10-22 11:03:38 +1000544 goto out_free_vblk;
Jens Axboe1cf7e9c2013-11-01 10:52:52 -0600545 spin_lock_init(&vblk->vq_lock);
Rusty Russelle467cde2007-10-22 11:03:38 +1000546
Rusty Russelle467cde2007-10-22 11:03:38 +1000547 /* FIXME: How many partitions? How long is a piece of string? */
Christian Borntraeger4f3bf192008-01-31 15:53:53 +0100548 vblk->disk = alloc_disk(1 << PART_BITS);
Rusty Russelle467cde2007-10-22 11:03:38 +1000549 if (!vblk->disk) {
550 err = -ENOMEM;
Jens Axboe1cf7e9c2013-11-01 10:52:52 -0600551 goto out_free_vq;
Rusty Russelle467cde2007-10-22 11:03:38 +1000552 }
553
Jens Axboe1cf7e9c2013-11-01 10:52:52 -0600554 virtio_mq_reg.cmd_size =
555 sizeof(struct virtblk_req) +
556 sizeof(struct scatterlist) * sg_elems;
557
558 q = vblk->disk->queue = blk_mq_init_queue(&virtio_mq_reg, vblk);
Christoph Hellwig69740c82010-02-24 14:22:25 -0600559 if (!q) {
Rusty Russelle467cde2007-10-22 11:03:38 +1000560 err = -ENOMEM;
561 goto out_put_disk;
562 }
563
Jens Axboe1cf7e9c2013-11-01 10:52:52 -0600564 blk_mq_init_commands(q, virtblk_init_vbr, vblk);
565
Christoph Hellwig69740c82010-02-24 14:22:25 -0600566 q->queuedata = vblk;
Fernando Luis Vázquez Cao7d116b62008-10-27 18:45:15 +0900567
Ren Mingxinc0aa3e02012-04-10 15:28:05 +0800568 virtblk_name_format("vd", index, vblk->disk->disk_name, DISK_NAME_LEN);
Christian Borntraegerd50ed902008-02-01 09:05:00 +0100569
Rusty Russelle467cde2007-10-22 11:03:38 +1000570 vblk->disk->major = major;
Christian Borntraegerd50ed902008-02-01 09:05:00 +0100571 vblk->disk->first_minor = index_to_minor(index);
Rusty Russelle467cde2007-10-22 11:03:38 +1000572 vblk->disk->private_data = vblk;
573 vblk->disk->fops = &virtblk_fops;
Jeremy Katzc4839342008-03-02 17:00:15 -0500574 vblk->disk->driverfs_dev = &vdev->dev;
Michael S. Tsirkin5087a502011-10-30 21:29:59 +0200575 vblk->index = index;
Christian Borntraeger4f3bf192008-01-31 15:53:53 +0100576
Tejun Heo02c42b72010-09-03 11:56:18 +0200577 /* configure queue flush support */
Paolo Bonzinicd5d5032012-07-03 15:19:37 +0200578 virtblk_update_cache_mode(vdev);
Rusty Russelle467cde2007-10-22 11:03:38 +1000579
Christian Borntraeger3ef53602008-05-16 11:17:03 +0200580 /* If disk is read-only in the host, the guest should obey */
581 if (virtio_has_feature(vdev, VIRTIO_BLK_F_RO))
582 set_disk_ro(vblk->disk, 1);
583
Rusty Russella586d4f2008-02-04 23:49:56 -0500584 /* Host must always specify the capacity. */
Rusty Russell855e0c52013-10-14 18:11:51 +1030585 virtio_cread(vdev, struct virtio_blk_config, capacity, &cap);
Rusty Russelle467cde2007-10-22 11:03:38 +1000586
587 /* If capacity is too big, truncate with warning. */
588 if ((sector_t)cap != cap) {
589 dev_warn(&vdev->dev, "Capacity %llu too large: truncating\n",
590 (unsigned long long)cap);
591 cap = (sector_t)-1;
592 }
593 set_capacity(vblk->disk, cap);
594
Rusty Russell0864b792008-12-30 09:26:05 -0600595 /* We can handle whatever the host told us to handle. */
Martin K. Petersenee714f22010-03-10 00:48:32 -0500596 blk_queue_max_segments(q, vblk->sg_elems-2);
Rusty Russell0864b792008-12-30 09:26:05 -0600597
Christoph Hellwig4eff3ca2009-07-17 21:47:45 -0600598 /* No need to bounce any requests */
Christoph Hellwig69740c82010-02-24 14:22:25 -0600599 blk_queue_bounce_limit(q, BLK_BOUNCE_ANY);
Christoph Hellwig4eff3ca2009-07-17 21:47:45 -0600600
Rusty Russell4b7f7e22008-12-30 09:26:04 -0600601 /* No real sector limit. */
Martin K. Petersenee714f22010-03-10 00:48:32 -0500602 blk_queue_max_hw_sectors(q, -1U);
Rusty Russell4b7f7e22008-12-30 09:26:04 -0600603
Rusty Russella586d4f2008-02-04 23:49:56 -0500604 /* Host can optionally specify maximum segment size and number of
605 * segments. */
Rusty Russell855e0c52013-10-14 18:11:51 +1030606 err = virtio_cread_feature(vdev, VIRTIO_BLK_F_SIZE_MAX,
607 struct virtio_blk_config, size_max, &v);
Rusty Russelle467cde2007-10-22 11:03:38 +1000608 if (!err)
Christoph Hellwig69740c82010-02-24 14:22:25 -0600609 blk_queue_max_segment_size(q, v);
Rusty Russell4b7f7e22008-12-30 09:26:04 -0600610 else
Christoph Hellwig69740c82010-02-24 14:22:25 -0600611 blk_queue_max_segment_size(q, -1U);
Rusty Russelle467cde2007-10-22 11:03:38 +1000612
Christian Borntraeger066f4d82008-05-29 11:08:26 +0200613 /* Host can optionally specify the block size of the device */
Rusty Russell855e0c52013-10-14 18:11:51 +1030614 err = virtio_cread_feature(vdev, VIRTIO_BLK_F_BLK_SIZE,
615 struct virtio_blk_config, blk_size,
616 &blk_size);
Christian Borntraeger066f4d82008-05-29 11:08:26 +0200617 if (!err)
Christoph Hellwig69740c82010-02-24 14:22:25 -0600618 blk_queue_logical_block_size(q, blk_size);
619 else
620 blk_size = queue_logical_block_size(q);
621
622 /* Use topology information if available */
Rusty Russell855e0c52013-10-14 18:11:51 +1030623 err = virtio_cread_feature(vdev, VIRTIO_BLK_F_TOPOLOGY,
624 struct virtio_blk_config, physical_block_exp,
625 &physical_block_exp);
Christoph Hellwig69740c82010-02-24 14:22:25 -0600626 if (!err && physical_block_exp)
627 blk_queue_physical_block_size(q,
628 blk_size * (1 << physical_block_exp));
629
Rusty Russell855e0c52013-10-14 18:11:51 +1030630 err = virtio_cread_feature(vdev, VIRTIO_BLK_F_TOPOLOGY,
631 struct virtio_blk_config, alignment_offset,
632 &alignment_offset);
Christoph Hellwig69740c82010-02-24 14:22:25 -0600633 if (!err && alignment_offset)
634 blk_queue_alignment_offset(q, blk_size * alignment_offset);
635
Rusty Russell855e0c52013-10-14 18:11:51 +1030636 err = virtio_cread_feature(vdev, VIRTIO_BLK_F_TOPOLOGY,
637 struct virtio_blk_config, min_io_size,
638 &min_io_size);
Christoph Hellwig69740c82010-02-24 14:22:25 -0600639 if (!err && min_io_size)
640 blk_queue_io_min(q, blk_size * min_io_size);
641
Rusty Russell855e0c52013-10-14 18:11:51 +1030642 err = virtio_cread_feature(vdev, VIRTIO_BLK_F_TOPOLOGY,
643 struct virtio_blk_config, opt_io_size,
644 &opt_io_size);
Christoph Hellwig69740c82010-02-24 14:22:25 -0600645 if (!err && opt_io_size)
646 blk_queue_io_opt(q, blk_size * opt_io_size);
647
Rusty Russelle467cde2007-10-22 11:03:38 +1000648 add_disk(vblk->disk);
Ryan Harpera5eb9e42010-06-23 22:19:57 -0500649 err = device_create_file(disk_to_dev(vblk->disk), &dev_attr_serial);
650 if (err)
651 goto out_del_disk;
652
Paolo Bonzinicd5d5032012-07-03 15:19:37 +0200653 if (virtio_has_feature(vdev, VIRTIO_BLK_F_CONFIG_WCE))
654 err = device_create_file(disk_to_dev(vblk->disk),
655 &dev_attr_cache_type_rw);
656 else
657 err = device_create_file(disk_to_dev(vblk->disk),
658 &dev_attr_cache_type_ro);
659 if (err)
660 goto out_del_disk;
Rusty Russelle467cde2007-10-22 11:03:38 +1000661 return 0;
662
Ryan Harpera5eb9e42010-06-23 22:19:57 -0500663out_del_disk:
664 del_gendisk(vblk->disk);
665 blk_cleanup_queue(vblk->disk->queue);
Rusty Russelle467cde2007-10-22 11:03:38 +1000666out_put_disk:
667 put_disk(vblk->disk);
Rusty Russelle467cde2007-10-22 11:03:38 +1000668out_free_vq:
Michael S. Tsirkind2a7ddd2009-06-12 22:16:36 -0600669 vdev->config->del_vqs(vdev);
Rusty Russelle467cde2007-10-22 11:03:38 +1000670out_free_vblk:
671 kfree(vblk);
Michael S. Tsirkin5087a502011-10-30 21:29:59 +0200672out_free_index:
673 ida_simple_remove(&vd_index_ida, index);
Rusty Russelle467cde2007-10-22 11:03:38 +1000674out:
675 return err;
676}
677
Greg Kroah-Hartman8d85fce2012-12-21 15:13:49 -0800678static void virtblk_remove(struct virtio_device *vdev)
Rusty Russelle467cde2007-10-22 11:03:38 +1000679{
680 struct virtio_blk *vblk = vdev->priv;
Michael S. Tsirkin5087a502011-10-30 21:29:59 +0200681 int index = vblk->index;
Alexander Graff4953fe2013-01-02 15:37:17 +1030682 int refc;
Rusty Russelle467cde2007-10-22 11:03:38 +1000683
Michael S. Tsirkin4678d6f2012-01-12 15:44:44 +1030684 /* Prevent config work handler from accessing the device. */
685 mutex_lock(&vblk->config_lock);
686 vblk->config_enable = false;
687 mutex_unlock(&vblk->config_lock);
Christoph Hellwig7a7c9242011-02-01 21:43:48 +0100688
Asias He02e2b122012-05-25 10:34:47 +0800689 del_gendisk(vblk->disk);
Asias He483001c2012-05-25 10:34:48 +0800690 blk_cleanup_queue(vblk->disk->queue);
Asias He02e2b122012-05-25 10:34:47 +0800691
Rusty Russell6e5aa7e2008-02-04 23:50:03 -0500692 /* Stop all the virtqueues. */
693 vdev->config->reset(vdev);
694
Michael S. Tsirkin4678d6f2012-01-12 15:44:44 +1030695 flush_work(&vblk->config_work);
696
Alexander Graff4953fe2013-01-02 15:37:17 +1030697 refc = atomic_read(&disk_to_dev(vblk->disk)->kobj.kref.refcount);
Rusty Russelle467cde2007-10-22 11:03:38 +1000698 put_disk(vblk->disk);
Michael S. Tsirkind2a7ddd2009-06-12 22:16:36 -0600699 vdev->config->del_vqs(vdev);
Rusty Russelle467cde2007-10-22 11:03:38 +1000700 kfree(vblk);
Alexander Graff4953fe2013-01-02 15:37:17 +1030701
702 /* Only free device id if we don't have any users */
703 if (refc == 1)
704 ida_simple_remove(&vd_index_ida, index);
Rusty Russelle467cde2007-10-22 11:03:38 +1000705}
706
Aaron Lu89107002013-09-17 09:25:23 +0930707#ifdef CONFIG_PM_SLEEP
Amit Shahf8fb5bc2011-12-22 16:58:30 +0530708static int virtblk_freeze(struct virtio_device *vdev)
709{
710 struct virtio_blk *vblk = vdev->priv;
711
712 /* Ensure we don't receive any more interrupts */
713 vdev->config->reset(vdev);
714
715 /* Prevent config work handler from accessing the device. */
716 mutex_lock(&vblk->config_lock);
717 vblk->config_enable = false;
718 mutex_unlock(&vblk->config_lock);
719
720 flush_work(&vblk->config_work);
721
Jens Axboe1cf7e9c2013-11-01 10:52:52 -0600722 blk_mq_stop_hw_queues(vblk->disk->queue);
Amit Shahf8fb5bc2011-12-22 16:58:30 +0530723
724 vdev->config->del_vqs(vdev);
725 return 0;
726}
727
728static int virtblk_restore(struct virtio_device *vdev)
729{
730 struct virtio_blk *vblk = vdev->priv;
731 int ret;
732
733 vblk->config_enable = true;
734 ret = init_vq(vdev->priv);
Jens Axboe1cf7e9c2013-11-01 10:52:52 -0600735 if (!ret)
736 blk_mq_start_stopped_hw_queues(vblk->disk->queue);
737
Amit Shahf8fb5bc2011-12-22 16:58:30 +0530738 return ret;
739}
740#endif
741
Márton Németh47483e22010-01-10 13:40:02 +0100742static const struct virtio_device_id id_table[] = {
Rusty Russelle467cde2007-10-22 11:03:38 +1000743 { VIRTIO_ID_BLOCK, VIRTIO_DEV_ANY_ID },
744 { 0 },
745};
746
Rusty Russellc45a6812008-05-02 21:50:50 -0500747static unsigned int features[] = {
Tejun Heo02c42b72010-09-03 11:56:18 +0200748 VIRTIO_BLK_F_SEG_MAX, VIRTIO_BLK_F_SIZE_MAX, VIRTIO_BLK_F_GEOMETRY,
749 VIRTIO_BLK_F_RO, VIRTIO_BLK_F_BLK_SIZE, VIRTIO_BLK_F_SCSI,
Paolo Bonzinicd5d5032012-07-03 15:19:37 +0200750 VIRTIO_BLK_F_WCE, VIRTIO_BLK_F_TOPOLOGY, VIRTIO_BLK_F_CONFIG_WCE
Rusty Russellc45a6812008-05-02 21:50:50 -0500751};
752
Greg Kroah-Hartman8d85fce2012-12-21 15:13:49 -0800753static struct virtio_driver virtio_blk = {
Christoph Hellwig7a7c9242011-02-01 21:43:48 +0100754 .feature_table = features,
755 .feature_table_size = ARRAY_SIZE(features),
756 .driver.name = KBUILD_MODNAME,
757 .driver.owner = THIS_MODULE,
758 .id_table = id_table,
759 .probe = virtblk_probe,
Greg Kroah-Hartman8d85fce2012-12-21 15:13:49 -0800760 .remove = virtblk_remove,
Christoph Hellwig7a7c9242011-02-01 21:43:48 +0100761 .config_changed = virtblk_config_changed,
Aaron Lu89107002013-09-17 09:25:23 +0930762#ifdef CONFIG_PM_SLEEP
Amit Shahf8fb5bc2011-12-22 16:58:30 +0530763 .freeze = virtblk_freeze,
764 .restore = virtblk_restore,
765#endif
Rusty Russelle467cde2007-10-22 11:03:38 +1000766};
767
768static int __init init(void)
769{
Christoph Hellwig7a7c9242011-02-01 21:43:48 +0100770 int error;
771
772 virtblk_wq = alloc_workqueue("virtio-blk", 0, 0);
773 if (!virtblk_wq)
774 return -ENOMEM;
775
Christian Borntraeger4f3bf192008-01-31 15:53:53 +0100776 major = register_blkdev(0, "virtblk");
Christoph Hellwig7a7c9242011-02-01 21:43:48 +0100777 if (major < 0) {
778 error = major;
779 goto out_destroy_workqueue;
780 }
781
782 error = register_virtio_driver(&virtio_blk);
783 if (error)
784 goto out_unregister_blkdev;
785 return 0;
786
787out_unregister_blkdev:
788 unregister_blkdev(major, "virtblk");
789out_destroy_workqueue:
790 destroy_workqueue(virtblk_wq);
791 return error;
Rusty Russelle467cde2007-10-22 11:03:38 +1000792}
793
794static void __exit fini(void)
795{
Christian Borntraeger4f3bf192008-01-31 15:53:53 +0100796 unregister_blkdev(major, "virtblk");
Rusty Russelle467cde2007-10-22 11:03:38 +1000797 unregister_virtio_driver(&virtio_blk);
Christoph Hellwig7a7c9242011-02-01 21:43:48 +0100798 destroy_workqueue(virtblk_wq);
Rusty Russelle467cde2007-10-22 11:03:38 +1000799}
800module_init(init);
801module_exit(fini);
802
803MODULE_DEVICE_TABLE(virtio, id_table);
804MODULE_DESCRIPTION("Virtio block driver");
805MODULE_LICENSE("GPL");