virtio_blk.c 20.7 KB
Newer Older
R
Rusty Russell 已提交
1 2
//#define DEBUG
#include <linux/spinlock.h>
3
#include <linux/slab.h>
R
Rusty Russell 已提交
4 5
#include <linux/blkdev.h>
#include <linux/hdreg.h>
6
#include <linux/module.h>
7
#include <linux/mutex.h>
R
Rusty Russell 已提交
8 9
#include <linux/virtio.h>
#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>
J
Jens Axboe 已提交
14 15
#include <linux/blk-mq.h>
#include <linux/numa.h>
16

17
#define PART_BITS 4
R
Rusty Russell 已提交
18

19 20 21
static int major;
static DEFINE_IDA(vd_index_ida);

22
static struct workqueue_struct *virtblk_wq;
23

R
Rusty Russell 已提交
24 25 26 27
struct virtio_blk
{
	struct virtio_device *vdev;
	struct virtqueue *vq;
J
Jens Axboe 已提交
28
	spinlock_t vq_lock;
R
Rusty Russell 已提交
29 30 31 32

	/* The disk structure for the kernel. */
	struct gendisk *disk;

33 34 35
	/* Process context for config space updates */
	struct work_struct config_work;

36 37 38 39 40 41
	/* Lock for config space updates */
	struct mutex config_lock;

	/* enable config space updates */
	bool config_enable;

42 43 44
	/* What host tells us, plus 2 for header & tailer. */
	unsigned int sg_elems;

45 46
	/* Ida index - used to track minor number allocations. */
	int index;
R
Rusty Russell 已提交
47 48 49 50 51 52
};

struct virtblk_req
{
	struct request *req;
	struct virtio_blk_outhdr out_hdr;
53
	struct virtio_scsi_inhdr in_hdr;
54
	u8 status;
55
	struct scatterlist sg[];
R
Rusty Russell 已提交
56 57
};

58 59 60 61 62 63 64 65 66 67 68 69
static inline int virtblk_result(struct virtblk_req *vbr)
{
	switch (vbr->status) {
	case VIRTIO_BLK_S_OK:
		return 0;
	case VIRTIO_BLK_S_UNSUPP:
		return -ENOTTY;
	default:
		return -EIO;
	}
}

70
static int __virtblk_add_req(struct virtqueue *vq,
71 72
			     struct virtblk_req *vbr,
			     struct scatterlist *data_sg,
R
Rusty Russell 已提交
73
			     bool have_data)
74
{
75
	struct scatterlist hdr, status, cmd, sense, inhdr, *sgs[6];
76
	unsigned int num_out = 0, num_in = 0;
77
	int type = vbr->out_hdr.type & ~VIRTIO_BLK_T_OUT;
78 79 80 81

	sg_init_one(&hdr, &vbr->out_hdr, sizeof(vbr->out_hdr));
	sgs[num_out++] = &hdr;

82 83 84 85 86 87 88 89 90 91 92
	/*
	 * If this is a packet command we need a couple of additional headers.
	 * Behind the normal outhdr we put a segment with the scsi command
	 * block, and before the normal inhdr we put the sense data and the
	 * inhdr with additional status information.
	 */
	if (type == VIRTIO_BLK_T_SCSI_CMD) {
		sg_init_one(&cmd, vbr->req->cmd, vbr->req->cmd_len);
		sgs[num_out++] = &cmd;
	}

R
Rusty Russell 已提交
93
	if (have_data) {
94
		if (vbr->out_hdr.type & VIRTIO_BLK_T_OUT)
95
			sgs[num_out++] = data_sg;
96
		else
97 98 99 100 101 102 103 104
			sgs[num_out + num_in++] = data_sg;
	}

	if (type == VIRTIO_BLK_T_SCSI_CMD) {
		sg_init_one(&sense, vbr->req->sense, SCSI_SENSE_BUFFERSIZE);
		sgs[num_out + num_in++] = &sense;
		sg_init_one(&inhdr, &vbr->in_hdr, sizeof(vbr->in_hdr));
		sgs[num_out + num_in++] = &inhdr;
105 106 107 108 109 110
	}

	sg_init_one(&status, &vbr->status, sizeof(vbr->status));
	sgs[num_out + num_in++] = &status;

	return virtqueue_add_sgs(vq, sgs, num_out, num_in, vbr, GFP_ATOMIC);
111 112
}

