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