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