113
static inline void virtblk_request_done(struct request *req)
114
{
115
	struct virtblk_req *vbr = blk_mq_rq_to_pdu(req);
116 117 118 119 120 121 122 123 124 125
	int error = virtblk_result(vbr);

	if (req->cmd_type == REQ_TYPE_BLOCK_PC) {
		req->resid_len = vbr->in_hdr.residual;
		req->sense_len = vbr->in_hdr.sense_len;
		req->errors = vbr->in_hdr.errors;
	} else if (req->cmd_type == REQ_TYPE_SPECIAL) {
		req->errors = (error != 0);
	}

J
Jens Axboe 已提交
126
	blk_mq_end_io(req, error);
127 128 129
}

static void virtblk_done(struct virtqueue *vq)
R
Rusty Russell 已提交
130 131
{
	struct virtio_blk *vblk = vq->vdev->priv;
J
Jens Axboe 已提交
132
	bool req_done = false;
R
Rusty Russell 已提交
133 134
	struct virtblk_req *vbr;
	unsigned long flags;
135
	unsigned int len;
R
Rusty Russell 已提交
136

J
Jens Axboe 已提交
137
	spin_lock_irqsave(&vblk->vq_lock, flags);
138 139 140
	do {
		virtqueue_disable_cb(vq);
		while ((vbr = virtqueue_get_buf(vblk->vq, &len)) != NULL) {
141
			blk_mq_complete_request(vbr->req);
J
Jens Axboe 已提交
142
			req_done = true;
143
		}
144 145
		if (unlikely(virtqueue_is_broken(vq)))
			break;
146
	} while (!virtqueue_enable_cb(vq));
J
Jens Axboe 已提交
147 148
	spin_unlock_irqrestore(&vblk->vq_lock, flags);

R
Rusty Russell 已提交
149
	/* In case queue is stopped waiting for more buffers. */
150
	if (req_done)
J
Jens Axboe 已提交
151
		blk_mq_start_stopped_hw_queues(vblk->disk->queue);
152 153
}

J
Jens Axboe 已提交
154
static int virtio_queue_rq(struct blk_mq_hw_ctx *hctx, struct request *req)
R
Rusty Russell 已提交
155
{
J
Jens Axboe 已提交
156
	struct virtio_blk *vblk = hctx->queue->queuedata;
157
	struct virtblk_req *vbr = blk_mq_rq_to_pdu(req);
J
Jens Axboe 已提交
158
	unsigned long flags;
159
	unsigned int num;
J
Jens Axboe 已提交
160
	const bool last = (req->cmd_flags & REQ_END) != 0;
161
	int err;
R
Rusty Russell 已提交
162

J
Jens Axboe 已提交
163
	BUG_ON(req->nr_phys_segments + 2 > vblk->sg_elems);
R
Rusty Russell 已提交
164 165

	vbr->req = req;
166 167
	if (req->cmd_flags & REQ_FLUSH) {
		vbr->out_hdr.type = VIRTIO_BLK_T_FLUSH;
168 169
		vbr->out_hdr.sector = 0;
		vbr->out_hdr.ioprio = req_get_ioprio(vbr->req);
170 171 172 173 174 175 176 177 178
	} else {
		switch (req->cmd_type) {
		case REQ_TYPE_FS:
			vbr->out_hdr.type = 0;
			vbr->out_hdr.sector = blk_rq_pos(vbr->req);
			vbr->out_hdr.ioprio = req_get_ioprio(vbr->req);
			break;
		case REQ_TYPE_BLOCK_PC:
			vbr->out_hdr.type = VIRTIO_BLK_T_SCSI_CMD;
179 180 181
			vbr->out_hdr.sector = 0;
			vbr->out_hdr.ioprio = req_get_ioprio(vbr->req);
			break;
182 183 184 185 186 187 188 189
		case REQ_TYPE_SPECIAL:
			vbr->out_hdr.type = VIRTIO_BLK_T_GET_ID;
			vbr->out_hdr.sector = 0;
			vbr->out_hdr.ioprio = req_get_ioprio(vbr->req);
			break;
		default:
			/* We don't put anything else in the queue. */
			BUG();
190
		}
R
Rusty Russell 已提交
191 192
	}

J
Jens Axboe 已提交
193
	num = blk_rq_map_sg(hctx->queue, vbr->req, vbr->sg);
194
	if (num) {
195
		if (rq_data_dir(vbr->req) == WRITE)
196
			vbr->out_hdr.type |= VIRTIO_BLK_T_OUT;
197
		else
198
			vbr->out_hdr.type |= VIRTIO_BLK_T_IN;
R
Rusty Russell 已提交
199 200
	}

J
Jens Axboe 已提交
201
	spin_lock_irqsave(&vblk->vq_lock, flags);
202 203
	err = __virtblk_add_req(vblk->vq, vbr, vbr->sg, num);
	if (err) {
204
		virtqueue_kick(vblk->vq);
J
Jens Axboe 已提交
205 206
		spin_unlock_irqrestore(&vblk->vq_lock, flags);
		blk_mq_stop_hw_queue(hctx);
207 208 209 210 211
		/* Out of mem doesn't actually happen, since we fall back
		 * to direct descriptors */
		if (err == -ENOMEM || err == -ENOSPC)
			return BLK_MQ_RQ_QUEUE_BUSY;
		return BLK_MQ_RQ_QUEUE_ERROR;
212 213
	}

J
Jens Axboe 已提交
214 215
	if (last)
		virtqueue_kick(vblk->vq);
216 217

	spin_unlock_irqrestore(&vblk->vq_lock, flags);
J
Jens Axboe 已提交
218
	return BLK_MQ_RQ_QUEUE_OK;
219 220
}

