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