1 #define DPRINTK(fmt, args...) \
2 pr_debug("xenbus_probe (%s:%d) " fmt ".\n", \
3 __func__, __LINE__, ##args)
5 #include <linux/kernel.h>
7 #include <linux/string.h>
8 #include <linux/ctype.h>
9 #include <linux/fcntl.h>
11 #include <linux/proc_fs.h>
12 #include <linux/notifier.h>
13 #include <linux/kthread.h>
14 #include <linux/mutex.h>
16 #include <linux/module.h>
19 #include <asm/pgtable.h>
20 #include <asm/xen/hypervisor.h>
21 #include <xen/xenbus.h>
22 #include <xen/events.h>
26 #include <xen/platform_pci.h>
28 #include "xenbus_comms.h"
29 #include "xenbus_probe.h"
32 static struct workqueue_struct
*xenbus_frontend_wq
;
34 /* device/<type>/<id> => <type>-<id> */
35 static int frontend_bus_id(char bus_id
[XEN_BUS_ID_SIZE
], const char *nodename
)
37 nodename
= strchr(nodename
, '/');
38 if (!nodename
|| strlen(nodename
+ 1) >= XEN_BUS_ID_SIZE
) {
39 printk(KERN_WARNING
"XENBUS: bad frontend %s\n", nodename
);
43 strlcpy(bus_id
, nodename
+ 1, XEN_BUS_ID_SIZE
);
44 if (!strchr(bus_id
, '/')) {
45 printk(KERN_WARNING
"XENBUS: bus_id %s no slash\n", bus_id
);
48 *strchr(bus_id
, '/') = '-';
52 /* device/<typename>/<name> */
53 static int xenbus_probe_frontend(struct xen_bus_type
*bus
, const char *type
,
59 /* ignore console/0 */
60 if (!strncmp(type
, "console", 7) && !strncmp(name
, "0", 1)) {
61 DPRINTK("Ignoring buggy device entry console/0");
65 nodename
= kasprintf(GFP_KERNEL
, "%s/%s/%s", bus
->root
, type
, name
);
69 DPRINTK("%s", nodename
);
71 err
= xenbus_probe_node(bus
, type
, nodename
);
76 static int xenbus_uevent_frontend(struct device
*_dev
,
77 struct kobj_uevent_env
*env
)
79 struct xenbus_device
*dev
= to_xenbus_device(_dev
);
81 if (add_uevent_var(env
, "MODALIAS=xen:%s", dev
->devicetype
))
88 static void backend_changed(struct xenbus_watch
*watch
,
89 const char **vec
, unsigned int len
)
91 xenbus_otherend_changed(watch
, vec
, len
, 1);
94 static void xenbus_frontend_delayed_resume(struct work_struct
*w
)
96 struct xenbus_device
*xdev
= container_of(w
, struct xenbus_device
, work
);
98 xenbus_dev_resume(&xdev
->dev
);
101 static int xenbus_frontend_dev_resume(struct device
*dev
)
104 * If xenstored is running in this domain, we cannot access the backend
105 * state at the moment, so we need to defer xenbus_dev_resume
107 if (xen_store_domain_type
== XS_LOCAL
) {
108 struct xenbus_device
*xdev
= to_xenbus_device(dev
);
110 if (!xenbus_frontend_wq
) {
111 pr_err("%s: no workqueue to process delayed resume\n",
116 INIT_WORK(&xdev
->work
, xenbus_frontend_delayed_resume
);
117 queue_work(xenbus_frontend_wq
, &xdev
->work
);
122 return xenbus_dev_resume(dev
);
125 static const struct dev_pm_ops xenbus_pm_ops
= {
126 .suspend
= xenbus_dev_suspend
,
127 .resume
= xenbus_frontend_dev_resume
,
128 .freeze
= xenbus_dev_suspend
,
129 .thaw
= xenbus_dev_cancel
,
130 .restore
= xenbus_dev_resume
,
133 static struct xen_bus_type xenbus_frontend
= {
135 .levels
= 2, /* device/type/<id> */
136 .get_bus_id
= frontend_bus_id
,
137 .probe
= xenbus_probe_frontend
,
138 .otherend_changed
= backend_changed
,
141 .match
= xenbus_match
,
142 .uevent
= xenbus_uevent_frontend
,
143 .probe
= xenbus_dev_probe
,
144 .remove
= xenbus_dev_remove
,
145 .shutdown
= xenbus_dev_shutdown
,
146 .dev_attrs
= xenbus_dev_attrs
,
148 .pm
= &xenbus_pm_ops
,
152 static void frontend_changed(struct xenbus_watch
*watch
,
153 const char **vec
, unsigned int len
)
157 xenbus_dev_changed(vec
[XS_WATCH_PATH
], &xenbus_frontend
);
161 /* We watch for devices appearing and vanishing. */
162 static struct xenbus_watch fe_watch
= {
164 .callback
= frontend_changed
,
167 static int read_backend_details(struct xenbus_device
*xendev
)
169 return xenbus_read_otherend_details(xendev
, "backend-id", "backend");
172 static int is_device_connecting(struct device
*dev
, void *data
, bool ignore_nonessential
)
174 struct xenbus_device
*xendev
= to_xenbus_device(dev
);
175 struct device_driver
*drv
= data
;
176 struct xenbus_driver
*xendrv
;
179 * A device with no driver will never connect. We care only about
180 * devices which should currently be in the process of connecting.
185 /* Is this search limited to a particular driver? */
186 if (drv
&& (dev
->driver
!= drv
))
189 if (ignore_nonessential
) {
190 /* With older QEMU, for PVonHVM guests the guest config files
191 * could contain: vfb = [ 'vnc=1, vnclisten=0.0.0.0']
192 * which is nonsensical as there is no PV FB (there can be
193 * a PVKB) running as HVM guest. */
195 if ((strncmp(xendev
->nodename
, "device/vkbd", 11) == 0))
198 if ((strncmp(xendev
->nodename
, "device/vfb", 10) == 0))
201 xendrv
= to_xenbus_driver(dev
->driver
);
202 return (xendev
->state
< XenbusStateConnected
||
203 (xendev
->state
== XenbusStateConnected
&&
204 xendrv
->is_ready
&& !xendrv
->is_ready(xendev
)));
206 static int essential_device_connecting(struct device
*dev
, void *data
)
208 return is_device_connecting(dev
, data
, true /* ignore PV[KBB+FB] */);
210 static int non_essential_device_connecting(struct device
*dev
, void *data
)
212 return is_device_connecting(dev
, data
, false);
215 static int exists_essential_connecting_device(struct device_driver
*drv
)
217 return bus_for_each_dev(&xenbus_frontend
.bus
, NULL
, drv
,
218 essential_device_connecting
);
220 static int exists_non_essential_connecting_device(struct device_driver
*drv
)
222 return bus_for_each_dev(&xenbus_frontend
.bus
, NULL
, drv
,
223 non_essential_device_connecting
);
226 static int print_device_status(struct device
*dev
, void *data
)
228 struct xenbus_device
*xendev
= to_xenbus_device(dev
);
229 struct device_driver
*drv
= data
;
231 /* Is this operation limited to a particular driver? */
232 if (drv
&& (dev
->driver
!= drv
))
236 /* Information only: is this too noisy? */
237 printk(KERN_INFO
"XENBUS: Device with no driver: %s\n",
239 } else if (xendev
->state
< XenbusStateConnected
) {
240 enum xenbus_state rstate
= XenbusStateUnknown
;
241 if (xendev
->otherend
)
242 rstate
= xenbus_read_driver_state(xendev
->otherend
);
243 printk(KERN_WARNING
"XENBUS: Timeout connecting "
244 "to device: %s (local state %d, remote state %d)\n",
245 xendev
->nodename
, xendev
->state
, rstate
);
251 /* We only wait for device setup after most initcalls have run. */
252 static int ready_to_wait_for_devices
;
254 static bool wait_loop(unsigned long start
, unsigned int max_delay
,
255 unsigned int *seconds_waited
)
257 if (time_after(jiffies
, start
+ (*seconds_waited
+5)*HZ
)) {
258 if (!*seconds_waited
)
259 printk(KERN_WARNING
"XENBUS: Waiting for "
260 "devices to initialise: ");
261 *seconds_waited
+= 5;
262 printk("%us...", max_delay
- *seconds_waited
);
263 if (*seconds_waited
== max_delay
)
267 schedule_timeout_interruptible(HZ
/10);
272 * On a 5-minute timeout, wait for all devices currently configured. We need
273 * to do this to guarantee that the filesystems and / or network devices
274 * needed for boot are available, before we can allow the boot to proceed.
276 * This needs to be on a late_initcall, to happen after the frontend device
277 * drivers have been initialised, but before the root fs is mounted.
279 * A possible improvement here would be to have the tools add a per-device
280 * flag to the store entry, indicating whether it is needed at boot time.
281 * This would allow people who knew what they were doing to accelerate their
282 * boot slightly, but of course needs tools or manual intervention to set up
283 * those flags correctly.
285 static void wait_for_devices(struct xenbus_driver
*xendrv
)
287 unsigned long start
= jiffies
;
288 struct device_driver
*drv
= xendrv
? &xendrv
->driver
: NULL
;
289 unsigned int seconds_waited
= 0;
291 if (!ready_to_wait_for_devices
|| !xen_domain())
294 while (exists_non_essential_connecting_device(drv
))
295 if (wait_loop(start
, 30, &seconds_waited
))
298 /* Skips PVKB and PVFB check.*/
299 while (exists_essential_connecting_device(drv
))
300 if (wait_loop(start
, 270, &seconds_waited
))
306 bus_for_each_dev(&xenbus_frontend
.bus
, NULL
, drv
,
307 print_device_status
);
310 int xenbus_register_frontend(struct xenbus_driver
*drv
)
314 drv
->read_otherend_details
= read_backend_details
;
316 ret
= xenbus_register_driver_common(drv
, &xenbus_frontend
);
320 /* If this driver is loaded as a module wait for devices to attach. */
321 wait_for_devices(drv
);
325 EXPORT_SYMBOL_GPL(xenbus_register_frontend
);
327 static DECLARE_WAIT_QUEUE_HEAD(backend_state_wq
);
328 static int backend_state
;
330 static void xenbus_reset_backend_state_changed(struct xenbus_watch
*w
,
331 const char **v
, unsigned int l
)
333 xenbus_scanf(XBT_NIL
, v
[XS_WATCH_PATH
], "", "%i", &backend_state
);
334 printk(KERN_DEBUG
"XENBUS: backend %s %s\n",
335 v
[XS_WATCH_PATH
], xenbus_strstate(backend_state
));
336 wake_up(&backend_state_wq
);
339 static void xenbus_reset_wait_for_backend(char *be
, int expected
)
342 timeout
= wait_event_interruptible_timeout(backend_state_wq
,
343 backend_state
== expected
, 5 * HZ
);
345 printk(KERN_INFO
"XENBUS: backend %s timed out.\n", be
);
349 * Reset frontend if it is in Connected or Closed state.
350 * Wait for backend to catch up.
351 * State Connected happens during kdump, Closed after kexec.
353 static void xenbus_reset_frontend(char *fe
, char *be
, int be_state
)
355 struct xenbus_watch be_watch
;
357 printk(KERN_DEBUG
"XENBUS: backend %s %s\n",
358 be
, xenbus_strstate(be_state
));
360 memset(&be_watch
, 0, sizeof(be_watch
));
361 be_watch
.node
= kasprintf(GFP_NOIO
| __GFP_HIGH
, "%s/state", be
);
365 be_watch
.callback
= xenbus_reset_backend_state_changed
;
366 backend_state
= XenbusStateUnknown
;
368 printk(KERN_INFO
"XENBUS: triggering reconnect on %s\n", be
);
369 register_xenbus_watch(&be_watch
);
371 /* fall through to forward backend to state XenbusStateInitialising */
373 case XenbusStateConnected
:
374 xenbus_printf(XBT_NIL
, fe
, "state", "%d", XenbusStateClosing
);
375 xenbus_reset_wait_for_backend(be
, XenbusStateClosing
);
377 case XenbusStateClosing
:
378 xenbus_printf(XBT_NIL
, fe
, "state", "%d", XenbusStateClosed
);
379 xenbus_reset_wait_for_backend(be
, XenbusStateClosed
);
381 case XenbusStateClosed
:
382 xenbus_printf(XBT_NIL
, fe
, "state", "%d", XenbusStateInitialising
);
383 xenbus_reset_wait_for_backend(be
, XenbusStateInitWait
);
386 unregister_xenbus_watch(&be_watch
);
387 printk(KERN_INFO
"XENBUS: reconnect done on %s\n", be
);
388 kfree(be_watch
.node
);
391 static void xenbus_check_frontend(char *class, char *dev
)
393 int be_state
, fe_state
, err
;
394 char *backend
, *frontend
;
396 frontend
= kasprintf(GFP_NOIO
| __GFP_HIGH
, "device/%s/%s", class, dev
);
400 err
= xenbus_scanf(XBT_NIL
, frontend
, "state", "%i", &fe_state
);
405 case XenbusStateConnected
:
406 case XenbusStateClosed
:
407 printk(KERN_DEBUG
"XENBUS: frontend %s %s\n",
408 frontend
, xenbus_strstate(fe_state
));
409 backend
= xenbus_read(XBT_NIL
, frontend
, "backend", NULL
);
410 if (!backend
|| IS_ERR(backend
))
412 err
= xenbus_scanf(XBT_NIL
, backend
, "state", "%i", &be_state
);
414 xenbus_reset_frontend(frontend
, backend
, be_state
);
424 static void xenbus_reset_state(void)
426 char **devclass
, **dev
;
427 int devclass_n
, dev_n
;
430 devclass
= xenbus_directory(XBT_NIL
, "device", "", &devclass_n
);
431 if (IS_ERR(devclass
))
434 for (i
= 0; i
< devclass_n
; i
++) {
435 dev
= xenbus_directory(XBT_NIL
, "device", devclass
[i
], &dev_n
);
438 for (j
= 0; j
< dev_n
; j
++)
439 xenbus_check_frontend(devclass
[i
], dev
[j
]);
445 static int frontend_probe_and_watch(struct notifier_block
*notifier
,
449 /* reset devices in Connected or Closed state */
450 if (xen_hvm_domain())
451 xenbus_reset_state();
452 /* Enumerate devices in xenstore and watch for changes. */
453 xenbus_probe_devices(&xenbus_frontend
);
454 register_xenbus_watch(&fe_watch
);
460 static int __init
xenbus_probe_frontend_init(void)
462 static struct notifier_block xenstore_notifier
= {
463 .notifier_call
= frontend_probe_and_watch
469 /* Register ourselves with the kernel bus subsystem */
470 err
= bus_register(&xenbus_frontend
.bus
);
474 register_xenstore_notifier(&xenstore_notifier
);
476 xenbus_frontend_wq
= create_workqueue("xenbus_frontend");
480 subsys_initcall(xenbus_probe_frontend_init
);
483 static int __init
boot_wait_for_devices(void)
485 if (xen_hvm_domain() && !xen_platform_pci_unplug
)
488 ready_to_wait_for_devices
= 1;
489 wait_for_devices(NULL
);
493 late_initcall(boot_wait_for_devices
);
496 MODULE_LICENSE("GPL");