221 222 223 224 225 226 227
/* return id (s/n) string for *disk to *id_str
 */
static int virtblk_get_id(struct gendisk *disk, char *id_str)
{
	struct virtio_blk *vblk = disk->private_data;
	struct request *req;
	struct bio *bio;
M
Mike Snitzer 已提交
228
	int err;
229 230 231 232 233 234 235 236 237 238 239 240 241

	bio = bio_map_kern(vblk->disk->queue, id_str, VIRTIO_BLK_ID_BYTES,
			   GFP_KERNEL);
	if (IS_ERR(bio))
		return PTR_ERR(bio);

	req = blk_make_request(vblk->disk->queue, bio, GFP_KERNEL);
	if (IS_ERR(req)) {
		bio_put(bio);
		return PTR_ERR(req);
	}

	req->cmd_type = REQ_TYPE_SPECIAL;
M
Mike Snitzer 已提交
242 243 244 245
	err = blk_execute_rq(vblk->disk->queue, vblk->disk, req, false);
	blk_put_request(req);

	return err;
246 247
}

248 249
static int virtblk_ioctl(struct block_device *bdev, fmode_t mode,
			     unsigned int cmd, unsigned long data)
R
Rusty Russell 已提交
250
{
251 252 253 254 255 256 257
	struct gendisk *disk = bdev->bd_disk;
	struct virtio_blk *vblk = disk->private_data;

	/*
	 * Only allow the generic SCSI ioctls if the host can support it.
	 */
	if (!virtio_has_feature(vblk->vdev, VIRTIO_BLK_F_SCSI))
258
		return -ENOTTY;
259

260 261
	return scsi_cmd_blk_ioctl(bdev, mode, cmd,
				  (void __user *)data);
R
Rusty Russell 已提交
262 263
}

264 265 266
/* We provide getgeo only to please some old bootloader/partitioning tools */
static int virtblk_getgeo(struct block_device *bd, struct hd_geometry *geo)
{
267 268 269
	struct virtio_blk *vblk = bd->bd_disk->private_data;

	/* see if the host passed in geometry config */
270 271 272 273 274 275 276
	if (virtio_has_feature(vblk->vdev, VIRTIO_BLK_F_GEOMETRY)) {
		virtio_cread(vblk->vdev, struct virtio_blk_config,
			     geometry.cylinders, &geo->cylinders);
		virtio_cread(vblk->vdev, struct virtio_blk_config,
			     geometry.heads, &geo->heads);
		virtio_cread(vblk->vdev, struct virtio_blk_config,
			     geometry.sectors, &geo->sectors);
277 278 279 280 281 282
	} else {
		/* some standard values, similar to sd */
		geo->heads = 1 << 6;
		geo->sectors = 1 << 5;
		geo->cylinders = get_capacity(bd->bd_disk) >> 11;
	}
283 284 285
	return 0;
}

286
static const struct block_device_operations virtblk_fops = {
287
	.ioctl  = virtblk_ioctl,
288 289
	.owner  = THIS_MODULE,
	.getgeo = virtblk_getgeo,
R
Rusty Russell 已提交
290 291
};

