1 /* Xenbus code for blkif backend
2 Copyright (C) 2005 Rusty Russell <rusty@rustcorp.com.au>
3 Copyright (C) 2005 XenSource Ltd
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
18 #include <linux/module.h>
19 #include <linux/kthread.h>
20 #include <xen/events.h>
21 #include <xen/grant_table.h>
25 #define DPRINTK(fmt, args...) \
26 pr_debug("blkback/xenbus (%s:%d) " fmt ".\n", \
27 __func__, __LINE__, ##args)
30 struct xenbus_device
*dev
;
31 struct blkif_st
*blkif
;
32 struct xenbus_watch backend_watch
;
38 static struct kmem_cache
*xen_blkif_cachep
;
39 static void connect(struct backend_info
*);
40 static int connect_ring(struct backend_info
*);
41 static void backend_changed(struct xenbus_watch
*, const char **,
44 struct xenbus_device
*xen_blkbk_xenbus(struct backend_info
*be
)
49 static int blkback_name(struct blkif_st
*blkif
, char *buf
)
51 char *devpath
, *devname
;
52 struct xenbus_device
*dev
= blkif
->be
->dev
;
54 devpath
= xenbus_read(XBT_NIL
, dev
->nodename
, "dev", NULL
);
56 return PTR_ERR(devpath
);
58 devname
= strstr(devpath
, "/dev/");
60 devname
+= strlen("/dev/");
64 snprintf(buf
, TASK_COMM_LEN
, "blkback.%d.%s", blkif
->domid
, devname
);
70 static void xen_update_blkif_status(struct blkif_st
*blkif
)
73 char name
[TASK_COMM_LEN
];
75 /* Not ready to connect? */
76 if (!blkif
->irq
|| !blkif
->vbd
.bdev
)
79 /* Already connected? */
80 if (blkif
->be
->dev
->state
== XenbusStateConnected
)
83 /* Attempt to connect: exit if we fail to. */
85 if (blkif
->be
->dev
->state
!= XenbusStateConnected
)
88 err
= blkback_name(blkif
, name
);
90 xenbus_dev_error(blkif
->be
->dev
, err
, "get blkback dev name");
94 err
= filemap_write_and_wait(blkif
->vbd
.bdev
->bd_inode
->i_mapping
);
96 xenbus_dev_error(blkif
->be
->dev
, err
, "block flush");
99 invalidate_inode_pages2(blkif
->vbd
.bdev
->bd_inode
->i_mapping
);
101 blkif
->xenblkd
= kthread_run(xen_blkif_schedule
, blkif
, name
);
102 if (IS_ERR(blkif
->xenblkd
)) {
103 err
= PTR_ERR(blkif
->xenblkd
);
104 blkif
->xenblkd
= NULL
;
105 xenbus_dev_error(blkif
->be
->dev
, err
, "start xenblkd");
109 static struct blkif_st
*xen_blkif_alloc(domid_t domid
)
111 struct blkif_st
*blkif
;
113 blkif
= kmem_cache_alloc(xen_blkif_cachep
, GFP_KERNEL
);
115 return ERR_PTR(-ENOMEM
);
117 memset(blkif
, 0, sizeof(*blkif
));
118 blkif
->domid
= domid
;
119 spin_lock_init(&blkif
->blk_ring_lock
);
120 atomic_set(&blkif
->refcnt
, 1);
121 init_waitqueue_head(&blkif
->wq
);
122 blkif
->st_print
= jiffies
;
123 init_waitqueue_head(&blkif
->waiting_to_free
);
128 static int map_frontend_page(struct blkif_st
*blkif
, unsigned long shared_page
)
130 struct gnttab_map_grant_ref op
;
132 gnttab_set_map_op(&op
, (unsigned long)blkif
->blk_ring_area
->addr
,
133 GNTMAP_host_map
, shared_page
, blkif
->domid
);
135 if (HYPERVISOR_grant_table_op(GNTTABOP_map_grant_ref
, &op
, 1))
139 DPRINTK(" Grant table operation failure !\n");
143 blkif
->shmem_ref
= shared_page
;
144 blkif
->shmem_handle
= op
.handle
;
149 static void unmap_frontend_page(struct blkif_st
*blkif
)
151 struct gnttab_unmap_grant_ref op
;
153 gnttab_set_unmap_op(&op
, (unsigned long)blkif
->blk_ring_area
->addr
,
154 GNTMAP_host_map
, blkif
->shmem_handle
);
156 if (HYPERVISOR_grant_table_op(GNTTABOP_unmap_grant_ref
, &op
, 1))
160 static int xen_blkif_map(struct blkif_st
*blkif
, unsigned long shared_page
,
165 /* Already connected through? */
169 blkif
->blk_ring_area
= alloc_vm_area(PAGE_SIZE
);
170 if (!blkif
->blk_ring_area
)
173 err
= map_frontend_page(blkif
, shared_page
);
175 free_vm_area(blkif
->blk_ring_area
);
179 switch (blkif
->blk_protocol
) {
180 case BLKIF_PROTOCOL_NATIVE
:
182 struct blkif_sring
*sring
;
183 sring
= (struct blkif_sring
*)blkif
->blk_ring_area
->addr
;
184 BACK_RING_INIT(&blkif
->blk_rings
.native
, sring
, PAGE_SIZE
);
187 case BLKIF_PROTOCOL_X86_32
:
189 struct blkif_x86_32_sring
*sring_x86_32
;
190 sring_x86_32
= (struct blkif_x86_32_sring
*)blkif
->blk_ring_area
->addr
;
191 BACK_RING_INIT(&blkif
->blk_rings
.x86_32
, sring_x86_32
, PAGE_SIZE
);
194 case BLKIF_PROTOCOL_X86_64
:
196 struct blkif_x86_64_sring
*sring_x86_64
;
197 sring_x86_64
= (struct blkif_x86_64_sring
*)blkif
->blk_ring_area
->addr
;
198 BACK_RING_INIT(&blkif
->blk_rings
.x86_64
, sring_x86_64
, PAGE_SIZE
);
205 err
= bind_interdomain_evtchn_to_irqhandler(blkif
->domid
, evtchn
,
207 "blkif-backend", blkif
);
209 unmap_frontend_page(blkif
);
210 free_vm_area(blkif
->blk_ring_area
);
211 blkif
->blk_rings
.common
.sring
= NULL
;
219 static void xen_blkif_disconnect(struct blkif_st
*blkif
)
221 if (blkif
->xenblkd
) {
222 kthread_stop(blkif
->xenblkd
);
223 blkif
->xenblkd
= NULL
;
226 atomic_dec(&blkif
->refcnt
);
227 wait_event(blkif
->waiting_to_free
, atomic_read(&blkif
->refcnt
) == 0);
228 atomic_inc(&blkif
->refcnt
);
231 unbind_from_irqhandler(blkif
->irq
, blkif
);
235 if (blkif
->blk_rings
.common
.sring
) {
236 unmap_frontend_page(blkif
);
237 free_vm_area(blkif
->blk_ring_area
);
238 blkif
->blk_rings
.common
.sring
= NULL
;
242 void xen_blkif_free(struct blkif_st
*blkif
)
244 if (!atomic_dec_and_test(&blkif
->refcnt
))
246 kmem_cache_free(xen_blkif_cachep
, blkif
);
249 int __init
xen_blkif_interface_init(void)
251 xen_blkif_cachep
= kmem_cache_create("blkif_cache",
252 sizeof(struct blkif_st
),
254 if (!xen_blkif_cachep
)
261 * sysfs interface for VBD I/O requests
264 #define VBD_SHOW(name, format, args...) \
265 static ssize_t show_##name(struct device *_dev, \
266 struct device_attribute *attr, \
269 struct xenbus_device *dev = to_xenbus_device(_dev); \
270 struct backend_info *be = dev_get_drvdata(&dev->dev); \
272 return sprintf(buf, format, ##args); \
274 static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL)
276 VBD_SHOW(oo_req
, "%d\n", be
->blkif
->st_oo_req
);
277 VBD_SHOW(rd_req
, "%d\n", be
->blkif
->st_rd_req
);
278 VBD_SHOW(wr_req
, "%d\n", be
->blkif
->st_wr_req
);
279 VBD_SHOW(f_req
, "%d\n", be
->blkif
->st_f_req
);
280 VBD_SHOW(rd_sect
, "%d\n", be
->blkif
->st_rd_sect
);
281 VBD_SHOW(wr_sect
, "%d\n", be
->blkif
->st_wr_sect
);
283 static struct attribute
*vbdstat_attrs
[] = {
284 &dev_attr_oo_req
.attr
,
285 &dev_attr_rd_req
.attr
,
286 &dev_attr_wr_req
.attr
,
287 &dev_attr_f_req
.attr
,
288 &dev_attr_rd_sect
.attr
,
289 &dev_attr_wr_sect
.attr
,
293 static struct attribute_group vbdstat_group
= {
294 .name
= "statistics",
295 .attrs
= vbdstat_attrs
,
298 VBD_SHOW(physical_device
, "%x:%x\n", be
->major
, be
->minor
);
299 VBD_SHOW(mode
, "%s\n", be
->mode
);
301 int xenvbd_sysfs_addif(struct xenbus_device
*dev
)
305 error
= device_create_file(&dev
->dev
, &dev_attr_physical_device
);
309 error
= device_create_file(&dev
->dev
, &dev_attr_mode
);
313 error
= sysfs_create_group(&dev
->dev
.kobj
, &vbdstat_group
);
319 fail3
: sysfs_remove_group(&dev
->dev
.kobj
, &vbdstat_group
);
320 fail2
: device_remove_file(&dev
->dev
, &dev_attr_mode
);
321 fail1
: device_remove_file(&dev
->dev
, &dev_attr_physical_device
);
325 void xenvbd_sysfs_delif(struct xenbus_device
*dev
)
327 sysfs_remove_group(&dev
->dev
.kobj
, &vbdstat_group
);
328 device_remove_file(&dev
->dev
, &dev_attr_mode
);
329 device_remove_file(&dev
->dev
, &dev_attr_physical_device
);
333 static void vbd_free(struct vbd
*vbd
)
336 blkdev_put(vbd
->bdev
, vbd
->readonly
? FMODE_READ
: FMODE_WRITE
);
340 static int vbd_create(struct blkif_st
*blkif
, blkif_vdev_t handle
,
341 unsigned major
, unsigned minor
, int readonly
,
345 struct block_device
*bdev
;
346 struct request_queue
*q
;
349 vbd
->handle
= handle
;
350 vbd
->readonly
= readonly
;
353 vbd
->pdevice
= MKDEV(major
, minor
);
355 bdev
= blkdev_get_by_dev(vbd
->pdevice
, vbd
->readonly
?
356 FMODE_READ
: FMODE_WRITE
, NULL
);
359 DPRINTK("vbd_creat: device %08x could not be opened.\n",
365 vbd
->size
= vbd_sz(vbd
);
367 if (vbd
->bdev
->bd_disk
== NULL
) {
368 DPRINTK("vbd_creat: device %08x doesn't exist.\n",
374 if (vbd
->bdev
->bd_disk
->flags
& GENHD_FL_CD
|| cdrom
)
375 vbd
->type
|= VDISK_CDROM
;
376 if (vbd
->bdev
->bd_disk
->flags
& GENHD_FL_REMOVABLE
)
377 vbd
->type
|= VDISK_REMOVABLE
;
379 q
= bdev_get_queue(bdev
);
380 if (q
&& q
->flush_flags
)
381 vbd
->flush_support
= true;
383 DPRINTK("Successful creation of handle=%04x (dom=%u)\n",
384 handle
, blkif
->domid
);
387 static int xen_blkbk_remove(struct xenbus_device
*dev
)
389 struct backend_info
*be
= dev_get_drvdata(&dev
->dev
);
393 if (be
->major
|| be
->minor
)
394 xenvbd_sysfs_delif(dev
);
396 if (be
->backend_watch
.node
) {
397 unregister_xenbus_watch(&be
->backend_watch
);
398 kfree(be
->backend_watch
.node
);
399 be
->backend_watch
.node
= NULL
;
403 xen_blkif_disconnect(be
->blkif
);
404 vbd_free(&be
->blkif
->vbd
);
405 xen_blkif_free(be
->blkif
);
410 dev_set_drvdata(&dev
->dev
, NULL
);
414 int xen_blkbk_flush_diskcache(struct xenbus_transaction xbt
,
415 struct backend_info
*be
, int state
)
417 struct xenbus_device
*dev
= be
->dev
;
420 err
= xenbus_printf(xbt
, dev
->nodename
, "feature-flush-cache",
423 xenbus_dev_fatal(dev
, err
, "writing feature-flush-cache");
429 * Entry point to this code when a new device is created. Allocate the basic
430 * structures, and watch the store waiting for the hotplug scripts to tell us
431 * the device's physical major and minor numbers. Switch to InitWait.
433 static int xen_blkbk_probe(struct xenbus_device
*dev
,
434 const struct xenbus_device_id
*id
)
437 struct backend_info
*be
= kzalloc(sizeof(struct backend_info
),
440 xenbus_dev_fatal(dev
, -ENOMEM
,
441 "allocating backend structure");
445 dev_set_drvdata(&dev
->dev
, be
);
447 be
->blkif
= xen_blkif_alloc(dev
->otherend_id
);
448 if (IS_ERR(be
->blkif
)) {
449 err
= PTR_ERR(be
->blkif
);
451 xenbus_dev_fatal(dev
, err
, "creating block interface");
455 /* setup back pointer */
458 err
= xenbus_watch_pathfmt(dev
, &be
->backend_watch
, backend_changed
,
459 "%s/%s", dev
->nodename
, "physical-device");
463 err
= xenbus_switch_state(dev
, XenbusStateInitWait
);
471 xen_blkbk_remove(dev
);
477 * Callback received when the hotplug scripts have placed the physical-device
478 * node. Read it and the mode node, and create a vbd. If the frontend is
481 static void backend_changed(struct xenbus_watch
*watch
,
482 const char **vec
, unsigned int len
)
487 struct backend_info
*be
488 = container_of(watch
, struct backend_info
, backend_watch
);
489 struct xenbus_device
*dev
= be
->dev
;
495 err
= xenbus_scanf(XBT_NIL
, dev
->nodename
, "physical-device", "%x:%x",
497 if (XENBUS_EXIST_ERR(err
)) {
498 /* Since this watch will fire once immediately after it is
499 registered, we expect this. Ignore it, and wait for the
504 xenbus_dev_fatal(dev
, err
, "reading physical-device");
508 if ((be
->major
|| be
->minor
) &&
509 ((be
->major
!= major
) || (be
->minor
!= minor
))) {
511 "blkback: changing physical device (from %x:%x to "
512 "%x:%x) not supported.\n", be
->major
, be
->minor
,
517 be
->mode
= xenbus_read(XBT_NIL
, dev
->nodename
, "mode", NULL
);
518 if (IS_ERR(be
->mode
)) {
519 err
= PTR_ERR(be
->mode
);
521 xenbus_dev_fatal(dev
, err
, "reading mode");
525 device_type
= xenbus_read(XBT_NIL
, dev
->otherend
, "device-type", NULL
);
526 if (!IS_ERR(device_type
)) {
527 cdrom
= strcmp(device_type
, "cdrom") == 0;
531 if (be
->major
== 0 && be
->minor
== 0) {
532 /* Front end dir is a number, which is used as the handle. */
534 char *p
= strrchr(dev
->otherend
, '/') + 1;
536 err
= strict_strtoul(p
, 0, &handle
);
543 err
= vbd_create(be
->blkif
, handle
, major
, minor
,
544 (NULL
== strchr(be
->mode
, 'w')), cdrom
);
546 be
->major
= be
->minor
= 0;
547 xenbus_dev_fatal(dev
, err
, "creating vbd structure");
551 err
= xenvbd_sysfs_addif(dev
);
553 vbd_free(&be
->blkif
->vbd
);
554 be
->major
= be
->minor
= 0;
555 xenbus_dev_fatal(dev
, err
, "creating sysfs entries");
559 /* We're potentially connected now */
560 xen_update_blkif_status(be
->blkif
);
566 * Callback received when the frontend's state changes.
568 static void frontend_changed(struct xenbus_device
*dev
,
569 enum xenbus_state frontend_state
)
571 struct backend_info
*be
= dev_get_drvdata(&dev
->dev
);
574 DPRINTK("%s", xenbus_strstate(frontend_state
));
576 switch (frontend_state
) {
577 case XenbusStateInitialising
:
578 if (dev
->state
== XenbusStateClosed
) {
579 printk(KERN_INFO
"%s: %s: prepare for reconnect\n",
580 __func__
, dev
->nodename
);
581 xenbus_switch_state(dev
, XenbusStateInitWait
);
585 case XenbusStateInitialised
:
586 case XenbusStateConnected
:
587 /* Ensure we connect even when two watches fire in
588 close successsion and we miss the intermediate value
589 of frontend_state. */
590 if (dev
->state
== XenbusStateConnected
)
593 /* Enforce precondition before potential leak point.
594 * blkif_disconnect() is idempotent.
596 xen_blkif_disconnect(be
->blkif
);
598 err
= connect_ring(be
);
601 xen_update_blkif_status(be
->blkif
);
604 case XenbusStateClosing
:
605 xen_blkif_disconnect(be
->blkif
);
606 xenbus_switch_state(dev
, XenbusStateClosing
);
609 case XenbusStateClosed
:
610 xenbus_switch_state(dev
, XenbusStateClosed
);
611 if (xenbus_dev_is_online(dev
))
613 /* fall through if not online */
614 case XenbusStateUnknown
:
615 /* implies blkif_disconnect() via blkback_remove() */
616 device_unregister(&dev
->dev
);
620 xenbus_dev_fatal(dev
, -EINVAL
, "saw state %d at frontend",
627 /* ** Connection ** */
631 * Write the physical details regarding the block device to the store, and
632 * switch to Connected state.
634 static void connect(struct backend_info
*be
)
636 struct xenbus_transaction xbt
;
638 struct xenbus_device
*dev
= be
->dev
;
640 DPRINTK("%s", dev
->otherend
);
642 /* Supply the information about the device the frontend needs */
644 err
= xenbus_transaction_start(&xbt
);
646 xenbus_dev_fatal(dev
, err
, "starting transaction");
650 err
= xen_blkbk_flush_diskcache(xbt
, be
, be
->blkif
->vbd
.flush_support
);
654 err
= xenbus_printf(xbt
, dev
->nodename
, "sectors", "%llu",
655 (unsigned long long)vbd_sz(&be
->blkif
->vbd
));
657 xenbus_dev_fatal(dev
, err
, "writing %s/sectors",
662 /* FIXME: use a typename instead */
663 err
= xenbus_printf(xbt
, dev
->nodename
, "info", "%u",
664 be
->blkif
->vbd
.type
|
665 (be
->blkif
->vbd
.readonly
? VDISK_READONLY
: 0));
667 xenbus_dev_fatal(dev
, err
, "writing %s/info",
671 err
= xenbus_printf(xbt
, dev
->nodename
, "sector-size", "%lu",
673 bdev_logical_block_size(be
->blkif
->vbd
.bdev
));
675 xenbus_dev_fatal(dev
, err
, "writing %s/sector-size",
680 err
= xenbus_transaction_end(xbt
, 0);
684 xenbus_dev_fatal(dev
, err
, "ending transaction");
686 err
= xenbus_switch_state(dev
, XenbusStateConnected
);
688 xenbus_dev_fatal(dev
, err
, "switching to Connected state",
693 xenbus_transaction_end(xbt
, 1);
697 static int connect_ring(struct backend_info
*be
)
699 struct xenbus_device
*dev
= be
->dev
;
700 unsigned long ring_ref
;
702 char protocol
[64] = "";
705 DPRINTK("%s", dev
->otherend
);
707 err
= xenbus_gather(XBT_NIL
, dev
->otherend
, "ring-ref", "%lu",
708 &ring_ref
, "event-channel", "%u", &evtchn
, NULL
);
710 xenbus_dev_fatal(dev
, err
,
711 "reading %s/ring-ref and event-channel",
716 be
->blkif
->blk_protocol
= BLKIF_PROTOCOL_NATIVE
;
717 err
= xenbus_gather(XBT_NIL
, dev
->otherend
, "protocol",
718 "%63s", protocol
, NULL
);
720 strcpy(protocol
, "unspecified, assuming native");
721 else if (0 == strcmp(protocol
, XEN_IO_PROTO_ABI_NATIVE
))
722 be
->blkif
->blk_protocol
= BLKIF_PROTOCOL_NATIVE
;
723 else if (0 == strcmp(protocol
, XEN_IO_PROTO_ABI_X86_32
))
724 be
->blkif
->blk_protocol
= BLKIF_PROTOCOL_X86_32
;
725 else if (0 == strcmp(protocol
, XEN_IO_PROTO_ABI_X86_64
))
726 be
->blkif
->blk_protocol
= BLKIF_PROTOCOL_X86_64
;
728 xenbus_dev_fatal(dev
, err
, "unknown fe protocol %s", protocol
);
732 "blkback: ring-ref %ld, event-channel %d, protocol %d (%s)\n",
733 ring_ref
, evtchn
, be
->blkif
->blk_protocol
, protocol
);
735 /* Map the shared frame, irq etc. */
736 err
= xen_blkif_map(be
->blkif
, ring_ref
, evtchn
);
738 xenbus_dev_fatal(dev
, err
, "mapping ring-ref %lu port %u",
747 /* ** Driver Registration ** */
750 static const struct xenbus_device_id xen_blkbk_ids
[] = {
756 static struct xenbus_driver xen_blkbk
= {
758 .owner
= THIS_MODULE
,
759 .ids
= xen_blkbk_ids
,
760 .probe
= xen_blkbk_probe
,
761 .remove
= xen_blkbk_remove
,
762 .otherend_changed
= frontend_changed
766 int xen_blkif_xenbus_init(void)
768 return xenbus_register_backend(&xen_blkbk
);