1 /******************************************************************************
2 * Talks to Xen Store to figure out what devices we have.
4 * Copyright (C) 2005 Rusty Russell, IBM Corporation
5 * Copyright (C) 2005 Mike Wray, Hewlett-Packard
6 * Copyright (C) 2005, 2006 XenSource Ltd
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License version 2
10 * as published by the Free Software Foundation; or, when distributed
11 * separately from the Linux kernel or incorporated into other
12 * software packages, subject to the following license:
14 * Permission is hereby granted, free of charge, to any person obtaining a copy
15 * of this source file (the "Software"), to deal in the Software without
16 * restriction, including without limitation the rights to use, copy, modify,
17 * merge, publish, distribute, sublicense, and/or sell copies of the Software,
18 * and to permit persons to whom the Software is furnished to do so, subject to
19 * the following conditions:
21 * The above copyright notice and this permission notice shall be included in
22 * all copies or substantial portions of the Software.
24 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
25 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
26 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
27 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
28 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
29 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
33 #define DPRINTK(fmt, args...) \
34 pr_debug("xenbus_probe (%s:%d) " fmt ".\n", \
35 __func__, __LINE__, ##args)
37 #include <linux/kernel.h>
38 #include <linux/err.h>
39 #include <linux/string.h>
40 #include <linux/ctype.h>
41 #include <linux/fcntl.h>
43 #include <linux/proc_fs.h>
44 #include <linux/notifier.h>
45 #include <linux/kthread.h>
46 #include <linux/mutex.h>
48 #include <linux/slab.h>
49 #include <linux/module.h>
52 #include <asm/pgtable.h>
53 #include <asm/xen/hypervisor.h>
56 #include <xen/xenbus.h>
57 #include <xen/events.h>
62 #include "xenbus_comms.h"
63 #include "xenbus_probe.h"
67 EXPORT_SYMBOL_GPL(xen_store_evtchn);
69 struct xenstore_domain_interface *xen_store_interface;
70 EXPORT_SYMBOL_GPL(xen_store_interface);
72 static unsigned long xen_store_mfn;
74 static BLOCKING_NOTIFIER_HEAD(xenstore_chain);
76 /* If something in array of ids matches this device, return it. */
77 static const struct xenbus_device_id *
78 match_device(const struct xenbus_device_id *arr, struct xenbus_device *dev)
80 for (; *arr->devicetype != '\0'; arr++) {
81 if (!strcmp(arr->devicetype, dev->devicetype))
87 int xenbus_match(struct device *_dev, struct device_driver *_drv)
89 struct xenbus_driver *drv = to_xenbus_driver(_drv);
94 return match_device(drv->ids, to_xenbus_device(_dev)) != NULL;
96 EXPORT_SYMBOL_GPL(xenbus_match);
99 static void free_otherend_details(struct xenbus_device *dev)
101 kfree(dev->otherend);
102 dev->otherend = NULL;
106 static void free_otherend_watch(struct xenbus_device *dev)
108 if (dev->otherend_watch.node) {
109 unregister_xenbus_watch(&dev->otherend_watch);
110 kfree(dev->otherend_watch.node);
111 dev->otherend_watch.node = NULL;
116 static int talk_to_otherend(struct xenbus_device *dev)
118 struct xenbus_driver *drv = to_xenbus_driver(dev->dev.driver);
120 free_otherend_watch(dev);
121 free_otherend_details(dev);
123 return drv->read_otherend_details(dev);
128 static int watch_otherend(struct xenbus_device *dev)
130 struct xen_bus_type *bus =
131 container_of(dev->dev.bus, struct xen_bus_type, bus);
133 return xenbus_watch_pathfmt(dev, &dev->otherend_watch,
134 bus->otherend_changed,
135 "%s/%s", dev->otherend, "state");
139 int xenbus_read_otherend_details(struct xenbus_device *xendev,
140 char *id_node, char *path_node)
142 int err = xenbus_gather(XBT_NIL, xendev->nodename,
143 id_node, "%i", &xendev->otherend_id,
144 path_node, NULL, &xendev->otherend,
147 xenbus_dev_fatal(xendev, err,
148 "reading other end details from %s",
152 if (strlen(xendev->otherend) == 0 ||
153 !xenbus_exists(XBT_NIL, xendev->otherend, "")) {
154 xenbus_dev_fatal(xendev, -ENOENT,
155 "unable to read other end from %s. "
156 "missing or inaccessible.",
158 free_otherend_details(xendev);
164 EXPORT_SYMBOL_GPL(xenbus_read_otherend_details);
166 void xenbus_otherend_changed(struct xenbus_watch *watch,
167 const char **vec, unsigned int len,
168 int ignore_on_shutdown)
170 struct xenbus_device *dev =
171 container_of(watch, struct xenbus_device, otherend_watch);
172 struct xenbus_driver *drv = to_xenbus_driver(dev->dev.driver);
173 enum xenbus_state state;
175 /* Protect us against watches firing on old details when the otherend
176 details change, say immediately after a resume. */
177 if (!dev->otherend ||
178 strncmp(dev->otherend, vec[XS_WATCH_PATH],
179 strlen(dev->otherend))) {
180 dev_dbg(&dev->dev, "Ignoring watch at %s\n",
185 state = xenbus_read_driver_state(dev->otherend);
187 dev_dbg(&dev->dev, "state is %d, (%s), %s, %s\n",
188 state, xenbus_strstate(state), dev->otherend_watch.node,
192 * Ignore xenbus transitions during shutdown. This prevents us doing
193 * work that can fail e.g., when the rootfs is gone.
195 if (system_state > SYSTEM_RUNNING) {
196 if (ignore_on_shutdown && (state == XenbusStateClosing))
197 xenbus_frontend_closed(dev);
201 if (drv->otherend_changed)
202 drv->otherend_changed(dev, state);
204 EXPORT_SYMBOL_GPL(xenbus_otherend_changed);
206 int xenbus_dev_probe(struct device *_dev)
208 struct xenbus_device *dev = to_xenbus_device(_dev);
209 struct xenbus_driver *drv = to_xenbus_driver(_dev->driver);
210 const struct xenbus_device_id *id;
213 DPRINTK("%s", dev->nodename);
220 id = match_device(drv->ids, dev);
226 err = talk_to_otherend(dev);
228 dev_warn(&dev->dev, "talk_to_otherend on %s failed.\n",
233 err = drv->probe(dev, id);
237 err = watch_otherend(dev);
239 dev_warn(&dev->dev, "watch_otherend on %s failed.\n",
246 xenbus_dev_error(dev, err, "xenbus_dev_probe on %s", dev->nodename);
247 xenbus_switch_state(dev, XenbusStateClosed);
250 EXPORT_SYMBOL_GPL(xenbus_dev_probe);
252 int xenbus_dev_remove(struct device *_dev)
254 struct xenbus_device *dev = to_xenbus_device(_dev);
255 struct xenbus_driver *drv = to_xenbus_driver(_dev->driver);
257 DPRINTK("%s", dev->nodename);
259 free_otherend_watch(dev);
264 free_otherend_details(dev);
266 xenbus_switch_state(dev, XenbusStateClosed);
269 EXPORT_SYMBOL_GPL(xenbus_dev_remove);
271 void xenbus_dev_shutdown(struct device *_dev)
273 struct xenbus_device *dev = to_xenbus_device(_dev);
274 unsigned long timeout = 5*HZ;
276 DPRINTK("%s", dev->nodename);
278 get_device(&dev->dev);
279 if (dev->state != XenbusStateConnected) {
280 printk(KERN_INFO "%s: %s: %s != Connected, skipping\n", __func__,
281 dev->nodename, xenbus_strstate(dev->state));
284 xenbus_switch_state(dev, XenbusStateClosing);
285 timeout = wait_for_completion_timeout(&dev->down, timeout);
287 printk(KERN_INFO "%s: %s timeout closing device\n",
288 __func__, dev->nodename);
290 put_device(&dev->dev);
292 EXPORT_SYMBOL_GPL(xenbus_dev_shutdown);
294 int xenbus_register_driver_common(struct xenbus_driver *drv,
295 struct xen_bus_type *bus)
297 drv->driver.bus = &bus->bus;
299 return driver_register(&drv->driver);
301 EXPORT_SYMBOL_GPL(xenbus_register_driver_common);
303 void xenbus_unregister_driver(struct xenbus_driver *drv)
305 driver_unregister(&drv->driver);
307 EXPORT_SYMBOL_GPL(xenbus_unregister_driver);
309 struct xb_find_info {
310 struct xenbus_device *dev;
311 const char *nodename;
314 static int cmp_dev(struct device *dev, void *data)
316 struct xenbus_device *xendev = to_xenbus_device(dev);
317 struct xb_find_info *info = data;
319 if (!strcmp(xendev->nodename, info->nodename)) {
327 static struct xenbus_device *xenbus_device_find(const char *nodename,
328 struct bus_type *bus)
330 struct xb_find_info info = { .dev = NULL, .nodename = nodename };
332 bus_for_each_dev(bus, NULL, &info, cmp_dev);
336 static int cleanup_dev(struct device *dev, void *data)
338 struct xenbus_device *xendev = to_xenbus_device(dev);
339 struct xb_find_info *info = data;
340 int len = strlen(info->nodename);
342 DPRINTK("%s", info->nodename);
344 /* Match the info->nodename path, or any subdirectory of that path. */
345 if (strncmp(xendev->nodename, info->nodename, len))
348 /* If the node name is longer, ensure it really is a subdirectory. */
349 if ((strlen(xendev->nodename) > len) && (xendev->nodename[len] != '/'))
357 static void xenbus_cleanup_devices(const char *path, struct bus_type *bus)
359 struct xb_find_info info = { .nodename = path };
363 bus_for_each_dev(bus, NULL, &info, cleanup_dev);
365 device_unregister(&info.dev->dev);
366 put_device(&info.dev->dev);
371 static void xenbus_dev_release(struct device *dev)
374 kfree(to_xenbus_device(dev));
377 static ssize_t nodename_show(struct device *dev,
378 struct device_attribute *attr, char *buf)
380 return sprintf(buf, "%s\n", to_xenbus_device(dev)->nodename);
383 static ssize_t devtype_show(struct device *dev,
384 struct device_attribute *attr, char *buf)
386 return sprintf(buf, "%s\n", to_xenbus_device(dev)->devicetype);
389 static ssize_t modalias_show(struct device *dev,
390 struct device_attribute *attr, char *buf)
392 return sprintf(buf, "%s:%s\n", dev->bus->name,
393 to_xenbus_device(dev)->devicetype);
396 struct device_attribute xenbus_dev_attrs[] = {
402 EXPORT_SYMBOL_GPL(xenbus_dev_attrs);
404 int xenbus_probe_node(struct xen_bus_type *bus,
406 const char *nodename)
408 char devname[XEN_BUS_ID_SIZE];
410 struct xenbus_device *xendev;
414 enum xenbus_state state = xenbus_read_driver_state(nodename);
416 if (state != XenbusStateInitialising) {
417 /* Device is not new, so ignore it. This can happen if a
418 device is going away after switching to Closed. */
422 stringlen = strlen(nodename) + 1 + strlen(type) + 1;
423 xendev = kzalloc(sizeof(*xendev) + stringlen, GFP_KERNEL);
427 xendev->state = XenbusStateInitialising;
429 /* Copy the strings into the extra space. */
431 tmpstring = (char *)(xendev + 1);
432 strcpy(tmpstring, nodename);
433 xendev->nodename = tmpstring;
435 tmpstring += strlen(tmpstring) + 1;
436 strcpy(tmpstring, type);
437 xendev->devicetype = tmpstring;
438 init_completion(&xendev->down);
440 xendev->dev.bus = &bus->bus;
441 xendev->dev.release = xenbus_dev_release;
443 err = bus->get_bus_id(devname, xendev->nodename);
447 dev_set_name(&xendev->dev, devname);
449 /* Register with generic device framework. */
450 err = device_register(&xendev->dev);
459 EXPORT_SYMBOL_GPL(xenbus_probe_node);
461 static int xenbus_probe_device_type(struct xen_bus_type *bus, const char *type)
465 unsigned int dir_n = 0;
468 dir = xenbus_directory(XBT_NIL, bus->root, type, &dir_n);
472 for (i = 0; i < dir_n; i++) {
473 err = bus->probe(bus, type, dir[i]);
482 int xenbus_probe_devices(struct xen_bus_type *bus)
486 unsigned int i, dir_n;
488 dir = xenbus_directory(XBT_NIL, bus->root, "", &dir_n);
492 for (i = 0; i < dir_n; i++) {
493 err = xenbus_probe_device_type(bus, dir[i]);
501 EXPORT_SYMBOL_GPL(xenbus_probe_devices);
503 static unsigned int char_count(const char *str, char c)
505 unsigned int i, ret = 0;
507 for (i = 0; str[i]; i++)
513 static int strsep_len(const char *str, char c, unsigned int len)
517 for (i = 0; str[i]; i++)
523 return (len == 0) ? i : -ERANGE;
526 void xenbus_dev_changed(const char *node, struct xen_bus_type *bus)
529 struct xenbus_device *dev;
530 char type[XEN_BUS_ID_SIZE];
531 const char *p, *root;
533 if (char_count(node, '/') < 2)
536 exists = xenbus_exists(XBT_NIL, node, "");
538 xenbus_cleanup_devices(node, &bus->bus);
542 /* backend/<type>/... or device/<type>/... */
543 p = strchr(node, '/') + 1;
544 snprintf(type, XEN_BUS_ID_SIZE, "%.*s", (int)strcspn(p, "/"), p);
545 type[XEN_BUS_ID_SIZE-1] = '\0';
547 rootlen = strsep_len(node, '/', bus->levels);
550 root = kasprintf(GFP_KERNEL, "%.*s", rootlen, node);
554 dev = xenbus_device_find(root, &bus->bus);
556 xenbus_probe_node(bus, type, root);
558 put_device(&dev->dev);
562 EXPORT_SYMBOL_GPL(xenbus_dev_changed);
564 int xenbus_dev_suspend(struct device *dev)
567 struct xenbus_driver *drv;
568 struct xenbus_device *xdev
569 = container_of(dev, struct xenbus_device, dev);
571 DPRINTK("%s", xdev->nodename);
573 if (dev->driver == NULL)
575 drv = to_xenbus_driver(dev->driver);
577 err = drv->suspend(xdev);
580 "xenbus: suspend %s failed: %i\n", dev_name(dev), err);
583 EXPORT_SYMBOL_GPL(xenbus_dev_suspend);
585 int xenbus_dev_resume(struct device *dev)
588 struct xenbus_driver *drv;
589 struct xenbus_device *xdev
590 = container_of(dev, struct xenbus_device, dev);
592 DPRINTK("%s", xdev->nodename);
594 if (dev->driver == NULL)
596 drv = to_xenbus_driver(dev->driver);
597 err = talk_to_otherend(xdev);
600 "xenbus: resume (talk_to_otherend) %s failed: %i\n",
605 xdev->state = XenbusStateInitialising;
608 err = drv->resume(xdev);
611 "xenbus: resume %s failed: %i\n",
617 err = watch_otherend(xdev);
620 "xenbus_probe: resume (watch_otherend) %s failed: "
621 "%d.\n", dev_name(dev), err);
627 EXPORT_SYMBOL_GPL(xenbus_dev_resume);
629 int xenbus_dev_cancel(struct device *dev)
635 EXPORT_SYMBOL_GPL(xenbus_dev_cancel);
637 /* A flag to determine if xenstored is 'ready' (i.e. has started) */
641 int register_xenstore_notifier(struct notifier_block *nb)
645 if (xenstored_ready > 0)
646 ret = nb->notifier_call(nb, 0, NULL);
648 blocking_notifier_chain_register(&xenstore_chain, nb);
652 EXPORT_SYMBOL_GPL(register_xenstore_notifier);
654 void unregister_xenstore_notifier(struct notifier_block *nb)
656 blocking_notifier_chain_unregister(&xenstore_chain, nb);
658 EXPORT_SYMBOL_GPL(unregister_xenstore_notifier);
660 void xenbus_probe(struct work_struct *unused)
664 /* Notify others that xenstore is up */
665 blocking_notifier_call_chain(&xenstore_chain, 0, NULL);
667 EXPORT_SYMBOL_GPL(xenbus_probe);
669 static int __init xenbus_probe_initcall(void)
674 if (xen_initial_domain() || xen_hvm_domain())
681 device_initcall(xenbus_probe_initcall);
683 /* Set up event channel for xenstored which is run as a local process
684 * (this is normally used only in dom0)
686 static int __init xenstored_local_init(void)
689 unsigned long page = 0;
690 struct evtchn_alloc_unbound alloc_unbound;
692 /* Allocate Xenstore page */
693 page = get_zeroed_page(GFP_KERNEL);
697 xen_store_mfn = xen_start_info->store_mfn =
698 pfn_to_mfn(virt_to_phys((void *)page) >>
701 /* Next allocate a local port which xenstored can bind to */
702 alloc_unbound.dom = DOMID_SELF;
703 alloc_unbound.remote_dom = DOMID_SELF;
705 err = HYPERVISOR_event_channel_op(EVTCHNOP_alloc_unbound,
711 xen_store_evtchn = xen_start_info->store_evtchn =
728 static int __init xenbus_init(void)
731 enum xenstore_init usage = UNKNOWN;
737 xenbus_ring_ops_init();
741 if (xen_hvm_domain())
743 if (xen_hvm_domain() && xen_initial_domain())
745 if (xen_pv_domain() && !xen_start_info->store_evtchn)
747 if (xen_pv_domain() && xen_start_info->store_evtchn)
752 err = xenstored_local_init();
755 xen_store_interface = mfn_to_virt(xen_store_mfn);
758 xen_store_evtchn = xen_start_info->store_evtchn;
759 xen_store_mfn = xen_start_info->store_mfn;
760 xen_store_interface = mfn_to_virt(xen_store_mfn);
763 err = hvm_get_parameter(HVM_PARAM_STORE_EVTCHN, &v);
766 xen_store_evtchn = (int)v;
767 err = hvm_get_parameter(HVM_PARAM_STORE_PFN, &v);
770 xen_store_mfn = (unsigned long)v;
771 xen_store_interface =
772 xen_remap(xen_store_mfn << PAGE_SHIFT, PAGE_SIZE);
775 pr_warn("Xenstore state unknown\n");
779 /* Initialize the interface to xenstore. */
783 "XENBUS: Error initializing xenstore comms: %i\n", err);
787 #ifdef CONFIG_XEN_COMPAT_XENFS
789 * Create xenfs mountpoint in /proc for compatibility with
790 * utilities that expect to find "xenbus" under "/proc/xen".
792 proc_mkdir("xen", NULL);
799 postcore_initcall(xenbus_init);
801 MODULE_LICENSE("GPL");