292 293 294 295 296
static int index_to_minor(int index)
{
	return index << PART_BITS;
}

297 298 299 300 301
static int minor_to_index(int minor)
{
	return minor >> PART_BITS;
}

302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
static ssize_t virtblk_serial_show(struct device *dev,
				struct device_attribute *attr, char *buf)
{
	struct gendisk *disk = dev_to_disk(dev);
	int err;

	/* sysfs gives us a PAGE_SIZE buffer */
	BUILD_BUG_ON(PAGE_SIZE < VIRTIO_BLK_ID_BYTES);

	buf[VIRTIO_BLK_ID_BYTES] = '\0';
	err = virtblk_get_id(disk, buf);
	if (!err)
		return strlen(buf);

	if (err == -EIO) /* Unsupported? Make it empty. */
		return 0;

	return err;
}
DEVICE_ATTR(serial, S_IRUGO, virtblk_serial_show, NULL);

323 324 325 326 327 328 329
static void virtblk_config_changed_work(struct work_struct *work)
{
	struct virtio_blk *vblk =
		container_of(work, struct virtio_blk, config_work);
	struct virtio_device *vdev = vblk->vdev;
	struct request_queue *q = vblk->disk->queue;
	char cap_str_2[10], cap_str_10[10];
330
	char *envp[] = { "RESIZE=1", NULL };
331 332
	u64 capacity, size;

333 334 335 336
	mutex_lock(&vblk->config_lock);
	if (!vblk->config_enable)
		goto done;

337
	/* Host must always specify the capacity. */
338
	virtio_cread(vdev, struct virtio_blk_config, capacity, &capacity);
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357

	/* If capacity is too big, truncate with warning. */
	if ((sector_t)capacity != capacity) {
		dev_warn(&vdev->dev, "Capacity %llu too large: truncating\n",
			 (unsigned long long)capacity);
		capacity = (sector_t)-1;
	}

	size = capacity * queue_logical_block_size(q);
	string_get_size(size, STRING_UNITS_2, cap_str_2, sizeof(cap_str_2));
	string_get_size(size, STRING_UNITS_10, cap_str_10, sizeof(cap_str_10));

	dev_notice(&vdev->dev,
		  "new size: %llu %d-byte logical blocks (%s/%s)\n",
		  (unsigned long long)capacity,
		  queue_logical_block_size(q),
		  cap_str_10, cap_str_2);

	set_capacity(vblk->disk, capacity);
358
	revalidate_disk(vblk->disk);
359
	kobject_uevent_env(&disk_to_dev(vblk->disk)->kobj, KOBJ_CHANGE, envp);
360 361
done:
	mutex_unlock(&vblk->config_lock);
362 363 364 365 366 367 368 369 370
}

static void virtblk_config_changed(struct virtio_device *vdev)
{
	struct virtio_blk *vblk = vdev->priv;

	queue_work(virtblk_wq, &vblk->config_work);
}

371 372 373 374 375
static int init_vq(struct virtio_blk *vblk)
{
	int err = 0;

	/* We expect one virtqueue, for output. */
376
	vblk->vq = virtio_find_single_vq(vblk->vdev, virtblk_done, "requests");
377 378 379 380 381 382
	if (IS_ERR(vblk->vq))
		err = PTR_ERR(vblk->vq);

	return err;
}

383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
/*
 * Legacy naming scheme used for virtio devices.  We are stuck with it for
 * virtio blk but don't ever use it for any new driver.
 */
static int virtblk_name_format(char *prefix, int index, char *buf, int buflen)
{
	const int base = 'z' - 'a' + 1;
	char *begin = buf + strlen(prefix);
	char *end = buf + buflen;
	char *p;
	int unit;

	p = end - 1;
	*p = '\0';
	unit = base;
	do {
		if (p == begin)
			return -EINVAL;
		*--p = 'a' + (index % unit);
		index = (index / unit) - 1;
	} while (index >= 0);

	memmove(begin, p, end - p);
	memcpy(buf, prefix, strlen(prefix));

	return 0;
}

