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 enum xenstore_init xen_store_domain_type;
73 EXPORT_SYMBOL_GPL(xen_store_domain_type);
75 static unsigned long xen_store_mfn;
77 static BLOCKING_NOTIFIER_HEAD(xenstore_chain);
79 /* If something in array of ids matches this device, return it. */
80 static const struct xenbus_device_id *
81 match_device(const struct xenbus_device_id *arr, struct xenbus_device *dev)
83 for (; *arr->devicetype != '\0'; arr++) {
84 if (!strcmp(arr->devicetype, dev->devicetype))
90 int xenbus_match(struct device *_dev, struct device_driver *_drv)
92 struct xenbus_driver *drv = to_xenbus_driver(_drv);
97 return match_device(drv->ids, to_xenbus_device(_dev)) != NULL;
99 EXPORT_SYMBOL_GPL(xenbus_match);
102 static void free_otherend_details(struct xenbus_device *dev)
104 kfree(dev->otherend);
105 dev->otherend = NULL;
109 static void free_otherend_watch(struct xenbus_device *dev)
111 if (dev->otherend_watch.node) {
112 unregister_xenbus_watch(&dev->otherend_watch);
113 kfree(dev->otherend_watch.node);
114 dev->otherend_watch.node = NULL;
119 static int talk_to_otherend(struct xenbus_device *dev)
121 struct xenbus_driver *drv = to_xenbus_driver(dev->dev.driver);
123 free_otherend_watch(dev);
124 free_otherend_details(dev);
126 return drv->read_otherend_details(dev);
131 static int watch_otherend(struct xenbus_device *dev)
133 struct xen_bus_type *bus =
134 container_of(dev->dev.bus, struct xen_bus_type, bus);
136 return xenbus_watch_pathfmt(dev, &dev->otherend_watch,
137 bus->otherend_changed,
138 "%s/%s", dev->otherend, "state");
142 int xenbus_read_otherend_details(struct xenbus_device *xendev,
143 char *id_node, char *path_node)
145 int err = xenbus_gather(XBT_NIL, xendev->nodename,
146 id_node, "%i", &xendev->otherend_id,
147 path_node, NULL, &xendev->otherend,
150 xenbus_dev_fatal(xendev, err,
151 "reading other end details from %s",
155 if (strlen(xendev->otherend) == 0 ||
156 !xenbus_exists(XBT_NIL, xendev->otherend, "")) {
157 xenbus_dev_fatal(xendev, -ENOENT,
158 "unable to read other end from %s. "
159 "missing or inaccessible.",
161 free_otherend_details(xendev);
167 EXPORT_SYMBOL_GPL(xenbus_read_otherend_details);
169 void xenbus_otherend_changed(struct xenbus_watch *watch,
170 const char **vec, unsigned int len,
171 int ignore_on_shutdown)
173 struct xenbus_device *dev =
174 container_of(watch, struct xenbus_device, otherend_watch);
175 struct xenbus_driver *drv = to_xenbus_driver(dev->dev.driver);
176 enum xenbus_state state;
178 /* Protect us against watches firing on old details when the otherend
179 details change, say immediately after a resume. */
180 if (!dev->otherend ||
181 strncmp(dev->otherend, vec[XS_WATCH_PATH],
182 strlen(dev->otherend))) {
183 dev_dbg(&dev->dev, "Ignoring watch at %s\n",
188 state = xenbus_read_driver_state(dev->otherend);
190 dev_dbg(&dev->dev, "state is %d, (%s), %s, %s\n",
191 state, xenbus_strstate(state), dev->otherend_watch.node,
195 * Ignore xenbus transitions during shutdown. This prevents us doing
196 * work that can fail e.g., when the rootfs is gone.
198 if (system_state > SYSTEM_RUNNING) {
199 if (ignore_on_shutdown && (state == XenbusStateClosing))
200 xenbus_frontend_closed(dev);
204 if (drv->otherend_changed)
205 drv->otherend_changed(dev, state);
207 EXPORT_SYMBOL_GPL(xenbus_otherend_changed);
209 int xenbus_dev_probe(struct device *_dev)
211 struct xenbus_device *dev = to_xenbus_device(_dev);
212 struct xenbus_driver *drv = to_xenbus_driver(_dev->driver);
213 const struct xenbus_device_id *id;
216 DPRINTK("%s", dev->nodename);
223 id = match_device(drv->ids, dev);
229 err = talk_to_otherend(dev);
231 dev_warn(&dev->dev, "talk_to_otherend on %s failed.\n",
236 err = drv->probe(dev, id);
240 err = watch_otherend(dev);
242 dev_warn(&dev->dev, "watch_otherend on %s failed.\n",
249 xenbus_dev_error(dev, err, "xenbus_dev_probe on %s", dev->nodename);
250 xenbus_switch_state(dev, XenbusStateClosed);
253 EXPORT_SYMBOL_GPL(xenbus_dev_probe);
255 int xenbus_dev_remove(struct device *_dev)
257 struct xenbus_device *dev = to_xenbus_device(_dev);
258 struct xenbus_driver *drv = to_xenbus_driver(_dev->driver);
260 DPRINTK("%s", dev->nodename);
262 free_otherend_watch(dev);
267 free_otherend_details(dev);
269 xenbus_switch_state(dev, XenbusStateClosed);
272 EXPORT_SYMBOL_GPL(xenbus_dev_remove);
274 void xenbus_dev_shutdown(struct device *_dev)
276 struct xenbus_device *dev = to_xenbus_device(_dev);
277 unsigned long timeout = 5*HZ;
279 DPRINTK("%s", dev->nodename);
281 get_device(&dev->dev);
282 if (dev->state != XenbusStateConnected) {
283 printk(KERN_INFO "%s: %s: %s != Connected, skipping\n", __func__,
284 dev->nodename, xenbus_strstate(dev->state));
287 xenbus_switch_state(dev, XenbusStateClosing);
288 timeout = wait_for_completion_timeout(&dev->down, timeout);
290 printk(KERN_INFO "%s: %s timeout closing device\n",
291 __func__, dev->nodename);
293 put_device(&dev->dev);
295 EXPORT_SYMBOL_GPL(xenbus_dev_shutdown);
297 int xenbus_register_driver_common(struct xenbus_driver *drv,
298 struct xen_bus_type *bus)
300 drv->driver.bus = &bus->bus;
302 return driver_register(&drv->driver);
304 EXPORT_SYMBOL_GPL(xenbus_register_driver_common);
306 void xenbus_unregister_driver(struct xenbus_driver *drv)
308 driver_unregister(&drv->driver);
310 EXPORT_SYMBOL_GPL(xenbus_unregister_driver);
312 struct xb_find_info {
313 struct xenbus_device *dev;
314 const char *nodename;
317 static int cmp_dev(struct device *dev, void *data)
319 struct xenbus_device *xendev = to_xenbus_device(dev);
320 struct xb_find_info *info = data;
322 if (!strcmp(xendev->nodename, info->nodename)) {
330 static struct xenbus_device *xenbus_device_find(const char *nodename,
331 struct bus_type *bus)
333 struct xb_find_info info = { .dev = NULL, .nodename = nodename };
335 bus_for_each_dev(bus, NULL, &info, cmp_dev);
339 static int cleanup_dev(struct device *dev, void *data)
341 struct xenbus_device *xendev = to_xenbus_device(dev);
342 struct xb_find_info *info = data;
343 int len = strlen(info->nodename);
345 DPRINTK("%s", info->nodename);
347 /* Match the info->nodename path, or any subdirectory of that path. */
348 if (strncmp(xendev->nodename, info->nodename, len))
351 /* If the node name is longer, ensure it really is a subdirectory. */
352 if ((strlen(xendev->nodename) > len) && (xendev->nodename[len] != '/'))
360 static void xenbus_cleanup_devices(const char *path, struct bus_type *bus)
362 struct xb_find_info info = { .nodename = path };
366 bus_for_each_dev(bus, NULL, &info, cleanup_dev);
368 device_unregister(&info.dev->dev);
369 put_device(&info.dev->dev);
374 static void xenbus_dev_release(struct device *dev)
377 kfree(to_xenbus_device(dev));
380 static ssize_t nodename_show(struct device *dev,
381 struct device_attribute *attr, char *buf)
383 return sprintf(buf, "%s\n", to_xenbus_device(dev)->nodename);
386 static ssize_t devtype_show(struct device *dev,
387 struct device_attribute *attr, char *buf)
389 return sprintf(buf, "%s\n", to_xenbus_device(dev)->devicetype);
392 static ssize_t modalias_show(struct device *dev,
393 struct device_attribute *attr, char *buf)
395 return sprintf(buf, "%s:%s\n", dev->bus->name,
396 to_xenbus_device(dev)->devicetype);
399 struct device_attribute xenbus_dev_attrs[] = {
405 EXPORT_SYMBOL_GPL(xenbus_dev_attrs);
407 int xenbus_probe_node(struct xen_bus_type *bus,
409 const char *nodename)
411 char devname[XEN_BUS_ID_SIZE];
413 struct xenbus_device *xendev;
417 enum xenbus_state state = xenbus_read_driver_state(nodename);
419 if (state != XenbusStateInitialising) {
420 /* Device is not new, so ignore it. This can happen if a
421 device is going away after switching to Closed. */
425 stringlen = strlen(nodename) + 1 + strlen(type) + 1;
426 xendev = kzalloc(sizeof(*xendev) + stringlen, GFP_KERNEL);
430 xendev->state = XenbusStateInitialising;
432 /* Copy the strings into the extra space. */
434 tmpstring = (char *)(xendev + 1);
435 strcpy(tmpstring, nodename);
436 xendev->nodename = tmpstring;
438 tmpstring += strlen(tmpstring) + 1;
439 strcpy(tmpstring, type);
440 xendev->devicetype = tmpstring;
441 init_completion(&xendev->down);
443 xendev->dev.bus = &bus->bus;
444 xendev->dev.release = xenbus_dev_release;
446 err = bus->get_bus_id(devname, xendev->nodename);
450 dev_set_name(&xendev->dev, devname);
452 /* Register with generic device framework. */
453 err = device_register(&xendev->dev);
462 EXPORT_SYMBOL_GPL(xenbus_probe_node);
464 static int xenbus_probe_device_type(struct xen_bus_type *bus, const char *type)
468 unsigned int dir_n = 0;
471 dir = xenbus_directory(XBT_NIL, bus->root, type, &dir_n);
475 for (i = 0; i < dir_n; i++) {
476 err = bus->probe(bus, type, dir[i]);
485 int xenbus_probe_devices(struct xen_bus_type *bus)
489 unsigned int i, dir_n;
491 dir = xenbus_directory(XBT_NIL, bus->root, "", &dir_n);
495 for (i = 0; i < dir_n; i++) {
496 err = xenbus_probe_device_type(bus, dir[i]);
504 EXPORT_SYMBOL_GPL(xenbus_probe_devices);
506 static unsigned int char_count(const char *str, char c)
508 unsigned int i, ret = 0;
510 for (i = 0; str[i]; i++)
516 static int strsep_len(const char *str, char c, unsigned int len)
520 for (i = 0; str[i]; i++)
526 return (len == 0) ? i : -ERANGE;
529 void xenbus_dev_changed(const char *node, struct xen_bus_type *bus)
532 struct xenbus_device *dev;
533 char type[XEN_BUS_ID_SIZE];
534 const char *p, *root;
536 if (char_count(node, '/') < 2)
539 exists = xenbus_exists(XBT_NIL, node, "");
541 xenbus_cleanup_devices(node, &bus->bus);
545 /* backend/<type>/... or device/<type>/... */
546 p = strchr(node, '/') + 1;
547 snprintf(type, XEN_BUS_ID_SIZE, "%.*s", (int)strcspn(p, "/"), p);
548 type[XEN_BUS_ID_SIZE-1] = '\0';
550 rootlen = strsep_len(node, '/', bus->levels);
553 root = kasprintf(GFP_KERNEL, "%.*s", rootlen, node);
557 dev = xenbus_device_find(root, &bus->bus);
559 xenbus_probe_node(bus, type, root);
561 put_device(&dev->dev);
565 EXPORT_SYMBOL_GPL(xenbus_dev_changed);
567 int xenbus_dev_suspend(struct device *dev)
570 struct xenbus_driver *drv;
571 struct xenbus_device *xdev
572 = container_of(dev, struct xenbus_device, dev);
574 DPRINTK("%s", xdev->nodename);
576 if (dev->driver == NULL)
578 drv = to_xenbus_driver(dev->driver);
580 err = drv->suspend(xdev);
583 "xenbus: suspend %s failed: %i\n", dev_name(dev), err);
586 EXPORT_SYMBOL_GPL(xenbus_dev_suspend);
588 int xenbus_dev_resume(struct device *dev)
591 struct xenbus_driver *drv;
592 struct xenbus_device *xdev
593 = container_of(dev, struct xenbus_device, dev);
595 DPRINTK("%s", xdev->nodename);
597 if (dev->driver == NULL)
599 drv = to_xenbus_driver(dev->driver);
600 err = talk_to_otherend(xdev);
603 "xenbus: resume (talk_to_otherend) %s failed: %i\n",
608 xdev->state = XenbusStateInitialising;
611 err = drv->resume(xdev);
614 "xenbus: resume %s failed: %i\n",
620 err = watch_otherend(xdev);
623 "xenbus_probe: resume (watch_otherend) %s failed: "
624 "%d.\n", dev_name(dev), err);
630 EXPORT_SYMBOL_GPL(xenbus_dev_resume);
632 int xenbus_dev_cancel(struct device *dev)
638 EXPORT_SYMBOL_GPL(xenbus_dev_cancel);
640 /* A flag to determine if xenstored is 'ready' (i.e. has started) */
644 int register_xenstore_notifier(struct notifier_block *nb)
648 if (xenstored_ready > 0)
649 ret = nb->notifier_call(nb, 0, NULL);
651 blocking_notifier_chain_register(&xenstore_chain, nb);
655 EXPORT_SYMBOL_GPL(register_xenstore_notifier);
657 void unregister_xenstore_notifier(struct notifier_block *nb)
659 blocking_notifier_chain_unregister(&xenstore_chain, nb);
661 EXPORT_SYMBOL_GPL(unregister_xenstore_notifier);
663 void xenbus_probe(struct work_struct *unused)
667 /* Notify others that xenstore is up */
668 blocking_notifier_call_chain(&xenstore_chain, 0, NULL);
670 EXPORT_SYMBOL_GPL(xenbus_probe);
672 static int __init xenbus_probe_initcall(void)
677 if (xen_initial_domain() || xen_hvm_domain())
684 device_initcall(xenbus_probe_initcall);
686 /* Set up event channel for xenstored which is run as a local process
687 * (this is normally used only in dom0)
689 static int __init xenstored_local_init(void)
692 unsigned long page = 0;
693 struct evtchn_alloc_unbound alloc_unbound;
695 /* Allocate Xenstore page */
696 page = get_zeroed_page(GFP_KERNEL);
700 xen_store_mfn = xen_start_info->store_mfn =
701 pfn_to_mfn(virt_to_phys((void *)page) >>
704 /* Next allocate a local port which xenstored can bind to */
705 alloc_unbound.dom = DOMID_SELF;
706 alloc_unbound.remote_dom = DOMID_SELF;
708 err = HYPERVISOR_event_channel_op(EVTCHNOP_alloc_unbound,
714 xen_store_evtchn = xen_start_info->store_evtchn =
725 static int __init xenbus_init(void)
729 xen_store_domain_type = XS_UNKNOWN;
734 xenbus_ring_ops_init();
737 xen_store_domain_type = XS_PV;
738 if (xen_hvm_domain())
739 xen_store_domain_type = XS_HVM;
740 if (xen_hvm_domain() && xen_initial_domain())
741 xen_store_domain_type = XS_LOCAL;
742 if (xen_pv_domain() && !xen_start_info->store_evtchn)
743 xen_store_domain_type = XS_LOCAL;
744 if (xen_pv_domain() && xen_start_info->store_evtchn)
747 switch (xen_store_domain_type) {
749 err = xenstored_local_init();
752 xen_store_interface = mfn_to_virt(xen_store_mfn);
755 xen_store_evtchn = xen_start_info->store_evtchn;
756 xen_store_mfn = xen_start_info->store_mfn;
757 xen_store_interface = mfn_to_virt(xen_store_mfn);
760 err = hvm_get_parameter(HVM_PARAM_STORE_EVTCHN, &v);
763 xen_store_evtchn = (int)v;
764 err = hvm_get_parameter(HVM_PARAM_STORE_PFN, &v);
767 xen_store_mfn = (unsigned long)v;
768 xen_store_interface =
769 xen_remap(xen_store_mfn << PAGE_SHIFT, PAGE_SIZE);
772 pr_warn("Xenstore state unknown\n");
776 /* Initialize the interface to xenstore. */
780 "XENBUS: Error initializing xenstore comms: %i\n", err);
784 #ifdef CONFIG_XEN_COMPAT_XENFS
786 * Create xenfs mountpoint in /proc for compatibility with
787 * utilities that expect to find "xenbus" under "/proc/xen".
789 proc_mkdir("xen", NULL);
796 postcore_initcall(xenbus_init);
798 MODULE_LICENSE("GPL");