2 * xen backend driver infrastructure
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; under version 2 of the License.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, see <http://www.gnu.org/licenses/>.
19 * TODO: add some xenbus / xenstore concepts overview here.
29 #include <sys/types.h>
32 #include <sys/signal.h>
36 #include <xen/grant_table.h>
39 #include "qemu-char.h"
41 #include "xen_backend.h"
43 /* ------------------------------------------------------------- */
46 XenXC xen_xc = XC_HANDLER_INITIAL_VALUE;
47 XenGnttab xen_xcg = XC_HANDLER_INITIAL_VALUE;
48 struct xs_handle *xenstore = NULL;
49 const char *xen_protocol;
52 static QTAILQ_HEAD(XenDeviceHead, XenDevice) xendevs = QTAILQ_HEAD_INITIALIZER(xendevs);
55 /* ------------------------------------------------------------- */
57 int xenstore_write_str(const char *base, const char *node, const char *val)
59 char abspath[XEN_BUFSIZE];
61 snprintf(abspath, sizeof(abspath), "%s/%s", base, node);
62 if (!xs_write(xenstore, 0, abspath, val, strlen(val))) {
68 char *xenstore_read_str(const char *base, const char *node)
70 char abspath[XEN_BUFSIZE];
72 char *str, *ret = NULL;
74 snprintf(abspath, sizeof(abspath), "%s/%s", base, node);
75 str = xs_read(xenstore, 0, abspath, &len);
77 /* move to qemu-allocated memory to make sure
78 * callers can savely g_free() stuff. */
85 int xenstore_write_int(const char *base, const char *node, int ival)
89 snprintf(val, sizeof(val), "%d", ival);
90 return xenstore_write_str(base, node, val);
93 int xenstore_read_int(const char *base, const char *node, int *ival)
98 val = xenstore_read_str(base, node);
99 if (val && 1 == sscanf(val, "%d", ival)) {
106 int xenstore_write_be_str(struct XenDevice *xendev, const char *node, const char *val)
108 return xenstore_write_str(xendev->be, node, val);
111 int xenstore_write_be_int(struct XenDevice *xendev, const char *node, int ival)
113 return xenstore_write_int(xendev->be, node, ival);
116 char *xenstore_read_be_str(struct XenDevice *xendev, const char *node)
118 return xenstore_read_str(xendev->be, node);
121 int xenstore_read_be_int(struct XenDevice *xendev, const char *node, int *ival)
123 return xenstore_read_int(xendev->be, node, ival);
126 char *xenstore_read_fe_str(struct XenDevice *xendev, const char *node)
128 return xenstore_read_str(xendev->fe, node);
131 int xenstore_read_fe_int(struct XenDevice *xendev, const char *node, int *ival)
133 return xenstore_read_int(xendev->fe, node, ival);
136 /* ------------------------------------------------------------- */
138 const char *xenbus_strstate(enum xenbus_state state)
140 static const char *const name[] = {
141 [ XenbusStateUnknown ] = "Unknown",
142 [ XenbusStateInitialising ] = "Initialising",
143 [ XenbusStateInitWait ] = "InitWait",
144 [ XenbusStateInitialised ] = "Initialised",
145 [ XenbusStateConnected ] = "Connected",
146 [ XenbusStateClosing ] = "Closing",
147 [ XenbusStateClosed ] = "Closed",
149 return (state < ARRAY_SIZE(name)) ? name[state] : "INVALID";
152 int xen_be_set_state(struct XenDevice *xendev, enum xenbus_state state)
156 rc = xenstore_write_be_int(xendev, "state", state);
160 xen_be_printf(xendev, 1, "backend state: %s -> %s\n",
161 xenbus_strstate(xendev->be_state), xenbus_strstate(state));
162 xendev->be_state = state;
166 /* ------------------------------------------------------------- */
168 struct XenDevice *xen_be_find_xendev(const char *type, int dom, int dev)
170 struct XenDevice *xendev;
172 QTAILQ_FOREACH(xendev, &xendevs, next) {
173 if (xendev->dom != dom) {
176 if (xendev->dev != dev) {
179 if (strcmp(xendev->type, type) != 0) {
188 * get xen backend device, allocate a new one if it doesn't exist.
190 static struct XenDevice *xen_be_get_xendev(const char *type, int dom, int dev,
191 struct XenDevOps *ops)
193 struct XenDevice *xendev;
196 xendev = xen_be_find_xendev(type, dom, dev);
201 /* init new xendev */
202 xendev = g_malloc0(ops->size);
208 dom0 = xs_get_domain_path(xenstore, 0);
209 snprintf(xendev->be, sizeof(xendev->be), "%s/backend/%s/%d/%d",
210 dom0, xendev->type, xendev->dom, xendev->dev);
211 snprintf(xendev->name, sizeof(xendev->name), "%s-%d",
212 xendev->type, xendev->dev);
215 xendev->debug = debug;
216 xendev->local_port = -1;
218 xendev->evtchndev = xen_xc_evtchn_open(NULL, 0);
219 if (xendev->evtchndev == XC_HANDLER_INITIAL_VALUE) {
220 xen_be_printf(NULL, 0, "can't open evtchn device\n");
224 fcntl(xc_evtchn_fd(xendev->evtchndev), F_SETFD, FD_CLOEXEC);
226 if (ops->flags & DEVOPS_FLAG_NEED_GNTDEV) {
227 xendev->gnttabdev = xen_xc_gnttab_open(NULL, 0);
228 if (xendev->gnttabdev == XC_HANDLER_INITIAL_VALUE) {
229 xen_be_printf(NULL, 0, "can't open gnttab device\n");
230 xc_evtchn_close(xendev->evtchndev);
235 xendev->gnttabdev = XC_HANDLER_INITIAL_VALUE;
238 QTAILQ_INSERT_TAIL(&xendevs, xendev, next);
240 if (xendev->ops->alloc) {
241 xendev->ops->alloc(xendev);
248 * release xen backend device.
250 static struct XenDevice *xen_be_del_xendev(int dom, int dev)
252 struct XenDevice *xendev, *xnext;
255 * This is pretty much like QTAILQ_FOREACH(xendev, &xendevs, next) but
256 * we save the next pointer in xnext because we might free xendev.
258 xnext = xendevs.tqh_first;
261 xnext = xendev->next.tqe_next;
263 if (xendev->dom != dom) {
266 if (xendev->dev != dev && dev != -1) {
270 if (xendev->ops->free) {
271 xendev->ops->free(xendev);
275 char token[XEN_BUFSIZE];
276 snprintf(token, sizeof(token), "fe:%p", xendev);
277 xs_unwatch(xenstore, xendev->fe, token);
281 if (xendev->evtchndev != XC_HANDLER_INITIAL_VALUE) {
282 xc_evtchn_close(xendev->evtchndev);
284 if (xendev->gnttabdev != XC_HANDLER_INITIAL_VALUE) {
285 xc_gnttab_close(xendev->gnttabdev);
288 QTAILQ_REMOVE(&xendevs, xendev, next);
295 * Sync internal data structures on xenstore updates.
296 * Node specifies the changed field. node = NULL means
297 * update all fields (used for initialization).
299 static void xen_be_backend_changed(struct XenDevice *xendev, const char *node)
301 if (node == NULL || strcmp(node, "online") == 0) {
302 if (xenstore_read_be_int(xendev, "online", &xendev->online) == -1) {
308 xen_be_printf(xendev, 2, "backend update: %s\n", node);
309 if (xendev->ops->backend_changed) {
310 xendev->ops->backend_changed(xendev, node);
315 static void xen_be_frontend_changed(struct XenDevice *xendev, const char *node)
319 if (node == NULL || strcmp(node, "state") == 0) {
320 if (xenstore_read_fe_int(xendev, "state", &fe_state) == -1) {
321 fe_state = XenbusStateUnknown;
323 if (xendev->fe_state != fe_state) {
324 xen_be_printf(xendev, 1, "frontend state: %s -> %s\n",
325 xenbus_strstate(xendev->fe_state),
326 xenbus_strstate(fe_state));
328 xendev->fe_state = fe_state;
330 if (node == NULL || strcmp(node, "protocol") == 0) {
331 g_free(xendev->protocol);
332 xendev->protocol = xenstore_read_fe_str(xendev, "protocol");
333 if (xendev->protocol) {
334 xen_be_printf(xendev, 1, "frontend protocol: %s\n", xendev->protocol);
339 xen_be_printf(xendev, 2, "frontend update: %s\n", node);
340 if (xendev->ops->frontend_changed) {
341 xendev->ops->frontend_changed(xendev, node);
346 /* ------------------------------------------------------------- */
347 /* Check for possible state transitions and perform them. */
350 * Initial xendev setup. Read frontend path, register watch for it.
351 * Should succeed once xend finished setting up the backend device.
353 * Also sets initial state (-> Initializing) when done. Which
354 * only affects the xendev->be_state variable as xenbus should
355 * already be put into that state by xend.
357 static int xen_be_try_setup(struct XenDevice *xendev)
359 char token[XEN_BUFSIZE];
362 if (xenstore_read_be_int(xendev, "state", &be_state) == -1) {
363 xen_be_printf(xendev, 0, "reading backend state failed\n");
367 if (be_state != XenbusStateInitialising) {
368 xen_be_printf(xendev, 0, "initial backend state is wrong (%s)\n",
369 xenbus_strstate(be_state));
373 xendev->fe = xenstore_read_be_str(xendev, "frontend");
374 if (xendev->fe == NULL) {
375 xen_be_printf(xendev, 0, "reading frontend path failed\n");
379 /* setup frontend watch */
380 snprintf(token, sizeof(token), "fe:%p", xendev);
381 if (!xs_watch(xenstore, xendev->fe, token)) {
382 xen_be_printf(xendev, 0, "watching frontend path (%s) failed\n",
386 xen_be_set_state(xendev, XenbusStateInitialising);
388 xen_be_backend_changed(xendev, NULL);
389 xen_be_frontend_changed(xendev, NULL);
394 * Try initialize xendev. Prepare everything the backend can do
395 * without synchronizing with the frontend. Fakes hotplug-status. No
396 * hotplug involved here because this is about userspace drivers, thus
397 * there are kernel backend devices which could invoke hotplug.
399 * Goes to InitWait on success.
401 static int xen_be_try_init(struct XenDevice *xendev)
405 if (!xendev->online) {
406 xen_be_printf(xendev, 1, "not online\n");
410 if (xendev->ops->init) {
411 rc = xendev->ops->init(xendev);
414 xen_be_printf(xendev, 1, "init() failed\n");
418 xenstore_write_be_str(xendev, "hotplug-status", "connected");
419 xen_be_set_state(xendev, XenbusStateInitWait);
424 * Try to initialise xendev. Depends on the frontend being ready
425 * for it (shared ring and evtchn info in xenstore, state being
426 * Initialised or Connected).
428 * Goes to Connected on success.
430 static int xen_be_try_initialise(struct XenDevice *xendev)
434 if (xendev->fe_state != XenbusStateInitialised &&
435 xendev->fe_state != XenbusStateConnected) {
436 if (xendev->ops->flags & DEVOPS_FLAG_IGNORE_STATE) {
437 xen_be_printf(xendev, 2, "frontend not ready, ignoring\n");
439 xen_be_printf(xendev, 2, "frontend not ready (yet)\n");
444 if (xendev->ops->initialise) {
445 rc = xendev->ops->initialise(xendev);
448 xen_be_printf(xendev, 0, "initialise() failed\n");
452 xen_be_set_state(xendev, XenbusStateConnected);
457 * Try to let xendev know that it is connected. Depends on the
458 * frontend being Connected. Note that this may be called more
459 * than once since the backend state is not modified.
461 static void xen_be_try_connected(struct XenDevice *xendev)
463 if (!xendev->ops->connected) {
467 if (xendev->fe_state != XenbusStateConnected) {
468 if (xendev->ops->flags & DEVOPS_FLAG_IGNORE_STATE) {
469 xen_be_printf(xendev, 2, "frontend not ready, ignoring\n");
471 xen_be_printf(xendev, 2, "frontend not ready (yet)\n");
476 xendev->ops->connected(xendev);
480 * Teardown connection.
482 * Goes to Closed when done.
484 static void xen_be_disconnect(struct XenDevice *xendev, enum xenbus_state state)
486 if (xendev->be_state != XenbusStateClosing &&
487 xendev->be_state != XenbusStateClosed &&
488 xendev->ops->disconnect) {
489 xendev->ops->disconnect(xendev);
491 if (xendev->be_state != state) {
492 xen_be_set_state(xendev, state);
497 * Try to reset xendev, for reconnection by another frontend instance.
499 static int xen_be_try_reset(struct XenDevice *xendev)
501 if (xendev->fe_state != XenbusStateInitialising) {
505 xen_be_printf(xendev, 1, "device reset (for re-connect)\n");
506 xen_be_set_state(xendev, XenbusStateInitialising);
511 * state change dispatcher function
513 void xen_be_check_state(struct XenDevice *xendev)
517 /* frontend may request shutdown from almost anywhere */
518 if (xendev->fe_state == XenbusStateClosing ||
519 xendev->fe_state == XenbusStateClosed) {
520 xen_be_disconnect(xendev, xendev->fe_state);
524 /* check for possible backend state transitions */
526 switch (xendev->be_state) {
527 case XenbusStateUnknown:
528 rc = xen_be_try_setup(xendev);
530 case XenbusStateInitialising:
531 rc = xen_be_try_init(xendev);
533 case XenbusStateInitWait:
534 rc = xen_be_try_initialise(xendev);
536 case XenbusStateConnected:
537 /* xendev->be_state doesn't change */
538 xen_be_try_connected(xendev);
541 case XenbusStateClosed:
542 rc = xen_be_try_reset(xendev);
553 /* ------------------------------------------------------------- */
555 static int xenstore_scan(const char *type, int dom, struct XenDevOps *ops)
557 struct XenDevice *xendev;
558 char path[XEN_BUFSIZE], token[XEN_BUFSIZE];
559 char **dev = NULL, *dom0;
560 unsigned int cdev, j;
563 dom0 = xs_get_domain_path(xenstore, 0);
564 snprintf(token, sizeof(token), "be:%p:%d:%p", type, dom, ops);
565 snprintf(path, sizeof(path), "%s/backend/%s/%d", dom0, type, dom);
567 if (!xs_watch(xenstore, path, token)) {
568 xen_be_printf(NULL, 0, "xen be: watching backend path (%s) failed\n", path);
572 /* look for backends */
573 dev = xs_directory(xenstore, 0, path, &cdev);
577 for (j = 0; j < cdev; j++) {
578 xendev = xen_be_get_xendev(type, dom, atoi(dev[j]), ops);
579 if (xendev == NULL) {
582 xen_be_check_state(xendev);
588 static void xenstore_update_be(char *watch, char *type, int dom,
589 struct XenDevOps *ops)
591 struct XenDevice *xendev;
592 char path[XEN_BUFSIZE], *dom0;
593 unsigned int len, dev;
595 dom0 = xs_get_domain_path(xenstore, 0);
596 len = snprintf(path, sizeof(path), "%s/backend/%s/%d", dom0, type, dom);
598 if (strncmp(path, watch, len) != 0) {
601 if (sscanf(watch+len, "/%u/%255s", &dev, path) != 2) {
603 if (sscanf(watch+len, "/%u", &dev) != 1) {
612 /* FIXME: detect devices being deleted from xenstore ... */
613 xen_be_del_xendev(dom, dev);
616 xendev = xen_be_get_xendev(type, dom, dev, ops);
617 if (xendev != NULL) {
618 xen_be_backend_changed(xendev, path);
619 xen_be_check_state(xendev);
623 static void xenstore_update_fe(char *watch, struct XenDevice *xendev)
628 len = strlen(xendev->fe);
629 if (strncmp(xendev->fe, watch, len) != 0) {
632 if (watch[len] != '/') {
635 node = watch + len + 1;
637 xen_be_frontend_changed(xendev, node);
638 xen_be_check_state(xendev);
641 static void xenstore_update(void *unused)
644 intptr_t type, ops, ptr;
645 unsigned int dom, count;
647 vec = xs_read_watch(xenstore, &count);
652 if (sscanf(vec[XS_WATCH_TOKEN], "be:%" PRIxPTR ":%d:%" PRIxPTR,
653 &type, &dom, &ops) == 3) {
654 xenstore_update_be(vec[XS_WATCH_PATH], (void*)type, dom, (void*)ops);
656 if (sscanf(vec[XS_WATCH_TOKEN], "fe:%" PRIxPTR, &ptr) == 1) {
657 xenstore_update_fe(vec[XS_WATCH_PATH], (void*)ptr);
664 static void xen_be_evtchn_event(void *opaque)
666 struct XenDevice *xendev = opaque;
669 port = xc_evtchn_pending(xendev->evtchndev);
670 if (port != xendev->local_port) {
671 xen_be_printf(xendev, 0, "xc_evtchn_pending returned %d (expected %d)\n",
672 port, xendev->local_port);
675 xc_evtchn_unmask(xendev->evtchndev, port);
677 if (xendev->ops->event) {
678 xendev->ops->event(xendev);
682 /* -------------------------------------------------------------------- */
684 int xen_be_init(void)
686 xenstore = xs_daemon_open();
688 xen_be_printf(NULL, 0, "can't connect to xenstored\n");
692 if (qemu_set_fd_handler(xs_fileno(xenstore), xenstore_update, NULL, NULL) < 0) {
696 if (xen_xc == XC_HANDLER_INITIAL_VALUE) {
697 /* Check if xen_init() have been called */
703 qemu_set_fd_handler(xs_fileno(xenstore), NULL, NULL, NULL);
704 xs_daemon_close(xenstore);
710 int xen_be_register(const char *type, struct XenDevOps *ops)
712 return xenstore_scan(type, xen_domid, ops);
715 int xen_be_bind_evtchn(struct XenDevice *xendev)
717 if (xendev->local_port != -1) {
720 xendev->local_port = xc_evtchn_bind_interdomain
721 (xendev->evtchndev, xendev->dom, xendev->remote_port);
722 if (xendev->local_port == -1) {
723 xen_be_printf(xendev, 0, "xc_evtchn_bind_interdomain failed\n");
726 xen_be_printf(xendev, 2, "bind evtchn port %d\n", xendev->local_port);
727 qemu_set_fd_handler(xc_evtchn_fd(xendev->evtchndev),
728 xen_be_evtchn_event, NULL, xendev);
732 void xen_be_unbind_evtchn(struct XenDevice *xendev)
734 if (xendev->local_port == -1) {
737 qemu_set_fd_handler(xc_evtchn_fd(xendev->evtchndev), NULL, NULL, NULL);
738 xc_evtchn_unbind(xendev->evtchndev, xendev->local_port);
739 xen_be_printf(xendev, 2, "unbind evtchn port %d\n", xendev->local_port);
740 xendev->local_port = -1;
743 int xen_be_send_notify(struct XenDevice *xendev)
745 return xc_evtchn_notify(xendev->evtchndev, xendev->local_port);
750 * 0 == errors (stderr + logfile).
751 * 1 == informative debug messages (logfile only).
752 * 2 == noisy debug messages (logfile only).
753 * 3 == will flood your log (logfile only).
755 void xen_be_printf(struct XenDevice *xendev, int msg_level, const char *fmt, ...)
760 if (msg_level > xendev->debug) {
763 qemu_log("xen be: %s: ", xendev->name);
764 if (msg_level == 0) {
765 fprintf(stderr, "xen be: %s: ", xendev->name);
768 if (msg_level > debug) {
771 qemu_log("xen be core: ");
772 if (msg_level == 0) {
773 fprintf(stderr, "xen be core: ");
777 qemu_log_vprintf(fmt, args);
779 if (msg_level == 0) {
781 vfprintf(stderr, fmt, args);