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