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;
109 static DEFINE_MUTEX(blkvsc_mutex);
111 static const char *g_blk_driver_name = "blkvsc";
113 /* {32412632-86cb-44a2-9b5c-50d1417354f5} */
114 static const struct hv_guid g_blk_device_type = {
116 0x32, 0x26, 0x41, 0x32, 0xcb, 0x86, 0xa2, 0x44,
117 0x9b, 0x5c, 0x50, 0xd1, 0x41, 0x73, 0x54, 0xf5
122 * There is a circular dependency involving blkvsc_request_completion()
123 * and blkvsc_do_request().
125 static void blkvsc_request_completion(struct hv_storvsc_request *request);
127 static int blk_vsc_on_device_add(struct hv_device *device,
128 void *additional_info)
130 struct storvsc_device_info *device_info;
133 device_info = (struct storvsc_device_info *)additional_info;
135 ret = stor_vsc_on_device_add(device, additional_info);
140 * We need to use the device instance guid to set the path and target
141 * id. For IDE devices, the device instance id is formatted as
142 * <bus id> * - <device id> - 8899 - 000000000000.
144 device_info->path_id = device->dev_instance.data[3] << 24 |
145 device->dev_instance.data[2] << 16 |
146 device->dev_instance.data[1] << 8 |
147 device->dev_instance.data[0];
149 device_info->target_id = device->dev_instance.data[5] << 8 |
150 device->dev_instance.data[4];
156 static int blk_vsc_initialize(struct hv_driver *driver)
158 struct storvsc_driver_object *stor_driver;
161 stor_driver = hvdr_to_stordr(driver);
163 /* Make sure we are at least 2 pages since 1 page is used for control */
164 /* ASSERT(stor_driver->RingBufferSize >= (PAGE_SIZE << 1)); */
166 driver->name = g_blk_driver_name;
167 memcpy(&driver->dev_type, &g_blk_device_type, sizeof(struct hv_guid));
171 * Divide the ring buffer data size (which is 1 page less than the ring
172 * buffer size since that page is reserved for the ring buffer indices)
173 * by the max request size (which is
174 * vmbus_channel_packet_multipage_buffer + struct vstor_packet + u64)
176 stor_driver->max_outstanding_req_per_channel =
177 ((stor_driver->ring_buffer_size - PAGE_SIZE) /
178 ALIGN(MAX_MULTIPAGE_BUFFER_PACKET +
179 sizeof(struct vstor_packet) + sizeof(u64),
182 DPRINT_INFO(BLKVSC, "max io outstd %u",
183 stor_driver->max_outstanding_req_per_channel);
185 /* Setup the dispatch table */
186 stor_driver->base.dev_add = blk_vsc_on_device_add;
187 stor_driver->base.dev_rm = stor_vsc_on_device_remove;
188 stor_driver->base.cleanup = stor_vsc_on_cleanup;
189 stor_driver->on_io_request = stor_vsc_on_io_request;
195 static int blkvsc_submit_request(struct blkvsc_request *blkvsc_req,
196 void (*request_completion)(struct hv_storvsc_request *))
198 struct block_device_context *blkdev = blkvsc_req->dev;
199 struct hv_device *device_ctx = blkdev->device_ctx;
200 struct hv_driver *drv =
201 drv_to_hv_drv(device_ctx->device.driver);
202 struct storvsc_driver_object *storvsc_drv_obj =
204 struct hv_storvsc_request *storvsc_req;
205 struct vmscsi_request *vm_srb;
208 DPRINT_DBG(BLKVSC_DRV, "blkvsc_submit_request() - "
209 "req %p type %s start_sector %lu count %ld offset %d "
210 "len %d\n", blkvsc_req,
211 (blkvsc_req->write) ? "WRITE" : "READ",
212 (unsigned long) blkvsc_req->sector_start,
213 blkvsc_req->sector_count,
214 blkvsc_req->request.data_buffer.offset,
215 blkvsc_req->request.data_buffer.len);
217 for (i = 0; i < (blkvsc_req->request.data_buffer.len >> 12); i++) {
218 DPRINT_DBG(BLKVSC_DRV, "blkvsc_submit_request() - "
219 "req %p pfn[%d] %llx\n",
221 blkvsc_req->request.data_buffer.pfn_array[i]);
225 storvsc_req = &blkvsc_req->request;
226 vm_srb = &storvsc_req->vstor_packet.vm_srb;
228 vm_srb->data_in = blkvsc_req->write ? WRITE_TYPE : READ_TYPE;
230 storvsc_req->on_io_completion = request_completion;
231 storvsc_req->context = blkvsc_req;
233 vm_srb->port_number = blkdev->port;
234 vm_srb->path_id = blkdev->path;
235 vm_srb->target_id = blkdev->target;
236 vm_srb->lun = 0; /* this is not really used at all */
238 vm_srb->cdb_length = blkvsc_req->cmd_len;
240 memcpy(vm_srb->cdb, blkvsc_req->cmnd, vm_srb->cdb_length);
242 storvsc_req->sense_buffer = blkvsc_req->sense_buffer;
244 ret = storvsc_drv_obj->on_io_request(blkdev->device_ctx,
245 &blkvsc_req->request);
247 blkdev->num_outstanding_reqs++;
253 static int blkvsc_open(struct block_device *bdev, fmode_t mode)
255 struct block_device_context *blkdev = bdev->bd_disk->private_data;
257 DPRINT_DBG(BLKVSC_DRV, "- users %d disk %s\n", blkdev->users,
258 blkdev->gd->disk_name);
260 mutex_lock(&blkvsc_mutex);
261 spin_lock(&blkdev->lock);
263 if (!blkdev->users && blkdev->device_type == DVD_TYPE) {
264 spin_unlock(&blkdev->lock);
265 check_disk_change(bdev);
266 spin_lock(&blkdev->lock);
271 spin_unlock(&blkdev->lock);
272 mutex_unlock(&blkvsc_mutex);
277 static int blkvsc_getgeo(struct block_device *bd, struct hd_geometry *hg)
279 sector_t total_sectors = get_capacity(bd->bd_disk);
280 sector_t cylinder_times_heads = 0;
283 int sectors_per_track = 0;
288 if (total_sectors > (65535 * 16 * 255))
289 total_sectors = (65535 * 16 * 255);
291 if (total_sectors >= (65535 * 16 * 63)) {
292 sectors_per_track = 255;
295 cylinder_times_heads = total_sectors;
296 /* sector_div stores the quotient in cylinder_times_heads */
297 rem = sector_div(cylinder_times_heads, sectors_per_track);
299 sectors_per_track = 17;
301 cylinder_times_heads = total_sectors;
302 /* sector_div stores the quotient in cylinder_times_heads */
303 rem = sector_div(cylinder_times_heads, sectors_per_track);
305 temp = cylinder_times_heads + 1023;
306 /* sector_div stores the quotient in temp */
307 rem = sector_div(temp, 1024);
315 if (cylinder_times_heads >= (heads * 1024) || (heads > 16)) {
316 sectors_per_track = 31;
319 cylinder_times_heads = total_sectors;
321 * sector_div stores the quotient in
322 * cylinder_times_heads
324 rem = sector_div(cylinder_times_heads,
328 if (cylinder_times_heads >= (heads * 1024)) {
329 sectors_per_track = 63;
332 cylinder_times_heads = total_sectors;
334 * sector_div stores the quotient in
335 * cylinder_times_heads
337 rem = sector_div(cylinder_times_heads,
342 temp = cylinder_times_heads;
343 /* sector_div stores the quotient in temp */
344 rem = sector_div(temp, heads);
348 hg->sectors = sectors_per_track;
349 hg->cylinders = cylinders;
351 DPRINT_INFO(BLKVSC_DRV, "CHS (%d, %d, %d)", cylinders, heads,
358 static void blkvsc_init_rw(struct blkvsc_request *blkvsc_req)
360 /* ASSERT(blkvsc_req->req); */
361 /* ASSERT(blkvsc_req->sector_count <=
362 (MAX_MULTIPAGE_BUFFER_COUNT*8)); */
364 blkvsc_req->cmd_len = 16;
366 if (blkvsc_req->sector_start > 0xffffffff) {
367 if (rq_data_dir(blkvsc_req->req)) {
368 blkvsc_req->write = 1;
369 blkvsc_req->cmnd[0] = WRITE_16;
371 blkvsc_req->write = 0;
372 blkvsc_req->cmnd[0] = READ_16;
375 blkvsc_req->cmnd[1] |=
376 (blkvsc_req->req->cmd_flags & REQ_FUA) ? 0x8 : 0;
378 *(unsigned long long *)&blkvsc_req->cmnd[2] =
379 cpu_to_be64(blkvsc_req->sector_start);
380 *(unsigned int *)&blkvsc_req->cmnd[10] =
381 cpu_to_be32(blkvsc_req->sector_count);
382 } else if ((blkvsc_req->sector_count > 0xff) ||
383 (blkvsc_req->sector_start > 0x1fffff)) {
384 if (rq_data_dir(blkvsc_req->req)) {
385 blkvsc_req->write = 1;
386 blkvsc_req->cmnd[0] = WRITE_10;
388 blkvsc_req->write = 0;
389 blkvsc_req->cmnd[0] = READ_10;
392 blkvsc_req->cmnd[1] |=
393 (blkvsc_req->req->cmd_flags & REQ_FUA) ? 0x8 : 0;
395 *(unsigned int *)&blkvsc_req->cmnd[2] =
396 cpu_to_be32(blkvsc_req->sector_start);
397 *(unsigned short *)&blkvsc_req->cmnd[7] =
398 cpu_to_be16(blkvsc_req->sector_count);
400 if (rq_data_dir(blkvsc_req->req)) {
401 blkvsc_req->write = 1;
402 blkvsc_req->cmnd[0] = WRITE_6;
404 blkvsc_req->write = 0;
405 blkvsc_req->cmnd[0] = READ_6;
408 *(unsigned int *)&blkvsc_req->cmnd[1] =
409 cpu_to_be32(blkvsc_req->sector_start) >> 8;
410 blkvsc_req->cmnd[1] &= 0x1f;
411 blkvsc_req->cmnd[4] = (unsigned char)blkvsc_req->sector_count;
416 static int blkvsc_ioctl(struct block_device *bd, fmode_t mode,
417 unsigned cmd, unsigned long argument)
419 /* struct block_device_context *blkdev = bd->bd_disk->private_data; */
424 * TODO: I think there is certain format for HDIO_GET_IDENTITY rather
425 * than just a GUID. Commented it out for now.
428 case HDIO_GET_IDENTITY:
429 DPRINT_INFO(BLKVSC_DRV, "HDIO_GET_IDENTITY\n");
430 if (copy_to_user((void __user *)arg, blkdev->device_id,
431 blkdev->device_id_len))
443 static void blkvsc_cmd_completion(struct hv_storvsc_request *request)
445 struct blkvsc_request *blkvsc_req =
446 (struct blkvsc_request *)request->context;
447 struct block_device_context *blkdev =
448 (struct block_device_context *)blkvsc_req->dev;
449 struct scsi_sense_hdr sense_hdr;
450 struct vmscsi_request *vm_srb;
452 DPRINT_DBG(BLKVSC_DRV, "blkvsc_cmd_completion() - req %p\n",
455 vm_srb = &blkvsc_req->request.vstor_packet.vm_srb;
456 blkdev->num_outstanding_reqs--;
458 if (vm_srb->scsi_status)
459 if (scsi_normalize_sense(blkvsc_req->sense_buffer,
460 SCSI_SENSE_BUFFERSIZE, &sense_hdr))
461 scsi_print_sense_hdr("blkvsc", &sense_hdr);
463 complete(&blkvsc_req->request.wait_event);
466 static int blkvsc_do_flush(struct block_device_context *blkdev)
468 struct blkvsc_request *blkvsc_req;
470 DPRINT_DBG(BLKVSC_DRV, "blkvsc_do_flush()\n");
472 if (blkdev->device_type != HARDDISK_TYPE)
475 blkvsc_req = kmem_cache_zalloc(blkdev->request_pool, GFP_KERNEL);
479 memset(blkvsc_req, 0, sizeof(struct blkvsc_request));
480 init_completion(&blkvsc_req->request.wait_event);
481 blkvsc_req->dev = blkdev;
482 blkvsc_req->req = NULL;
483 blkvsc_req->write = 0;
485 blkvsc_req->request.data_buffer.pfn_array[0] = 0;
486 blkvsc_req->request.data_buffer.offset = 0;
487 blkvsc_req->request.data_buffer.len = 0;
489 blkvsc_req->cmnd[0] = SYNCHRONIZE_CACHE;
490 blkvsc_req->cmd_len = 10;
492 blkvsc_submit_request(blkvsc_req, blkvsc_cmd_completion);
494 wait_for_completion_interruptible(&blkvsc_req->request.wait_event);
496 kmem_cache_free(blkvsc_req->dev->request_pool, blkvsc_req);
502 static int blkvsc_cancel_pending_reqs(struct block_device_context *blkdev)
504 struct blkvsc_request *pend_req, *tmp;
505 struct blkvsc_request *comp_req, *tmp2;
506 struct vmscsi_request *vm_srb;
510 DPRINT_DBG(BLKVSC_DRV, "blkvsc_cancel_pending_reqs()");
512 /* Flush the pending list first */
513 list_for_each_entry_safe(pend_req, tmp, &blkdev->pending_list,
516 * The pend_req could be part of a partially completed
517 * request. If so, complete those req first until we
520 list_for_each_entry_safe(comp_req, tmp2,
521 &pend_req->group->blkvsc_req_list,
523 DPRINT_DBG(BLKVSC_DRV, "completing blkvsc_req %p "
524 "sect_start %lu sect_count %ld\n",
526 (unsigned long) comp_req->sector_start,
527 comp_req->sector_count);
529 if (comp_req == pend_req)
532 list_del(&comp_req->req_entry);
536 &comp_req->request.vstor_packet.
538 ret = __blk_end_request(comp_req->req,
539 (!vm_srb->scsi_status ? 0 : -EIO),
540 comp_req->sector_count *
541 blkdev->sector_size);
543 /* FIXME: shouldn't this do more than return? */
548 kmem_cache_free(blkdev->request_pool, comp_req);
551 DPRINT_DBG(BLKVSC_DRV, "cancelling pending request - %p\n",
554 list_del(&pend_req->pend_entry);
556 list_del(&pend_req->req_entry);
559 if (!__blk_end_request(pend_req->req, -EIO,
560 pend_req->sector_count *
561 blkdev->sector_size)) {
563 * All the sectors have been xferred ie the
566 DPRINT_DBG(BLKVSC_DRV,
567 "blkvsc_cancel_pending_reqs() - "
568 "req %p COMPLETED\n", pend_req->req);
569 kmem_cache_free(blkdev->request_pool,
574 kmem_cache_free(blkdev->request_pool, pend_req);
583 * blkvsc_remove() - Callback when our device is removed
585 static int blkvsc_remove(struct device *device)
587 struct hv_driver *drv =
588 drv_to_hv_drv(device->driver);
589 struct storvsc_driver_object *storvsc_drv_obj =
591 struct hv_device *device_obj = device_to_hv_device(device);
592 struct block_device_context *blkdev = dev_get_drvdata(device);
596 DPRINT_DBG(BLKVSC_DRV, "blkvsc_remove()\n");
598 if (!storvsc_drv_obj->base.dev_rm)
602 * Call to the vsc driver to let it know that the device is being
605 ret = storvsc_drv_obj->base.dev_rm(device_obj);
608 DPRINT_ERR(BLKVSC_DRV,
609 "unable to remove blkvsc device (ret %d)", ret);
612 /* Get to a known state */
613 spin_lock_irqsave(&blkdev->lock, flags);
615 blkdev->shutting_down = 1;
617 blk_stop_queue(blkdev->gd->queue);
619 spin_unlock_irqrestore(&blkdev->lock, flags);
621 while (blkdev->num_outstanding_reqs) {
622 DPRINT_INFO(STORVSC, "waiting for %d requests to complete...",
623 blkdev->num_outstanding_reqs);
627 blkvsc_do_flush(blkdev);
629 spin_lock_irqsave(&blkdev->lock, flags);
631 blkvsc_cancel_pending_reqs(blkdev);
633 spin_unlock_irqrestore(&blkdev->lock, flags);
635 blk_cleanup_queue(blkdev->gd->queue);
637 del_gendisk(blkdev->gd);
639 kmem_cache_destroy(blkdev->request_pool);
646 static void blkvsc_shutdown(struct device *device)
648 struct block_device_context *blkdev = dev_get_drvdata(device);
654 DPRINT_DBG(BLKVSC_DRV, "blkvsc_shutdown - users %d disk %s\n",
655 blkdev->users, blkdev->gd->disk_name);
657 spin_lock_irqsave(&blkdev->lock, flags);
659 blkdev->shutting_down = 1;
661 blk_stop_queue(blkdev->gd->queue);
663 spin_unlock_irqrestore(&blkdev->lock, flags);
665 while (blkdev->num_outstanding_reqs) {
666 DPRINT_INFO(STORVSC, "waiting for %d requests to complete...",
667 blkdev->num_outstanding_reqs);
671 blkvsc_do_flush(blkdev);
673 spin_lock_irqsave(&blkdev->lock, flags);
675 blkvsc_cancel_pending_reqs(blkdev);
677 spin_unlock_irqrestore(&blkdev->lock, flags);
680 static int blkvsc_release(struct gendisk *disk, fmode_t mode)
682 struct block_device_context *blkdev = disk->private_data;
684 DPRINT_DBG(BLKVSC_DRV, "- users %d disk %s\n", blkdev->users,
685 blkdev->gd->disk_name);
687 mutex_lock(&blkvsc_mutex);
688 spin_lock(&blkdev->lock);
689 if (blkdev->users == 1) {
690 spin_unlock(&blkdev->lock);
691 blkvsc_do_flush(blkdev);
692 spin_lock(&blkdev->lock);
697 spin_unlock(&blkdev->lock);
698 mutex_unlock(&blkvsc_mutex);
703 /* Do a scsi READ_CAPACITY cmd here to get the size of the disk */
704 static int blkvsc_do_read_capacity(struct block_device_context *blkdev)
706 struct blkvsc_request *blkvsc_req;
707 struct page *page_buf;
709 struct scsi_sense_hdr sense_hdr;
710 struct vmscsi_request *vm_srb;
712 DPRINT_DBG(BLKVSC_DRV, "blkvsc_do_read_capacity()\n");
714 blkdev->sector_size = 0;
715 blkdev->capacity = 0;
716 blkdev->media_not_present = 0; /* assume a disk is present */
718 blkvsc_req = kmem_cache_zalloc(blkdev->request_pool, GFP_KERNEL);
722 memset(blkvsc_req, 0, sizeof(struct blkvsc_request));
723 page_buf = alloc_page(GFP_KERNEL);
725 kmem_cache_free(blkvsc_req->dev->request_pool, blkvsc_req);
729 vm_srb = &blkvsc_req->request.vstor_packet.vm_srb;
730 init_completion(&blkvsc_req->request.wait_event);
731 blkvsc_req->dev = blkdev;
732 blkvsc_req->req = NULL;
733 blkvsc_req->write = 0;
735 blkvsc_req->request.data_buffer.pfn_array[0] =
736 page_to_pfn(page_buf);
737 blkvsc_req->request.data_buffer.offset = 0;
738 blkvsc_req->request.data_buffer.len = 8;
740 blkvsc_req->cmnd[0] = READ_CAPACITY;
741 blkvsc_req->cmd_len = 16;
743 blkvsc_submit_request(blkvsc_req, blkvsc_cmd_completion);
745 DPRINT_DBG(BLKVSC_DRV, "waiting %p to complete\n",
748 wait_for_completion_interruptible(&blkvsc_req->request.wait_event);
751 if (vm_srb->scsi_status) {
752 scsi_normalize_sense(blkvsc_req->sense_buffer,
753 SCSI_SENSE_BUFFERSIZE, &sense_hdr);
755 if (sense_hdr.asc == 0x3A) {
756 /* Medium not present */
757 blkdev->media_not_present = 1;
761 buf = kmap(page_buf);
764 blkdev->capacity = ((buf[0] << 24) | (buf[1] << 16) |
765 (buf[2] << 8) | buf[3]) + 1;
766 blkdev->sector_size = (buf[4] << 24) | (buf[5] << 16) |
767 (buf[6] << 8) | buf[7];
771 __free_page(page_buf);
773 kmem_cache_free(blkvsc_req->dev->request_pool, blkvsc_req);
779 static int blkvsc_do_read_capacity16(struct block_device_context *blkdev)
781 struct blkvsc_request *blkvsc_req;
782 struct page *page_buf;
784 struct scsi_sense_hdr sense_hdr;
785 struct vmscsi_request *vm_srb;
787 DPRINT_DBG(BLKVSC_DRV, "blkvsc_do_read_capacity16()\n");
789 blkdev->sector_size = 0;
790 blkdev->capacity = 0;
791 blkdev->media_not_present = 0; /* assume a disk is present */
793 blkvsc_req = kmem_cache_zalloc(blkdev->request_pool, GFP_KERNEL);
797 memset(blkvsc_req, 0, sizeof(struct blkvsc_request));
798 vm_srb = &blkvsc_req->request.vstor_packet.vm_srb;
799 page_buf = alloc_page(GFP_KERNEL);
801 kmem_cache_free(blkvsc_req->dev->request_pool, blkvsc_req);
805 init_completion(&blkvsc_req->request.wait_event);
806 blkvsc_req->dev = blkdev;
807 blkvsc_req->req = NULL;
808 blkvsc_req->write = 0;
810 blkvsc_req->request.data_buffer.pfn_array[0] =
811 page_to_pfn(page_buf);
812 blkvsc_req->request.data_buffer.offset = 0;
813 blkvsc_req->request.data_buffer.len = 12;
815 blkvsc_req->cmnd[0] = 0x9E; /* READ_CAPACITY16; */
816 blkvsc_req->cmd_len = 16;
819 * Set this here since the completion routine may be invoked
820 * and completed before we return
823 blkvsc_submit_request(blkvsc_req, blkvsc_cmd_completion);
825 DPRINT_DBG(BLKVSC_DRV, "waiting %p to complete\n",
828 wait_for_completion_interruptible(&blkvsc_req->request.wait_event);
831 if (vm_srb->scsi_status) {
832 scsi_normalize_sense(blkvsc_req->sense_buffer,
833 SCSI_SENSE_BUFFERSIZE, &sense_hdr);
834 if (sense_hdr.asc == 0x3A) {
835 /* Medium not present */
836 blkdev->media_not_present = 1;
840 buf = kmap(page_buf);
843 blkdev->capacity = be64_to_cpu(*(unsigned long long *) &buf[0]) + 1;
844 blkdev->sector_size = be32_to_cpu(*(unsigned int *)&buf[8]);
847 blkdev->capacity = ((buf[0] << 24) | (buf[1] << 16) |
848 (buf[2] << 8) | buf[3]) + 1;
849 blkdev->sector_size = (buf[4] << 24) | (buf[5] << 16) |
850 (buf[6] << 8) | buf[7];
855 __free_page(page_buf);
857 kmem_cache_free(blkvsc_req->dev->request_pool, blkvsc_req);
862 static int blkvsc_revalidate_disk(struct gendisk *gd)
864 struct block_device_context *blkdev = gd->private_data;
866 DPRINT_DBG(BLKVSC_DRV, "- enter\n");
868 if (blkdev->device_type == DVD_TYPE) {
869 blkvsc_do_read_capacity(blkdev);
870 set_capacity(blkdev->gd, blkdev->capacity *
871 (blkdev->sector_size/512));
872 blk_queue_logical_block_size(gd->queue, blkdev->sector_size);
878 /* Do a scsi INQUIRY cmd here to get the device type (ie disk or dvd) */
879 static int blkvsc_do_inquiry(struct block_device_context *blkdev)
881 struct blkvsc_request *blkvsc_req;
882 struct page *page_buf;
884 unsigned char device_type;
886 DPRINT_DBG(BLKVSC_DRV, "blkvsc_do_inquiry()\n");
888 blkvsc_req = kmem_cache_zalloc(blkdev->request_pool, GFP_KERNEL);
892 memset(blkvsc_req, 0, sizeof(struct blkvsc_request));
893 page_buf = alloc_page(GFP_KERNEL);
895 kmem_cache_free(blkvsc_req->dev->request_pool, blkvsc_req);
899 init_completion(&blkvsc_req->request.wait_event);
900 blkvsc_req->dev = blkdev;
901 blkvsc_req->req = NULL;
902 blkvsc_req->write = 0;
904 blkvsc_req->request.data_buffer.pfn_array[0] =
905 page_to_pfn(page_buf);
906 blkvsc_req->request.data_buffer.offset = 0;
907 blkvsc_req->request.data_buffer.len = 64;
909 blkvsc_req->cmnd[0] = INQUIRY;
910 blkvsc_req->cmnd[1] = 0x1; /* Get product data */
911 blkvsc_req->cmnd[2] = 0x83; /* mode page 83 */
912 blkvsc_req->cmnd[4] = 64;
913 blkvsc_req->cmd_len = 6;
915 blkvsc_submit_request(blkvsc_req, blkvsc_cmd_completion);
917 DPRINT_DBG(BLKVSC_DRV, "waiting %p to complete\n",
920 wait_for_completion_interruptible(&blkvsc_req->request.wait_event);
922 buf = kmap(page_buf);
924 /* print_hex_dump_bytes("", DUMP_PREFIX_NONE, buf, 64); */
926 device_type = buf[0] & 0x1F;
928 if (device_type == 0x0) {
929 blkdev->device_type = HARDDISK_TYPE;
930 } else if (device_type == 0x5) {
931 blkdev->device_type = DVD_TYPE;
933 /* TODO: this is currently unsupported device type */
934 blkdev->device_type = UNKNOWN_DEV_TYPE;
937 DPRINT_DBG(BLKVSC_DRV, "device type %d\n", device_type);
939 blkdev->device_id_len = buf[7];
940 if (blkdev->device_id_len > 64)
941 blkdev->device_id_len = 64;
943 memcpy(blkdev->device_id, &buf[8], blkdev->device_id_len);
944 /* printk_hex_dump_bytes("", DUMP_PREFIX_NONE, blkdev->device_id,
945 * blkdev->device_id_len); */
949 __free_page(page_buf);
951 kmem_cache_free(blkvsc_req->dev->request_pool, blkvsc_req);
958 * We break the request into 1 or more blkvsc_requests and submit
959 * them. If we cant submit them all, we put them on the
960 * pending_list. The blkvsc_request() will work on the pending_list.
962 static int blkvsc_do_request(struct block_device_context *blkdev,
965 struct bio *bio = NULL;
966 struct bio_vec *bvec = NULL;
967 struct bio_vec *prev_bvec = NULL;
968 struct blkvsc_request *blkvsc_req = NULL;
969 struct blkvsc_request *tmp;
972 sector_t start_sector;
973 unsigned long num_sectors = 0;
976 struct blkvsc_request_group *group = NULL;
978 DPRINT_DBG(BLKVSC_DRV, "blkdev %p req %p sect %lu\n", blkdev, req,
979 (unsigned long)blk_rq_pos(req));
981 /* Create a group to tie req to list of blkvsc_reqs */
982 group = kmem_cache_zalloc(blkdev->request_pool, GFP_ATOMIC);
986 INIT_LIST_HEAD(&group->blkvsc_req_list);
987 group->outstanding = group->status = 0;
989 start_sector = blk_rq_pos(req);
991 /* foreach bio in the request */
993 for (bio = req->bio; bio; bio = bio->bi_next) {
995 * Map this bio into an existing or new storvsc request
997 bio_for_each_segment(bvec, bio, seg_idx) {
998 DPRINT_DBG(BLKVSC_DRV, "bio_for_each_segment() "
999 "- req %p bio %p bvec %p seg_idx %d "
1000 "databuf_idx %d\n", req, bio, bvec,
1001 seg_idx, databuf_idx);
1003 /* Get a new storvsc request */
1005 if ((!blkvsc_req) ||
1006 (databuf_idx >= MAX_MULTIPAGE_BUFFER_COUNT)
1007 /* hole at the begin of page */
1008 || (bvec->bv_offset != 0) ||
1009 /* hold at the end of page */
1011 (prev_bvec->bv_len != PAGE_SIZE))) {
1012 /* submit the prev one */
1014 blkvsc_req->sector_start =
1017 blkvsc_req->sector_start,
1018 (blkdev->sector_size >> 9));
1020 blkvsc_req->sector_count =
1022 (blkdev->sector_size >> 9);
1023 blkvsc_init_rw(blkvsc_req);
1027 * Create new blkvsc_req to represent
1032 blkdev->request_pool, GFP_ATOMIC);
1034 /* free up everything */
1035 list_for_each_entry_safe(
1037 &group->blkvsc_req_list,
1040 &blkvsc_req->req_entry);
1042 blkdev->request_pool,
1047 blkdev->request_pool, group);
1051 memset(blkvsc_req, 0,
1052 sizeof(struct blkvsc_request));
1054 blkvsc_req->dev = blkdev;
1055 blkvsc_req->req = req;
1056 blkvsc_req->request.
1059 blkvsc_req->request.
1060 data_buffer.len = 0;
1062 /* Add to the group */
1063 blkvsc_req->group = group;
1064 blkvsc_req->group->outstanding++;
1065 list_add_tail(&blkvsc_req->req_entry,
1066 &blkvsc_req->group->blkvsc_req_list);
1068 start_sector += num_sectors;
1074 * Add the curr bvec/segment to the curr
1077 blkvsc_req->request.data_buffer.
1078 pfn_array[databuf_idx]
1079 = page_to_pfn(bvec->bv_page);
1080 blkvsc_req->request.data_buffer.len
1086 num_sectors += bvec->bv_len >> 9;
1088 } /* bio_for_each_segment */
1090 } /* rq_for_each_bio */
1093 /* Handle the last one */
1095 DPRINT_DBG(BLKVSC_DRV, "blkdev %p req %p group %p count %d\n",
1096 blkdev, req, blkvsc_req->group,
1097 blkvsc_req->group->outstanding);
1099 blkvsc_req->sector_start = start_sector;
1100 sector_div(blkvsc_req->sector_start,
1101 (blkdev->sector_size >> 9));
1103 blkvsc_req->sector_count = num_sectors /
1104 (blkdev->sector_size >> 9);
1106 blkvsc_init_rw(blkvsc_req);
1109 list_for_each_entry(blkvsc_req, &group->blkvsc_req_list, req_entry) {
1111 DPRINT_DBG(BLKVSC_DRV, "adding blkvsc_req to "
1112 "pending_list - blkvsc_req %p start_sect %lu"
1113 " sect_count %ld (%lu %ld)\n", blkvsc_req,
1114 (unsigned long)blkvsc_req->sector_start,
1115 blkvsc_req->sector_count,
1116 (unsigned long)start_sector,
1117 (unsigned long)num_sectors);
1119 list_add_tail(&blkvsc_req->pend_entry,
1120 &blkdev->pending_list);
1122 ret = blkvsc_submit_request(blkvsc_req,
1123 blkvsc_request_completion);
1126 list_add_tail(&blkvsc_req->pend_entry,
1127 &blkdev->pending_list);
1130 DPRINT_DBG(BLKVSC_DRV, "submitted blkvsc_req %p "
1131 "start_sect %lu sect_count %ld (%lu %ld) "
1132 "ret %d\n", blkvsc_req,
1133 (unsigned long)blkvsc_req->sector_start,
1134 blkvsc_req->sector_count,
1135 (unsigned long)start_sector,
1143 static int blkvsc_do_pending_reqs(struct block_device_context *blkdev)
1145 struct blkvsc_request *pend_req, *tmp;
1148 /* Flush the pending list first */
1149 list_for_each_entry_safe(pend_req, tmp, &blkdev->pending_list,
1151 DPRINT_DBG(BLKVSC_DRV, "working off pending_list - %p\n",
1154 ret = blkvsc_submit_request(pend_req,
1155 blkvsc_request_completion);
1159 list_del(&pend_req->pend_entry);
1166 static void blkvsc_request(struct request_queue *queue)
1168 struct block_device_context *blkdev = NULL;
1169 struct request *req;
1172 DPRINT_DBG(BLKVSC_DRV, "- enter\n");
1173 while ((req = blk_peek_request(queue)) != NULL) {
1174 DPRINT_DBG(BLKVSC_DRV, "- req %p\n", req);
1176 blkdev = req->rq_disk->private_data;
1177 if (blkdev->shutting_down || req->cmd_type != REQ_TYPE_FS ||
1178 blkdev->media_not_present) {
1179 __blk_end_request_cur(req, 0);
1183 ret = blkvsc_do_pending_reqs(blkdev);
1186 DPRINT_DBG(BLKVSC_DRV,
1187 "- stop queue - pending_list not empty\n");
1188 blk_stop_queue(queue);
1192 blk_start_request(req);
1194 ret = blkvsc_do_request(blkdev, req);
1196 DPRINT_DBG(BLKVSC_DRV, "- stop queue - no room\n");
1197 blk_stop_queue(queue);
1199 } else if (ret < 0) {
1200 DPRINT_DBG(BLKVSC_DRV, "- stop queue - no mem\n");
1201 blk_requeue_request(queue, req);
1202 blk_stop_queue(queue);
1209 static int blkvsc_probe(struct device *dev);
1211 static int blkvsc_ringbuffer_size = BLKVSC_RING_BUFFER_SIZE;
1212 module_param(blkvsc_ringbuffer_size, int, S_IRUGO);
1213 MODULE_PARM_DESC(ring_size, "Ring buffer size (in bytes)");
1215 /* The one and only one */
1216 static struct storvsc_driver_object g_blkvsc_drv;
1218 static const struct block_device_operations block_ops = {
1219 .owner = THIS_MODULE,
1220 .open = blkvsc_open,
1221 .release = blkvsc_release,
1222 .revalidate_disk = blkvsc_revalidate_disk,
1223 .getgeo = blkvsc_getgeo,
1224 .ioctl = blkvsc_ioctl,
1228 * blkvsc_drv_init - BlkVsc driver initialization.
1230 static int blkvsc_drv_init(void)
1232 struct storvsc_driver_object *storvsc_drv_obj = &g_blkvsc_drv;
1233 struct hv_driver *drv = &g_blkvsc_drv.base;
1236 storvsc_drv_obj->ring_buffer_size = blkvsc_ringbuffer_size;
1238 drv->priv = storvsc_drv_obj;
1240 /* Callback to client driver to complete the initialization */
1241 blk_vsc_initialize(&storvsc_drv_obj->base);
1243 drv->driver.name = storvsc_drv_obj->base.name;
1245 drv->driver.probe = blkvsc_probe;
1246 drv->driver.remove = blkvsc_remove;
1247 drv->driver.shutdown = blkvsc_shutdown;
1249 /* The driver belongs to vmbus */
1250 ret = vmbus_child_driver_register(&drv->driver);
1255 static int blkvsc_drv_exit_cb(struct device *dev, void *data)
1257 struct device **curr = (struct device **)data;
1259 return 1; /* stop iterating */
1262 static void blkvsc_drv_exit(void)
1264 struct storvsc_driver_object *storvsc_drv_obj = &g_blkvsc_drv;
1265 struct hv_driver *drv = &g_blkvsc_drv.base;
1266 struct device *current_dev;
1272 /* Get the device */
1273 ret = driver_for_each_device(&drv->driver, NULL,
1274 (void *) ¤t_dev,
1275 blkvsc_drv_exit_cb);
1278 DPRINT_WARN(BLKVSC_DRV,
1279 "driver_for_each_device returned %d", ret);
1282 if (current_dev == NULL)
1285 /* Initiate removal from the top-down */
1286 device_unregister(current_dev);
1289 if (storvsc_drv_obj->base.cleanup)
1290 storvsc_drv_obj->base.cleanup(&storvsc_drv_obj->base);
1292 vmbus_child_driver_unregister(&drv->driver);
1298 * blkvsc_probe - Add a new device for this driver
1300 static int blkvsc_probe(struct device *device)
1302 struct hv_driver *drv =
1303 drv_to_hv_drv(device->driver);
1304 struct storvsc_driver_object *storvsc_drv_obj =
1306 struct hv_device *device_obj = device_to_hv_device(device);
1308 struct block_device_context *blkdev = NULL;
1309 struct storvsc_device_info device_info;
1313 static int ide0_registered;
1314 static int ide1_registered;
1316 DPRINT_DBG(BLKVSC_DRV, "blkvsc_probe - enter");
1318 if (!storvsc_drv_obj->base.dev_add) {
1319 DPRINT_ERR(BLKVSC_DRV, "OnDeviceAdd() not set");
1324 blkdev = kzalloc(sizeof(struct block_device_context), GFP_KERNEL);
1330 INIT_LIST_HEAD(&blkdev->pending_list);
1332 /* Initialize what we can here */
1333 spin_lock_init(&blkdev->lock);
1335 /* ASSERT(sizeof(struct blkvsc_request_group) <= */
1336 /* sizeof(struct blkvsc_request)); */
1338 blkdev->request_pool = kmem_cache_create(dev_name(&device_obj->device),
1339 sizeof(struct blkvsc_request), 0,
1340 SLAB_HWCACHE_ALIGN, NULL);
1341 if (!blkdev->request_pool) {
1347 /* Call to the vsc driver to add the device */
1348 ret = storvsc_drv_obj->base.dev_add(device_obj, &device_info);
1350 DPRINT_ERR(BLKVSC_DRV, "unable to add blkvsc device");
1354 blkdev->device_ctx = device_obj;
1355 /* this identified the device 0 or 1 */
1356 blkdev->target = device_info.target_id;
1357 /* this identified the ide ctrl 0 or 1 */
1358 blkdev->path = device_info.path_id;
1360 dev_set_drvdata(device, blkdev);
1362 /* Calculate the major and device num */
1363 if (blkdev->path == 0) {
1365 devnum = blkdev->path + blkdev->target; /* 0 or 1 */
1367 if (!ide0_registered) {
1368 ret = register_blkdev(major, "ide");
1370 DPRINT_ERR(BLKVSC_DRV,
1371 "register_blkdev() failed! ret %d",
1376 ide0_registered = 1;
1378 } else if (blkdev->path == 1) {
1380 devnum = blkdev->path + blkdev->target + 1; /* 2 or 3 */
1382 if (!ide1_registered) {
1383 ret = register_blkdev(major, "ide");
1385 DPRINT_ERR(BLKVSC_DRV,
1386 "register_blkdev() failed! ret %d",
1391 ide1_registered = 1;
1394 DPRINT_ERR(BLKVSC_DRV, "invalid pathid");
1399 DPRINT_INFO(BLKVSC_DRV, "blkvsc registered for major %d!!", major);
1401 blkdev->gd = alloc_disk(BLKVSC_MINORS);
1403 DPRINT_ERR(BLKVSC_DRV, "register_blkdev() failed! ret %d", ret);
1408 blkdev->gd->queue = blk_init_queue(blkvsc_request, &blkdev->lock);
1410 blk_queue_max_segment_size(blkdev->gd->queue, PAGE_SIZE);
1411 blk_queue_max_segments(blkdev->gd->queue, MAX_MULTIPAGE_BUFFER_COUNT);
1412 blk_queue_segment_boundary(blkdev->gd->queue, PAGE_SIZE-1);
1413 blk_queue_bounce_limit(blkdev->gd->queue, BLK_BOUNCE_ANY);
1414 blk_queue_dma_alignment(blkdev->gd->queue, 511);
1416 blkdev->gd->major = major;
1417 if (devnum == 1 || devnum == 3)
1418 blkdev->gd->first_minor = BLKVSC_MINORS;
1420 blkdev->gd->first_minor = 0;
1421 blkdev->gd->fops = &block_ops;
1422 blkdev->gd->events = DISK_EVENT_MEDIA_CHANGE;
1423 blkdev->gd->private_data = blkdev;
1424 blkdev->gd->driverfs_dev = &(blkdev->device_ctx->device);
1425 sprintf(blkdev->gd->disk_name, "hd%c", 'a' + devnum);
1427 blkvsc_do_inquiry(blkdev);
1428 if (blkdev->device_type == DVD_TYPE) {
1429 set_disk_ro(blkdev->gd, 1);
1430 blkdev->gd->flags |= GENHD_FL_REMOVABLE;
1431 blkvsc_do_read_capacity(blkdev);
1433 blkvsc_do_read_capacity16(blkdev);
1436 set_capacity(blkdev->gd, blkdev->capacity * (blkdev->sector_size/512));
1437 blk_queue_logical_block_size(blkdev->gd->queue, blkdev->sector_size);
1439 add_disk(blkdev->gd);
1441 DPRINT_INFO(BLKVSC_DRV, "%s added!! capacity %lu sector_size %d",
1442 blkdev->gd->disk_name, (unsigned long)blkdev->capacity,
1443 blkdev->sector_size);
1448 storvsc_drv_obj->base.dev_rm(device_obj);
1452 if (blkdev->request_pool) {
1453 kmem_cache_destroy(blkdev->request_pool);
1454 blkdev->request_pool = NULL;
1463 static void blkvsc_request_completion(struct hv_storvsc_request *request)
1465 struct blkvsc_request *blkvsc_req =
1466 (struct blkvsc_request *)request->context;
1467 struct block_device_context *blkdev =
1468 (struct block_device_context *)blkvsc_req->dev;
1469 unsigned long flags;
1470 struct blkvsc_request *comp_req, *tmp;
1471 struct vmscsi_request *vm_srb;
1473 /* ASSERT(blkvsc_req->group); */
1475 DPRINT_DBG(BLKVSC_DRV, "blkdev %p blkvsc_req %p group %p type %s "
1476 "sect_start %lu sect_count %ld len %d group outstd %d "
1477 "total outstd %d\n",
1478 blkdev, blkvsc_req, blkvsc_req->group,
1479 (blkvsc_req->write) ? "WRITE" : "READ",
1480 (unsigned long)blkvsc_req->sector_start,
1481 blkvsc_req->sector_count,
1482 blkvsc_req->request.data_buffer.len,
1483 blkvsc_req->group->outstanding,
1484 blkdev->num_outstanding_reqs);
1486 spin_lock_irqsave(&blkdev->lock, flags);
1488 blkdev->num_outstanding_reqs--;
1489 blkvsc_req->group->outstanding--;
1492 * Only start processing when all the blkvsc_reqs are
1493 * completed. This guarantees no out-of-order blkvsc_req
1494 * completion when calling end_that_request_first()
1496 if (blkvsc_req->group->outstanding == 0) {
1497 list_for_each_entry_safe(comp_req, tmp,
1498 &blkvsc_req->group->blkvsc_req_list,
1500 DPRINT_DBG(BLKVSC_DRV, "completing blkvsc_req %p "
1501 "sect_start %lu sect_count %ld\n",
1503 (unsigned long)comp_req->sector_start,
1504 comp_req->sector_count);
1506 list_del(&comp_req->req_entry);
1509 &comp_req->request.vstor_packet.vm_srb;
1510 if (!__blk_end_request(comp_req->req,
1511 (!vm_srb->scsi_status ? 0 : -EIO),
1512 comp_req->sector_count * blkdev->sector_size)) {
1514 * All the sectors have been xferred ie the
1517 DPRINT_DBG(BLKVSC_DRV, "req %p COMPLETED\n",
1519 kmem_cache_free(blkdev->request_pool,
1523 kmem_cache_free(blkdev->request_pool, comp_req);
1526 if (!blkdev->shutting_down) {
1527 blkvsc_do_pending_reqs(blkdev);
1528 blk_start_queue(blkdev->gd->queue);
1529 blkvsc_request(blkdev->gd->queue);
1533 spin_unlock_irqrestore(&blkdev->lock, flags);
1536 static int __init blkvsc_init(void)
1540 BUILD_BUG_ON(sizeof(sector_t) != 8);
1542 DPRINT_INFO(BLKVSC_DRV, "Blkvsc initializing....");
1544 ret = blkvsc_drv_init();
1549 static void __exit blkvsc_exit(void)
1554 MODULE_LICENSE("GPL");
1555 MODULE_VERSION(HV_DRV_VERSION);
1556 MODULE_DESCRIPTION("Microsoft Hyper-V virtual block driver");
1557 module_init(blkvsc_init);
1558 module_exit(blkvsc_exit);