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 struct xenbus_device *dev;
26 struct xen_blkif *blkif;
27 struct xenbus_watch backend_watch;
33 static struct kmem_cache *xen_blkif_cachep;
34 static void connect(struct backend_info *);
35 static int connect_ring(struct backend_info *);
36 static void backend_changed(struct xenbus_watch *, const char **,
39 struct xenbus_device *xen_blkbk_xenbus(struct backend_info *be)
44 static int blkback_name(struct xen_blkif *blkif, char *buf)
46 char *devpath, *devname;
47 struct xenbus_device *dev = blkif->be->dev;
49 devpath = xenbus_read(XBT_NIL, dev->nodename, "dev", NULL);
51 return PTR_ERR(devpath);
53 devname = strstr(devpath, "/dev/");
55 devname += strlen("/dev/");
59 snprintf(buf, TASK_COMM_LEN, "blkback.%d.%s", blkif->domid, devname);
65 static void xen_update_blkif_status(struct xen_blkif *blkif)
68 char name[TASK_COMM_LEN];
70 /* Not ready to connect? */
71 if (!blkif->irq || !blkif->vbd.bdev)
74 /* Already connected? */
75 if (blkif->be->dev->state == XenbusStateConnected)
78 /* Attempt to connect: exit if we fail to. */
80 if (blkif->be->dev->state != XenbusStateConnected)
83 err = blkback_name(blkif, name);
85 xenbus_dev_error(blkif->be->dev, err, "get blkback dev name");
89 err = filemap_write_and_wait(blkif->vbd.bdev->bd_inode->i_mapping);
91 xenbus_dev_error(blkif->be->dev, err, "block flush");
94 invalidate_inode_pages2(blkif->vbd.bdev->bd_inode->i_mapping);
96 blkif->xenblkd = kthread_run(xen_blkif_schedule, blkif, name);
97 if (IS_ERR(blkif->xenblkd)) {
98 err = PTR_ERR(blkif->xenblkd);
99 blkif->xenblkd = NULL;
100 xenbus_dev_error(blkif->be->dev, err, "start xenblkd");
104 static struct xen_blkif *xen_blkif_alloc(domid_t domid)
106 struct xen_blkif *blkif;
108 blkif = kmem_cache_alloc(xen_blkif_cachep, GFP_KERNEL);
110 return ERR_PTR(-ENOMEM);
112 memset(blkif, 0, sizeof(*blkif));
113 blkif->domid = domid;
114 spin_lock_init(&blkif->blk_ring_lock);
115 atomic_set(&blkif->refcnt, 1);
116 init_waitqueue_head(&blkif->wq);
117 init_completion(&blkif->drain_complete);
118 atomic_set(&blkif->drain, 0);
119 blkif->st_print = jiffies;
120 init_waitqueue_head(&blkif->waiting_to_free);
125 static int xen_blkif_map(struct xen_blkif *blkif, unsigned long shared_page,
130 /* Already connected through? */
134 err = xenbus_map_ring_valloc(blkif->be->dev, shared_page, &blkif->blk_ring);
138 switch (blkif->blk_protocol) {
139 case BLKIF_PROTOCOL_NATIVE:
141 struct blkif_sring *sring;
142 sring = (struct blkif_sring *)blkif->blk_ring;
143 BACK_RING_INIT(&blkif->blk_rings.native, sring, PAGE_SIZE);
146 case BLKIF_PROTOCOL_X86_32:
148 struct blkif_x86_32_sring *sring_x86_32;
149 sring_x86_32 = (struct blkif_x86_32_sring *)blkif->blk_ring;
150 BACK_RING_INIT(&blkif->blk_rings.x86_32, sring_x86_32, PAGE_SIZE);
153 case BLKIF_PROTOCOL_X86_64:
155 struct blkif_x86_64_sring *sring_x86_64;
156 sring_x86_64 = (struct blkif_x86_64_sring *)blkif->blk_ring;
157 BACK_RING_INIT(&blkif->blk_rings.x86_64, sring_x86_64, PAGE_SIZE);
164 err = bind_interdomain_evtchn_to_irqhandler(blkif->domid, evtchn,
166 "blkif-backend", blkif);
168 xenbus_unmap_ring_vfree(blkif->be->dev, blkif->blk_ring);
169 blkif->blk_rings.common.sring = NULL;
177 static void xen_blkif_disconnect(struct xen_blkif *blkif)
179 if (blkif->xenblkd) {
180 kthread_stop(blkif->xenblkd);
181 blkif->xenblkd = NULL;
184 atomic_dec(&blkif->refcnt);
185 wait_event(blkif->waiting_to_free, atomic_read(&blkif->refcnt) == 0);
186 atomic_inc(&blkif->refcnt);
189 unbind_from_irqhandler(blkif->irq, blkif);
193 if (blkif->blk_rings.common.sring) {
194 xenbus_unmap_ring_vfree(blkif->be->dev, blkif->blk_ring);
195 blkif->blk_rings.common.sring = NULL;
199 void xen_blkif_free(struct xen_blkif *blkif)
201 if (!atomic_dec_and_test(&blkif->refcnt))
203 kmem_cache_free(xen_blkif_cachep, blkif);
206 int __init xen_blkif_interface_init(void)
208 xen_blkif_cachep = kmem_cache_create("blkif_cache",
209 sizeof(struct xen_blkif),
211 if (!xen_blkif_cachep)
218 * sysfs interface for VBD I/O requests
221 #define VBD_SHOW(name, format, args...) \
222 static ssize_t show_##name(struct device *_dev, \
223 struct device_attribute *attr, \
226 struct xenbus_device *dev = to_xenbus_device(_dev); \
227 struct backend_info *be = dev_get_drvdata(&dev->dev); \
229 return sprintf(buf, format, ##args); \
231 static DEVICE_ATTR(name, S_IRUGO, show_##name, NULL)
233 VBD_SHOW(oo_req, "%d\n", be->blkif->st_oo_req);
234 VBD_SHOW(rd_req, "%d\n", be->blkif->st_rd_req);
235 VBD_SHOW(wr_req, "%d\n", be->blkif->st_wr_req);
236 VBD_SHOW(f_req, "%d\n", be->blkif->st_f_req);
237 VBD_SHOW(ds_req, "%d\n", be->blkif->st_ds_req);
238 VBD_SHOW(rd_sect, "%d\n", be->blkif->st_rd_sect);
239 VBD_SHOW(wr_sect, "%d\n", be->blkif->st_wr_sect);
241 static struct attribute *xen_vbdstat_attrs[] = {
242 &dev_attr_oo_req.attr,
243 &dev_attr_rd_req.attr,
244 &dev_attr_wr_req.attr,
245 &dev_attr_f_req.attr,
246 &dev_attr_ds_req.attr,
247 &dev_attr_rd_sect.attr,
248 &dev_attr_wr_sect.attr,
252 static struct attribute_group xen_vbdstat_group = {
253 .name = "statistics",
254 .attrs = xen_vbdstat_attrs,
257 VBD_SHOW(physical_device, "%x:%x\n", be->major, be->minor);
258 VBD_SHOW(mode, "%s\n", be->mode);
260 int xenvbd_sysfs_addif(struct xenbus_device *dev)
264 error = device_create_file(&dev->dev, &dev_attr_physical_device);
268 error = device_create_file(&dev->dev, &dev_attr_mode);
272 error = sysfs_create_group(&dev->dev.kobj, &xen_vbdstat_group);
278 fail3: sysfs_remove_group(&dev->dev.kobj, &xen_vbdstat_group);
279 fail2: device_remove_file(&dev->dev, &dev_attr_mode);
280 fail1: device_remove_file(&dev->dev, &dev_attr_physical_device);
284 void xenvbd_sysfs_delif(struct xenbus_device *dev)
286 sysfs_remove_group(&dev->dev.kobj, &xen_vbdstat_group);
287 device_remove_file(&dev->dev, &dev_attr_mode);
288 device_remove_file(&dev->dev, &dev_attr_physical_device);
292 static void xen_vbd_free(struct xen_vbd *vbd)
295 blkdev_put(vbd->bdev, vbd->readonly ? FMODE_READ : FMODE_WRITE);
299 static int xen_vbd_create(struct xen_blkif *blkif, blkif_vdev_t handle,
300 unsigned major, unsigned minor, int readonly,
304 struct block_device *bdev;
305 struct request_queue *q;
308 vbd->handle = handle;
309 vbd->readonly = readonly;
312 vbd->pdevice = MKDEV(major, minor);
314 bdev = blkdev_get_by_dev(vbd->pdevice, vbd->readonly ?
315 FMODE_READ : FMODE_WRITE, NULL);
318 DPRINTK("xen_vbd_create: device %08x could not be opened.\n",
324 if (vbd->bdev->bd_disk == NULL) {
325 DPRINTK("xen_vbd_create: device %08x doesn't exist.\n",
330 vbd->size = vbd_sz(vbd);
332 if (vbd->bdev->bd_disk->flags & GENHD_FL_CD || cdrom)
333 vbd->type |= VDISK_CDROM;
334 if (vbd->bdev->bd_disk->flags & GENHD_FL_REMOVABLE)
335 vbd->type |= VDISK_REMOVABLE;
337 q = bdev_get_queue(bdev);
338 if (q && q->flush_flags)
339 vbd->flush_support = true;
341 DPRINTK("Successful creation of handle=%04x (dom=%u)\n",
342 handle, blkif->domid);
345 static int xen_blkbk_remove(struct xenbus_device *dev)
347 struct backend_info *be = dev_get_drvdata(&dev->dev);
351 if (be->major || be->minor)
352 xenvbd_sysfs_delif(dev);
354 if (be->backend_watch.node) {
355 unregister_xenbus_watch(&be->backend_watch);
356 kfree(be->backend_watch.node);
357 be->backend_watch.node = NULL;
361 xen_blkif_disconnect(be->blkif);
362 xen_vbd_free(&be->blkif->vbd);
363 xen_blkif_free(be->blkif);
368 dev_set_drvdata(&dev->dev, NULL);
372 int xen_blkbk_flush_diskcache(struct xenbus_transaction xbt,
373 struct backend_info *be, int state)
375 struct xenbus_device *dev = be->dev;
378 err = xenbus_printf(xbt, dev->nodename, "feature-flush-cache",
381 xenbus_dev_fatal(dev, err, "writing feature-flush-cache");
386 int xen_blkbk_discard(struct xenbus_transaction xbt, struct backend_info *be)
388 struct xenbus_device *dev = be->dev;
389 struct xen_blkif *blkif = be->blkif;
394 type = xenbus_read(XBT_NIL, dev->nodename, "type", NULL);
396 if (strncmp(type, "file", 4) == 0) {
398 blkif->blk_backend_type = BLKIF_BACKEND_FILE;
400 if (strncmp(type, "phy", 3) == 0) {
401 struct block_device *bdev = be->blkif->vbd.bdev;
402 struct request_queue *q = bdev_get_queue(bdev);
403 if (blk_queue_discard(q)) {
404 err = xenbus_printf(xbt, dev->nodename,
405 "discard-granularity", "%u",
406 q->limits.discard_granularity);
408 xenbus_dev_fatal(dev, err,
409 "writing discard-granularity");
412 err = xenbus_printf(xbt, dev->nodename,
413 "discard-alignment", "%u",
414 q->limits.discard_alignment);
416 xenbus_dev_fatal(dev, err,
417 "writing discard-alignment");
421 blkif->blk_backend_type = BLKIF_BACKEND_PHY;
426 xenbus_dev_fatal(dev, err, "reading type");
430 err = xenbus_printf(xbt, dev->nodename, "feature-discard",
433 xenbus_dev_fatal(dev, err, "writing feature-discard");
439 int xen_blkbk_barrier(struct xenbus_transaction xbt,
440 struct backend_info *be, int state)
442 struct xenbus_device *dev = be->dev;
445 err = xenbus_printf(xbt, dev->nodename, "feature-barrier",
448 xenbus_dev_fatal(dev, err, "writing feature-barrier");
454 * Entry point to this code when a new device is created. Allocate the basic
455 * structures, and watch the store waiting for the hotplug scripts to tell us
456 * the device's physical major and minor numbers. Switch to InitWait.
458 static int xen_blkbk_probe(struct xenbus_device *dev,
459 const struct xenbus_device_id *id)
462 struct backend_info *be = kzalloc(sizeof(struct backend_info),
465 xenbus_dev_fatal(dev, -ENOMEM,
466 "allocating backend structure");
470 dev_set_drvdata(&dev->dev, be);
472 be->blkif = xen_blkif_alloc(dev->otherend_id);
473 if (IS_ERR(be->blkif)) {
474 err = PTR_ERR(be->blkif);
476 xenbus_dev_fatal(dev, err, "creating block interface");
480 /* setup back pointer */
483 err = xenbus_watch_pathfmt(dev, &be->backend_watch, backend_changed,
484 "%s/%s", dev->nodename, "physical-device");
488 err = xenbus_switch_state(dev, XenbusStateInitWait);
496 xen_blkbk_remove(dev);
502 * Callback received when the hotplug scripts have placed the physical-device
503 * node. Read it and the mode node, and create a vbd. If the frontend is
506 static void backend_changed(struct xenbus_watch *watch,
507 const char **vec, unsigned int len)
512 struct backend_info *be
513 = container_of(watch, struct backend_info, backend_watch);
514 struct xenbus_device *dev = be->dev;
520 err = xenbus_scanf(XBT_NIL, dev->nodename, "physical-device", "%x:%x",
522 if (XENBUS_EXIST_ERR(err)) {
524 * Since this watch will fire once immediately after it is
525 * registered, we expect this. Ignore it, and wait for the
531 xenbus_dev_fatal(dev, err, "reading physical-device");
535 if ((be->major || be->minor) &&
536 ((be->major != major) || (be->minor != minor))) {
537 pr_warn(DRV_PFX "changing physical device (from %x:%x to %x:%x) not supported.\n",
538 be->major, be->minor, major, minor);
542 be->mode = xenbus_read(XBT_NIL, dev->nodename, "mode", NULL);
543 if (IS_ERR(be->mode)) {
544 err = PTR_ERR(be->mode);
546 xenbus_dev_fatal(dev, err, "reading mode");
550 device_type = xenbus_read(XBT_NIL, dev->otherend, "device-type", NULL);
551 if (!IS_ERR(device_type)) {
552 cdrom = strcmp(device_type, "cdrom") == 0;
556 if (be->major == 0 && be->minor == 0) {
557 /* Front end dir is a number, which is used as the handle. */
559 char *p = strrchr(dev->otherend, '/') + 1;
561 err = strict_strtoul(p, 0, &handle);
568 err = xen_vbd_create(be->blkif, handle, major, minor,
569 (NULL == strchr(be->mode, 'w')), cdrom);
573 xenbus_dev_fatal(dev, err, "creating vbd structure");
577 err = xenvbd_sysfs_addif(dev);
579 xen_vbd_free(&be->blkif->vbd);
582 xenbus_dev_fatal(dev, err, "creating sysfs entries");
586 /* We're potentially connected now */
587 xen_update_blkif_status(be->blkif);
593 * Callback received when the frontend's state changes.
595 static void frontend_changed(struct xenbus_device *dev,
596 enum xenbus_state frontend_state)
598 struct backend_info *be = dev_get_drvdata(&dev->dev);
601 DPRINTK("%s", xenbus_strstate(frontend_state));
603 switch (frontend_state) {
604 case XenbusStateInitialising:
605 if (dev->state == XenbusStateClosed) {
606 pr_info(DRV_PFX "%s: prepare for reconnect\n",
608 xenbus_switch_state(dev, XenbusStateInitWait);
612 case XenbusStateInitialised:
613 case XenbusStateConnected:
615 * Ensure we connect even when two watches fire in
616 * close successsion and we miss the intermediate value
619 if (dev->state == XenbusStateConnected)
623 * Enforce precondition before potential leak point.
624 * xen_blkif_disconnect() is idempotent.
626 xen_blkif_disconnect(be->blkif);
628 err = connect_ring(be);
631 xen_update_blkif_status(be->blkif);
634 case XenbusStateClosing:
635 xenbus_switch_state(dev, XenbusStateClosing);
638 case XenbusStateClosed:
639 xen_blkif_disconnect(be->blkif);
640 xenbus_switch_state(dev, XenbusStateClosed);
641 if (xenbus_dev_is_online(dev))
643 /* fall through if not online */
644 case XenbusStateUnknown:
645 /* implies xen_blkif_disconnect() via xen_blkbk_remove() */
646 device_unregister(&dev->dev);
650 xenbus_dev_fatal(dev, -EINVAL, "saw state %d at frontend",
657 /* ** Connection ** */
661 * Write the physical details regarding the block device to the store, and
662 * switch to Connected state.
664 static void connect(struct backend_info *be)
666 struct xenbus_transaction xbt;
668 struct xenbus_device *dev = be->dev;
670 DPRINTK("%s", dev->otherend);
672 /* Supply the information about the device the frontend needs */
674 err = xenbus_transaction_start(&xbt);
676 xenbus_dev_fatal(dev, err, "starting transaction");
680 err = xen_blkbk_flush_diskcache(xbt, be, be->blkif->vbd.flush_support);
684 err = xen_blkbk_discard(xbt, be);
686 /* If we can't advertise it is OK. */
687 err = xen_blkbk_barrier(xbt, be, be->blkif->vbd.flush_support);
689 err = xenbus_printf(xbt, dev->nodename, "sectors", "%llu",
690 (unsigned long long)vbd_sz(&be->blkif->vbd));
692 xenbus_dev_fatal(dev, err, "writing %s/sectors",
697 /* FIXME: use a typename instead */
698 err = xenbus_printf(xbt, dev->nodename, "info", "%u",
699 be->blkif->vbd.type |
700 (be->blkif->vbd.readonly ? VDISK_READONLY : 0));
702 xenbus_dev_fatal(dev, err, "writing %s/info",
706 err = xenbus_printf(xbt, dev->nodename, "sector-size", "%lu",
708 bdev_logical_block_size(be->blkif->vbd.bdev));
710 xenbus_dev_fatal(dev, err, "writing %s/sector-size",
715 err = xenbus_transaction_end(xbt, 0);
719 xenbus_dev_fatal(dev, err, "ending transaction");
721 err = xenbus_switch_state(dev, XenbusStateConnected);
723 xenbus_dev_fatal(dev, err, "%s: switching to Connected state",
728 xenbus_transaction_end(xbt, 1);
732 static int connect_ring(struct backend_info *be)
734 struct xenbus_device *dev = be->dev;
735 unsigned long ring_ref;
737 char protocol[64] = "";
740 DPRINTK("%s", dev->otherend);
742 err = xenbus_gather(XBT_NIL, dev->otherend, "ring-ref", "%lu",
743 &ring_ref, "event-channel", "%u", &evtchn, NULL);
745 xenbus_dev_fatal(dev, err,
746 "reading %s/ring-ref and event-channel",
751 be->blkif->blk_protocol = BLKIF_PROTOCOL_NATIVE;
752 err = xenbus_gather(XBT_NIL, dev->otherend, "protocol",
753 "%63s", protocol, NULL);
755 strcpy(protocol, "unspecified, assuming native");
756 else if (0 == strcmp(protocol, XEN_IO_PROTO_ABI_NATIVE))
757 be->blkif->blk_protocol = BLKIF_PROTOCOL_NATIVE;
758 else if (0 == strcmp(protocol, XEN_IO_PROTO_ABI_X86_32))
759 be->blkif->blk_protocol = BLKIF_PROTOCOL_X86_32;
760 else if (0 == strcmp(protocol, XEN_IO_PROTO_ABI_X86_64))
761 be->blkif->blk_protocol = BLKIF_PROTOCOL_X86_64;
763 xenbus_dev_fatal(dev, err, "unknown fe protocol %s", protocol);
766 pr_info(DRV_PFX "ring-ref %ld, event-channel %d, protocol %d (%s)\n",
767 ring_ref, evtchn, be->blkif->blk_protocol, protocol);
769 /* Map the shared frame, irq etc. */
770 err = xen_blkif_map(be->blkif, ring_ref, evtchn);
772 xenbus_dev_fatal(dev, err, "mapping ring-ref %lu port %u",
781 /* ** Driver Registration ** */
784 static const struct xenbus_device_id xen_blkbk_ids[] = {
790 static struct xenbus_driver xen_blkbk = {
792 .owner = THIS_MODULE,
793 .ids = xen_blkbk_ids,
794 .probe = xen_blkbk_probe,
795 .remove = xen_blkbk_remove,
796 .otherend_changed = frontend_changed
800 int xen_blkif_xenbus_init(void)
802 return xenbus_register_backend(&xen_blkbk);