411 412 413 414 415
static int virtblk_get_cache_mode(struct virtio_device *vdev)
{
	u8 writeback;
	int err;

416 417 418
	err = virtio_cread_feature(vdev, VIRTIO_BLK_F_CONFIG_WCE,
				   struct virtio_blk_config, wce,
				   &writeback);
419 420 421 422 423 424 425 426 427 428 429
	if (err)
		writeback = virtio_has_feature(vdev, VIRTIO_BLK_F_WCE);

	return writeback;
}

static void virtblk_update_cache_mode(struct virtio_device *vdev)
{
	u8 writeback = virtblk_get_cache_mode(vdev);
	struct virtio_blk *vblk = vdev->priv;

430
	if (writeback)
431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
		blk_queue_flush(vblk->disk->queue, REQ_FLUSH);
	else
		blk_queue_flush(vblk->disk->queue, 0);

	revalidate_disk(vblk->disk);
}

static const char *const virtblk_cache_types[] = {
	"write through", "write back"
};

static ssize_t
virtblk_cache_type_store(struct device *dev, struct device_attribute *attr,
			 const char *buf, size_t count)
{
	struct gendisk *disk = dev_to_disk(dev);
	struct virtio_blk *vblk = disk->private_data;
	struct virtio_device *vdev = vblk->vdev;
	int i;

	BUG_ON(!virtio_has_feature(vblk->vdev, VIRTIO_BLK_F_CONFIG_WCE));
	for (i = ARRAY_SIZE(virtblk_cache_types); --i >= 0; )
		if (sysfs_streq(buf, virtblk_cache_types[i]))
			break;

	if (i < 0)
		return -EINVAL;

459
	virtio_cwrite8(vdev, offsetof(struct virtio_blk_config, wce), i);
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
	virtblk_update_cache_mode(vdev);
	return count;
}

static ssize_t
virtblk_cache_type_show(struct device *dev, struct device_attribute *attr,
			 char *buf)
{
	struct gendisk *disk = dev_to_disk(dev);
	struct virtio_blk *vblk = disk->private_data;
	u8 writeback = virtblk_get_cache_mode(vblk->vdev);

	BUG_ON(writeback >= ARRAY_SIZE(virtblk_cache_types));
	return snprintf(buf, 40, "%s\n", virtblk_cache_types[writeback]);
}

static const struct device_attribute dev_attr_cache_type_ro =
	__ATTR(cache_type, S_IRUGO,
	       virtblk_cache_type_show, NULL);
static const struct device_attribute dev_attr_cache_type_rw =
	__ATTR(cache_type, S_IRUGO|S_IWUSR,
	       virtblk_cache_type_show, virtblk_cache_type_store);

483 484 485 486 487 488 489 490 491 492
static int virtblk_init_request(void *data, struct blk_mq_hw_ctx *hctx,
		struct request *rq, unsigned int nr)
{
	struct virtio_blk *vblk = data;
	struct virtblk_req *vbr = blk_mq_rq_to_pdu(rq);

	sg_init_table(vbr->sg, vblk->sg_elems);
	return 0;
}

J
Jens Axboe 已提交
493 494 495 496 497
static struct blk_mq_ops virtio_mq_ops = {
	.queue_rq	= virtio_queue_rq,
	.map_queue	= blk_mq_map_queue,
	.alloc_hctx	= blk_mq_alloc_single_hw_queue,
	.free_hctx	= blk_mq_free_single_hw_queue,
498
	.init_request	= virtblk_init_request,
499
	.complete	= virtblk_request_done,
J
Jens Axboe 已提交
500 501 502 503 504
};

static struct blk_mq_reg virtio_mq_reg = {
	.ops		= &virtio_mq_ops,
	.nr_hw_queues	= 1,
505
	.queue_depth	= 0, /* Set in virtblk_probe */
J
Jens Axboe 已提交
506 507 508
	.numa_node	= NUMA_NO_NODE,
	.flags		= BLK_MQ_F_SHOULD_MERGE,
};
509
module_param_named(queue_depth, virtio_mq_reg.queue_depth, uint, 0444);
J
Jens Axboe 已提交
510

