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);
260 free_otherend_details(dev);
265 xenbus_switch_state(dev, XenbusStateClosed);
268 EXPORT_SYMBOL_GPL(xenbus_dev_remove);
270 void xenbus_dev_shutdown(struct device *_dev)
272 struct xenbus_device *dev = to_xenbus_device(_dev);
273 unsigned long timeout = 5*HZ;
275 DPRINTK("%s", dev->nodename);
277 get_device(&dev->dev);
278 if (dev->state != XenbusStateConnected) {
279 printk(KERN_INFO "%s: %s: %s != Connected, skipping\n", __func__,
280 dev->nodename, xenbus_strstate(dev->state));
283 xenbus_switch_state(dev, XenbusStateClosing);
284 timeout = wait_for_completion_timeout(&dev->down, timeout);
286 printk(KERN_INFO "%s: %s timeout closing device\n",
287 __func__, dev->nodename);
289 put_device(&dev->dev);
291 EXPORT_SYMBOL_GPL(xenbus_dev_shutdown);
293 int xenbus_register_driver_common(struct xenbus_driver *drv,
294 struct xen_bus_type *bus)
296 drv->driver.bus = &bus->bus;
298 return driver_register(&drv->driver);
300 EXPORT_SYMBOL_GPL(xenbus_register_driver_common);
302 void xenbus_unregister_driver(struct xenbus_driver *drv)
304 driver_unregister(&drv->driver);
306 EXPORT_SYMBOL_GPL(xenbus_unregister_driver);
308 struct xb_find_info {
309 struct xenbus_device *dev;
310 const char *nodename;
313 static int cmp_dev(struct device *dev, void *data)
315 struct xenbus_device *xendev = to_xenbus_device(dev);
316 struct xb_find_info *info = data;
318 if (!strcmp(xendev->nodename, info->nodename)) {
326 struct xenbus_device *xenbus_device_find(const char *nodename,
327 struct bus_type *bus)
329 struct xb_find_info info = { .dev = NULL, .nodename = nodename };
331 bus_for_each_dev(bus, NULL, &info, cmp_dev);
335 static int cleanup_dev(struct device *dev, void *data)
337 struct xenbus_device *xendev = to_xenbus_device(dev);
338 struct xb_find_info *info = data;
339 int len = strlen(info->nodename);
341 DPRINTK("%s", info->nodename);
343 /* Match the info->nodename path, or any subdirectory of that path. */
344 if (strncmp(xendev->nodename, info->nodename, len))
347 /* If the node name is longer, ensure it really is a subdirectory. */
348 if ((strlen(xendev->nodename) > len) && (xendev->nodename[len] != '/'))
356 static void xenbus_cleanup_devices(const char *path, struct bus_type *bus)
358 struct xb_find_info info = { .nodename = path };
362 bus_for_each_dev(bus, NULL, &info, cleanup_dev);
364 device_unregister(&info.dev->dev);
365 put_device(&info.dev->dev);
370 static void xenbus_dev_release(struct device *dev)
373 kfree(to_xenbus_device(dev));
376 static ssize_t nodename_show(struct device *dev,
377 struct device_attribute *attr, char *buf)
379 return sprintf(buf, "%s\n", to_xenbus_device(dev)->nodename);
382 static ssize_t devtype_show(struct device *dev,
383 struct device_attribute *attr, char *buf)
385 return sprintf(buf, "%s\n", to_xenbus_device(dev)->devicetype);
388 static ssize_t modalias_show(struct device *dev,
389 struct device_attribute *attr, char *buf)
391 return sprintf(buf, "%s:%s\n", dev->bus->name,
392 to_xenbus_device(dev)->devicetype);
395 struct device_attribute xenbus_dev_attrs[] = {
401 EXPORT_SYMBOL_GPL(xenbus_dev_attrs);
403 int xenbus_probe_node(struct xen_bus_type *bus,
405 const char *nodename)
407 char devname[XEN_BUS_ID_SIZE];
409 struct xenbus_device *xendev;
413 enum xenbus_state state = xenbus_read_driver_state(nodename);
415 if (state != XenbusStateInitialising) {
416 /* Device is not new, so ignore it. This can happen if a
417 device is going away after switching to Closed. */
421 stringlen = strlen(nodename) + 1 + strlen(type) + 1;
422 xendev = kzalloc(sizeof(*xendev) + stringlen, GFP_KERNEL);
426 xendev->state = XenbusStateInitialising;
428 /* Copy the strings into the extra space. */
430 tmpstring = (char *)(xendev + 1);
431 strcpy(tmpstring, nodename);
432 xendev->nodename = tmpstring;
434 tmpstring += strlen(tmpstring) + 1;
435 strcpy(tmpstring, type);
436 xendev->devicetype = tmpstring;
437 init_completion(&xendev->down);
439 xendev->dev.bus = &bus->bus;
440 xendev->dev.release = xenbus_dev_release;
442 err = bus->get_bus_id(devname, xendev->nodename);
446 dev_set_name(&xendev->dev, devname);
448 /* Register with generic device framework. */
449 err = device_register(&xendev->dev);
458 EXPORT_SYMBOL_GPL(xenbus_probe_node);
460 static int xenbus_probe_device_type(struct xen_bus_type *bus, const char *type)
464 unsigned int dir_n = 0;
467 dir = xenbus_directory(XBT_NIL, bus->root, type, &dir_n);
471 for (i = 0; i < dir_n; i++) {
472 err = bus->probe(bus, type, dir[i]);
481 int xenbus_probe_devices(struct xen_bus_type *bus)
485 unsigned int i, dir_n;
487 dir = xenbus_directory(XBT_NIL, bus->root, "", &dir_n);
491 for (i = 0; i < dir_n; i++) {
492 err = xenbus_probe_device_type(bus, dir[i]);
500 EXPORT_SYMBOL_GPL(xenbus_probe_devices);
502 static unsigned int char_count(const char *str, char c)
504 unsigned int i, ret = 0;
506 for (i = 0; str[i]; i++)
512 static int strsep_len(const char *str, char c, unsigned int len)
516 for (i = 0; str[i]; i++)
522 return (len == 0) ? i : -ERANGE;
525 void xenbus_dev_changed(const char *node, struct xen_bus_type *bus)
528 struct xenbus_device *dev;
529 char type[XEN_BUS_ID_SIZE];
530 const char *p, *root;
532 if (char_count(node, '/') < 2)
535 exists = xenbus_exists(XBT_NIL, node, "");
537 xenbus_cleanup_devices(node, &bus->bus);
541 /* backend/<type>/... or device/<type>/... */
542 p = strchr(node, '/') + 1;
543 snprintf(type, XEN_BUS_ID_SIZE, "%.*s", (int)strcspn(p, "/"), p);
544 type[XEN_BUS_ID_SIZE-1] = '\0';
546 rootlen = strsep_len(node, '/', bus->levels);
549 root = kasprintf(GFP_KERNEL, "%.*s", rootlen, node);
553 dev = xenbus_device_find(root, &bus->bus);
555 xenbus_probe_node(bus, type, root);
557 put_device(&dev->dev);
561 EXPORT_SYMBOL_GPL(xenbus_dev_changed);
563 int xenbus_dev_suspend(struct device *dev)
566 struct xenbus_driver *drv;
567 struct xenbus_device *xdev
568 = container_of(dev, struct xenbus_device, dev);
570 DPRINTK("%s", xdev->nodename);
572 if (dev->driver == NULL)
574 drv = to_xenbus_driver(dev->driver);
576 err = drv->suspend(xdev);
579 "xenbus: suspend %s failed: %i\n", dev_name(dev), err);
582 EXPORT_SYMBOL_GPL(xenbus_dev_suspend);
584 int xenbus_dev_resume(struct device *dev)
587 struct xenbus_driver *drv;
588 struct xenbus_device *xdev
589 = container_of(dev, struct xenbus_device, dev);
591 DPRINTK("%s", xdev->nodename);
593 if (dev->driver == NULL)
595 drv = to_xenbus_driver(dev->driver);
596 err = talk_to_otherend(xdev);
599 "xenbus: resume (talk_to_otherend) %s failed: %i\n",
604 xdev->state = XenbusStateInitialising;
607 err = drv->resume(xdev);
610 "xenbus: resume %s failed: %i\n",
616 err = watch_otherend(xdev);
619 "xenbus_probe: resume (watch_otherend) %s failed: "
620 "%d.\n", dev_name(dev), err);
626 EXPORT_SYMBOL_GPL(xenbus_dev_resume);
628 int xenbus_dev_cancel(struct device *dev)
634 EXPORT_SYMBOL_GPL(xenbus_dev_cancel);
636 /* A flag to determine if xenstored is 'ready' (i.e. has started) */
640 int register_xenstore_notifier(struct notifier_block *nb)
644 if (xenstored_ready > 0)
645 ret = nb->notifier_call(nb, 0, NULL);
647 blocking_notifier_chain_register(&xenstore_chain, nb);
651 EXPORT_SYMBOL_GPL(register_xenstore_notifier);
653 void unregister_xenstore_notifier(struct notifier_block *nb)
655 blocking_notifier_chain_unregister(&xenstore_chain, nb);
657 EXPORT_SYMBOL_GPL(unregister_xenstore_notifier);
659 void xenbus_probe(struct work_struct *unused)
663 /* Notify others that xenstore is up */
664 blocking_notifier_call_chain(&xenstore_chain, 0, NULL);
666 EXPORT_SYMBOL_GPL(xenbus_probe);
668 static int __init xenbus_probe_initcall(void)
673 if (xen_initial_domain() || xen_hvm_domain())
680 device_initcall(xenbus_probe_initcall);
682 /* Set up event channel for xenstored which is run as a local process
683 * (this is normally used only in dom0)
685 static int __init xenstored_local_init(void)
688 unsigned long page = 0;
689 struct evtchn_alloc_unbound alloc_unbound;
691 /* Allocate Xenstore page */
692 page = get_zeroed_page(GFP_KERNEL);
696 xen_store_mfn = xen_start_info->store_mfn =
697 pfn_to_mfn(virt_to_phys((void *)page) >>
700 /* Next allocate a local port which xenstored can bind to */
701 alloc_unbound.dom = DOMID_SELF;
702 alloc_unbound.remote_dom = DOMID_SELF;
704 err = HYPERVISOR_event_channel_op(EVTCHNOP_alloc_unbound,
710 xen_store_evtchn = xen_start_info->store_evtchn =
721 static int __init xenbus_init(void)
728 xenbus_ring_ops_init();
730 if (xen_hvm_domain()) {
732 err = hvm_get_parameter(HVM_PARAM_STORE_EVTCHN, &v);
735 xen_store_evtchn = (int)v;
736 err = hvm_get_parameter(HVM_PARAM_STORE_PFN, &v);
739 xen_store_mfn = (unsigned long)v;
740 xen_store_interface = ioremap(xen_store_mfn << PAGE_SHIFT, PAGE_SIZE);
742 xen_store_evtchn = xen_start_info->store_evtchn;
743 xen_store_mfn = xen_start_info->store_mfn;
744 if (xen_store_evtchn)
747 err = xenstored_local_init();
751 xen_store_interface = mfn_to_virt(xen_store_mfn);
754 /* Initialize the interface to xenstore. */
758 "XENBUS: Error initializing xenstore comms: %i\n", err);
762 #ifdef CONFIG_XEN_COMPAT_XENFS
764 * Create xenfs mountpoint in /proc for compatibility with
765 * utilities that expect to find "xenbus" under "/proc/xen".
767 proc_mkdir("xen", NULL);
774 postcore_initcall(xenbus_init);
776 MODULE_LICENSE("GPL");