]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/block/virtio_blk.c
locking/atomic, kref: Add KREF_INIT()
[mirror_ubuntu-bionic-kernel.git] / drivers / block / virtio_blk.c
CommitLineData
e467cde2
RR
1//#define DEBUG
2#include <linux/spinlock.h>
5a0e3ad6 3#include <linux/slab.h>
e467cde2
RR
4#include <linux/blkdev.h>
5#include <linux/hdreg.h>
0c8d44f2 6#include <linux/module.h>
4678d6f9 7#include <linux/mutex.h>
e467cde2
RR
8#include <linux/virtio.h>
9#include <linux/virtio_blk.h>
3d1266c7 10#include <linux/scatterlist.h>
7a7c924c 11#include <linux/string_helpers.h>
6917f83f 12#include <scsi/scsi_cmnd.h>
5087a50e 13#include <linux/idr.h>
1cf7e9c6
JA
14#include <linux/blk-mq.h>
15#include <linux/numa.h>
3d1266c7 16
4f3bf19c 17#define PART_BITS 4
6a27b656 18#define VQ_NAME_LEN 16
e467cde2 19
5087a50e
MT
20static int major;
21static DEFINE_IDA(vd_index_ida);
22
2a647bfe 23static struct workqueue_struct *virtblk_wq;
4f3bf19c 24
6a27b656
ML
25struct virtio_blk_vq {
26 struct virtqueue *vq;
27 spinlock_t lock;
28 char name[VQ_NAME_LEN];
29} ____cacheline_aligned_in_smp;
30
bb6ec576 31struct virtio_blk {
e467cde2 32 struct virtio_device *vdev;
e467cde2
RR
33
34 /* The disk structure for the kernel. */
35 struct gendisk *disk;
36
24d2f903
CH
37 /* Block layer tags. */
38 struct blk_mq_tag_set tag_set;
39
7a7c924c
CH
40 /* Process context for config space updates */
41 struct work_struct config_work;
42
0864b79a
RR
43 /* What host tells us, plus 2 for header & tailer. */
44 unsigned int sg_elems;
45
5087a50e
MT
46 /* Ida index - used to track minor number allocations. */
47 int index;
6a27b656
ML
48
49 /* num of vqs */
50 int num_vqs;
51 struct virtio_blk_vq *vqs;
e467cde2
RR
52};
53
bb6ec576 54struct virtblk_req {
e467cde2
RR
55 struct request *req;
56 struct virtio_blk_outhdr out_hdr;
1cde26f9 57 struct virtio_scsi_inhdr in_hdr;
cb38fa23 58 u8 status;
a98755c5 59 struct scatterlist sg[];
e467cde2
RR
60};
61
a98755c5
AH
62static inline int virtblk_result(struct virtblk_req *vbr)
63{
64 switch (vbr->status) {
65 case VIRTIO_BLK_S_OK:
66 return 0;
67 case VIRTIO_BLK_S_UNSUPP:
68 return -ENOTTY;
69 default:
70 return -EIO;
71 }
72}
73
8f39db9d 74static int __virtblk_add_req(struct virtqueue *vq,
20af3cfd
PB
75 struct virtblk_req *vbr,
76 struct scatterlist *data_sg,
0a11cc36 77 bool have_data)
c85a1f91 78{
20af3cfd 79 struct scatterlist hdr, status, cmd, sense, inhdr, *sgs[6];
8f39db9d 80 unsigned int num_out = 0, num_in = 0;
19c1c5a6 81 __virtio32 type = vbr->out_hdr.type & ~cpu_to_virtio32(vq->vdev, VIRTIO_BLK_T_OUT);
8f39db9d
PB
82
83 sg_init_one(&hdr, &vbr->out_hdr, sizeof(vbr->out_hdr));
84 sgs[num_out++] = &hdr;
85
20af3cfd
PB
86 /*
87 * If this is a packet command we need a couple of additional headers.
88 * Behind the normal outhdr we put a segment with the scsi command
89 * block, and before the normal inhdr we put the sense data and the
90 * inhdr with additional status information.
91 */
19c1c5a6 92 if (type == cpu_to_virtio32(vq->vdev, VIRTIO_BLK_T_SCSI_CMD)) {
20af3cfd
PB
93 sg_init_one(&cmd, vbr->req->cmd, vbr->req->cmd_len);
94 sgs[num_out++] = &cmd;
95 }
96
0a11cc36 97 if (have_data) {
19c1c5a6 98 if (vbr->out_hdr.type & cpu_to_virtio32(vq->vdev, VIRTIO_BLK_T_OUT))
20af3cfd 99 sgs[num_out++] = data_sg;
8f39db9d 100 else
20af3cfd
PB
101 sgs[num_out + num_in++] = data_sg;
102 }
103
19c1c5a6 104 if (type == cpu_to_virtio32(vq->vdev, VIRTIO_BLK_T_SCSI_CMD)) {
20af3cfd
PB
105 sg_init_one(&sense, vbr->req->sense, SCSI_SENSE_BUFFERSIZE);
106 sgs[num_out + num_in++] = &sense;
107 sg_init_one(&inhdr, &vbr->in_hdr, sizeof(vbr->in_hdr));
108 sgs[num_out + num_in++] = &inhdr;
8f39db9d
PB
109 }
110
111 sg_init_one(&status, &vbr->status, sizeof(vbr->status));
112 sgs[num_out + num_in++] = &status;
113
114 return virtqueue_add_sgs(vq, sgs, num_out, num_in, vbr, GFP_ATOMIC);
5ee21a52
PB
115}
116
5124c285 117static inline void virtblk_request_done(struct request *req)
a98755c5 118{
9d74e257 119 struct virtblk_req *vbr = blk_mq_rq_to_pdu(req);
19c1c5a6 120 struct virtio_blk *vblk = req->q->queuedata;
a98755c5
AH
121 int error = virtblk_result(vbr);
122
123 if (req->cmd_type == REQ_TYPE_BLOCK_PC) {
19c1c5a6
MT
124 req->resid_len = virtio32_to_cpu(vblk->vdev, vbr->in_hdr.residual);
125 req->sense_len = virtio32_to_cpu(vblk->vdev, vbr->in_hdr.sense_len);
126 req->errors = virtio32_to_cpu(vblk->vdev, vbr->in_hdr.errors);
4f8c9510 127 } else if (req->cmd_type == REQ_TYPE_DRV_PRIV) {
a98755c5
AH
128 req->errors = (error != 0);
129 }
130
c8a446ad 131 blk_mq_end_request(req, error);
a98755c5
AH
132}
133
134static void virtblk_done(struct virtqueue *vq)
e467cde2
RR
135{
136 struct virtio_blk *vblk = vq->vdev->priv;
1cf7e9c6 137 bool req_done = false;
6a27b656 138 int qid = vq->index;
e467cde2 139 struct virtblk_req *vbr;
e467cde2 140 unsigned long flags;
a98755c5 141 unsigned int len;
e467cde2 142
6a27b656 143 spin_lock_irqsave(&vblk->vqs[qid].lock, flags);
bb811108
AH
144 do {
145 virtqueue_disable_cb(vq);
6a27b656 146 while ((vbr = virtqueue_get_buf(vblk->vqs[qid].vq, &len)) != NULL) {
f4829a9b 147 blk_mq_complete_request(vbr->req, vbr->req->errors);
1cf7e9c6 148 req_done = true;
33659ebb 149 }
7f03b17d
HG
150 if (unlikely(virtqueue_is_broken(vq)))
151 break;
bb811108 152 } while (!virtqueue_enable_cb(vq));
1cf7e9c6 153
e467cde2 154 /* In case queue is stopped waiting for more buffers. */
a98755c5 155 if (req_done)
1b4a3258 156 blk_mq_start_stopped_hw_queues(vblk->disk->queue, true);
6a27b656 157 spin_unlock_irqrestore(&vblk->vqs[qid].lock, flags);
a98755c5
AH
158}
159
74c45052
JA
160static int virtio_queue_rq(struct blk_mq_hw_ctx *hctx,
161 const struct blk_mq_queue_data *bd)
e467cde2 162{
1cf7e9c6 163 struct virtio_blk *vblk = hctx->queue->queuedata;
74c45052 164 struct request *req = bd->rq;
9d74e257 165 struct virtblk_req *vbr = blk_mq_rq_to_pdu(req);
1cf7e9c6 166 unsigned long flags;
20af3cfd 167 unsigned int num;
6a27b656 168 int qid = hctx->queue_num;
5261b85e 169 int err;
e8edca6f 170 bool notify = false;
e467cde2 171
1cf7e9c6 172 BUG_ON(req->nr_phys_segments + 2 > vblk->sg_elems);
e467cde2
RR
173
174 vbr->req = req;
3a5e02ce 175 if (req_op(req) == REQ_OP_FLUSH) {
19c1c5a6 176 vbr->out_hdr.type = cpu_to_virtio32(vblk->vdev, VIRTIO_BLK_T_FLUSH);
4cb2ea28 177 vbr->out_hdr.sector = 0;
19c1c5a6 178 vbr->out_hdr.ioprio = cpu_to_virtio32(vblk->vdev, req_get_ioprio(vbr->req));
dd40e456
FT
179 } else {
180 switch (req->cmd_type) {
181 case REQ_TYPE_FS:
182 vbr->out_hdr.type = 0;
19c1c5a6
MT
183 vbr->out_hdr.sector = cpu_to_virtio64(vblk->vdev, blk_rq_pos(vbr->req));
184 vbr->out_hdr.ioprio = cpu_to_virtio32(vblk->vdev, req_get_ioprio(vbr->req));
dd40e456
FT
185 break;
186 case REQ_TYPE_BLOCK_PC:
19c1c5a6 187 vbr->out_hdr.type = cpu_to_virtio32(vblk->vdev, VIRTIO_BLK_T_SCSI_CMD);
f1b0ef06 188 vbr->out_hdr.sector = 0;
19c1c5a6 189 vbr->out_hdr.ioprio = cpu_to_virtio32(vblk->vdev, req_get_ioprio(vbr->req));
f1b0ef06 190 break;
4f8c9510 191 case REQ_TYPE_DRV_PRIV:
19c1c5a6 192 vbr->out_hdr.type = cpu_to_virtio32(vblk->vdev, VIRTIO_BLK_T_GET_ID);
dd40e456 193 vbr->out_hdr.sector = 0;
19c1c5a6 194 vbr->out_hdr.ioprio = cpu_to_virtio32(vblk->vdev, req_get_ioprio(vbr->req));
dd40e456
FT
195 break;
196 default:
197 /* We don't put anything else in the queue. */
198 BUG();
f1b0ef06 199 }
e467cde2
RR
200 }
201
e2490073
CH
202 blk_mq_start_request(req);
203
1cf7e9c6 204 num = blk_rq_map_sg(hctx->queue, vbr->req, vbr->sg);
1cde26f9 205 if (num) {
20af3cfd 206 if (rq_data_dir(vbr->req) == WRITE)
19c1c5a6 207 vbr->out_hdr.type |= cpu_to_virtio32(vblk->vdev, VIRTIO_BLK_T_OUT);
20af3cfd 208 else
19c1c5a6 209 vbr->out_hdr.type |= cpu_to_virtio32(vblk->vdev, VIRTIO_BLK_T_IN);
e467cde2
RR
210 }
211
6a27b656
ML
212 spin_lock_irqsave(&vblk->vqs[qid].lock, flags);
213 err = __virtblk_add_req(vblk->vqs[qid].vq, vbr, vbr->sg, num);
5261b85e 214 if (err) {
6a27b656 215 virtqueue_kick(vblk->vqs[qid].vq);
1cf7e9c6 216 blk_mq_stop_hw_queue(hctx);
6a27b656 217 spin_unlock_irqrestore(&vblk->vqs[qid].lock, flags);
5261b85e
RR
218 /* Out of mem doesn't actually happen, since we fall back
219 * to direct descriptors */
220 if (err == -ENOMEM || err == -ENOSPC)
221 return BLK_MQ_RQ_QUEUE_BUSY;
222 return BLK_MQ_RQ_QUEUE_ERROR;
a98755c5
AH
223 }
224
74c45052 225 if (bd->last && virtqueue_kick_prepare(vblk->vqs[qid].vq))
e8edca6f 226 notify = true;
6a27b656 227 spin_unlock_irqrestore(&vblk->vqs[qid].lock, flags);
e8edca6f
ML
228
229 if (notify)
6a27b656 230 virtqueue_notify(vblk->vqs[qid].vq);
1cf7e9c6 231 return BLK_MQ_RQ_QUEUE_OK;
a98755c5
AH
232}
233
4cb2ea28 234/* return id (s/n) string for *disk to *id_str
235 */
236static int virtblk_get_id(struct gendisk *disk, char *id_str)
237{
238 struct virtio_blk *vblk = disk->private_data;
f9596695 239 struct request_queue *q = vblk->disk->queue;
4cb2ea28 240 struct request *req;
e4c4776d 241 int err;
4cb2ea28 242
f9596695
CH
243 req = blk_get_request(q, READ, GFP_KERNEL);
244 if (IS_ERR(req))
4cb2ea28 245 return PTR_ERR(req);
4f8c9510 246 req->cmd_type = REQ_TYPE_DRV_PRIV;
f9596695
CH
247
248 err = blk_rq_map_kern(q, req, id_str, VIRTIO_BLK_ID_BYTES, GFP_KERNEL);
249 if (err)
250 goto out;
251
e4c4776d 252 err = blk_execute_rq(vblk->disk->queue, vblk->disk, req, false);
f9596695 253out:
e4c4776d 254 blk_put_request(req);
e4c4776d 255 return err;
4cb2ea28 256}
257
fe5a50a1
CH
258static int virtblk_ioctl(struct block_device *bdev, fmode_t mode,
259 unsigned int cmd, unsigned long data)
e467cde2 260{
1cde26f9
HR
261 struct gendisk *disk = bdev->bd_disk;
262 struct virtio_blk *vblk = disk->private_data;
263
264 /*
265 * Only allow the generic SCSI ioctls if the host can support it.
266 */
267 if (!virtio_has_feature(vblk->vdev, VIRTIO_BLK_F_SCSI))
d9ecdea7 268 return -ENOTTY;
1cde26f9 269
577ebb37
PB
270 return scsi_cmd_blk_ioctl(bdev, mode, cmd,
271 (void __user *)data);
e467cde2
RR
272}
273
135da0b0
CB
274/* We provide getgeo only to please some old bootloader/partitioning tools */
275static int virtblk_getgeo(struct block_device *bd, struct hd_geometry *geo)
276{
48e4043d 277 struct virtio_blk *vblk = bd->bd_disk->private_data;
48e4043d
RH
278
279 /* see if the host passed in geometry config */
855e0c52
RR
280 if (virtio_has_feature(vblk->vdev, VIRTIO_BLK_F_GEOMETRY)) {
281 virtio_cread(vblk->vdev, struct virtio_blk_config,
282 geometry.cylinders, &geo->cylinders);
283 virtio_cread(vblk->vdev, struct virtio_blk_config,
284 geometry.heads, &geo->heads);
285 virtio_cread(vblk->vdev, struct virtio_blk_config,
286 geometry.sectors, &geo->sectors);
48e4043d
RH
287 } else {
288 /* some standard values, similar to sd */
289 geo->heads = 1 << 6;
290 geo->sectors = 1 << 5;
291 geo->cylinders = get_capacity(bd->bd_disk) >> 11;
292 }
135da0b0
CB
293 return 0;
294}
295
83d5cde4 296static const struct block_device_operations virtblk_fops = {
8a6cfeb6 297 .ioctl = virtblk_ioctl,
135da0b0
CB
298 .owner = THIS_MODULE,
299 .getgeo = virtblk_getgeo,
e467cde2
RR
300};
301
d50ed907
CB
302static int index_to_minor(int index)
303{
304 return index << PART_BITS;
305}
306
5087a50e
MT
307static int minor_to_index(int minor)
308{
309 return minor >> PART_BITS;
310}
311
a5eb9e4f
RH
312static ssize_t virtblk_serial_show(struct device *dev,
313 struct device_attribute *attr, char *buf)
314{
315 struct gendisk *disk = dev_to_disk(dev);
316 int err;
317
318 /* sysfs gives us a PAGE_SIZE buffer */
319 BUILD_BUG_ON(PAGE_SIZE < VIRTIO_BLK_ID_BYTES);
320
321 buf[VIRTIO_BLK_ID_BYTES] = '\0';
322 err = virtblk_get_id(disk, buf);
323 if (!err)
324 return strlen(buf);
325
326 if (err == -EIO) /* Unsupported? Make it empty. */
327 return 0;
328
329 return err;
330}
393c525b
MT
331
332static DEVICE_ATTR(serial, S_IRUGO, virtblk_serial_show, NULL);
a5eb9e4f 333
7a7c924c
CH
334static void virtblk_config_changed_work(struct work_struct *work)
335{
336 struct virtio_blk *vblk =
337 container_of(work, struct virtio_blk, config_work);
338 struct virtio_device *vdev = vblk->vdev;
339 struct request_queue *q = vblk->disk->queue;
340 char cap_str_2[10], cap_str_10[10];
9d9598b8 341 char *envp[] = { "RESIZE=1", NULL };
b9f28d86 342 u64 capacity;
7a7c924c
CH
343
344 /* Host must always specify the capacity. */
855e0c52 345 virtio_cread(vdev, struct virtio_blk_config, capacity, &capacity);
7a7c924c
CH
346
347 /* If capacity is too big, truncate with warning. */
348 if ((sector_t)capacity != capacity) {
349 dev_warn(&vdev->dev, "Capacity %llu too large: truncating\n",
350 (unsigned long long)capacity);
351 capacity = (sector_t)-1;
352 }
353
b9f28d86
JB
354 string_get_size(capacity, queue_logical_block_size(q),
355 STRING_UNITS_2, cap_str_2, sizeof(cap_str_2));
356 string_get_size(capacity, queue_logical_block_size(q),
357 STRING_UNITS_10, cap_str_10, sizeof(cap_str_10));
7a7c924c
CH
358
359 dev_notice(&vdev->dev,
360 "new size: %llu %d-byte logical blocks (%s/%s)\n",
361 (unsigned long long)capacity,
362 queue_logical_block_size(q),
363 cap_str_10, cap_str_2);
364
365 set_capacity(vblk->disk, capacity);
e9986f30 366 revalidate_disk(vblk->disk);
9d9598b8 367 kobject_uevent_env(&disk_to_dev(vblk->disk)->kobj, KOBJ_CHANGE, envp);
7a7c924c
CH
368}
369
370static void virtblk_config_changed(struct virtio_device *vdev)
371{
372 struct virtio_blk *vblk = vdev->priv;
373
374 queue_work(virtblk_wq, &vblk->config_work);
375}
376
6abd6e5a
AS
377static int init_vq(struct virtio_blk *vblk)
378{
2ff98449 379 int err;
6a27b656
ML
380 int i;
381 vq_callback_t **callbacks;
382 const char **names;
383 struct virtqueue **vqs;
384 unsigned short num_vqs;
385 struct virtio_device *vdev = vblk->vdev;
386
387 err = virtio_cread_feature(vdev, VIRTIO_BLK_F_MQ,
388 struct virtio_blk_config, num_queues,
389 &num_vqs);
390 if (err)
391 num_vqs = 1;
392
668866b6 393 vblk->vqs = kmalloc_array(num_vqs, sizeof(*vblk->vqs), GFP_KERNEL);
347a5293
MH
394 if (!vblk->vqs)
395 return -ENOMEM;
6a27b656 396
668866b6
ME
397 names = kmalloc_array(num_vqs, sizeof(*names), GFP_KERNEL);
398 callbacks = kmalloc_array(num_vqs, sizeof(*callbacks), GFP_KERNEL);
399 vqs = kmalloc_array(num_vqs, sizeof(*vqs), GFP_KERNEL);
347a5293
MH
400 if (!names || !callbacks || !vqs) {
401 err = -ENOMEM;
402 goto out;
403 }
6abd6e5a 404
6a27b656
ML
405 for (i = 0; i < num_vqs; i++) {
406 callbacks[i] = virtblk_done;
407 snprintf(vblk->vqs[i].name, VQ_NAME_LEN, "req.%d", i);
408 names[i] = vblk->vqs[i].name;
409 }
410
411 /* Discover virtqueues and write information to configuration. */
412 err = vdev->config->find_vqs(vdev, num_vqs, vqs, callbacks, names);
413 if (err)
347a5293 414 goto out;
6abd6e5a 415
6a27b656
ML
416 for (i = 0; i < num_vqs; i++) {
417 spin_lock_init(&vblk->vqs[i].lock);
418 vblk->vqs[i].vq = vqs[i];
419 }
420 vblk->num_vqs = num_vqs;
421
347a5293 422out:
6a27b656 423 kfree(vqs);
6a27b656 424 kfree(callbacks);
6a27b656 425 kfree(names);
6a27b656
ML
426 if (err)
427 kfree(vblk->vqs);
6abd6e5a
AS
428 return err;
429}
430
c0aa3e09
RM
431/*
432 * Legacy naming scheme used for virtio devices. We are stuck with it for
433 * virtio blk but don't ever use it for any new driver.
434 */
435static int virtblk_name_format(char *prefix, int index, char *buf, int buflen)
436{
437 const int base = 'z' - 'a' + 1;
438 char *begin = buf + strlen(prefix);
439 char *end = buf + buflen;
440 char *p;
441 int unit;
442
443 p = end - 1;
444 *p = '\0';
445 unit = base;
446 do {
447 if (p == begin)
448 return -EINVAL;
449 *--p = 'a' + (index % unit);
450 index = (index / unit) - 1;
451 } while (index >= 0);
452
453 memmove(begin, p, end - p);
454 memcpy(buf, prefix, strlen(prefix));
455
456 return 0;
457}
458
cd5d5038
PB
459static int virtblk_get_cache_mode(struct virtio_device *vdev)
460{
461 u8 writeback;
462 int err;
463
855e0c52
RR
464 err = virtio_cread_feature(vdev, VIRTIO_BLK_F_CONFIG_WCE,
465 struct virtio_blk_config, wce,
466 &writeback);
592002f5
MT
467
468 /*
469 * If WCE is not configurable and flush is not available,
470 * assume no writeback cache is in use.
471 */
cd5d5038 472 if (err)
592002f5 473 writeback = virtio_has_feature(vdev, VIRTIO_BLK_F_FLUSH);
cd5d5038
PB
474
475 return writeback;
476}
477
478static void virtblk_update_cache_mode(struct virtio_device *vdev)
479{
480 u8 writeback = virtblk_get_cache_mode(vdev);
481 struct virtio_blk *vblk = vdev->priv;
482
ad9126ac 483 blk_queue_write_cache(vblk->disk->queue, writeback, false);
cd5d5038
PB
484 revalidate_disk(vblk->disk);
485}
486
487static const char *const virtblk_cache_types[] = {
488 "write through", "write back"
489};
490
491static ssize_t
492virtblk_cache_type_store(struct device *dev, struct device_attribute *attr,
493 const char *buf, size_t count)
494{
495 struct gendisk *disk = dev_to_disk(dev);
496 struct virtio_blk *vblk = disk->private_data;
497 struct virtio_device *vdev = vblk->vdev;
498 int i;
cd5d5038
PB
499
500 BUG_ON(!virtio_has_feature(vblk->vdev, VIRTIO_BLK_F_CONFIG_WCE));
501 for (i = ARRAY_SIZE(virtblk_cache_types); --i >= 0; )
502 if (sysfs_streq(buf, virtblk_cache_types[i]))
503 break;
504
505 if (i < 0)
506 return -EINVAL;
507
855e0c52 508 virtio_cwrite8(vdev, offsetof(struct virtio_blk_config, wce), i);
cd5d5038
PB
509 virtblk_update_cache_mode(vdev);
510 return count;
511}
512
513static ssize_t
514virtblk_cache_type_show(struct device *dev, struct device_attribute *attr,
515 char *buf)
516{
517 struct gendisk *disk = dev_to_disk(dev);
518 struct virtio_blk *vblk = disk->private_data;
519 u8 writeback = virtblk_get_cache_mode(vblk->vdev);
520
521 BUG_ON(writeback >= ARRAY_SIZE(virtblk_cache_types));
522 return snprintf(buf, 40, "%s\n", virtblk_cache_types[writeback]);
523}
524
525static const struct device_attribute dev_attr_cache_type_ro =
526 __ATTR(cache_type, S_IRUGO,
527 virtblk_cache_type_show, NULL);
528static const struct device_attribute dev_attr_cache_type_rw =
529 __ATTR(cache_type, S_IRUGO|S_IWUSR,
530 virtblk_cache_type_show, virtblk_cache_type_store);
531
24d2f903
CH
532static int virtblk_init_request(void *data, struct request *rq,
533 unsigned int hctx_idx, unsigned int request_idx,
534 unsigned int numa_node)
e9b267d9
CH
535{
536 struct virtio_blk *vblk = data;
537 struct virtblk_req *vbr = blk_mq_rq_to_pdu(rq);
538
539 sg_init_table(vbr->sg, vblk->sg_elems);
540 return 0;
541}
542
1cf7e9c6
JA
543static struct blk_mq_ops virtio_mq_ops = {
544 .queue_rq = virtio_queue_rq,
5124c285 545 .complete = virtblk_request_done,
24d2f903 546 .init_request = virtblk_init_request,
1cf7e9c6
JA
547};
548
24d2f903
CH
549static unsigned int virtblk_queue_depth;
550module_param_named(queue_depth, virtblk_queue_depth, uint, 0444);
1cf7e9c6 551
8d85fce7 552static int virtblk_probe(struct virtio_device *vdev)
e467cde2
RR
553{
554 struct virtio_blk *vblk;
69740c8b 555 struct request_queue *q;
5087a50e 556 int err, index;
a98755c5 557
e467cde2 558 u64 cap;
69740c8b
CH
559 u32 v, blk_size, sg_elems, opt_io_size;
560 u16 min_io_size;
561 u8 physical_block_exp, alignment_offset;
e467cde2 562
a4379fd8
MT
563 if (!vdev->config->get) {
564 dev_err(&vdev->dev, "%s failure: config access disabled\n",
565 __func__);
566 return -EINVAL;
567 }
568
5087a50e
MT
569 err = ida_simple_get(&vd_index_ida, 0, minor_to_index(1 << MINORBITS),
570 GFP_KERNEL);
571 if (err < 0)
572 goto out;
573 index = err;
4f3bf19c 574
0864b79a 575 /* We need to know how many segments before we allocate. */
855e0c52
RR
576 err = virtio_cread_feature(vdev, VIRTIO_BLK_F_SEG_MAX,
577 struct virtio_blk_config, seg_max,
578 &sg_elems);
a5b365a6
CH
579
580 /* We need at least one SG element, whatever they say. */
581 if (err || !sg_elems)
0864b79a
RR
582 sg_elems = 1;
583
584 /* We need an extra sg elements at head and tail. */
585 sg_elems += 2;
1cf7e9c6 586 vdev->priv = vblk = kmalloc(sizeof(*vblk), GFP_KERNEL);
e467cde2
RR
587 if (!vblk) {
588 err = -ENOMEM;
5087a50e 589 goto out_free_index;
e467cde2
RR
590 }
591
e467cde2 592 vblk->vdev = vdev;
0864b79a 593 vblk->sg_elems = sg_elems;
a98755c5 594
7a7c924c 595 INIT_WORK(&vblk->config_work, virtblk_config_changed_work);
e467cde2 596
6abd6e5a
AS
597 err = init_vq(vblk);
598 if (err)
e467cde2 599 goto out_free_vblk;
e467cde2 600
e467cde2 601 /* FIXME: How many partitions? How long is a piece of string? */
4f3bf19c 602 vblk->disk = alloc_disk(1 << PART_BITS);
e467cde2
RR
603 if (!vblk->disk) {
604 err = -ENOMEM;
1cf7e9c6 605 goto out_free_vq;
e467cde2
RR
606 }
607
fc4324b4 608 /* Default queue sizing is to fill the ring. */
24d2f903 609 if (!virtblk_queue_depth) {
6a27b656 610 virtblk_queue_depth = vblk->vqs[0].vq->num_free;
fc4324b4
RR
611 /* ... but without indirect descs, we use 2 descs per req */
612 if (!virtio_has_feature(vdev, VIRTIO_RING_F_INDIRECT_DESC))
24d2f903 613 virtblk_queue_depth /= 2;
fc4324b4 614 }
24d2f903
CH
615
616 memset(&vblk->tag_set, 0, sizeof(vblk->tag_set));
617 vblk->tag_set.ops = &virtio_mq_ops;
24d2f903
CH
618 vblk->tag_set.queue_depth = virtblk_queue_depth;
619 vblk->tag_set.numa_node = NUMA_NO_NODE;
620 vblk->tag_set.flags = BLK_MQ_F_SHOULD_MERGE;
621 vblk->tag_set.cmd_size =
1cf7e9c6
JA
622 sizeof(struct virtblk_req) +
623 sizeof(struct scatterlist) * sg_elems;
24d2f903 624 vblk->tag_set.driver_data = vblk;
6a27b656 625 vblk->tag_set.nr_hw_queues = vblk->num_vqs;
1cf7e9c6 626
24d2f903
CH
627 err = blk_mq_alloc_tag_set(&vblk->tag_set);
628 if (err)
629 goto out_put_disk;
630
631 q = vblk->disk->queue = blk_mq_init_queue(&vblk->tag_set);
35b489d3 632 if (IS_ERR(q)) {
e467cde2 633 err = -ENOMEM;
24d2f903 634 goto out_free_tags;
e467cde2
RR
635 }
636
69740c8b 637 q->queuedata = vblk;
7d116b62 638
c0aa3e09 639 virtblk_name_format("vd", index, vblk->disk->disk_name, DISK_NAME_LEN);
d50ed907 640
e467cde2 641 vblk->disk->major = major;
d50ed907 642 vblk->disk->first_minor = index_to_minor(index);
e467cde2
RR
643 vblk->disk->private_data = vblk;
644 vblk->disk->fops = &virtblk_fops;
5fa3142d 645 vblk->disk->flags |= GENHD_FL_EXT_DEVT;
5087a50e 646 vblk->index = index;
4f3bf19c 647
02c42b7a 648 /* configure queue flush support */
cd5d5038 649 virtblk_update_cache_mode(vdev);
e467cde2 650
3ef53609
CB
651 /* If disk is read-only in the host, the guest should obey */
652 if (virtio_has_feature(vdev, VIRTIO_BLK_F_RO))
653 set_disk_ro(vblk->disk, 1);
654
a586d4f6 655 /* Host must always specify the capacity. */
855e0c52 656 virtio_cread(vdev, struct virtio_blk_config, capacity, &cap);
e467cde2
RR
657
658 /* If capacity is too big, truncate with warning. */
659 if ((sector_t)cap != cap) {
660 dev_warn(&vdev->dev, "Capacity %llu too large: truncating\n",
661 (unsigned long long)cap);
662 cap = (sector_t)-1;
663 }
664 set_capacity(vblk->disk, cap);
665
0864b79a 666 /* We can handle whatever the host told us to handle. */
ee714f2d 667 blk_queue_max_segments(q, vblk->sg_elems-2);
0864b79a 668
4eff3cae 669 /* No need to bounce any requests */
69740c8b 670 blk_queue_bounce_limit(q, BLK_BOUNCE_ANY);
4eff3cae 671
4b7f7e20 672 /* No real sector limit. */
ee714f2d 673 blk_queue_max_hw_sectors(q, -1U);
4b7f7e20 674
a586d4f6
RR
675 /* Host can optionally specify maximum segment size and number of
676 * segments. */
855e0c52
RR
677 err = virtio_cread_feature(vdev, VIRTIO_BLK_F_SIZE_MAX,
678 struct virtio_blk_config, size_max, &v);
e467cde2 679 if (!err)
69740c8b 680 blk_queue_max_segment_size(q, v);
4b7f7e20 681 else
69740c8b 682 blk_queue_max_segment_size(q, -1U);
e467cde2 683
066f4d82 684 /* Host can optionally specify the block size of the device */
855e0c52
RR
685 err = virtio_cread_feature(vdev, VIRTIO_BLK_F_BLK_SIZE,
686 struct virtio_blk_config, blk_size,
687 &blk_size);
066f4d82 688 if (!err)
69740c8b
CH
689 blk_queue_logical_block_size(q, blk_size);
690 else
691 blk_size = queue_logical_block_size(q);
692
693 /* Use topology information if available */
855e0c52
RR
694 err = virtio_cread_feature(vdev, VIRTIO_BLK_F_TOPOLOGY,
695 struct virtio_blk_config, physical_block_exp,
696 &physical_block_exp);
69740c8b
CH
697 if (!err && physical_block_exp)
698 blk_queue_physical_block_size(q,
699 blk_size * (1 << physical_block_exp));
700
855e0c52
RR
701 err = virtio_cread_feature(vdev, VIRTIO_BLK_F_TOPOLOGY,
702 struct virtio_blk_config, alignment_offset,
703 &alignment_offset);
69740c8b
CH
704 if (!err && alignment_offset)
705 blk_queue_alignment_offset(q, blk_size * alignment_offset);
706
855e0c52
RR
707 err = virtio_cread_feature(vdev, VIRTIO_BLK_F_TOPOLOGY,
708 struct virtio_blk_config, min_io_size,
709 &min_io_size);
69740c8b
CH
710 if (!err && min_io_size)
711 blk_queue_io_min(q, blk_size * min_io_size);
712
855e0c52
RR
713 err = virtio_cread_feature(vdev, VIRTIO_BLK_F_TOPOLOGY,
714 struct virtio_blk_config, opt_io_size,
715 &opt_io_size);
69740c8b
CH
716 if (!err && opt_io_size)
717 blk_queue_io_opt(q, blk_size * opt_io_size);
718
7a11370e
MT
719 virtio_device_ready(vdev);
720
0d52c756 721 device_add_disk(&vdev->dev, vblk->disk);
a5eb9e4f
RH
722 err = device_create_file(disk_to_dev(vblk->disk), &dev_attr_serial);
723 if (err)
724 goto out_del_disk;
725
cd5d5038
PB
726 if (virtio_has_feature(vdev, VIRTIO_BLK_F_CONFIG_WCE))
727 err = device_create_file(disk_to_dev(vblk->disk),
728 &dev_attr_cache_type_rw);
729 else
730 err = device_create_file(disk_to_dev(vblk->disk),
731 &dev_attr_cache_type_ro);
732 if (err)
733 goto out_del_disk;
e467cde2
RR
734 return 0;
735
a5eb9e4f
RH
736out_del_disk:
737 del_gendisk(vblk->disk);
738 blk_cleanup_queue(vblk->disk->queue);
24d2f903
CH
739out_free_tags:
740 blk_mq_free_tag_set(&vblk->tag_set);
e467cde2
RR
741out_put_disk:
742 put_disk(vblk->disk);
e467cde2 743out_free_vq:
d2a7ddda 744 vdev->config->del_vqs(vdev);
e467cde2
RR
745out_free_vblk:
746 kfree(vblk);
5087a50e
MT
747out_free_index:
748 ida_simple_remove(&vd_index_ida, index);
e467cde2
RR
749out:
750 return err;
751}
752
8d85fce7 753static void virtblk_remove(struct virtio_device *vdev)
e467cde2
RR
754{
755 struct virtio_blk *vblk = vdev->priv;
5087a50e 756 int index = vblk->index;
f4953fe6 757 int refc;
e467cde2 758
cc74f719
MT
759 /* Make sure no work handler is accessing the device. */
760 flush_work(&vblk->config_work);
7a7c924c 761
02e2b124 762 del_gendisk(vblk->disk);
483001c7 763 blk_cleanup_queue(vblk->disk->queue);
02e2b124 764
24d2f903
CH
765 blk_mq_free_tag_set(&vblk->tag_set);
766
6e5aa7ef
RR
767 /* Stop all the virtqueues. */
768 vdev->config->reset(vdev);
769
f4953fe6 770 refc = atomic_read(&disk_to_dev(vblk->disk)->kobj.kref.refcount);
e467cde2 771 put_disk(vblk->disk);
d2a7ddda 772 vdev->config->del_vqs(vdev);
6a27b656 773 kfree(vblk->vqs);
e467cde2 774 kfree(vblk);
f4953fe6
AG
775
776 /* Only free device id if we don't have any users */
777 if (refc == 1)
778 ida_simple_remove(&vd_index_ida, index);
e467cde2
RR
779}
780
89107000 781#ifdef CONFIG_PM_SLEEP
f8fb5bc2
AS
782static int virtblk_freeze(struct virtio_device *vdev)
783{
784 struct virtio_blk *vblk = vdev->priv;
785
786 /* Ensure we don't receive any more interrupts */
787 vdev->config->reset(vdev);
788
cc74f719 789 /* Make sure no work handler is accessing the device. */
f8fb5bc2
AS
790 flush_work(&vblk->config_work);
791
1cf7e9c6 792 blk_mq_stop_hw_queues(vblk->disk->queue);
f8fb5bc2
AS
793
794 vdev->config->del_vqs(vdev);
795 return 0;
796}
797
798static int virtblk_restore(struct virtio_device *vdev)
799{
800 struct virtio_blk *vblk = vdev->priv;
801 int ret;
802
f8fb5bc2 803 ret = init_vq(vdev->priv);
6d62c37f
MT
804 if (ret)
805 return ret;
806
807 virtio_device_ready(vdev);
1cf7e9c6 808
6d62c37f
MT
809 blk_mq_start_stopped_hw_queues(vblk->disk->queue, true);
810 return 0;
f8fb5bc2
AS
811}
812#endif
813
47483e25 814static const struct virtio_device_id id_table[] = {
e467cde2
RR
815 { VIRTIO_ID_BLOCK, VIRTIO_DEV_ANY_ID },
816 { 0 },
817};
818
19c1c5a6 819static unsigned int features_legacy[] = {
02c42b7a
TH
820 VIRTIO_BLK_F_SEG_MAX, VIRTIO_BLK_F_SIZE_MAX, VIRTIO_BLK_F_GEOMETRY,
821 VIRTIO_BLK_F_RO, VIRTIO_BLK_F_BLK_SIZE, VIRTIO_BLK_F_SCSI,
592002f5 822 VIRTIO_BLK_F_FLUSH, VIRTIO_BLK_F_TOPOLOGY, VIRTIO_BLK_F_CONFIG_WCE,
6a27b656 823 VIRTIO_BLK_F_MQ,
19c1c5a6
MT
824}
825;
826static unsigned int features[] = {
827 VIRTIO_BLK_F_SEG_MAX, VIRTIO_BLK_F_SIZE_MAX, VIRTIO_BLK_F_GEOMETRY,
828 VIRTIO_BLK_F_RO, VIRTIO_BLK_F_BLK_SIZE,
592002f5 829 VIRTIO_BLK_F_FLUSH, VIRTIO_BLK_F_TOPOLOGY, VIRTIO_BLK_F_CONFIG_WCE,
19c1c5a6 830 VIRTIO_BLK_F_MQ,
c45a6816
RR
831};
832
8d85fce7 833static struct virtio_driver virtio_blk = {
19c1c5a6
MT
834 .feature_table = features,
835 .feature_table_size = ARRAY_SIZE(features),
836 .feature_table_legacy = features_legacy,
837 .feature_table_size_legacy = ARRAY_SIZE(features_legacy),
838 .driver.name = KBUILD_MODNAME,
839 .driver.owner = THIS_MODULE,
840 .id_table = id_table,
841 .probe = virtblk_probe,
842 .remove = virtblk_remove,
843 .config_changed = virtblk_config_changed,
89107000 844#ifdef CONFIG_PM_SLEEP
19c1c5a6
MT
845 .freeze = virtblk_freeze,
846 .restore = virtblk_restore,
f8fb5bc2 847#endif
e467cde2
RR
848};
849
850static int __init init(void)
851{
7a7c924c
CH
852 int error;
853
854 virtblk_wq = alloc_workqueue("virtio-blk", 0, 0);
855 if (!virtblk_wq)
856 return -ENOMEM;
857
4f3bf19c 858 major = register_blkdev(0, "virtblk");
7a7c924c
CH
859 if (major < 0) {
860 error = major;
861 goto out_destroy_workqueue;
862 }
863
864 error = register_virtio_driver(&virtio_blk);
865 if (error)
866 goto out_unregister_blkdev;
867 return 0;
868
869out_unregister_blkdev:
870 unregister_blkdev(major, "virtblk");
871out_destroy_workqueue:
872 destroy_workqueue(virtblk_wq);
873 return error;
e467cde2
RR
874}
875
876static void __exit fini(void)
877{
878 unregister_virtio_driver(&virtio_blk);
38f37b57 879 unregister_blkdev(major, "virtblk");
7a7c924c 880 destroy_workqueue(virtblk_wq);
e467cde2
RR
881}
882module_init(init);
883module_exit(fini);
884
885MODULE_DEVICE_TABLE(virtio, id_table);
886MODULE_DESCRIPTION("Virtio block driver");
887MODULE_LICENSE("GPL");