drivers/block/virtio_blk.c

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