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