511
static int virtblk_probe(struct virtio_device *vdev)
R
Rusty Russell 已提交
512 513
{
	struct virtio_blk *vblk;
514
	struct request_queue *q;
515
	int err, index;
516

R
Rusty Russell 已提交
517
	u64 cap;
518 519 520
	u32 v, blk_size, sg_elems, opt_io_size;
	u16 min_io_size;
	u8 physical_block_exp, alignment_offset;
R
Rusty Russell 已提交
521

522 523 524 525 526
	err = ida_simple_get(&vd_index_ida, 0, minor_to_index(1 << MINORBITS),
			     GFP_KERNEL);
	if (err < 0)
		goto out;
	index = err;
527

528
	/* We need to know how many segments before we allocate. */
529 530 531
	err = virtio_cread_feature(vdev, VIRTIO_BLK_F_SEG_MAX,
				   struct virtio_blk_config, seg_max,
				   &sg_elems);
532 533 534

	/* We need at least one SG element, whatever they say. */
	if (err || !sg_elems)
535 536 537 538
		sg_elems = 1;

	/* We need an extra sg elements at head and tail. */
	sg_elems += 2;
J
Jens Axboe 已提交
539
	vdev->priv = vblk = kmalloc(sizeof(*vblk), GFP_KERNEL);
R
Rusty Russell 已提交
540 541
	if (!vblk) {
		err = -ENOMEM;
542
		goto out_free_index;
R
Rusty Russell 已提交
543 544 545
	}

	vblk->vdev = vdev;
546
	vblk->sg_elems = sg_elems;
547
	mutex_init(&vblk->config_lock);
548

549
	INIT_WORK(&vblk->config_work, virtblk_config_changed_work);
550
	vblk->config_enable = true;
R
Rusty Russell 已提交
551

552 553
	err = init_vq(vblk);
	if (err)
R
Rusty Russell 已提交
554
		goto out_free_vblk;
J
Jens Axboe 已提交
555
	spin_lock_init(&vblk->vq_lock);
R
Rusty Russell 已提交
556 557

	/* FIXME: How many partitions?  How long is a piece of string? */
558
	vblk->disk = alloc_disk(1 << PART_BITS);
R
Rusty Russell 已提交
559 560
	if (!vblk->disk) {
		err = -ENOMEM;
J
Jens Axboe 已提交
561
		goto out_free_vq;
R
Rusty Russell 已提交
562 563
	}

564 565 566 567 568 569 570
	/* Default queue sizing is to fill the ring. */
	if (!virtio_mq_reg.queue_depth) {
		virtio_mq_reg.queue_depth = vblk->vq->num_free;
		/* ... but without indirect descs, we use 2 descs per req */
		if (!virtio_has_feature(vdev, VIRTIO_RING_F_INDIRECT_DESC))
			virtio_mq_reg.queue_depth /= 2;
	}
J
Jens Axboe 已提交
571 572 573 574 575
	virtio_mq_reg.cmd_size =
		sizeof(struct virtblk_req) +
		sizeof(struct scatterlist) * sg_elems;

	q = vblk->disk->queue = blk_mq_init_queue(&virtio_mq_reg, vblk);
576
	if (!q) {
R
Rusty Russell 已提交
577 578 579 580
		err = -ENOMEM;
		goto out_put_disk;
	}

581
	q->queuedata = vblk;
582

583
	virtblk_name_format("vd", index, vblk->disk->disk_name, DISK_NAME_LEN);
584

R
Rusty Russell 已提交
585
	vblk->disk->major = major;
586
	vblk->disk->first_minor = index_to_minor(index);
R
Rusty Russell 已提交
587 588
	vblk->disk->private_data = vblk;
	vblk->disk->fops = &virtblk_fops;
589
	vblk->disk->driverfs_dev = &vdev->dev;
590
	vblk->index = index;
591

592
	/* configure queue flush support */
593
	virtblk_update_cache_mode(vdev);
R
Rusty Russell 已提交
594

595 596 597 598
	/* If disk is read-only in the host, the guest should obey */
	if (virtio_has_feature(vdev, VIRTIO_BLK_F_RO))
		set_disk_ro(vblk->disk, 1);

599
	/* Host must always specify the capacity. */
600
	virtio_cread(vdev, struct virtio_blk_config, capacity, &cap);
R
Rusty Russell 已提交
601 602 603 604 605 606 607 608 609

	/* If capacity is too big, truncate with warning. */
	if ((sector_t)cap != cap) {
		dev_warn(&vdev->dev, "Capacity %llu too large: truncating\n",
			 (unsigned long long)cap);
		cap = (sector_t)-1;
	}
	set_capacity(vblk->disk, cap);

610
	/* We can handle whatever the host told us to handle. */
611
	blk_queue_max_segments(q, vblk->sg_elems-2);
612

613
	/* No need to bounce any requests */
614
	blk_queue_bounce_limit(q, BLK_BOUNCE_ANY);
615

616
	/* No real sector limit. */
617
	blk_queue_max_hw_sectors(q, -1U);
618

619 620
	/* Host can optionally specify maximum segment size and number of
	 * segments. */
621 622
	err = virtio_cread_feature(vdev, VIRTIO_BLK_F_SIZE_MAX,
				   struct virtio_blk_config, size_max, &v);
R
Rusty Russell 已提交
623
	if (!err)
624
		blk_queue_max_segment_size(q, v);
625
	else
626
		blk_queue_max_segment_size(q, -1U);
R
Rusty Russell 已提交
627

628
	/* Host can optionally specify the block size of the device */
629 630 631
	err = virtio_cread_feature(vdev, VIRTIO_BLK_F_BLK_SIZE,
				   struct virtio_blk_config, blk_size,
				   &blk_size);
632
	if (!err)
633 634 635 636 637
		blk_queue_logical_block_size(q, blk_size);
	else
		blk_size = queue_logical_block_size(q);

	/* Use topology information if available */
638 639 640
	err = virtio_cread_feature(vdev, VIRTIO_BLK_F_TOPOLOGY,
				   struct virtio_blk_config, physical_block_exp,
				   &physical_block_exp);
641 642 643 644
	if (!err && physical_block_exp)
		blk_queue_physical_block_size(q,
				blk_size * (1 << physical_block_exp));

645 646 647
	err = virtio_cread_feature(vdev, VIRTIO_BLK_F_TOPOLOGY,
				   struct virtio_blk_config, alignment_offset,
				   &alignment_offset);
648 649 650
	if (!err && alignment_offset)
		blk_queue_alignment_offset(q, blk_size * alignment_offset);

651 652 653
	err = virtio_cread_feature(vdev, VIRTIO_BLK_F_TOPOLOGY,
				   struct virtio_blk_config, min_io_size,
				   &min_io_size);
654 655 656
	if (!err && min_io_size)
		blk_queue_io_min(q, blk_size * min_io_size);

657 658 659
	err = virtio_cread_feature(vdev, VIRTIO_BLK_F_TOPOLOGY,
				   struct virtio_blk_config, opt_io_size,
				   &opt_io_size);
660 661 662
	if (!err && opt_io_size)
		blk_queue_io_opt(q, blk_size * opt_io_size);

R
Rusty Russell 已提交
663
	add_disk(vblk->disk);
664 665 666 667
	err = device_create_file(disk_to_dev(vblk->disk), &dev_attr_serial);
	if (err)
		goto out_del_disk;

668 669 670 671 672 673 674 675
	if (virtio_has_feature(vdev, VIRTIO_BLK_F_CONFIG_WCE))
		err = device_create_file(disk_to_dev(vblk->disk),
					 &dev_attr_cache_type_rw);
	else
		err = device_create_file(disk_to_dev(vblk->disk),
					 &dev_attr_cache_type_ro);
	if (err)
		goto out_del_disk;
R
Rusty Russell 已提交
676 677
	return 0;

678 679 680
out_del_disk:
	del_gendisk(vblk->disk);
	blk_cleanup_queue(vblk->disk->queue);
R
Rusty Russell 已提交
681 682 683
out_put_disk:
	put_disk(vblk->disk);
out_free_vq:
684
	vdev->config->del_vqs(vdev);
R
Rusty Russell 已提交
685 686
out_free_vblk:
	kfree(vblk);
687 688
out_free_index:
	ida_simple_remove(&vd_index_ida, index);
R
Rusty Russell 已提交
689 690 691 692
out:
	return err;
}

