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 pr_fmt(fmt) KBUILD_MODNAME ": " fmt
35 #define DPRINTK(fmt, args...) \
36 pr_debug("xenbus_probe (%s:%d) " fmt ".\n", \
37 __func__, __LINE__, ##args)
39 #include <linux/kernel.h>
40 #include <linux/err.h>
41 #include <linux/string.h>
42 #include <linux/ctype.h>
43 #include <linux/fcntl.h>
45 #include <linux/proc_fs.h>
46 #include <linux/notifier.h>
47 #include <linux/kthread.h>
48 #include <linux/mutex.h>
50 #include <linux/slab.h>
51 #include <linux/module.h>
54 #include <asm/pgtable.h>
55 #include <asm/xen/hypervisor.h>
58 #include <xen/xenbus.h>
59 #include <xen/events.h>
60 #include <xen/xen-ops.h>
65 #include "xenbus_comms.h"
66 #include "xenbus_probe.h"
70 EXPORT_SYMBOL_GPL(xen_store_evtchn
);
72 struct xenstore_domain_interface
*xen_store_interface
;
73 EXPORT_SYMBOL_GPL(xen_store_interface
);
75 enum xenstore_init xen_store_domain_type
;
76 EXPORT_SYMBOL_GPL(xen_store_domain_type
);
78 static unsigned long xen_store_gfn
;
80 static BLOCKING_NOTIFIER_HEAD(xenstore_chain
);
82 /* If something in array of ids matches this device, return it. */
83 static const struct xenbus_device_id
*
84 match_device(const struct xenbus_device_id
*arr
, struct xenbus_device
*dev
)
86 for (; *arr
->devicetype
!= '\0'; arr
++) {
87 if (!strcmp(arr
->devicetype
, dev
->devicetype
))
93 int xenbus_match(struct device
*_dev
, struct device_driver
*_drv
)
95 struct xenbus_driver
*drv
= to_xenbus_driver(_drv
);
100 return match_device(drv
->ids
, to_xenbus_device(_dev
)) != NULL
;
102 EXPORT_SYMBOL_GPL(xenbus_match
);
105 static void free_otherend_details(struct xenbus_device
*dev
)
107 kfree(dev
->otherend
);
108 dev
->otherend
= NULL
;
112 static void free_otherend_watch(struct xenbus_device
*dev
)
114 if (dev
->otherend_watch
.node
) {
115 unregister_xenbus_watch(&dev
->otherend_watch
);
116 kfree(dev
->otherend_watch
.node
);
117 dev
->otherend_watch
.node
= NULL
;
122 static int talk_to_otherend(struct xenbus_device
*dev
)
124 struct xenbus_driver
*drv
= to_xenbus_driver(dev
->dev
.driver
);
126 free_otherend_watch(dev
);
127 free_otherend_details(dev
);
129 return drv
->read_otherend_details(dev
);
134 static int watch_otherend(struct xenbus_device
*dev
)
136 struct xen_bus_type
*bus
=
137 container_of(dev
->dev
.bus
, struct xen_bus_type
, bus
);
139 return xenbus_watch_pathfmt(dev
, &dev
->otherend_watch
,
140 bus
->otherend_changed
,
141 "%s/%s", dev
->otherend
, "state");
145 int xenbus_read_otherend_details(struct xenbus_device
*xendev
,
146 char *id_node
, char *path_node
)
148 int err
= xenbus_gather(XBT_NIL
, xendev
->nodename
,
149 id_node
, "%i", &xendev
->otherend_id
,
150 path_node
, NULL
, &xendev
->otherend
,
153 xenbus_dev_fatal(xendev
, err
,
154 "reading other end details from %s",
158 if (strlen(xendev
->otherend
) == 0 ||
159 !xenbus_exists(XBT_NIL
, xendev
->otherend
, "")) {
160 xenbus_dev_fatal(xendev
, -ENOENT
,
161 "unable to read other end from %s. "
162 "missing or inaccessible.",
164 free_otherend_details(xendev
);
170 EXPORT_SYMBOL_GPL(xenbus_read_otherend_details
);
172 void xenbus_otherend_changed(struct xenbus_watch
*watch
,
173 const char **vec
, unsigned int len
,
174 int ignore_on_shutdown
)
176 struct xenbus_device
*dev
=
177 container_of(watch
, struct xenbus_device
, otherend_watch
);
178 struct xenbus_driver
*drv
= to_xenbus_driver(dev
->dev
.driver
);
179 enum xenbus_state state
;
181 /* Protect us against watches firing on old details when the otherend
182 details change, say immediately after a resume. */
183 if (!dev
->otherend
||
184 strncmp(dev
->otherend
, vec
[XS_WATCH_PATH
],
185 strlen(dev
->otherend
))) {
186 dev_dbg(&dev
->dev
, "Ignoring watch at %s\n",
191 state
= xenbus_read_driver_state(dev
->otherend
);
193 dev_dbg(&dev
->dev
, "state is %d, (%s), %s, %s\n",
194 state
, xenbus_strstate(state
), dev
->otherend_watch
.node
,
198 * Ignore xenbus transitions during shutdown. This prevents us doing
199 * work that can fail e.g., when the rootfs is gone.
201 if (system_state
> SYSTEM_RUNNING
) {
202 if (ignore_on_shutdown
&& (state
== XenbusStateClosing
))
203 xenbus_frontend_closed(dev
);
207 if (drv
->otherend_changed
)
208 drv
->otherend_changed(dev
, state
);
210 EXPORT_SYMBOL_GPL(xenbus_otherend_changed
);
212 int xenbus_dev_probe(struct device
*_dev
)
214 struct xenbus_device
*dev
= to_xenbus_device(_dev
);
215 struct xenbus_driver
*drv
= to_xenbus_driver(_dev
->driver
);
216 const struct xenbus_device_id
*id
;
219 DPRINTK("%s", dev
->nodename
);
226 id
= match_device(drv
->ids
, dev
);
232 err
= talk_to_otherend(dev
);
234 dev_warn(&dev
->dev
, "talk_to_otherend on %s failed.\n",
239 err
= drv
->probe(dev
, id
);
243 err
= watch_otherend(dev
);
245 dev_warn(&dev
->dev
, "watch_otherend on %s failed.\n",
252 xenbus_dev_error(dev
, err
, "xenbus_dev_probe on %s", dev
->nodename
);
253 xenbus_switch_state(dev
, XenbusStateClosed
);
256 EXPORT_SYMBOL_GPL(xenbus_dev_probe
);
258 int xenbus_dev_remove(struct device
*_dev
)
260 struct xenbus_device
*dev
= to_xenbus_device(_dev
);
261 struct xenbus_driver
*drv
= to_xenbus_driver(_dev
->driver
);
263 DPRINTK("%s", dev
->nodename
);
265 free_otherend_watch(dev
);
270 free_otherend_details(dev
);
272 xenbus_switch_state(dev
, XenbusStateClosed
);
275 EXPORT_SYMBOL_GPL(xenbus_dev_remove
);
277 void xenbus_dev_shutdown(struct device
*_dev
)
279 struct xenbus_device
*dev
= to_xenbus_device(_dev
);
280 unsigned long timeout
= 5*HZ
;
282 DPRINTK("%s", dev
->nodename
);
284 get_device(&dev
->dev
);
285 if (dev
->state
!= XenbusStateConnected
) {
286 pr_info("%s: %s: %s != Connected, skipping\n",
287 __func__
, dev
->nodename
, xenbus_strstate(dev
->state
));
290 xenbus_switch_state(dev
, XenbusStateClosing
);
291 timeout
= wait_for_completion_timeout(&dev
->down
, timeout
);
293 pr_info("%s: %s timeout closing device\n",
294 __func__
, dev
->nodename
);
296 put_device(&dev
->dev
);
298 EXPORT_SYMBOL_GPL(xenbus_dev_shutdown
);
300 int xenbus_register_driver_common(struct xenbus_driver
*drv
,
301 struct xen_bus_type
*bus
,
302 struct module
*owner
, const char *mod_name
)
304 drv
->driver
.name
= drv
->name
? drv
->name
: drv
->ids
[0].devicetype
;
305 drv
->driver
.bus
= &bus
->bus
;
306 drv
->driver
.owner
= owner
;
307 drv
->driver
.mod_name
= mod_name
;
309 return driver_register(&drv
->driver
);
311 EXPORT_SYMBOL_GPL(xenbus_register_driver_common
);
313 void xenbus_unregister_driver(struct xenbus_driver
*drv
)
315 driver_unregister(&drv
->driver
);
317 EXPORT_SYMBOL_GPL(xenbus_unregister_driver
);
319 struct xb_find_info
{
320 struct xenbus_device
*dev
;
321 const char *nodename
;
324 static int cmp_dev(struct device
*dev
, void *data
)
326 struct xenbus_device
*xendev
= to_xenbus_device(dev
);
327 struct xb_find_info
*info
= data
;
329 if (!strcmp(xendev
->nodename
, info
->nodename
)) {
337 static struct xenbus_device
*xenbus_device_find(const char *nodename
,
338 struct bus_type
*bus
)
340 struct xb_find_info info
= { .dev
= NULL
, .nodename
= nodename
};
342 bus_for_each_dev(bus
, NULL
, &info
, cmp_dev
);
346 static int cleanup_dev(struct device
*dev
, void *data
)
348 struct xenbus_device
*xendev
= to_xenbus_device(dev
);
349 struct xb_find_info
*info
= data
;
350 int len
= strlen(info
->nodename
);
352 DPRINTK("%s", info
->nodename
);
354 /* Match the info->nodename path, or any subdirectory of that path. */
355 if (strncmp(xendev
->nodename
, info
->nodename
, len
))
358 /* If the node name is longer, ensure it really is a subdirectory. */
359 if ((strlen(xendev
->nodename
) > len
) && (xendev
->nodename
[len
] != '/'))
367 static void xenbus_cleanup_devices(const char *path
, struct bus_type
*bus
)
369 struct xb_find_info info
= { .nodename
= path
};
373 bus_for_each_dev(bus
, NULL
, &info
, cleanup_dev
);
375 device_unregister(&info
.dev
->dev
);
376 put_device(&info
.dev
->dev
);
381 static void xenbus_dev_release(struct device
*dev
)
384 kfree(to_xenbus_device(dev
));
387 static ssize_t
nodename_show(struct device
*dev
,
388 struct device_attribute
*attr
, char *buf
)
390 return sprintf(buf
, "%s\n", to_xenbus_device(dev
)->nodename
);
392 static DEVICE_ATTR_RO(nodename
);
394 static ssize_t
devtype_show(struct device
*dev
,
395 struct device_attribute
*attr
, char *buf
)
397 return sprintf(buf
, "%s\n", to_xenbus_device(dev
)->devicetype
);
399 static DEVICE_ATTR_RO(devtype
);
401 static ssize_t
modalias_show(struct device
*dev
,
402 struct device_attribute
*attr
, char *buf
)
404 return sprintf(buf
, "%s:%s\n", dev
->bus
->name
,
405 to_xenbus_device(dev
)->devicetype
);
407 static DEVICE_ATTR_RO(modalias
);
409 static struct attribute
*xenbus_dev_attrs
[] = {
410 &dev_attr_nodename
.attr
,
411 &dev_attr_devtype
.attr
,
412 &dev_attr_modalias
.attr
,
416 static const struct attribute_group xenbus_dev_group
= {
417 .attrs
= xenbus_dev_attrs
,
420 const struct attribute_group
*xenbus_dev_groups
[] = {
424 EXPORT_SYMBOL_GPL(xenbus_dev_groups
);
426 int xenbus_probe_node(struct xen_bus_type
*bus
,
428 const char *nodename
)
430 char devname
[XEN_BUS_ID_SIZE
];
432 struct xenbus_device
*xendev
;
436 enum xenbus_state state
= xenbus_read_driver_state(nodename
);
438 if (state
!= XenbusStateInitialising
) {
439 /* Device is not new, so ignore it. This can happen if a
440 device is going away after switching to Closed. */
444 stringlen
= strlen(nodename
) + 1 + strlen(type
) + 1;
445 xendev
= kzalloc(sizeof(*xendev
) + stringlen
, GFP_KERNEL
);
449 xendev
->state
= XenbusStateInitialising
;
451 /* Copy the strings into the extra space. */
453 tmpstring
= (char *)(xendev
+ 1);
454 strcpy(tmpstring
, nodename
);
455 xendev
->nodename
= tmpstring
;
457 tmpstring
+= strlen(tmpstring
) + 1;
458 strcpy(tmpstring
, type
);
459 xendev
->devicetype
= tmpstring
;
460 init_completion(&xendev
->down
);
462 xendev
->dev
.bus
= &bus
->bus
;
463 xendev
->dev
.release
= xenbus_dev_release
;
465 err
= bus
->get_bus_id(devname
, xendev
->nodename
);
469 dev_set_name(&xendev
->dev
, "%s", devname
);
471 /* Register with generic device framework. */
472 err
= device_register(&xendev
->dev
);
481 EXPORT_SYMBOL_GPL(xenbus_probe_node
);
483 static int xenbus_probe_device_type(struct xen_bus_type
*bus
, const char *type
)
487 unsigned int dir_n
= 0;
490 dir
= xenbus_directory(XBT_NIL
, bus
->root
, type
, &dir_n
);
494 for (i
= 0; i
< dir_n
; i
++) {
495 err
= bus
->probe(bus
, type
, dir
[i
]);
504 int xenbus_probe_devices(struct xen_bus_type
*bus
)
508 unsigned int i
, dir_n
;
510 dir
= xenbus_directory(XBT_NIL
, bus
->root
, "", &dir_n
);
514 for (i
= 0; i
< dir_n
; i
++) {
515 err
= xenbus_probe_device_type(bus
, dir
[i
]);
523 EXPORT_SYMBOL_GPL(xenbus_probe_devices
);
525 static unsigned int char_count(const char *str
, char c
)
527 unsigned int i
, ret
= 0;
529 for (i
= 0; str
[i
]; i
++)
535 static int strsep_len(const char *str
, char c
, unsigned int len
)
539 for (i
= 0; str
[i
]; i
++)
545 return (len
== 0) ? i
: -ERANGE
;
548 void xenbus_dev_changed(const char *node
, struct xen_bus_type
*bus
)
551 struct xenbus_device
*dev
;
552 char type
[XEN_BUS_ID_SIZE
];
553 const char *p
, *root
;
555 if (char_count(node
, '/') < 2)
558 exists
= xenbus_exists(XBT_NIL
, node
, "");
560 xenbus_cleanup_devices(node
, &bus
->bus
);
564 /* backend/<type>/... or device/<type>/... */
565 p
= strchr(node
, '/') + 1;
566 snprintf(type
, XEN_BUS_ID_SIZE
, "%.*s", (int)strcspn(p
, "/"), p
);
567 type
[XEN_BUS_ID_SIZE
-1] = '\0';
569 rootlen
= strsep_len(node
, '/', bus
->levels
);
572 root
= kasprintf(GFP_KERNEL
, "%.*s", rootlen
, node
);
576 dev
= xenbus_device_find(root
, &bus
->bus
);
578 xenbus_probe_node(bus
, type
, root
);
580 put_device(&dev
->dev
);
584 EXPORT_SYMBOL_GPL(xenbus_dev_changed
);
586 int xenbus_dev_suspend(struct device
*dev
)
589 struct xenbus_driver
*drv
;
590 struct xenbus_device
*xdev
591 = container_of(dev
, struct xenbus_device
, dev
);
593 DPRINTK("%s", xdev
->nodename
);
595 if (dev
->driver
== NULL
)
597 drv
= to_xenbus_driver(dev
->driver
);
599 err
= drv
->suspend(xdev
);
601 pr_warn("suspend %s failed: %i\n", dev_name(dev
), err
);
604 EXPORT_SYMBOL_GPL(xenbus_dev_suspend
);
606 int xenbus_dev_resume(struct device
*dev
)
609 struct xenbus_driver
*drv
;
610 struct xenbus_device
*xdev
611 = container_of(dev
, struct xenbus_device
, dev
);
613 DPRINTK("%s", xdev
->nodename
);
615 if (dev
->driver
== NULL
)
617 drv
= to_xenbus_driver(dev
->driver
);
618 err
= talk_to_otherend(xdev
);
620 pr_warn("resume (talk_to_otherend) %s failed: %i\n",
625 xdev
->state
= XenbusStateInitialising
;
628 err
= drv
->resume(xdev
);
630 pr_warn("resume %s failed: %i\n", dev_name(dev
), err
);
635 err
= watch_otherend(xdev
);
637 pr_warn("resume (watch_otherend) %s failed: %d.\n",
644 EXPORT_SYMBOL_GPL(xenbus_dev_resume
);
646 int xenbus_dev_cancel(struct device
*dev
)
652 EXPORT_SYMBOL_GPL(xenbus_dev_cancel
);
654 /* A flag to determine if xenstored is 'ready' (i.e. has started) */
658 int register_xenstore_notifier(struct notifier_block
*nb
)
662 if (xenstored_ready
> 0)
663 ret
= nb
->notifier_call(nb
, 0, NULL
);
665 blocking_notifier_chain_register(&xenstore_chain
, nb
);
669 EXPORT_SYMBOL_GPL(register_xenstore_notifier
);
671 void unregister_xenstore_notifier(struct notifier_block
*nb
)
673 blocking_notifier_chain_unregister(&xenstore_chain
, nb
);
675 EXPORT_SYMBOL_GPL(unregister_xenstore_notifier
);
677 void xenbus_probe(struct work_struct
*unused
)
681 /* Notify others that xenstore is up */
682 blocking_notifier_call_chain(&xenstore_chain
, 0, NULL
);
684 EXPORT_SYMBOL_GPL(xenbus_probe
);
686 static int __init
xenbus_probe_initcall(void)
691 if (xen_initial_domain() || xen_hvm_domain())
698 device_initcall(xenbus_probe_initcall
);
700 /* Set up event channel for xenstored which is run as a local process
701 * (this is normally used only in dom0)
703 static int __init
xenstored_local_init(void)
706 unsigned long page
= 0;
707 struct evtchn_alloc_unbound alloc_unbound
;
709 /* Allocate Xenstore page */
710 page
= get_zeroed_page(GFP_KERNEL
);
714 xen_store_gfn
= xen_start_info
->store_mfn
= virt_to_gfn((void *)page
);
716 /* Next allocate a local port which xenstored can bind to */
717 alloc_unbound
.dom
= DOMID_SELF
;
718 alloc_unbound
.remote_dom
= DOMID_SELF
;
720 err
= HYPERVISOR_event_channel_op(EVTCHNOP_alloc_unbound
,
726 xen_store_evtchn
= xen_start_info
->store_evtchn
=
737 static int xenbus_resume_cb(struct notifier_block
*nb
,
738 unsigned long action
, void *data
)
742 if (xen_hvm_domain()) {
745 err
= hvm_get_parameter(HVM_PARAM_STORE_EVTCHN
, &v
);
747 xen_store_evtchn
= v
;
749 pr_warn("Cannot update xenstore event channel: %d\n",
752 xen_store_evtchn
= xen_start_info
->store_evtchn
;
757 static struct notifier_block xenbus_resume_nb
= {
758 .notifier_call
= xenbus_resume_cb
,
761 static int __init
xenbus_init(void)
765 xen_store_domain_type
= XS_UNKNOWN
;
770 xenbus_ring_ops_init();
773 xen_store_domain_type
= XS_PV
;
774 if (xen_hvm_domain())
775 xen_store_domain_type
= XS_HVM
;
776 if (xen_hvm_domain() && xen_initial_domain())
777 xen_store_domain_type
= XS_LOCAL
;
778 if (xen_pv_domain() && !xen_start_info
->store_evtchn
)
779 xen_store_domain_type
= XS_LOCAL
;
780 if (xen_pv_domain() && xen_start_info
->store_evtchn
)
783 switch (xen_store_domain_type
) {
785 err
= xenstored_local_init();
788 xen_store_interface
= gfn_to_virt(xen_store_gfn
);
791 xen_store_evtchn
= xen_start_info
->store_evtchn
;
792 xen_store_gfn
= xen_start_info
->store_mfn
;
793 xen_store_interface
= gfn_to_virt(xen_store_gfn
);
796 err
= hvm_get_parameter(HVM_PARAM_STORE_EVTCHN
, &v
);
799 xen_store_evtchn
= (int)v
;
800 err
= hvm_get_parameter(HVM_PARAM_STORE_PFN
, &v
);
803 xen_store_gfn
= (unsigned long)v
;
804 xen_store_interface
=
805 xen_remap(xen_store_gfn
<< XEN_PAGE_SHIFT
,
809 pr_warn("Xenstore state unknown\n");
813 /* Initialize the interface to xenstore. */
816 pr_warn("Error initializing xenstore comms: %i\n", err
);
820 if ((xen_store_domain_type
!= XS_LOCAL
) &&
821 (xen_store_domain_type
!= XS_UNKNOWN
))
822 xen_resume_notifier_register(&xenbus_resume_nb
);
824 #ifdef CONFIG_XEN_COMPAT_XENFS
826 * Create xenfs mountpoint in /proc for compatibility with
827 * utilities that expect to find "xenbus" under "/proc/xen".
829 proc_mkdir("xen", NULL
);
836 postcore_initcall(xenbus_init
);
838 MODULE_LICENSE("GPL");