2 * Copyright (c) 2009, Microsoft Corporation.
4 * This program is free software; you can redistribute it and/or modify it
5 * under the terms and conditions of the GNU General Public License,
6 * version 2, as published by the Free Software Foundation.
8 * This program is distributed in the hope it will be useful, but WITHOUT
9 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
13 * You should have received a copy of the GNU General Public License along with
14 * this program; if not, write to the Free Software Foundation, Inc., 59 Temple
15 * Place - Suite 330, Boston, MA 02111-1307 USA.
18 * Haiyang Zhang <haiyangz@microsoft.com>
19 * Hank Janssen <hjanssen@microsoft.com>
21 #include <linux/init.h>
22 #include <linux/module.h>
23 #include <linux/device.h>
24 #include <linux/blkdev.h>
25 #include <linux/major.h>
26 #include <linux/delay.h>
27 #include <linux/hdreg.h>
28 #include <linux/mutex.h>
29 #include <linux/slab.h>
30 #include <scsi/scsi.h>
31 #include <scsi/scsi_cmnd.h>
32 #include <scsi/scsi_eh.h>
33 #include <scsi/scsi_dbg.h>
36 #include "version_info.h"
38 #include "storvsc_api.h"
41 #define BLKVSC_MINORS 64
43 enum blkvsc_device_type {
50 * This request ties the struct request and struct
51 * blkvsc_request/hv_storvsc_request together A struct request may be
52 * represented by 1 or more struct blkvsc_request
54 struct blkvsc_request_group {
57 struct list_head blkvsc_req_list; /* list of blkvsc_requests */
60 struct blkvsc_request {
61 /* blkvsc_request_group.blkvsc_req_list */
62 struct list_head req_entry;
64 /* block_device_context.pending_list */
65 struct list_head pend_entry;
67 /* This may be null if we generate a request internally */
70 struct block_device_context *dev;
72 /* The group this request is part of. Maybe null */
73 struct blkvsc_request_group *group;
76 sector_t sector_start;
77 unsigned long sector_count;
79 unsigned char sense_buffer[SCSI_SENSE_BUFFERSIZE];
80 unsigned char cmd_len;
81 unsigned char cmnd[MAX_COMMAND_SIZE];
83 struct hv_storvsc_request request;
86 /* Per device structure */
87 struct block_device_context {
88 /* point back to our device context */
89 struct hv_device *device_ctx;
90 struct kmem_cache *request_pool;
93 enum blkvsc_device_type device_type;
94 struct list_head pending_list;
96 unsigned char device_id[64];
97 unsigned int device_id_len;
98 int num_outstanding_reqs;
100 int media_not_present;
101 unsigned int sector_size;
105 unsigned char target;
110 static const char *g_blk_driver_name = "blkvsc";
112 /* {32412632-86cb-44a2-9b5c-50d1417354f5} */
113 static const struct hv_guid g_blk_device_type = {
115 0x32, 0x26, 0x41, 0x32, 0xcb, 0x86, 0xa2, 0x44,
116 0x9b, 0x5c, 0x50, 0xd1, 0x41, 0x73, 0x54, 0xf5
120 static int blk_vsc_on_device_add(struct hv_device *device,
121 void *additional_info)
123 struct storvsc_device_info *device_info;
126 device_info = (struct storvsc_device_info *)additional_info;
128 ret = stor_vsc_on_device_add(device, additional_info);
133 * We need to use the device instance guid to set the path and target
134 * id. For IDE devices, the device instance id is formatted as
135 * <bus id> * - <device id> - 8899 - 000000000000.
137 device_info->path_id = device->dev_instance.data[3] << 24 |
138 device->dev_instance.data[2] << 16 |
139 device->dev_instance.data[1] << 8 |
140 device->dev_instance.data[0];
142 device_info->target_id = device->dev_instance.data[5] << 8 |
143 device->dev_instance.data[4];
149 static int blk_vsc_initialize(struct hv_driver *driver)
151 struct storvsc_driver_object *stor_driver;
154 stor_driver = hvdr_to_stordr(driver);
156 /* Make sure we are at least 2 pages since 1 page is used for control */
157 /* ASSERT(stor_driver->RingBufferSize >= (PAGE_SIZE << 1)); */
159 driver->name = g_blk_driver_name;
160 memcpy(&driver->dev_type, &g_blk_device_type, sizeof(struct hv_guid));
164 * Divide the ring buffer data size (which is 1 page less than the ring
165 * buffer size since that page is reserved for the ring buffer indices)
166 * by the max request size (which is
167 * vmbus_channel_packet_multipage_buffer + struct vstor_packet + u64)
169 stor_driver->max_outstanding_req_per_channel =
170 ((stor_driver->ring_buffer_size - PAGE_SIZE) /
171 ALIGN(MAX_MULTIPAGE_BUFFER_PACKET +
172 sizeof(struct vstor_packet) + sizeof(u64),
175 DPRINT_INFO(BLKVSC, "max io outstd %u",
176 stor_driver->max_outstanding_req_per_channel);
178 /* Setup the dispatch table */
179 stor_driver->base.dev_add = blk_vsc_on_device_add;
180 stor_driver->base.dev_rm = stor_vsc_on_device_remove;
181 stor_driver->base.cleanup = stor_vsc_on_cleanup;
182 stor_driver->on_io_request = stor_vsc_on_io_request;
188 static int blkvsc_submit_request(struct blkvsc_request *blkvsc_req,
189 void (*request_completion)(struct hv_storvsc_request *))
191 struct block_device_context *blkdev = blkvsc_req->dev;
192 struct hv_device *device_ctx = blkdev->device_ctx;
193 struct hv_driver *drv =
194 drv_to_hv_drv(device_ctx->device.driver);
195 struct storvsc_driver_object *storvsc_drv_obj =
197 struct hv_storvsc_request *storvsc_req;
198 struct vmscsi_request *vm_srb;
201 DPRINT_DBG(BLKVSC_DRV, "blkvsc_submit_request() - "
202 "req %p type %s start_sector %lu count %ld offset %d "
203 "len %d\n", blkvsc_req,
204 (blkvsc_req->write) ? "WRITE" : "READ",
205 (unsigned long) blkvsc_req->sector_start,
206 blkvsc_req->sector_count,
207 blkvsc_req->request.data_buffer.offset,
208 blkvsc_req->request.data_buffer.len);
210 for (i = 0; i < (blkvsc_req->request.data_buffer.len >> 12); i++) {
211 DPRINT_DBG(BLKVSC_DRV, "blkvsc_submit_request() - "
212 "req %p pfn[%d] %llx\n",
214 blkvsc_req->request.data_buffer.pfn_array[i]);
218 storvsc_req = &blkvsc_req->request;
219 vm_srb = &storvsc_req->vstor_packet.vm_srb;
221 vm_srb->data_in = blkvsc_req->write ? WRITE_TYPE : READ_TYPE;
223 storvsc_req->on_io_completion = request_completion;
224 storvsc_req->context = blkvsc_req;
226 vm_srb->port_number = blkdev->port;
227 vm_srb->path_id = blkdev->path;
228 vm_srb->target_id = blkdev->target;
229 vm_srb->lun = 0; /* this is not really used at all */
231 vm_srb->cdb_length = blkvsc_req->cmd_len;
233 memcpy(vm_srb->cdb, blkvsc_req->cmnd, vm_srb->cdb_length);
235 storvsc_req->sense_buffer = blkvsc_req->sense_buffer;
237 ret = storvsc_drv_obj->on_io_request(blkdev->device_ctx,
238 &blkvsc_req->request);
240 blkdev->num_outstanding_reqs++;
247 static DEFINE_MUTEX(blkvsc_mutex);
248 static int blkvsc_probe(struct device *dev);
249 static int blkvsc_remove(struct device *device);
250 static void blkvsc_shutdown(struct device *device);
252 static int blkvsc_open(struct block_device *bdev, fmode_t mode);
253 static int blkvsc_release(struct gendisk *disk, fmode_t mode);
254 static unsigned int blkvsc_check_events(struct gendisk *gd,
255 unsigned int clearing);
256 static int blkvsc_revalidate_disk(struct gendisk *gd);
257 static int blkvsc_getgeo(struct block_device *bd, struct hd_geometry *hg);
258 static int blkvsc_ioctl(struct block_device *bd, fmode_t mode,
259 unsigned cmd, unsigned long argument);
260 static void blkvsc_request(struct request_queue *queue);
261 static void blkvsc_request_completion(struct hv_storvsc_request *request);
262 static int blkvsc_do_request(struct block_device_context *blkdev,
263 struct request *req);
264 static void blkvsc_init_rw(struct blkvsc_request *blkvsc_req);
265 static void blkvsc_cmd_completion(struct hv_storvsc_request *request);
266 static int blkvsc_do_inquiry(struct block_device_context *blkdev);
267 static int blkvsc_do_read_capacity(struct block_device_context *blkdev);
268 static int blkvsc_do_read_capacity16(struct block_device_context *blkdev);
269 static int blkvsc_do_flush(struct block_device_context *blkdev);
270 static int blkvsc_cancel_pending_reqs(struct block_device_context *blkdev);
271 static int blkvsc_do_pending_reqs(struct block_device_context *blkdev);
273 static int blkvsc_ringbuffer_size = BLKVSC_RING_BUFFER_SIZE;
274 module_param(blkvsc_ringbuffer_size, int, S_IRUGO);
275 MODULE_PARM_DESC(ring_size, "Ring buffer size (in bytes)");
277 /* The one and only one */
278 static struct storvsc_driver_object g_blkvsc_drv;
280 static const struct block_device_operations block_ops = {
281 .owner = THIS_MODULE,
283 .release = blkvsc_release,
284 .check_events = blkvsc_check_events,
285 .revalidate_disk = blkvsc_revalidate_disk,
286 .getgeo = blkvsc_getgeo,
287 .ioctl = blkvsc_ioctl,
291 * blkvsc_drv_init - BlkVsc driver initialization.
293 static int blkvsc_drv_init(void)
295 struct storvsc_driver_object *storvsc_drv_obj = &g_blkvsc_drv;
296 struct hv_driver *drv = &g_blkvsc_drv.base;
299 storvsc_drv_obj->ring_buffer_size = blkvsc_ringbuffer_size;
301 drv->priv = storvsc_drv_obj;
303 /* Callback to client driver to complete the initialization */
304 blk_vsc_initialize(&storvsc_drv_obj->base);
306 drv->driver.name = storvsc_drv_obj->base.name;
308 drv->driver.probe = blkvsc_probe;
309 drv->driver.remove = blkvsc_remove;
310 drv->driver.shutdown = blkvsc_shutdown;
312 /* The driver belongs to vmbus */
313 ret = vmbus_child_driver_register(&drv->driver);
318 static int blkvsc_drv_exit_cb(struct device *dev, void *data)
320 struct device **curr = (struct device **)data;
322 return 1; /* stop iterating */
325 static void blkvsc_drv_exit(void)
327 struct storvsc_driver_object *storvsc_drv_obj = &g_blkvsc_drv;
328 struct hv_driver *drv = &g_blkvsc_drv.base;
329 struct device *current_dev;
336 ret = driver_for_each_device(&drv->driver, NULL,
337 (void *) ¤t_dev,
341 DPRINT_WARN(BLKVSC_DRV,
342 "driver_for_each_device returned %d", ret);
345 if (current_dev == NULL)
348 /* Initiate removal from the top-down */
349 device_unregister(current_dev);
352 if (storvsc_drv_obj->base.cleanup)
353 storvsc_drv_obj->base.cleanup(&storvsc_drv_obj->base);
355 vmbus_child_driver_unregister(&drv->driver);
361 * blkvsc_probe - Add a new device for this driver
363 static int blkvsc_probe(struct device *device)
365 struct hv_driver *drv =
366 drv_to_hv_drv(device->driver);
367 struct storvsc_driver_object *storvsc_drv_obj =
369 struct hv_device *device_obj = device_to_hv_device(device);
371 struct block_device_context *blkdev = NULL;
372 struct storvsc_device_info device_info;
376 static int ide0_registered;
377 static int ide1_registered;
379 DPRINT_DBG(BLKVSC_DRV, "blkvsc_probe - enter");
381 if (!storvsc_drv_obj->base.dev_add) {
382 DPRINT_ERR(BLKVSC_DRV, "OnDeviceAdd() not set");
387 blkdev = kzalloc(sizeof(struct block_device_context), GFP_KERNEL);
393 INIT_LIST_HEAD(&blkdev->pending_list);
395 /* Initialize what we can here */
396 spin_lock_init(&blkdev->lock);
398 /* ASSERT(sizeof(struct blkvsc_request_group) <= */
399 /* sizeof(struct blkvsc_request)); */
401 blkdev->request_pool = kmem_cache_create(dev_name(&device_obj->device),
402 sizeof(struct blkvsc_request), 0,
403 SLAB_HWCACHE_ALIGN, NULL);
404 if (!blkdev->request_pool) {
410 /* Call to the vsc driver to add the device */
411 ret = storvsc_drv_obj->base.dev_add(device_obj, &device_info);
413 DPRINT_ERR(BLKVSC_DRV, "unable to add blkvsc device");
417 blkdev->device_ctx = device_obj;
418 /* this identified the device 0 or 1 */
419 blkdev->target = device_info.target_id;
420 /* this identified the ide ctrl 0 or 1 */
421 blkdev->path = device_info.path_id;
423 dev_set_drvdata(device, blkdev);
425 /* Calculate the major and device num */
426 if (blkdev->path == 0) {
428 devnum = blkdev->path + blkdev->target; /* 0 or 1 */
430 if (!ide0_registered) {
431 ret = register_blkdev(major, "ide");
433 DPRINT_ERR(BLKVSC_DRV,
434 "register_blkdev() failed! ret %d",
441 } else if (blkdev->path == 1) {
443 devnum = blkdev->path + blkdev->target + 1; /* 2 or 3 */
445 if (!ide1_registered) {
446 ret = register_blkdev(major, "ide");
448 DPRINT_ERR(BLKVSC_DRV,
449 "register_blkdev() failed! ret %d",
457 DPRINT_ERR(BLKVSC_DRV, "invalid pathid");
462 DPRINT_INFO(BLKVSC_DRV, "blkvsc registered for major %d!!", major);
464 blkdev->gd = alloc_disk(BLKVSC_MINORS);
466 DPRINT_ERR(BLKVSC_DRV, "register_blkdev() failed! ret %d", ret);
471 blkdev->gd->queue = blk_init_queue(blkvsc_request, &blkdev->lock);
473 blk_queue_max_segment_size(blkdev->gd->queue, PAGE_SIZE);
474 blk_queue_max_segments(blkdev->gd->queue, MAX_MULTIPAGE_BUFFER_COUNT);
475 blk_queue_segment_boundary(blkdev->gd->queue, PAGE_SIZE-1);
476 blk_queue_bounce_limit(blkdev->gd->queue, BLK_BOUNCE_ANY);
477 blk_queue_dma_alignment(blkdev->gd->queue, 511);
479 blkdev->gd->major = major;
480 if (devnum == 1 || devnum == 3)
481 blkdev->gd->first_minor = BLKVSC_MINORS;
483 blkdev->gd->first_minor = 0;
484 blkdev->gd->fops = &block_ops;
485 blkdev->gd->events = DISK_EVENT_MEDIA_CHANGE;
486 blkdev->gd->private_data = blkdev;
487 blkdev->gd->driverfs_dev = &(blkdev->device_ctx->device);
488 sprintf(blkdev->gd->disk_name, "hd%c", 'a' + devnum);
490 blkvsc_do_inquiry(blkdev);
491 if (blkdev->device_type == DVD_TYPE) {
492 set_disk_ro(blkdev->gd, 1);
493 blkdev->gd->flags |= GENHD_FL_REMOVABLE;
494 blkvsc_do_read_capacity(blkdev);
496 blkvsc_do_read_capacity16(blkdev);
499 set_capacity(blkdev->gd, blkdev->capacity * (blkdev->sector_size/512));
500 blk_queue_logical_block_size(blkdev->gd->queue, blkdev->sector_size);
502 add_disk(blkdev->gd);
504 DPRINT_INFO(BLKVSC_DRV, "%s added!! capacity %lu sector_size %d",
505 blkdev->gd->disk_name, (unsigned long)blkdev->capacity,
506 blkdev->sector_size);
511 storvsc_drv_obj->base.dev_rm(device_obj);
515 if (blkdev->request_pool) {
516 kmem_cache_destroy(blkdev->request_pool);
517 blkdev->request_pool = NULL;
526 static void blkvsc_shutdown(struct device *device)
528 struct block_device_context *blkdev = dev_get_drvdata(device);
534 DPRINT_DBG(BLKVSC_DRV, "blkvsc_shutdown - users %d disk %s\n",
535 blkdev->users, blkdev->gd->disk_name);
537 spin_lock_irqsave(&blkdev->lock, flags);
539 blkdev->shutting_down = 1;
541 blk_stop_queue(blkdev->gd->queue);
543 spin_unlock_irqrestore(&blkdev->lock, flags);
545 while (blkdev->num_outstanding_reqs) {
546 DPRINT_INFO(STORVSC, "waiting for %d requests to complete...",
547 blkdev->num_outstanding_reqs);
551 blkvsc_do_flush(blkdev);
553 spin_lock_irqsave(&blkdev->lock, flags);
555 blkvsc_cancel_pending_reqs(blkdev);
557 spin_unlock_irqrestore(&blkdev->lock, flags);
560 static int blkvsc_do_flush(struct block_device_context *blkdev)
562 struct blkvsc_request *blkvsc_req;
564 DPRINT_DBG(BLKVSC_DRV, "blkvsc_do_flush()\n");
566 if (blkdev->device_type != HARDDISK_TYPE)
569 blkvsc_req = kmem_cache_zalloc(blkdev->request_pool, GFP_KERNEL);
573 memset(blkvsc_req, 0, sizeof(struct blkvsc_request));
574 init_completion(&blkvsc_req->request.wait_event);
575 blkvsc_req->dev = blkdev;
576 blkvsc_req->req = NULL;
577 blkvsc_req->write = 0;
579 blkvsc_req->request.data_buffer.pfn_array[0] = 0;
580 blkvsc_req->request.data_buffer.offset = 0;
581 blkvsc_req->request.data_buffer.len = 0;
583 blkvsc_req->cmnd[0] = SYNCHRONIZE_CACHE;
584 blkvsc_req->cmd_len = 10;
586 blkvsc_submit_request(blkvsc_req, blkvsc_cmd_completion);
588 wait_for_completion_interruptible(&blkvsc_req->request.wait_event);
590 kmem_cache_free(blkvsc_req->dev->request_pool, blkvsc_req);
595 /* Do a scsi INQUIRY cmd here to get the device type (ie disk or dvd) */
596 static int blkvsc_do_inquiry(struct block_device_context *blkdev)
598 struct blkvsc_request *blkvsc_req;
599 struct page *page_buf;
601 unsigned char device_type;
603 DPRINT_DBG(BLKVSC_DRV, "blkvsc_do_inquiry()\n");
605 blkvsc_req = kmem_cache_zalloc(blkdev->request_pool, GFP_KERNEL);
609 memset(blkvsc_req, 0, sizeof(struct blkvsc_request));
610 page_buf = alloc_page(GFP_KERNEL);
612 kmem_cache_free(blkvsc_req->dev->request_pool, blkvsc_req);
616 init_completion(&blkvsc_req->request.wait_event);
617 blkvsc_req->dev = blkdev;
618 blkvsc_req->req = NULL;
619 blkvsc_req->write = 0;
621 blkvsc_req->request.data_buffer.pfn_array[0] =
622 page_to_pfn(page_buf);
623 blkvsc_req->request.data_buffer.offset = 0;
624 blkvsc_req->request.data_buffer.len = 64;
626 blkvsc_req->cmnd[0] = INQUIRY;
627 blkvsc_req->cmnd[1] = 0x1; /* Get product data */
628 blkvsc_req->cmnd[2] = 0x83; /* mode page 83 */
629 blkvsc_req->cmnd[4] = 64;
630 blkvsc_req->cmd_len = 6;
632 blkvsc_submit_request(blkvsc_req, blkvsc_cmd_completion);
634 DPRINT_DBG(BLKVSC_DRV, "waiting %p to complete\n",
637 wait_for_completion_interruptible(&blkvsc_req->request.wait_event);
639 buf = kmap(page_buf);
641 /* print_hex_dump_bytes("", DUMP_PREFIX_NONE, buf, 64); */
643 device_type = buf[0] & 0x1F;
645 if (device_type == 0x0) {
646 blkdev->device_type = HARDDISK_TYPE;
647 } else if (device_type == 0x5) {
648 blkdev->device_type = DVD_TYPE;
650 /* TODO: this is currently unsupported device type */
651 blkdev->device_type = UNKNOWN_DEV_TYPE;
654 DPRINT_DBG(BLKVSC_DRV, "device type %d\n", device_type);
656 blkdev->device_id_len = buf[7];
657 if (blkdev->device_id_len > 64)
658 blkdev->device_id_len = 64;
660 memcpy(blkdev->device_id, &buf[8], blkdev->device_id_len);
661 /* printk_hex_dump_bytes("", DUMP_PREFIX_NONE, blkdev->device_id,
662 * blkdev->device_id_len); */
666 __free_page(page_buf);
668 kmem_cache_free(blkvsc_req->dev->request_pool, blkvsc_req);
673 /* Do a scsi READ_CAPACITY cmd here to get the size of the disk */
674 static int blkvsc_do_read_capacity(struct block_device_context *blkdev)
676 struct blkvsc_request *blkvsc_req;
677 struct page *page_buf;
679 struct scsi_sense_hdr sense_hdr;
680 struct vmscsi_request *vm_srb;
682 DPRINT_DBG(BLKVSC_DRV, "blkvsc_do_read_capacity()\n");
684 blkdev->sector_size = 0;
685 blkdev->capacity = 0;
686 blkdev->media_not_present = 0; /* assume a disk is present */
688 blkvsc_req = kmem_cache_zalloc(blkdev->request_pool, GFP_KERNEL);
692 memset(blkvsc_req, 0, sizeof(struct blkvsc_request));
693 page_buf = alloc_page(GFP_KERNEL);
695 kmem_cache_free(blkvsc_req->dev->request_pool, blkvsc_req);
699 vm_srb = &blkvsc_req->request.vstor_packet.vm_srb;
700 init_completion(&blkvsc_req->request.wait_event);
701 blkvsc_req->dev = blkdev;
702 blkvsc_req->req = NULL;
703 blkvsc_req->write = 0;
705 blkvsc_req->request.data_buffer.pfn_array[0] =
706 page_to_pfn(page_buf);
707 blkvsc_req->request.data_buffer.offset = 0;
708 blkvsc_req->request.data_buffer.len = 8;
710 blkvsc_req->cmnd[0] = READ_CAPACITY;
711 blkvsc_req->cmd_len = 16;
713 blkvsc_submit_request(blkvsc_req, blkvsc_cmd_completion);
715 DPRINT_DBG(BLKVSC_DRV, "waiting %p to complete\n",
718 wait_for_completion_interruptible(&blkvsc_req->request.wait_event);
721 if (vm_srb->scsi_status) {
722 scsi_normalize_sense(blkvsc_req->sense_buffer,
723 SCSI_SENSE_BUFFERSIZE, &sense_hdr);
725 if (sense_hdr.asc == 0x3A) {
726 /* Medium not present */
727 blkdev->media_not_present = 1;
731 buf = kmap(page_buf);
734 blkdev->capacity = ((buf[0] << 24) | (buf[1] << 16) |
735 (buf[2] << 8) | buf[3]) + 1;
736 blkdev->sector_size = (buf[4] << 24) | (buf[5] << 16) |
737 (buf[6] << 8) | buf[7];
741 __free_page(page_buf);
743 kmem_cache_free(blkvsc_req->dev->request_pool, blkvsc_req);
748 static int blkvsc_do_read_capacity16(struct block_device_context *blkdev)
750 struct blkvsc_request *blkvsc_req;
751 struct page *page_buf;
753 struct scsi_sense_hdr sense_hdr;
754 struct vmscsi_request *vm_srb;
756 DPRINT_DBG(BLKVSC_DRV, "blkvsc_do_read_capacity16()\n");
758 blkdev->sector_size = 0;
759 blkdev->capacity = 0;
760 blkdev->media_not_present = 0; /* assume a disk is present */
762 blkvsc_req = kmem_cache_zalloc(blkdev->request_pool, GFP_KERNEL);
766 memset(blkvsc_req, 0, sizeof(struct blkvsc_request));
767 vm_srb = &blkvsc_req->request.vstor_packet.vm_srb;
768 page_buf = alloc_page(GFP_KERNEL);
770 kmem_cache_free(blkvsc_req->dev->request_pool, blkvsc_req);
774 init_completion(&blkvsc_req->request.wait_event);
775 blkvsc_req->dev = blkdev;
776 blkvsc_req->req = NULL;
777 blkvsc_req->write = 0;
779 blkvsc_req->request.data_buffer.pfn_array[0] =
780 page_to_pfn(page_buf);
781 blkvsc_req->request.data_buffer.offset = 0;
782 blkvsc_req->request.data_buffer.len = 12;
784 blkvsc_req->cmnd[0] = 0x9E; /* READ_CAPACITY16; */
785 blkvsc_req->cmd_len = 16;
788 * Set this here since the completion routine may be invoked
789 * and completed before we return
792 blkvsc_submit_request(blkvsc_req, blkvsc_cmd_completion);
794 DPRINT_DBG(BLKVSC_DRV, "waiting %p to complete\n",
797 wait_for_completion_interruptible(&blkvsc_req->request.wait_event);
800 if (vm_srb->scsi_status) {
801 scsi_normalize_sense(blkvsc_req->sense_buffer,
802 SCSI_SENSE_BUFFERSIZE, &sense_hdr);
803 if (sense_hdr.asc == 0x3A) {
804 /* Medium not present */
805 blkdev->media_not_present = 1;
809 buf = kmap(page_buf);
812 blkdev->capacity = be64_to_cpu(*(unsigned long long *) &buf[0]) + 1;
813 blkdev->sector_size = be32_to_cpu(*(unsigned int *)&buf[8]);
816 blkdev->capacity = ((buf[0] << 24) | (buf[1] << 16) |
817 (buf[2] << 8) | buf[3]) + 1;
818 blkdev->sector_size = (buf[4] << 24) | (buf[5] << 16) |
819 (buf[6] << 8) | buf[7];
824 __free_page(page_buf);
826 kmem_cache_free(blkvsc_req->dev->request_pool, blkvsc_req);
832 * blkvsc_remove() - Callback when our device is removed
834 static int blkvsc_remove(struct device *device)
836 struct hv_driver *drv =
837 drv_to_hv_drv(device->driver);
838 struct storvsc_driver_object *storvsc_drv_obj =
840 struct hv_device *device_obj = device_to_hv_device(device);
841 struct block_device_context *blkdev = dev_get_drvdata(device);
845 DPRINT_DBG(BLKVSC_DRV, "blkvsc_remove()\n");
847 if (!storvsc_drv_obj->base.dev_rm)
851 * Call to the vsc driver to let it know that the device is being
854 ret = storvsc_drv_obj->base.dev_rm(device_obj);
857 DPRINT_ERR(BLKVSC_DRV,
858 "unable to remove blkvsc device (ret %d)", ret);
861 /* Get to a known state */
862 spin_lock_irqsave(&blkdev->lock, flags);
864 blkdev->shutting_down = 1;
866 blk_stop_queue(blkdev->gd->queue);
868 spin_unlock_irqrestore(&blkdev->lock, flags);
870 while (blkdev->num_outstanding_reqs) {
871 DPRINT_INFO(STORVSC, "waiting for %d requests to complete...",
872 blkdev->num_outstanding_reqs);
876 blkvsc_do_flush(blkdev);
878 spin_lock_irqsave(&blkdev->lock, flags);
880 blkvsc_cancel_pending_reqs(blkdev);
882 spin_unlock_irqrestore(&blkdev->lock, flags);
884 blk_cleanup_queue(blkdev->gd->queue);
886 del_gendisk(blkdev->gd);
888 kmem_cache_destroy(blkdev->request_pool);
895 static void blkvsc_init_rw(struct blkvsc_request *blkvsc_req)
897 /* ASSERT(blkvsc_req->req); */
898 /* ASSERT(blkvsc_req->sector_count <= (MAX_MULTIPAGE_BUFFER_COUNT*8)); */
900 blkvsc_req->cmd_len = 16;
902 if (blkvsc_req->sector_start > 0xffffffff) {
903 if (rq_data_dir(blkvsc_req->req)) {
904 blkvsc_req->write = 1;
905 blkvsc_req->cmnd[0] = WRITE_16;
907 blkvsc_req->write = 0;
908 blkvsc_req->cmnd[0] = READ_16;
911 blkvsc_req->cmnd[1] |=
912 (blkvsc_req->req->cmd_flags & REQ_FUA) ? 0x8 : 0;
914 *(unsigned long long *)&blkvsc_req->cmnd[2] =
915 cpu_to_be64(blkvsc_req->sector_start);
916 *(unsigned int *)&blkvsc_req->cmnd[10] =
917 cpu_to_be32(blkvsc_req->sector_count);
918 } else if ((blkvsc_req->sector_count > 0xff) ||
919 (blkvsc_req->sector_start > 0x1fffff)) {
920 if (rq_data_dir(blkvsc_req->req)) {
921 blkvsc_req->write = 1;
922 blkvsc_req->cmnd[0] = WRITE_10;
924 blkvsc_req->write = 0;
925 blkvsc_req->cmnd[0] = READ_10;
928 blkvsc_req->cmnd[1] |=
929 (blkvsc_req->req->cmd_flags & REQ_FUA) ? 0x8 : 0;
931 *(unsigned int *)&blkvsc_req->cmnd[2] =
932 cpu_to_be32(blkvsc_req->sector_start);
933 *(unsigned short *)&blkvsc_req->cmnd[7] =
934 cpu_to_be16(blkvsc_req->sector_count);
936 if (rq_data_dir(blkvsc_req->req)) {
937 blkvsc_req->write = 1;
938 blkvsc_req->cmnd[0] = WRITE_6;
940 blkvsc_req->write = 0;
941 blkvsc_req->cmnd[0] = READ_6;
944 *(unsigned int *)&blkvsc_req->cmnd[1] =
945 cpu_to_be32(blkvsc_req->sector_start) >> 8;
946 blkvsc_req->cmnd[1] &= 0x1f;
947 blkvsc_req->cmnd[4] = (unsigned char)blkvsc_req->sector_count;
953 * We break the request into 1 or more blkvsc_requests and submit
954 * them. If we can't submit them all, we put them on the
955 * pending_list. The blkvsc_request() will work on the pending_list.
957 static int blkvsc_do_request(struct block_device_context *blkdev,
960 struct bio *bio = NULL;
961 struct bio_vec *bvec = NULL;
962 struct bio_vec *prev_bvec = NULL;
963 struct blkvsc_request *blkvsc_req = NULL;
964 struct blkvsc_request *tmp;
967 sector_t start_sector;
968 unsigned long num_sectors = 0;
971 struct blkvsc_request_group *group = NULL;
973 DPRINT_DBG(BLKVSC_DRV, "blkdev %p req %p sect %lu\n", blkdev, req,
974 (unsigned long)blk_rq_pos(req));
976 /* Create a group to tie req to list of blkvsc_reqs */
977 group = kmem_cache_zalloc(blkdev->request_pool, GFP_ATOMIC);
981 INIT_LIST_HEAD(&group->blkvsc_req_list);
982 group->outstanding = group->status = 0;
984 start_sector = blk_rq_pos(req);
986 /* foreach bio in the request */
988 for (bio = req->bio; bio; bio = bio->bi_next) {
990 * Map this bio into an existing or new storvsc request
992 bio_for_each_segment(bvec, bio, seg_idx) {
993 DPRINT_DBG(BLKVSC_DRV, "bio_for_each_segment() "
994 "- req %p bio %p bvec %p seg_idx %d "
995 "databuf_idx %d\n", req, bio, bvec,
996 seg_idx, databuf_idx);
998 /* Get a new storvsc request */
1000 if ((!blkvsc_req) ||
1001 (databuf_idx >= MAX_MULTIPAGE_BUFFER_COUNT)
1002 /* hole at the begin of page */
1003 || (bvec->bv_offset != 0) ||
1004 /* hold at the end of page */
1006 (prev_bvec->bv_len != PAGE_SIZE))) {
1007 /* submit the prev one */
1009 blkvsc_req->sector_start = start_sector;
1010 sector_div(blkvsc_req->sector_start, (blkdev->sector_size >> 9));
1012 blkvsc_req->sector_count = num_sectors / (blkdev->sector_size >> 9);
1013 blkvsc_init_rw(blkvsc_req);
1017 * Create new blkvsc_req to represent
1022 blkdev->request_pool, GFP_ATOMIC);
1024 /* free up everything */
1025 list_for_each_entry_safe(
1027 &group->blkvsc_req_list,
1029 list_del(&blkvsc_req->req_entry);
1030 kmem_cache_free(blkdev->request_pool, blkvsc_req);
1033 kmem_cache_free(blkdev->request_pool, group);
1037 memset(blkvsc_req, 0,
1038 sizeof(struct blkvsc_request));
1040 blkvsc_req->dev = blkdev;
1041 blkvsc_req->req = req;
1042 blkvsc_req->request.
1045 blkvsc_req->request.
1046 data_buffer.len = 0;
1048 /* Add to the group */
1049 blkvsc_req->group = group;
1050 blkvsc_req->group->outstanding++;
1051 list_add_tail(&blkvsc_req->req_entry,
1052 &blkvsc_req->group->blkvsc_req_list);
1054 start_sector += num_sectors;
1059 /* Add the curr bvec/segment to the curr blkvsc_req */
1060 blkvsc_req->request.data_buffer.
1061 pfn_array[databuf_idx]
1062 = page_to_pfn(bvec->bv_page);
1063 blkvsc_req->request.data_buffer.len
1069 num_sectors += bvec->bv_len >> 9;
1071 } /* bio_for_each_segment */
1073 } /* rq_for_each_bio */
1076 /* Handle the last one */
1078 DPRINT_DBG(BLKVSC_DRV, "blkdev %p req %p group %p count %d\n",
1079 blkdev, req, blkvsc_req->group,
1080 blkvsc_req->group->outstanding);
1082 blkvsc_req->sector_start = start_sector;
1083 sector_div(blkvsc_req->sector_start,
1084 (blkdev->sector_size >> 9));
1086 blkvsc_req->sector_count = num_sectors /
1087 (blkdev->sector_size >> 9);
1089 blkvsc_init_rw(blkvsc_req);
1092 list_for_each_entry(blkvsc_req, &group->blkvsc_req_list, req_entry) {
1094 DPRINT_DBG(BLKVSC_DRV, "adding blkvsc_req to "
1095 "pending_list - blkvsc_req %p start_sect %lu"
1096 " sect_count %ld (%lu %ld)\n", blkvsc_req,
1097 (unsigned long)blkvsc_req->sector_start,
1098 blkvsc_req->sector_count,
1099 (unsigned long)start_sector,
1100 (unsigned long)num_sectors);
1102 list_add_tail(&blkvsc_req->pend_entry,
1103 &blkdev->pending_list);
1105 ret = blkvsc_submit_request(blkvsc_req,
1106 blkvsc_request_completion);
1109 list_add_tail(&blkvsc_req->pend_entry,
1110 &blkdev->pending_list);
1113 DPRINT_DBG(BLKVSC_DRV, "submitted blkvsc_req %p "
1114 "start_sect %lu sect_count %ld (%lu %ld) "
1115 "ret %d\n", blkvsc_req,
1116 (unsigned long)blkvsc_req->sector_start,
1117 blkvsc_req->sector_count,
1118 (unsigned long)start_sector,
1126 static void blkvsc_cmd_completion(struct hv_storvsc_request *request)
1128 struct blkvsc_request *blkvsc_req =
1129 (struct blkvsc_request *)request->context;
1130 struct block_device_context *blkdev =
1131 (struct block_device_context *)blkvsc_req->dev;
1132 struct scsi_sense_hdr sense_hdr;
1133 struct vmscsi_request *vm_srb;
1135 DPRINT_DBG(BLKVSC_DRV, "blkvsc_cmd_completion() - req %p\n",
1138 vm_srb = &blkvsc_req->request.vstor_packet.vm_srb;
1139 blkdev->num_outstanding_reqs--;
1141 if (vm_srb->scsi_status)
1142 if (scsi_normalize_sense(blkvsc_req->sense_buffer,
1143 SCSI_SENSE_BUFFERSIZE, &sense_hdr))
1144 scsi_print_sense_hdr("blkvsc", &sense_hdr);
1146 complete(&blkvsc_req->request.wait_event);
1149 static void blkvsc_request_completion(struct hv_storvsc_request *request)
1151 struct blkvsc_request *blkvsc_req =
1152 (struct blkvsc_request *)request->context;
1153 struct block_device_context *blkdev =
1154 (struct block_device_context *)blkvsc_req->dev;
1155 unsigned long flags;
1156 struct blkvsc_request *comp_req, *tmp;
1157 struct vmscsi_request *vm_srb;
1159 /* ASSERT(blkvsc_req->group); */
1161 DPRINT_DBG(BLKVSC_DRV, "blkdev %p blkvsc_req %p group %p type %s "
1162 "sect_start %lu sect_count %ld len %d group outstd %d "
1163 "total outstd %d\n",
1164 blkdev, blkvsc_req, blkvsc_req->group,
1165 (blkvsc_req->write) ? "WRITE" : "READ",
1166 (unsigned long)blkvsc_req->sector_start,
1167 blkvsc_req->sector_count,
1168 blkvsc_req->request.data_buffer.len,
1169 blkvsc_req->group->outstanding,
1170 blkdev->num_outstanding_reqs);
1172 spin_lock_irqsave(&blkdev->lock, flags);
1174 blkdev->num_outstanding_reqs--;
1175 blkvsc_req->group->outstanding--;
1178 * Only start processing when all the blkvsc_reqs are
1179 * completed. This guarantees no out-of-order blkvsc_req
1180 * completion when calling end_that_request_first()
1182 if (blkvsc_req->group->outstanding == 0) {
1183 list_for_each_entry_safe(comp_req, tmp,
1184 &blkvsc_req->group->blkvsc_req_list,
1186 DPRINT_DBG(BLKVSC_DRV, "completing blkvsc_req %p "
1187 "sect_start %lu sect_count %ld\n",
1189 (unsigned long)comp_req->sector_start,
1190 comp_req->sector_count);
1192 list_del(&comp_req->req_entry);
1195 &comp_req->request.vstor_packet.vm_srb;
1196 if (!__blk_end_request(comp_req->req,
1197 (!vm_srb->scsi_status ? 0 : -EIO),
1198 comp_req->sector_count * blkdev->sector_size)) {
1200 * All the sectors have been xferred ie the
1203 DPRINT_DBG(BLKVSC_DRV, "req %p COMPLETED\n",
1205 kmem_cache_free(blkdev->request_pool,
1209 kmem_cache_free(blkdev->request_pool, comp_req);
1212 if (!blkdev->shutting_down) {
1213 blkvsc_do_pending_reqs(blkdev);
1214 blk_start_queue(blkdev->gd->queue);
1215 blkvsc_request(blkdev->gd->queue);
1219 spin_unlock_irqrestore(&blkdev->lock, flags);
1222 static int blkvsc_cancel_pending_reqs(struct block_device_context *blkdev)
1224 struct blkvsc_request *pend_req, *tmp;
1225 struct blkvsc_request *comp_req, *tmp2;
1226 struct vmscsi_request *vm_srb;
1230 DPRINT_DBG(BLKVSC_DRV, "blkvsc_cancel_pending_reqs()");
1232 /* Flush the pending list first */
1233 list_for_each_entry_safe(pend_req, tmp, &blkdev->pending_list,
1236 * The pend_req could be part of a partially completed
1237 * request. If so, complete those req first until we
1240 list_for_each_entry_safe(comp_req, tmp2,
1241 &pend_req->group->blkvsc_req_list,
1243 DPRINT_DBG(BLKVSC_DRV, "completing blkvsc_req %p "
1244 "sect_start %lu sect_count %ld\n",
1246 (unsigned long) comp_req->sector_start,
1247 comp_req->sector_count);
1249 if (comp_req == pend_req)
1252 list_del(&comp_req->req_entry);
1254 if (comp_req->req) {
1256 &comp_req->request.vstor_packet.
1258 ret = __blk_end_request(comp_req->req,
1259 (!vm_srb->scsi_status ? 0 : -EIO),
1260 comp_req->sector_count *
1261 blkdev->sector_size);
1263 /* FIXME: shouldn't this do more than return? */
1268 kmem_cache_free(blkdev->request_pool, comp_req);
1271 DPRINT_DBG(BLKVSC_DRV, "cancelling pending request - %p\n",
1274 list_del(&pend_req->pend_entry);
1276 list_del(&pend_req->req_entry);
1278 if (comp_req->req) {
1279 if (!__blk_end_request(pend_req->req, -EIO,
1280 pend_req->sector_count *
1281 blkdev->sector_size)) {
1283 * All the sectors have been xferred ie the
1286 DPRINT_DBG(BLKVSC_DRV,
1287 "blkvsc_cancel_pending_reqs() - "
1288 "req %p COMPLETED\n", pend_req->req);
1289 kmem_cache_free(blkdev->request_pool,
1294 kmem_cache_free(blkdev->request_pool, pend_req);
1301 static int blkvsc_do_pending_reqs(struct block_device_context *blkdev)
1303 struct blkvsc_request *pend_req, *tmp;
1306 /* Flush the pending list first */
1307 list_for_each_entry_safe(pend_req, tmp, &blkdev->pending_list,
1309 DPRINT_DBG(BLKVSC_DRV, "working off pending_list - %p\n",
1312 ret = blkvsc_submit_request(pend_req,
1313 blkvsc_request_completion);
1317 list_del(&pend_req->pend_entry);
1323 static void blkvsc_request(struct request_queue *queue)
1325 struct block_device_context *blkdev = NULL;
1326 struct request *req;
1329 DPRINT_DBG(BLKVSC_DRV, "- enter\n");
1330 while ((req = blk_peek_request(queue)) != NULL) {
1331 DPRINT_DBG(BLKVSC_DRV, "- req %p\n", req);
1333 blkdev = req->rq_disk->private_data;
1334 if (blkdev->shutting_down || req->cmd_type != REQ_TYPE_FS ||
1335 blkdev->media_not_present) {
1336 __blk_end_request_cur(req, 0);
1340 ret = blkvsc_do_pending_reqs(blkdev);
1343 DPRINT_DBG(BLKVSC_DRV,
1344 "- stop queue - pending_list not empty\n");
1345 blk_stop_queue(queue);
1349 blk_start_request(req);
1351 ret = blkvsc_do_request(blkdev, req);
1353 DPRINT_DBG(BLKVSC_DRV, "- stop queue - no room\n");
1354 blk_stop_queue(queue);
1356 } else if (ret < 0) {
1357 DPRINT_DBG(BLKVSC_DRV, "- stop queue - no mem\n");
1358 blk_requeue_request(queue, req);
1359 blk_stop_queue(queue);
1365 static int blkvsc_open(struct block_device *bdev, fmode_t mode)
1367 struct block_device_context *blkdev = bdev->bd_disk->private_data;
1369 DPRINT_DBG(BLKVSC_DRV, "- users %d disk %s\n", blkdev->users,
1370 blkdev->gd->disk_name);
1372 mutex_lock(&blkvsc_mutex);
1373 spin_lock(&blkdev->lock);
1375 if (!blkdev->users && blkdev->device_type == DVD_TYPE) {
1376 spin_unlock(&blkdev->lock);
1377 check_disk_change(bdev);
1378 spin_lock(&blkdev->lock);
1383 spin_unlock(&blkdev->lock);
1384 mutex_unlock(&blkvsc_mutex);
1388 static int blkvsc_release(struct gendisk *disk, fmode_t mode)
1390 struct block_device_context *blkdev = disk->private_data;
1392 DPRINT_DBG(BLKVSC_DRV, "- users %d disk %s\n", blkdev->users,
1393 blkdev->gd->disk_name);
1395 mutex_lock(&blkvsc_mutex);
1396 spin_lock(&blkdev->lock);
1397 if (blkdev->users == 1) {
1398 spin_unlock(&blkdev->lock);
1399 blkvsc_do_flush(blkdev);
1400 spin_lock(&blkdev->lock);
1405 spin_unlock(&blkdev->lock);
1406 mutex_unlock(&blkvsc_mutex);
1410 static unsigned int blkvsc_check_events(struct gendisk *gd,
1411 unsigned int clearing)
1413 DPRINT_DBG(BLKVSC_DRV, "- enter\n");
1414 return DISK_EVENT_MEDIA_CHANGE;
1417 static int blkvsc_revalidate_disk(struct gendisk *gd)
1419 struct block_device_context *blkdev = gd->private_data;
1421 DPRINT_DBG(BLKVSC_DRV, "- enter\n");
1423 if (blkdev->device_type == DVD_TYPE) {
1424 blkvsc_do_read_capacity(blkdev);
1425 set_capacity(blkdev->gd, blkdev->capacity *
1426 (blkdev->sector_size/512));
1427 blk_queue_logical_block_size(gd->queue, blkdev->sector_size);
1432 static int blkvsc_getgeo(struct block_device *bd, struct hd_geometry *hg)
1434 sector_t total_sectors = get_capacity(bd->bd_disk);
1435 sector_t cylinder_times_heads = 0;
1438 int sectors_per_track = 0;
1443 if (total_sectors > (65535 * 16 * 255))
1444 total_sectors = (65535 * 16 * 255);
1446 if (total_sectors >= (65535 * 16 * 63)) {
1447 sectors_per_track = 255;
1450 cylinder_times_heads = total_sectors;
1451 /* sector_div stores the quotient in cylinder_times_heads */
1452 rem = sector_div(cylinder_times_heads, sectors_per_track);
1454 sectors_per_track = 17;
1456 cylinder_times_heads = total_sectors;
1457 /* sector_div stores the quotient in cylinder_times_heads */
1458 rem = sector_div(cylinder_times_heads, sectors_per_track);
1460 temp = cylinder_times_heads + 1023;
1461 /* sector_div stores the quotient in temp */
1462 rem = sector_div(temp, 1024);
1470 if (cylinder_times_heads >= (heads * 1024) || (heads > 16)) {
1471 sectors_per_track = 31;
1474 cylinder_times_heads = total_sectors;
1476 * sector_div stores the quotient in
1477 * cylinder_times_heads
1479 rem = sector_div(cylinder_times_heads,
1483 if (cylinder_times_heads >= (heads * 1024)) {
1484 sectors_per_track = 63;
1487 cylinder_times_heads = total_sectors;
1489 * sector_div stores the quotient in
1490 * cylinder_times_heads
1492 rem = sector_div(cylinder_times_heads,
1497 temp = cylinder_times_heads;
1498 /* sector_div stores the quotient in temp */
1499 rem = sector_div(temp, heads);
1503 hg->sectors = sectors_per_track;
1504 hg->cylinders = cylinders;
1506 DPRINT_INFO(BLKVSC_DRV, "CHS (%d, %d, %d)", cylinders, heads,
1512 static int blkvsc_ioctl(struct block_device *bd, fmode_t mode,
1513 unsigned cmd, unsigned long argument)
1515 /* struct block_device_context *blkdev = bd->bd_disk->private_data; */
1520 * TODO: I think there is certain format for HDIO_GET_IDENTITY rather
1521 * than just a GUID. Commented it out for now.
1524 case HDIO_GET_IDENTITY:
1525 DPRINT_INFO(BLKVSC_DRV, "HDIO_GET_IDENTITY\n");
1526 if (copy_to_user((void __user *)arg, blkdev->device_id,
1527 blkdev->device_id_len))
1539 static int __init blkvsc_init(void)
1543 BUILD_BUG_ON(sizeof(sector_t) != 8);
1545 DPRINT_INFO(BLKVSC_DRV, "Blkvsc initializing....");
1547 ret = blkvsc_drv_init();
1552 static void __exit blkvsc_exit(void)
1557 MODULE_LICENSE("GPL");
1558 MODULE_VERSION(HV_DRV_VERSION);
1559 MODULE_DESCRIPTION("Microsoft Hyper-V virtual block driver");
1560 module_init(blkvsc_init);
1561 module_exit(blkvsc_exit);