693
static void virtblk_remove(struct virtio_device *vdev)
R
Rusty Russell 已提交
694 695
{
	struct virtio_blk *vblk = vdev->priv;
696
	int index = vblk->index;
697
	int refc;
R
Rusty Russell 已提交
698

699 700 701 702
	/* Prevent config work handler from accessing the device. */
	mutex_lock(&vblk->config_lock);
	vblk->config_enable = false;
	mutex_unlock(&vblk->config_lock);
703

704
	del_gendisk(vblk->disk);
705
	blk_cleanup_queue(vblk->disk->queue);
706

R
Rusty Russell 已提交
707 708 709
	/* Stop all the virtqueues. */
	vdev->config->reset(vdev);

710 711
	flush_work(&vblk->config_work);

712
	refc = atomic_read(&disk_to_dev(vblk->disk)->kobj.kref.refcount);
R
Rusty Russell 已提交
713
	put_disk(vblk->disk);
714
	vdev->config->del_vqs(vdev);
R
Rusty Russell 已提交
715
	kfree(vblk);
716 717 718 719

	/* Only free device id if we don't have any users */
	if (refc == 1)
		ida_simple_remove(&vd_index_ida, index);
R
Rusty Russell 已提交
720 721
}

722
#ifdef CONFIG_PM_SLEEP
723 724 725 726 727 728 729 730 731 732 733 734 735 736
static int virtblk_freeze(struct virtio_device *vdev)
{
	struct virtio_blk *vblk = vdev->priv;

	/* Ensure we don't receive any more interrupts */
	vdev->config->reset(vdev);

	/* Prevent config work handler from accessing the device. */
	mutex_lock(&vblk->config_lock);
	vblk->config_enable = false;
	mutex_unlock(&vblk->config_lock);

	flush_work(&vblk->config_work);

J
Jens Axboe 已提交
737
	blk_mq_stop_hw_queues(vblk->disk->queue);
738 739 740 741 742 743 744 745 746 747 748 749

	vdev->config->del_vqs(vdev);
	return 0;
}

