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