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++;
246 static unsigned int blkvsc_check_events(struct gendisk *gd,
247 unsigned int clearing)
249 DPRINT_DBG(BLKVSC_DRV, "- enter\n");
250 return DISK_EVENT_MEDIA_CHANGE;
255 static DEFINE_MUTEX(blkvsc_mutex);
256 static int blkvsc_probe(struct device *dev);
257 static int blkvsc_remove(struct device *device);
258 static void blkvsc_shutdown(struct device *device);
260 static int blkvsc_open(struct block_device *bdev, fmode_t mode);
261 static int blkvsc_release(struct gendisk *disk, fmode_t mode);
262 static int blkvsc_revalidate_disk(struct gendisk *gd);
263 static int blkvsc_getgeo(struct block_device *bd, struct hd_geometry *hg);
264 static int blkvsc_ioctl(struct block_device *bd, fmode_t mode,
265 unsigned cmd, unsigned long argument);
266 static void blkvsc_request(struct request_queue *queue);
267 static void blkvsc_request_completion(struct hv_storvsc_request *request);
268 static int blkvsc_do_request(struct block_device_context *blkdev,
269 struct request *req);
270 static void blkvsc_init_rw(struct blkvsc_request *blkvsc_req);
271 static void blkvsc_cmd_completion(struct hv_storvsc_request *request);
272 static int blkvsc_do_inquiry(struct block_device_context *blkdev);
273 static int blkvsc_do_read_capacity(struct block_device_context *blkdev);
274 static int blkvsc_do_read_capacity16(struct block_device_context *blkdev);
275 static int blkvsc_do_flush(struct block_device_context *blkdev);
276 static int blkvsc_cancel_pending_reqs(struct block_device_context *blkdev);
277 static int blkvsc_do_pending_reqs(struct block_device_context *blkdev);
279 static int blkvsc_ringbuffer_size = BLKVSC_RING_BUFFER_SIZE;
280 module_param(blkvsc_ringbuffer_size, int, S_IRUGO);
281 MODULE_PARM_DESC(ring_size, "Ring buffer size (in bytes)");
283 /* The one and only one */
284 static struct storvsc_driver_object g_blkvsc_drv;
286 static const struct block_device_operations block_ops = {
287 .owner = THIS_MODULE,
289 .release = blkvsc_release,
290 .check_events = blkvsc_check_events,
291 .revalidate_disk = blkvsc_revalidate_disk,
292 .getgeo = blkvsc_getgeo,
293 .ioctl = blkvsc_ioctl,
297 * blkvsc_drv_init - BlkVsc driver initialization.
299 static int blkvsc_drv_init(void)
301 struct storvsc_driver_object *storvsc_drv_obj = &g_blkvsc_drv;
302 struct hv_driver *drv = &g_blkvsc_drv.base;
305 storvsc_drv_obj->ring_buffer_size = blkvsc_ringbuffer_size;
307 drv->priv = storvsc_drv_obj;
309 /* Callback to client driver to complete the initialization */
310 blk_vsc_initialize(&storvsc_drv_obj->base);
312 drv->driver.name = storvsc_drv_obj->base.name;
314 drv->driver.probe = blkvsc_probe;
315 drv->driver.remove = blkvsc_remove;
316 drv->driver.shutdown = blkvsc_shutdown;
318 /* The driver belongs to vmbus */
319 ret = vmbus_child_driver_register(&drv->driver);
324 static int blkvsc_drv_exit_cb(struct device *dev, void *data)
326 struct device **curr = (struct device **)data;
328 return 1; /* stop iterating */
331 static void blkvsc_drv_exit(void)
333 struct storvsc_driver_object *storvsc_drv_obj = &g_blkvsc_drv;
334 struct hv_driver *drv = &g_blkvsc_drv.base;
335 struct device *current_dev;
342 ret = driver_for_each_device(&drv->driver, NULL,
343 (void *) ¤t_dev,
347 DPRINT_WARN(BLKVSC_DRV,
348 "driver_for_each_device returned %d", ret);
351 if (current_dev == NULL)
354 /* Initiate removal from the top-down */
355 device_unregister(current_dev);
358 if (storvsc_drv_obj->base.cleanup)
359 storvsc_drv_obj->base.cleanup(&storvsc_drv_obj->base);
361 vmbus_child_driver_unregister(&drv->driver);
367 * blkvsc_probe - Add a new device for this driver
369 static int blkvsc_probe(struct device *device)
371 struct hv_driver *drv =
372 drv_to_hv_drv(device->driver);
373 struct storvsc_driver_object *storvsc_drv_obj =
375 struct hv_device *device_obj = device_to_hv_device(device);
377 struct block_device_context *blkdev = NULL;
378 struct storvsc_device_info device_info;
382 static int ide0_registered;
383 static int ide1_registered;
385 DPRINT_DBG(BLKVSC_DRV, "blkvsc_probe - enter");
387 if (!storvsc_drv_obj->base.dev_add) {
388 DPRINT_ERR(BLKVSC_DRV, "OnDeviceAdd() not set");
393 blkdev = kzalloc(sizeof(struct block_device_context), GFP_KERNEL);
399 INIT_LIST_HEAD(&blkdev->pending_list);
401 /* Initialize what we can here */
402 spin_lock_init(&blkdev->lock);
404 /* ASSERT(sizeof(struct blkvsc_request_group) <= */
405 /* sizeof(struct blkvsc_request)); */
407 blkdev->request_pool = kmem_cache_create(dev_name(&device_obj->device),
408 sizeof(struct blkvsc_request), 0,
409 SLAB_HWCACHE_ALIGN, NULL);
410 if (!blkdev->request_pool) {
416 /* Call to the vsc driver to add the device */
417 ret = storvsc_drv_obj->base.dev_add(device_obj, &device_info);
419 DPRINT_ERR(BLKVSC_DRV, "unable to add blkvsc device");
423 blkdev->device_ctx = device_obj;
424 /* this identified the device 0 or 1 */
425 blkdev->target = device_info.target_id;
426 /* this identified the ide ctrl 0 or 1 */
427 blkdev->path = device_info.path_id;
429 dev_set_drvdata(device, blkdev);
431 /* Calculate the major and device num */
432 if (blkdev->path == 0) {
434 devnum = blkdev->path + blkdev->target; /* 0 or 1 */
436 if (!ide0_registered) {
437 ret = register_blkdev(major, "ide");
439 DPRINT_ERR(BLKVSC_DRV,
440 "register_blkdev() failed! ret %d",
447 } else if (blkdev->path == 1) {
449 devnum = blkdev->path + blkdev->target + 1; /* 2 or 3 */
451 if (!ide1_registered) {
452 ret = register_blkdev(major, "ide");
454 DPRINT_ERR(BLKVSC_DRV,
455 "register_blkdev() failed! ret %d",
463 DPRINT_ERR(BLKVSC_DRV, "invalid pathid");
468 DPRINT_INFO(BLKVSC_DRV, "blkvsc registered for major %d!!", major);
470 blkdev->gd = alloc_disk(BLKVSC_MINORS);
472 DPRINT_ERR(BLKVSC_DRV, "register_blkdev() failed! ret %d", ret);
477 blkdev->gd->queue = blk_init_queue(blkvsc_request, &blkdev->lock);
479 blk_queue_max_segment_size(blkdev->gd->queue, PAGE_SIZE);
480 blk_queue_max_segments(blkdev->gd->queue, MAX_MULTIPAGE_BUFFER_COUNT);
481 blk_queue_segment_boundary(blkdev->gd->queue, PAGE_SIZE-1);
482 blk_queue_bounce_limit(blkdev->gd->queue, BLK_BOUNCE_ANY);
483 blk_queue_dma_alignment(blkdev->gd->queue, 511);
485 blkdev->gd->major = major;
486 if (devnum == 1 || devnum == 3)
487 blkdev->gd->first_minor = BLKVSC_MINORS;
489 blkdev->gd->first_minor = 0;
490 blkdev->gd->fops = &block_ops;
491 blkdev->gd->events = DISK_EVENT_MEDIA_CHANGE;
492 blkdev->gd->private_data = blkdev;
493 blkdev->gd->driverfs_dev = &(blkdev->device_ctx->device);
494 sprintf(blkdev->gd->disk_name, "hd%c", 'a' + devnum);
496 blkvsc_do_inquiry(blkdev);
497 if (blkdev->device_type == DVD_TYPE) {
498 set_disk_ro(blkdev->gd, 1);
499 blkdev->gd->flags |= GENHD_FL_REMOVABLE;
500 blkvsc_do_read_capacity(blkdev);
502 blkvsc_do_read_capacity16(blkdev);
505 set_capacity(blkdev->gd, blkdev->capacity * (blkdev->sector_size/512));
506 blk_queue_logical_block_size(blkdev->gd->queue, blkdev->sector_size);
508 add_disk(blkdev->gd);
510 DPRINT_INFO(BLKVSC_DRV, "%s added!! capacity %lu sector_size %d",
511 blkdev->gd->disk_name, (unsigned long)blkdev->capacity,
512 blkdev->sector_size);
517 storvsc_drv_obj->base.dev_rm(device_obj);
521 if (blkdev->request_pool) {
522 kmem_cache_destroy(blkdev->request_pool);
523 blkdev->request_pool = NULL;
532 static void blkvsc_shutdown(struct device *device)
534 struct block_device_context *blkdev = dev_get_drvdata(device);
540 DPRINT_DBG(BLKVSC_DRV, "blkvsc_shutdown - users %d disk %s\n",
541 blkdev->users, blkdev->gd->disk_name);
543 spin_lock_irqsave(&blkdev->lock, flags);
545 blkdev->shutting_down = 1;
547 blk_stop_queue(blkdev->gd->queue);
549 spin_unlock_irqrestore(&blkdev->lock, flags);
551 while (blkdev->num_outstanding_reqs) {
552 DPRINT_INFO(STORVSC, "waiting for %d requests to complete...",
553 blkdev->num_outstanding_reqs);
557 blkvsc_do_flush(blkdev);
559 spin_lock_irqsave(&blkdev->lock, flags);
561 blkvsc_cancel_pending_reqs(blkdev);
563 spin_unlock_irqrestore(&blkdev->lock, flags);
566 static int blkvsc_do_flush(struct block_device_context *blkdev)
568 struct blkvsc_request *blkvsc_req;
570 DPRINT_DBG(BLKVSC_DRV, "blkvsc_do_flush()\n");
572 if (blkdev->device_type != HARDDISK_TYPE)
575 blkvsc_req = kmem_cache_zalloc(blkdev->request_pool, GFP_KERNEL);
579 memset(blkvsc_req, 0, sizeof(struct blkvsc_request));
580 init_completion(&blkvsc_req->request.wait_event);
581 blkvsc_req->dev = blkdev;
582 blkvsc_req->req = NULL;
583 blkvsc_req->write = 0;
585 blkvsc_req->request.data_buffer.pfn_array[0] = 0;
586 blkvsc_req->request.data_buffer.offset = 0;
587 blkvsc_req->request.data_buffer.len = 0;
589 blkvsc_req->cmnd[0] = SYNCHRONIZE_CACHE;
590 blkvsc_req->cmd_len = 10;
592 blkvsc_submit_request(blkvsc_req, blkvsc_cmd_completion);
594 wait_for_completion_interruptible(&blkvsc_req->request.wait_event);
596 kmem_cache_free(blkvsc_req->dev->request_pool, blkvsc_req);
601 /* Do a scsi INQUIRY cmd here to get the device type (ie disk or dvd) */
602 static int blkvsc_do_inquiry(struct block_device_context *blkdev)
604 struct blkvsc_request *blkvsc_req;
605 struct page *page_buf;
607 unsigned char device_type;
609 DPRINT_DBG(BLKVSC_DRV, "blkvsc_do_inquiry()\n");
611 blkvsc_req = kmem_cache_zalloc(blkdev->request_pool, GFP_KERNEL);
615 memset(blkvsc_req, 0, sizeof(struct blkvsc_request));
616 page_buf = alloc_page(GFP_KERNEL);
618 kmem_cache_free(blkvsc_req->dev->request_pool, blkvsc_req);
622 init_completion(&blkvsc_req->request.wait_event);
623 blkvsc_req->dev = blkdev;
624 blkvsc_req->req = NULL;
625 blkvsc_req->write = 0;
627 blkvsc_req->request.data_buffer.pfn_array[0] =
628 page_to_pfn(page_buf);
629 blkvsc_req->request.data_buffer.offset = 0;
630 blkvsc_req->request.data_buffer.len = 64;
632 blkvsc_req->cmnd[0] = INQUIRY;
633 blkvsc_req->cmnd[1] = 0x1; /* Get product data */
634 blkvsc_req->cmnd[2] = 0x83; /* mode page 83 */
635 blkvsc_req->cmnd[4] = 64;
636 blkvsc_req->cmd_len = 6;
638 blkvsc_submit_request(blkvsc_req, blkvsc_cmd_completion);
640 DPRINT_DBG(BLKVSC_DRV, "waiting %p to complete\n",
643 wait_for_completion_interruptible(&blkvsc_req->request.wait_event);
645 buf = kmap(page_buf);
647 /* print_hex_dump_bytes("", DUMP_PREFIX_NONE, buf, 64); */
649 device_type = buf[0] & 0x1F;
651 if (device_type == 0x0) {
652 blkdev->device_type = HARDDISK_TYPE;
653 } else if (device_type == 0x5) {
654 blkdev->device_type = DVD_TYPE;
656 /* TODO: this is currently unsupported device type */
657 blkdev->device_type = UNKNOWN_DEV_TYPE;
660 DPRINT_DBG(BLKVSC_DRV, "device type %d\n", device_type);
662 blkdev->device_id_len = buf[7];
663 if (blkdev->device_id_len > 64)
664 blkdev->device_id_len = 64;
666 memcpy(blkdev->device_id, &buf[8], blkdev->device_id_len);
667 /* printk_hex_dump_bytes("", DUMP_PREFIX_NONE, blkdev->device_id,
668 * blkdev->device_id_len); */
672 __free_page(page_buf);
674 kmem_cache_free(blkvsc_req->dev->request_pool, blkvsc_req);
679 /* Do a scsi READ_CAPACITY cmd here to get the size of the disk */
680 static int blkvsc_do_read_capacity(struct block_device_context *blkdev)
682 struct blkvsc_request *blkvsc_req;
683 struct page *page_buf;
685 struct scsi_sense_hdr sense_hdr;
686 struct vmscsi_request *vm_srb;
688 DPRINT_DBG(BLKVSC_DRV, "blkvsc_do_read_capacity()\n");
690 blkdev->sector_size = 0;
691 blkdev->capacity = 0;
692 blkdev->media_not_present = 0; /* assume a disk is present */
694 blkvsc_req = kmem_cache_zalloc(blkdev->request_pool, GFP_KERNEL);
698 memset(blkvsc_req, 0, sizeof(struct blkvsc_request));
699 page_buf = alloc_page(GFP_KERNEL);
701 kmem_cache_free(blkvsc_req->dev->request_pool, blkvsc_req);
705 vm_srb = &blkvsc_req->request.vstor_packet.vm_srb;
706 init_completion(&blkvsc_req->request.wait_event);
707 blkvsc_req->dev = blkdev;
708 blkvsc_req->req = NULL;
709 blkvsc_req->write = 0;
711 blkvsc_req->request.data_buffer.pfn_array[0] =
712 page_to_pfn(page_buf);
713 blkvsc_req->request.data_buffer.offset = 0;
714 blkvsc_req->request.data_buffer.len = 8;
716 blkvsc_req->cmnd[0] = READ_CAPACITY;
717 blkvsc_req->cmd_len = 16;
719 blkvsc_submit_request(blkvsc_req, blkvsc_cmd_completion);
721 DPRINT_DBG(BLKVSC_DRV, "waiting %p to complete\n",
724 wait_for_completion_interruptible(&blkvsc_req->request.wait_event);
727 if (vm_srb->scsi_status) {
728 scsi_normalize_sense(blkvsc_req->sense_buffer,
729 SCSI_SENSE_BUFFERSIZE, &sense_hdr);
731 if (sense_hdr.asc == 0x3A) {
732 /* Medium not present */
733 blkdev->media_not_present = 1;
737 buf = kmap(page_buf);
740 blkdev->capacity = ((buf[0] << 24) | (buf[1] << 16) |
741 (buf[2] << 8) | buf[3]) + 1;
742 blkdev->sector_size = (buf[4] << 24) | (buf[5] << 16) |
743 (buf[6] << 8) | buf[7];
747 __free_page(page_buf);
749 kmem_cache_free(blkvsc_req->dev->request_pool, blkvsc_req);
754 static int blkvsc_do_read_capacity16(struct block_device_context *blkdev)
756 struct blkvsc_request *blkvsc_req;
757 struct page *page_buf;
759 struct scsi_sense_hdr sense_hdr;
760 struct vmscsi_request *vm_srb;
762 DPRINT_DBG(BLKVSC_DRV, "blkvsc_do_read_capacity16()\n");
764 blkdev->sector_size = 0;
765 blkdev->capacity = 0;
766 blkdev->media_not_present = 0; /* assume a disk is present */
768 blkvsc_req = kmem_cache_zalloc(blkdev->request_pool, GFP_KERNEL);
772 memset(blkvsc_req, 0, sizeof(struct blkvsc_request));
773 vm_srb = &blkvsc_req->request.vstor_packet.vm_srb;
774 page_buf = alloc_page(GFP_KERNEL);
776 kmem_cache_free(blkvsc_req->dev->request_pool, blkvsc_req);
780 init_completion(&blkvsc_req->request.wait_event);
781 blkvsc_req->dev = blkdev;
782 blkvsc_req->req = NULL;
783 blkvsc_req->write = 0;
785 blkvsc_req->request.data_buffer.pfn_array[0] =
786 page_to_pfn(page_buf);
787 blkvsc_req->request.data_buffer.offset = 0;
788 blkvsc_req->request.data_buffer.len = 12;
790 blkvsc_req->cmnd[0] = 0x9E; /* READ_CAPACITY16; */
791 blkvsc_req->cmd_len = 16;
794 * Set this here since the completion routine may be invoked
795 * and completed before we return
798 blkvsc_submit_request(blkvsc_req, blkvsc_cmd_completion);
800 DPRINT_DBG(BLKVSC_DRV, "waiting %p to complete\n",
803 wait_for_completion_interruptible(&blkvsc_req->request.wait_event);
806 if (vm_srb->scsi_status) {
807 scsi_normalize_sense(blkvsc_req->sense_buffer,
808 SCSI_SENSE_BUFFERSIZE, &sense_hdr);
809 if (sense_hdr.asc == 0x3A) {
810 /* Medium not present */
811 blkdev->media_not_present = 1;
815 buf = kmap(page_buf);
818 blkdev->capacity = be64_to_cpu(*(unsigned long long *) &buf[0]) + 1;
819 blkdev->sector_size = be32_to_cpu(*(unsigned int *)&buf[8]);
822 blkdev->capacity = ((buf[0] << 24) | (buf[1] << 16) |
823 (buf[2] << 8) | buf[3]) + 1;
824 blkdev->sector_size = (buf[4] << 24) | (buf[5] << 16) |
825 (buf[6] << 8) | buf[7];
830 __free_page(page_buf);
832 kmem_cache_free(blkvsc_req->dev->request_pool, blkvsc_req);
838 * blkvsc_remove() - Callback when our device is removed
840 static int blkvsc_remove(struct device *device)
842 struct hv_driver *drv =
843 drv_to_hv_drv(device->driver);
844 struct storvsc_driver_object *storvsc_drv_obj =
846 struct hv_device *device_obj = device_to_hv_device(device);
847 struct block_device_context *blkdev = dev_get_drvdata(device);
851 DPRINT_DBG(BLKVSC_DRV, "blkvsc_remove()\n");
853 if (!storvsc_drv_obj->base.dev_rm)
857 * Call to the vsc driver to let it know that the device is being
860 ret = storvsc_drv_obj->base.dev_rm(device_obj);
863 DPRINT_ERR(BLKVSC_DRV,
864 "unable to remove blkvsc device (ret %d)", ret);
867 /* Get to a known state */
868 spin_lock_irqsave(&blkdev->lock, flags);
870 blkdev->shutting_down = 1;
872 blk_stop_queue(blkdev->gd->queue);
874 spin_unlock_irqrestore(&blkdev->lock, flags);
876 while (blkdev->num_outstanding_reqs) {
877 DPRINT_INFO(STORVSC, "waiting for %d requests to complete...",
878 blkdev->num_outstanding_reqs);
882 blkvsc_do_flush(blkdev);
884 spin_lock_irqsave(&blkdev->lock, flags);
886 blkvsc_cancel_pending_reqs(blkdev);
888 spin_unlock_irqrestore(&blkdev->lock, flags);
890 blk_cleanup_queue(blkdev->gd->queue);
892 del_gendisk(blkdev->gd);
894 kmem_cache_destroy(blkdev->request_pool);
901 static void blkvsc_init_rw(struct blkvsc_request *blkvsc_req)
903 /* ASSERT(blkvsc_req->req); */
904 /* ASSERT(blkvsc_req->sector_count <= (MAX_MULTIPAGE_BUFFER_COUNT*8)); */
906 blkvsc_req->cmd_len = 16;
908 if (blkvsc_req->sector_start > 0xffffffff) {
909 if (rq_data_dir(blkvsc_req->req)) {
910 blkvsc_req->write = 1;
911 blkvsc_req->cmnd[0] = WRITE_16;
913 blkvsc_req->write = 0;
914 blkvsc_req->cmnd[0] = READ_16;
917 blkvsc_req->cmnd[1] |=
918 (blkvsc_req->req->cmd_flags & REQ_FUA) ? 0x8 : 0;
920 *(unsigned long long *)&blkvsc_req->cmnd[2] =
921 cpu_to_be64(blkvsc_req->sector_start);
922 *(unsigned int *)&blkvsc_req->cmnd[10] =
923 cpu_to_be32(blkvsc_req->sector_count);
924 } else if ((blkvsc_req->sector_count > 0xff) ||
925 (blkvsc_req->sector_start > 0x1fffff)) {
926 if (rq_data_dir(blkvsc_req->req)) {
927 blkvsc_req->write = 1;
928 blkvsc_req->cmnd[0] = WRITE_10;
930 blkvsc_req->write = 0;
931 blkvsc_req->cmnd[0] = READ_10;
934 blkvsc_req->cmnd[1] |=
935 (blkvsc_req->req->cmd_flags & REQ_FUA) ? 0x8 : 0;
937 *(unsigned int *)&blkvsc_req->cmnd[2] =
938 cpu_to_be32(blkvsc_req->sector_start);
939 *(unsigned short *)&blkvsc_req->cmnd[7] =
940 cpu_to_be16(blkvsc_req->sector_count);
942 if (rq_data_dir(blkvsc_req->req)) {
943 blkvsc_req->write = 1;
944 blkvsc_req->cmnd[0] = WRITE_6;
946 blkvsc_req->write = 0;
947 blkvsc_req->cmnd[0] = READ_6;
950 *(unsigned int *)&blkvsc_req->cmnd[1] =
951 cpu_to_be32(blkvsc_req->sector_start) >> 8;
952 blkvsc_req->cmnd[1] &= 0x1f;
953 blkvsc_req->cmnd[4] = (unsigned char)blkvsc_req->sector_count;
959 * We break the request into 1 or more blkvsc_requests and submit
960 * them. If we can't submit them all, we put them on the
961 * pending_list. The blkvsc_request() will work on the pending_list.
963 static int blkvsc_do_request(struct block_device_context *blkdev,
966 struct bio *bio = NULL;
967 struct bio_vec *bvec = NULL;
968 struct bio_vec *prev_bvec = NULL;
969 struct blkvsc_request *blkvsc_req = NULL;
970 struct blkvsc_request *tmp;
973 sector_t start_sector;
974 unsigned long num_sectors = 0;
977 struct blkvsc_request_group *group = NULL;
979 DPRINT_DBG(BLKVSC_DRV, "blkdev %p req %p sect %lu\n", blkdev, req,
980 (unsigned long)blk_rq_pos(req));
982 /* Create a group to tie req to list of blkvsc_reqs */
983 group = kmem_cache_zalloc(blkdev->request_pool, GFP_ATOMIC);
987 INIT_LIST_HEAD(&group->blkvsc_req_list);
988 group->outstanding = group->status = 0;
990 start_sector = blk_rq_pos(req);
992 /* foreach bio in the request */
994 for (bio = req->bio; bio; bio = bio->bi_next) {
996 * Map this bio into an existing or new storvsc request
998 bio_for_each_segment(bvec, bio, seg_idx) {
999 DPRINT_DBG(BLKVSC_DRV, "bio_for_each_segment() "
1000 "- req %p bio %p bvec %p seg_idx %d "
1001 "databuf_idx %d\n", req, bio, bvec,
1002 seg_idx, databuf_idx);
1004 /* Get a new storvsc request */
1006 if ((!blkvsc_req) ||
1007 (databuf_idx >= MAX_MULTIPAGE_BUFFER_COUNT)
1008 /* hole at the begin of page */
1009 || (bvec->bv_offset != 0) ||
1010 /* hold at the end of page */
1012 (prev_bvec->bv_len != PAGE_SIZE))) {
1013 /* submit the prev one */
1015 blkvsc_req->sector_start = start_sector;
1016 sector_div(blkvsc_req->sector_start, (blkdev->sector_size >> 9));
1018 blkvsc_req->sector_count = num_sectors / (blkdev->sector_size >> 9);
1019 blkvsc_init_rw(blkvsc_req);
1023 * Create new blkvsc_req to represent
1028 blkdev->request_pool, GFP_ATOMIC);
1030 /* free up everything */
1031 list_for_each_entry_safe(
1033 &group->blkvsc_req_list,
1035 list_del(&blkvsc_req->req_entry);
1036 kmem_cache_free(blkdev->request_pool, blkvsc_req);
1039 kmem_cache_free(blkdev->request_pool, group);
1043 memset(blkvsc_req, 0,
1044 sizeof(struct blkvsc_request));
1046 blkvsc_req->dev = blkdev;
1047 blkvsc_req->req = req;
1048 blkvsc_req->request.
1051 blkvsc_req->request.
1052 data_buffer.len = 0;
1054 /* Add to the group */
1055 blkvsc_req->group = group;
1056 blkvsc_req->group->outstanding++;
1057 list_add_tail(&blkvsc_req->req_entry,
1058 &blkvsc_req->group->blkvsc_req_list);
1060 start_sector += num_sectors;
1065 /* Add the curr bvec/segment to the curr blkvsc_req */
1066 blkvsc_req->request.data_buffer.
1067 pfn_array[databuf_idx]
1068 = page_to_pfn(bvec->bv_page);
1069 blkvsc_req->request.data_buffer.len
1075 num_sectors += bvec->bv_len >> 9;
1077 } /* bio_for_each_segment */
1079 } /* rq_for_each_bio */
1082 /* Handle the last one */
1084 DPRINT_DBG(BLKVSC_DRV, "blkdev %p req %p group %p count %d\n",
1085 blkdev, req, blkvsc_req->group,
1086 blkvsc_req->group->outstanding);
1088 blkvsc_req->sector_start = start_sector;
1089 sector_div(blkvsc_req->sector_start,
1090 (blkdev->sector_size >> 9));
1092 blkvsc_req->sector_count = num_sectors /
1093 (blkdev->sector_size >> 9);
1095 blkvsc_init_rw(blkvsc_req);
1098 list_for_each_entry(blkvsc_req, &group->blkvsc_req_list, req_entry) {
1100 DPRINT_DBG(BLKVSC_DRV, "adding blkvsc_req to "
1101 "pending_list - blkvsc_req %p start_sect %lu"
1102 " sect_count %ld (%lu %ld)\n", blkvsc_req,
1103 (unsigned long)blkvsc_req->sector_start,
1104 blkvsc_req->sector_count,
1105 (unsigned long)start_sector,
1106 (unsigned long)num_sectors);
1108 list_add_tail(&blkvsc_req->pend_entry,
1109 &blkdev->pending_list);
1111 ret = blkvsc_submit_request(blkvsc_req,
1112 blkvsc_request_completion);
1115 list_add_tail(&blkvsc_req->pend_entry,
1116 &blkdev->pending_list);
1119 DPRINT_DBG(BLKVSC_DRV, "submitted blkvsc_req %p "
1120 "start_sect %lu sect_count %ld (%lu %ld) "
1121 "ret %d\n", blkvsc_req,
1122 (unsigned long)blkvsc_req->sector_start,
1123 blkvsc_req->sector_count,
1124 (unsigned long)start_sector,
1132 static void blkvsc_cmd_completion(struct hv_storvsc_request *request)
1134 struct blkvsc_request *blkvsc_req =
1135 (struct blkvsc_request *)request->context;
1136 struct block_device_context *blkdev =
1137 (struct block_device_context *)blkvsc_req->dev;
1138 struct scsi_sense_hdr sense_hdr;
1139 struct vmscsi_request *vm_srb;
1141 DPRINT_DBG(BLKVSC_DRV, "blkvsc_cmd_completion() - req %p\n",
1144 vm_srb = &blkvsc_req->request.vstor_packet.vm_srb;
1145 blkdev->num_outstanding_reqs--;
1147 if (vm_srb->scsi_status)
1148 if (scsi_normalize_sense(blkvsc_req->sense_buffer,
1149 SCSI_SENSE_BUFFERSIZE, &sense_hdr))
1150 scsi_print_sense_hdr("blkvsc", &sense_hdr);
1152 complete(&blkvsc_req->request.wait_event);
1155 static void blkvsc_request_completion(struct hv_storvsc_request *request)
1157 struct blkvsc_request *blkvsc_req =
1158 (struct blkvsc_request *)request->context;
1159 struct block_device_context *blkdev =
1160 (struct block_device_context *)blkvsc_req->dev;
1161 unsigned long flags;
1162 struct blkvsc_request *comp_req, *tmp;
1163 struct vmscsi_request *vm_srb;
1165 /* ASSERT(blkvsc_req->group); */
1167 DPRINT_DBG(BLKVSC_DRV, "blkdev %p blkvsc_req %p group %p type %s "
1168 "sect_start %lu sect_count %ld len %d group outstd %d "
1169 "total outstd %d\n",
1170 blkdev, blkvsc_req, blkvsc_req->group,
1171 (blkvsc_req->write) ? "WRITE" : "READ",
1172 (unsigned long)blkvsc_req->sector_start,
1173 blkvsc_req->sector_count,
1174 blkvsc_req->request.data_buffer.len,
1175 blkvsc_req->group->outstanding,
1176 blkdev->num_outstanding_reqs);
1178 spin_lock_irqsave(&blkdev->lock, flags);
1180 blkdev->num_outstanding_reqs--;
1181 blkvsc_req->group->outstanding--;
1184 * Only start processing when all the blkvsc_reqs are
1185 * completed. This guarantees no out-of-order blkvsc_req
1186 * completion when calling end_that_request_first()
1188 if (blkvsc_req->group->outstanding == 0) {
1189 list_for_each_entry_safe(comp_req, tmp,
1190 &blkvsc_req->group->blkvsc_req_list,
1192 DPRINT_DBG(BLKVSC_DRV, "completing blkvsc_req %p "
1193 "sect_start %lu sect_count %ld\n",
1195 (unsigned long)comp_req->sector_start,
1196 comp_req->sector_count);
1198 list_del(&comp_req->req_entry);
1201 &comp_req->request.vstor_packet.vm_srb;
1202 if (!__blk_end_request(comp_req->req,
1203 (!vm_srb->scsi_status ? 0 : -EIO),
1204 comp_req->sector_count * blkdev->sector_size)) {
1206 * All the sectors have been xferred ie the
1209 DPRINT_DBG(BLKVSC_DRV, "req %p COMPLETED\n",
1211 kmem_cache_free(blkdev->request_pool,
1215 kmem_cache_free(blkdev->request_pool, comp_req);
1218 if (!blkdev->shutting_down) {
1219 blkvsc_do_pending_reqs(blkdev);
1220 blk_start_queue(blkdev->gd->queue);
1221 blkvsc_request(blkdev->gd->queue);
1225 spin_unlock_irqrestore(&blkdev->lock, flags);
1228 static int blkvsc_cancel_pending_reqs(struct block_device_context *blkdev)
1230 struct blkvsc_request *pend_req, *tmp;
1231 struct blkvsc_request *comp_req, *tmp2;
1232 struct vmscsi_request *vm_srb;
1236 DPRINT_DBG(BLKVSC_DRV, "blkvsc_cancel_pending_reqs()");
1238 /* Flush the pending list first */
1239 list_for_each_entry_safe(pend_req, tmp, &blkdev->pending_list,
1242 * The pend_req could be part of a partially completed
1243 * request. If so, complete those req first until we
1246 list_for_each_entry_safe(comp_req, tmp2,
1247 &pend_req->group->blkvsc_req_list,
1249 DPRINT_DBG(BLKVSC_DRV, "completing blkvsc_req %p "
1250 "sect_start %lu sect_count %ld\n",
1252 (unsigned long) comp_req->sector_start,
1253 comp_req->sector_count);
1255 if (comp_req == pend_req)
1258 list_del(&comp_req->req_entry);
1260 if (comp_req->req) {
1262 &comp_req->request.vstor_packet.
1264 ret = __blk_end_request(comp_req->req,
1265 (!vm_srb->scsi_status ? 0 : -EIO),
1266 comp_req->sector_count *
1267 blkdev->sector_size);
1269 /* FIXME: shouldn't this do more than return? */
1274 kmem_cache_free(blkdev->request_pool, comp_req);
1277 DPRINT_DBG(BLKVSC_DRV, "cancelling pending request - %p\n",
1280 list_del(&pend_req->pend_entry);
1282 list_del(&pend_req->req_entry);
1284 if (comp_req->req) {
1285 if (!__blk_end_request(pend_req->req, -EIO,
1286 pend_req->sector_count *
1287 blkdev->sector_size)) {
1289 * All the sectors have been xferred ie the
1292 DPRINT_DBG(BLKVSC_DRV,
1293 "blkvsc_cancel_pending_reqs() - "
1294 "req %p COMPLETED\n", pend_req->req);
1295 kmem_cache_free(blkdev->request_pool,
1300 kmem_cache_free(blkdev->request_pool, pend_req);
1307 static int blkvsc_do_pending_reqs(struct block_device_context *blkdev)
1309 struct blkvsc_request *pend_req, *tmp;
1312 /* Flush the pending list first */
1313 list_for_each_entry_safe(pend_req, tmp, &blkdev->pending_list,
1315 DPRINT_DBG(BLKVSC_DRV, "working off pending_list - %p\n",
1318 ret = blkvsc_submit_request(pend_req,
1319 blkvsc_request_completion);
1323 list_del(&pend_req->pend_entry);
1329 static void blkvsc_request(struct request_queue *queue)
1331 struct block_device_context *blkdev = NULL;
1332 struct request *req;
1335 DPRINT_DBG(BLKVSC_DRV, "- enter\n");
1336 while ((req = blk_peek_request(queue)) != NULL) {
1337 DPRINT_DBG(BLKVSC_DRV, "- req %p\n", req);
1339 blkdev = req->rq_disk->private_data;
1340 if (blkdev->shutting_down || req->cmd_type != REQ_TYPE_FS ||
1341 blkdev->media_not_present) {
1342 __blk_end_request_cur(req, 0);
1346 ret = blkvsc_do_pending_reqs(blkdev);
1349 DPRINT_DBG(BLKVSC_DRV,
1350 "- stop queue - pending_list not empty\n");
1351 blk_stop_queue(queue);
1355 blk_start_request(req);
1357 ret = blkvsc_do_request(blkdev, req);
1359 DPRINT_DBG(BLKVSC_DRV, "- stop queue - no room\n");
1360 blk_stop_queue(queue);
1362 } else if (ret < 0) {
1363 DPRINT_DBG(BLKVSC_DRV, "- stop queue - no mem\n");
1364 blk_requeue_request(queue, req);
1365 blk_stop_queue(queue);
1371 static int blkvsc_open(struct block_device *bdev, fmode_t mode)
1373 struct block_device_context *blkdev = bdev->bd_disk->private_data;
1375 DPRINT_DBG(BLKVSC_DRV, "- users %d disk %s\n", blkdev->users,
1376 blkdev->gd->disk_name);
1378 mutex_lock(&blkvsc_mutex);
1379 spin_lock(&blkdev->lock);
1381 if (!blkdev->users && blkdev->device_type == DVD_TYPE) {
1382 spin_unlock(&blkdev->lock);
1383 check_disk_change(bdev);
1384 spin_lock(&blkdev->lock);
1389 spin_unlock(&blkdev->lock);
1390 mutex_unlock(&blkvsc_mutex);
1394 static int blkvsc_release(struct gendisk *disk, fmode_t mode)
1396 struct block_device_context *blkdev = disk->private_data;
1398 DPRINT_DBG(BLKVSC_DRV, "- users %d disk %s\n", blkdev->users,
1399 blkdev->gd->disk_name);
1401 mutex_lock(&blkvsc_mutex);
1402 spin_lock(&blkdev->lock);
1403 if (blkdev->users == 1) {
1404 spin_unlock(&blkdev->lock);
1405 blkvsc_do_flush(blkdev);
1406 spin_lock(&blkdev->lock);
1411 spin_unlock(&blkdev->lock);
1412 mutex_unlock(&blkvsc_mutex);
1416 static int blkvsc_revalidate_disk(struct gendisk *gd)
1418 struct block_device_context *blkdev = gd->private_data;
1420 DPRINT_DBG(BLKVSC_DRV, "- enter\n");
1422 if (blkdev->device_type == DVD_TYPE) {
1423 blkvsc_do_read_capacity(blkdev);
1424 set_capacity(blkdev->gd, blkdev->capacity *
1425 (blkdev->sector_size/512));
1426 blk_queue_logical_block_size(gd->queue, blkdev->sector_size);
1431 static int blkvsc_getgeo(struct block_device *bd, struct hd_geometry *hg)
1433 sector_t total_sectors = get_capacity(bd->bd_disk);
1434 sector_t cylinder_times_heads = 0;
1437 int sectors_per_track = 0;
1442 if (total_sectors > (65535 * 16 * 255))
1443 total_sectors = (65535 * 16 * 255);
1445 if (total_sectors >= (65535 * 16 * 63)) {
1446 sectors_per_track = 255;
1449 cylinder_times_heads = total_sectors;
1450 /* sector_div stores the quotient in cylinder_times_heads */
1451 rem = sector_div(cylinder_times_heads, sectors_per_track);
1453 sectors_per_track = 17;
1455 cylinder_times_heads = total_sectors;
1456 /* sector_div stores the quotient in cylinder_times_heads */
1457 rem = sector_div(cylinder_times_heads, sectors_per_track);
1459 temp = cylinder_times_heads + 1023;
1460 /* sector_div stores the quotient in temp */
1461 rem = sector_div(temp, 1024);
1469 if (cylinder_times_heads >= (heads * 1024) || (heads > 16)) {
1470 sectors_per_track = 31;
1473 cylinder_times_heads = total_sectors;
1475 * sector_div stores the quotient in
1476 * cylinder_times_heads
1478 rem = sector_div(cylinder_times_heads,
1482 if (cylinder_times_heads >= (heads * 1024)) {
1483 sectors_per_track = 63;
1486 cylinder_times_heads = total_sectors;
1488 * sector_div stores the quotient in
1489 * cylinder_times_heads
1491 rem = sector_div(cylinder_times_heads,
1496 temp = cylinder_times_heads;
1497 /* sector_div stores the quotient in temp */
1498 rem = sector_div(temp, heads);
1502 hg->sectors = sectors_per_track;
1503 hg->cylinders = cylinders;
1505 DPRINT_INFO(BLKVSC_DRV, "CHS (%d, %d, %d)", cylinders, heads,
1511 static int blkvsc_ioctl(struct block_device *bd, fmode_t mode,
1512 unsigned cmd, unsigned long argument)
1514 /* struct block_device_context *blkdev = bd->bd_disk->private_data; */
1519 * TODO: I think there is certain format for HDIO_GET_IDENTITY rather
1520 * than just a GUID. Commented it out for now.
1523 case HDIO_GET_IDENTITY:
1524 DPRINT_INFO(BLKVSC_DRV, "HDIO_GET_IDENTITY\n");
1525 if (copy_to_user((void __user *)arg, blkdev->device_id,
1526 blkdev->device_id_len))
1538 static int __init blkvsc_init(void)
1542 BUILD_BUG_ON(sizeof(sector_t) != 8);
1544 DPRINT_INFO(BLKVSC_DRV, "Blkvsc initializing....");
1546 ret = blkvsc_drv_init();
1551 static void __exit blkvsc_exit(void)
1556 MODULE_LICENSE("GPL");
1557 MODULE_VERSION(HV_DRV_VERSION);
1558 MODULE_DESCRIPTION("Microsoft Hyper-V virtual block driver");
1559 module_init(blkvsc_init);
1560 module_exit(blkvsc_exit);