static int virtblk_restore(struct virtio_device *vdev)
{
	struct virtio_blk *vblk = vdev->priv;
	int ret;

	vblk->config_enable = true;
	ret = init_vq(vdev->priv);
J
Jens Axboe 已提交
750 751 752
	if (!ret)
		blk_mq_start_stopped_hw_queues(vblk->disk->queue);

753 754 755 756
	return ret;
}
#endif

757
static const struct virtio_device_id id_table[] = {
R
Rusty Russell 已提交
758 759 760 761
	{ VIRTIO_ID_BLOCK, VIRTIO_DEV_ANY_ID },
	{ 0 },
};

762
static unsigned int features[] = {
763 764
	VIRTIO_BLK_F_SEG_MAX, VIRTIO_BLK_F_SIZE_MAX, VIRTIO_BLK_F_GEOMETRY,
	VIRTIO_BLK_F_RO, VIRTIO_BLK_F_BLK_SIZE, VIRTIO_BLK_F_SCSI,
765
	VIRTIO_BLK_F_WCE, VIRTIO_BLK_F_TOPOLOGY, VIRTIO_BLK_F_CONFIG_WCE
766 767
};

768
static struct virtio_driver virtio_blk = {
769 770 771 772 773 774
	.feature_table		= features,
	.feature_table_size	= ARRAY_SIZE(features),
	.driver.name		= KBUILD_MODNAME,
	.driver.owner		= THIS_MODULE,
	.id_table		= id_table,
	.probe			= virtblk_probe,
775
	.remove			= virtblk_remove,
776
	.config_changed		= virtblk_config_changed,
777
#ifdef CONFIG_PM_SLEEP
778 779 780
	.freeze			= virtblk_freeze,
	.restore		= virtblk_restore,
#endif
R
Rusty Russell 已提交
781 782 783 784
};

static int __init init(void)
{
785 786 787 788 789 790
	int error;

	virtblk_wq = alloc_workqueue("virtio-blk", 0, 0);
	if (!virtblk_wq)
		return -ENOMEM;

791
	major = register_blkdev(0, "virtblk");
792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
	if (major < 0) {
		error = major;
		goto out_destroy_workqueue;
	}

	error = register_virtio_driver(&virtio_blk);
	if (error)
		goto out_unregister_blkdev;
	return 0;

out_unregister_blkdev:
	unregister_blkdev(major, "virtblk");
out_destroy_workqueue:
	destroy_workqueue(virtblk_wq);
	return error;
R
Rusty Russell 已提交
807 808 809 810
}

static void __exit fini(void)
{
811
	unregister_blkdev(major, "virtblk");
R
Rusty Russell 已提交
812
	unregister_virtio_driver(&virtio_blk);
813
	destroy_workqueue(virtblk_wq);
R
Rusty Russell 已提交
814 815 816 817 818 819 820
}
module_init(init);
module_exit(fini);

MODULE_DEVICE_TABLE(virtio, id_table);
MODULE_DESCRIPTION("Virtio block driver");
MODULE_LICENSE("GPL");