2 * Xenbus code for netif backend
4 * Copyright (C) 2005 Rusty Russell <rusty@rustcorp.com.au>
5 * Copyright (C) 2005 XenSource Ltd
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, see <http://www.gnu.org/licenses/>.
22 #include <linux/vmalloc.h>
23 #include <linux/rtnetlink.h>
26 struct xenbus_device *dev;
29 /* This is the state that will be reflected in xenstore when any
30 * active hotplug script completes.
32 enum xenbus_state state;
34 enum xenbus_state frontend_state;
35 struct xenbus_watch hotplug_status_watch;
36 u8 have_hotplug_status_watch:1;
39 static int connect_rings(struct backend_info *be, struct xenvif_queue *queue);
40 static void connect(struct backend_info *be);
41 static int read_xenbus_vif_flags(struct backend_info *be);
42 static void backend_create_xenvif(struct backend_info *be);
43 static void unregister_hotplug_status_watch(struct backend_info *be);
44 static void set_backend_state(struct backend_info *be,
45 enum xenbus_state state);
47 static int netback_remove(struct xenbus_device *dev)
49 struct backend_info *be = dev_get_drvdata(&dev->dev);
51 set_backend_state(be, XenbusStateClosed);
53 unregister_hotplug_status_watch(be);
55 kobject_uevent(&dev->dev.kobj, KOBJ_OFFLINE);
56 xenbus_rm(XBT_NIL, dev->nodename, "hotplug-status");
61 dev_set_drvdata(&dev->dev, NULL);
67 * Entry point to this code when a new device is created. Allocate the basic
68 * structures and switch to InitWait.
70 static int netback_probe(struct xenbus_device *dev,
71 const struct xenbus_device_id *id)
74 struct xenbus_transaction xbt;
77 struct backend_info *be = kzalloc(sizeof(struct backend_info),
80 xenbus_dev_fatal(dev, -ENOMEM,
81 "allocating backend structure");
86 dev_set_drvdata(&dev->dev, be);
91 err = xenbus_transaction_start(&xbt);
93 xenbus_dev_fatal(dev, err, "starting transaction");
97 err = xenbus_printf(xbt, dev->nodename, "feature-sg", "%d", sg);
99 message = "writing feature-sg";
100 goto abort_transaction;
103 err = xenbus_printf(xbt, dev->nodename, "feature-gso-tcpv4",
106 message = "writing feature-gso-tcpv4";
107 goto abort_transaction;
110 err = xenbus_printf(xbt, dev->nodename, "feature-gso-tcpv6",
113 message = "writing feature-gso-tcpv6";
114 goto abort_transaction;
117 /* We support partial checksum setup for IPv6 packets */
118 err = xenbus_printf(xbt, dev->nodename,
119 "feature-ipv6-csum-offload",
122 message = "writing feature-ipv6-csum-offload";
123 goto abort_transaction;
126 /* We support rx-copy path. */
127 err = xenbus_printf(xbt, dev->nodename,
128 "feature-rx-copy", "%d", 1);
130 message = "writing feature-rx-copy";
131 goto abort_transaction;
135 * We don't support rx-flip path (except old guests who don't
136 * grok this feature flag).
138 err = xenbus_printf(xbt, dev->nodename,
139 "feature-rx-flip", "%d", 0);
141 message = "writing feature-rx-flip";
142 goto abort_transaction;
145 err = xenbus_transaction_end(xbt, 0);
146 } while (err == -EAGAIN);
149 xenbus_dev_fatal(dev, err, "completing transaction");
154 * Split event channels support, this is optional so it is not
155 * put inside the above loop.
157 err = xenbus_printf(XBT_NIL, dev->nodename,
158 "feature-split-event-channels",
159 "%u", separate_tx_rx_irq);
161 pr_debug("Error writing feature-split-event-channels\n");
163 /* Multi-queue support: This is an optional feature. */
164 err = xenbus_printf(XBT_NIL, dev->nodename,
165 "multi-queue-max-queues", "%u", xenvif_max_queues);
167 pr_debug("Error writing multi-queue-max-queues\n");
169 err = xenbus_switch_state(dev, XenbusStateInitWait);
173 be->state = XenbusStateInitWait;
175 /* This kicks hotplug scripts, so do it immediately. */
176 backend_create_xenvif(be);
181 xenbus_transaction_end(xbt, 1);
182 xenbus_dev_fatal(dev, err, "%s", message);
184 pr_debug("failed\n");
191 * Handle the creation of the hotplug script environment. We add the script
192 * and vif variables to the environment, for the benefit of the vif-* hotplug
195 static int netback_uevent(struct xenbus_device *xdev,
196 struct kobj_uevent_env *env)
198 struct backend_info *be = dev_get_drvdata(&xdev->dev);
201 val = xenbus_read(XBT_NIL, xdev->nodename, "script", NULL);
203 int err = PTR_ERR(val);
204 xenbus_dev_fatal(xdev, err, "reading script");
207 if (add_uevent_var(env, "script=%s", val)) {
217 return add_uevent_var(env, "vif=%s", be->vif->dev->name);
221 static void backend_create_xenvif(struct backend_info *be)
225 struct xenbus_device *dev = be->dev;
230 err = xenbus_scanf(XBT_NIL, dev->nodename, "handle", "%li", &handle);
232 xenbus_dev_fatal(dev, err, "reading handle");
236 be->vif = xenvif_alloc(&dev->dev, dev->otherend_id, handle);
237 if (IS_ERR(be->vif)) {
238 err = PTR_ERR(be->vif);
240 xenbus_dev_fatal(dev, err, "creating interface");
244 kobject_uevent(&dev->dev.kobj, KOBJ_ONLINE);
247 static void backend_disconnect(struct backend_info *be)
250 xenvif_disconnect(be->vif);
253 static void backend_connect(struct backend_info *be)
259 static inline void backend_switch_state(struct backend_info *be,
260 enum xenbus_state state)
262 struct xenbus_device *dev = be->dev;
264 pr_debug("%s -> %s\n", dev->nodename, xenbus_strstate(state));
267 /* If we are waiting for a hotplug script then defer the
268 * actual xenbus state change.
270 if (!be->have_hotplug_status_watch)
271 xenbus_switch_state(dev, state);
274 /* Handle backend state transitions:
276 * The backend state starts in InitWait and the following transitions are
279 * InitWait -> Connected
291 * The state argument specifies the eventual state of the backend and the
292 * function transitions to that state via the shortest path.
294 static void set_backend_state(struct backend_info *be,
295 enum xenbus_state state)
297 while (be->state != state) {
299 case XenbusStateClosed:
301 case XenbusStateInitWait:
302 case XenbusStateConnected:
303 pr_info("%s: prepare for reconnect\n",
305 backend_switch_state(be, XenbusStateInitWait);
307 case XenbusStateClosing:
308 backend_switch_state(be, XenbusStateClosing);
314 case XenbusStateInitWait:
316 case XenbusStateConnected:
318 backend_switch_state(be, XenbusStateConnected);
320 case XenbusStateClosing:
321 case XenbusStateClosed:
322 backend_switch_state(be, XenbusStateClosing);
328 case XenbusStateConnected:
330 case XenbusStateInitWait:
331 case XenbusStateClosing:
332 case XenbusStateClosed:
333 backend_disconnect(be);
334 backend_switch_state(be, XenbusStateClosing);
340 case XenbusStateClosing:
342 case XenbusStateInitWait:
343 case XenbusStateConnected:
344 case XenbusStateClosed:
345 backend_switch_state(be, XenbusStateClosed);
358 * Callback received when the frontend's state changes.
360 static void frontend_changed(struct xenbus_device *dev,
361 enum xenbus_state frontend_state)
363 struct backend_info *be = dev_get_drvdata(&dev->dev);
365 pr_debug("%s -> %s\n", dev->otherend, xenbus_strstate(frontend_state));
367 be->frontend_state = frontend_state;
369 switch (frontend_state) {
370 case XenbusStateInitialising:
371 set_backend_state(be, XenbusStateInitWait);
374 case XenbusStateInitialised:
377 case XenbusStateConnected:
378 set_backend_state(be, XenbusStateConnected);
381 case XenbusStateClosing:
382 set_backend_state(be, XenbusStateClosing);
385 case XenbusStateClosed:
386 set_backend_state(be, XenbusStateClosed);
387 if (xenbus_dev_is_online(dev))
389 /* fall through if not online */
390 case XenbusStateUnknown:
391 set_backend_state(be, XenbusStateClosed);
392 device_unregister(&dev->dev);
396 xenbus_dev_fatal(dev, -EINVAL, "saw state %d at frontend",
403 static void xen_net_read_rate(struct xenbus_device *dev,
404 unsigned long *bytes, unsigned long *usec)
410 /* Default to unlimited bandwidth. */
414 ratestr = xenbus_read(XBT_NIL, dev->nodename, "rate", NULL);
419 b = simple_strtoul(s, &e, 10);
420 if ((s == e) || (*e != ','))
424 u = simple_strtoul(s, &e, 10);
425 if ((s == e) || (*e != '\0'))
435 pr_warn("Failed to parse network rate limit. Traffic unlimited.\n");
439 static int xen_net_read_mac(struct xenbus_device *dev, u8 mac[])
441 char *s, *e, *macstr;
444 macstr = s = xenbus_read(XBT_NIL, dev->nodename, "mac", NULL);
446 return PTR_ERR(macstr);
448 for (i = 0; i < ETH_ALEN; i++) {
449 mac[i] = simple_strtoul(s, &e, 16);
450 if ((s == e) || (*e != ((i == ETH_ALEN-1) ? '\0' : ':'))) {
461 static void unregister_hotplug_status_watch(struct backend_info *be)
463 if (be->have_hotplug_status_watch) {
464 unregister_xenbus_watch(&be->hotplug_status_watch);
465 kfree(be->hotplug_status_watch.node);
467 be->have_hotplug_status_watch = 0;
470 static void hotplug_status_changed(struct xenbus_watch *watch,
472 unsigned int vec_size)
474 struct backend_info *be = container_of(watch,
476 hotplug_status_watch);
480 str = xenbus_read(XBT_NIL, be->dev->nodename, "hotplug-status", &len);
483 if (len == sizeof("connected")-1 && !memcmp(str, "connected", len)) {
484 /* Complete any pending state change */
485 xenbus_switch_state(be->dev, be->state);
487 /* Not interested in this watch anymore. */
488 unregister_hotplug_status_watch(be);
493 static void connect(struct backend_info *be)
496 struct xenbus_device *dev = be->dev;
497 unsigned long credit_bytes, credit_usec;
498 unsigned int queue_index;
499 unsigned int requested_num_queues;
500 struct xenvif_queue *queue;
502 /* Check whether the frontend requested multiple queues
503 * and read the number requested.
505 err = xenbus_scanf(XBT_NIL, dev->otherend,
506 "multi-queue-num-queues",
507 "%u", &requested_num_queues);
509 requested_num_queues = 1; /* Fall back to single queue */
510 } else if (requested_num_queues > xenvif_max_queues) {
511 /* buggy or malicious guest */
512 xenbus_dev_fatal(dev, err,
513 "guest requested %u queues, exceeding the maximum of %u.",
514 requested_num_queues, xenvif_max_queues);
518 err = xen_net_read_mac(dev, be->vif->fe_dev_addr);
520 xenbus_dev_fatal(dev, err, "parsing %s/mac", dev->nodename);
524 xen_net_read_rate(dev, &credit_bytes, &credit_usec);
525 read_xenbus_vif_flags(be);
527 /* Use the number of queues requested by the frontend */
528 be->vif->queues = vzalloc(requested_num_queues *
529 sizeof(struct xenvif_queue));
530 be->vif->num_queues = requested_num_queues;
532 for (queue_index = 0; queue_index < requested_num_queues; ++queue_index) {
533 queue = &be->vif->queues[queue_index];
534 queue->vif = be->vif;
535 queue->id = queue_index;
536 snprintf(queue->name, sizeof(queue->name), "%s-q%u",
537 be->vif->dev->name, queue->id);
539 err = xenvif_init_queue(queue);
541 /* xenvif_init_queue() cleans up after itself on
542 * failure, but we need to clean up any previously
543 * initialised queues. Set num_queues to i so that
544 * earlier queues can be destroyed using the regular
547 be->vif->num_queues = queue_index;
551 queue->remaining_credit = credit_bytes;
553 err = connect_rings(be, queue);
555 /* connect_rings() cleans up after itself on failure,
556 * but we need to clean up after xenvif_init_queue() here,
557 * and also clean up any previously initialised queues.
559 xenvif_deinit_queue(queue);
560 be->vif->num_queues = queue_index;
565 /* Initialisation completed, tell core driver the number of
569 netif_set_real_num_tx_queues(be->vif->dev, requested_num_queues);
570 netif_set_real_num_rx_queues(be->vif->dev, requested_num_queues);
573 xenvif_carrier_on(be->vif);
575 unregister_hotplug_status_watch(be);
576 err = xenbus_watch_pathfmt(dev, &be->hotplug_status_watch,
577 hotplug_status_changed,
578 "%s/%s", dev->nodename, "hotplug-status");
580 be->have_hotplug_status_watch = 1;
582 netif_tx_wake_all_queues(be->vif->dev);
587 if (be->vif->num_queues > 0)
588 xenvif_disconnect(be->vif); /* Clean up existing queues */
589 vfree(be->vif->queues);
590 be->vif->queues = NULL;
591 be->vif->num_queues = 0;
596 static int connect_rings(struct backend_info *be, struct xenvif_queue *queue)
598 struct xenbus_device *dev = be->dev;
599 unsigned int num_queues = queue->vif->num_queues;
600 unsigned long tx_ring_ref, rx_ring_ref;
601 unsigned int tx_evtchn, rx_evtchn;
605 const size_t xenstore_path_ext_size = 11; /* sufficient for "/queue-NNN" */
607 /* If the frontend requested 1 queue, or we have fallen back
608 * to single queue due to lack of frontend support for multi-
609 * queue, expect the remaining XenStore keys in the toplevel
610 * directory. Otherwise, expect them in a subdirectory called
613 if (num_queues == 1) {
614 xspath = kzalloc(strlen(dev->otherend) + 1, GFP_KERNEL);
616 xenbus_dev_fatal(dev, -ENOMEM,
617 "reading ring references");
620 strcpy(xspath, dev->otherend);
622 xspathsize = strlen(dev->otherend) + xenstore_path_ext_size;
623 xspath = kzalloc(xspathsize, GFP_KERNEL);
625 xenbus_dev_fatal(dev, -ENOMEM,
626 "reading ring references");
629 snprintf(xspath, xspathsize, "%s/queue-%u", dev->otherend,
633 err = xenbus_gather(XBT_NIL, xspath,
634 "tx-ring-ref", "%lu", &tx_ring_ref,
635 "rx-ring-ref", "%lu", &rx_ring_ref, NULL);
637 xenbus_dev_fatal(dev, err,
638 "reading %s/ring-ref",
643 /* Try split event channels first, then single event channel. */
644 err = xenbus_gather(XBT_NIL, xspath,
645 "event-channel-tx", "%u", &tx_evtchn,
646 "event-channel-rx", "%u", &rx_evtchn, NULL);
648 err = xenbus_scanf(XBT_NIL, xspath,
649 "event-channel", "%u", &tx_evtchn);
651 xenbus_dev_fatal(dev, err,
652 "reading %s/event-channel(-tx/rx)",
656 rx_evtchn = tx_evtchn;
659 /* Map the shared frame, irq etc. */
660 err = xenvif_connect(queue, tx_ring_ref, rx_ring_ref,
661 tx_evtchn, rx_evtchn);
663 xenbus_dev_fatal(dev, err,
664 "mapping shared-frames %lu/%lu port tx %u rx %u",
665 tx_ring_ref, rx_ring_ref,
666 tx_evtchn, rx_evtchn);
671 err: /* Regular return falls through with err == 0 */
676 static int read_xenbus_vif_flags(struct backend_info *be)
678 struct xenvif *vif = be->vif;
679 struct xenbus_device *dev = be->dev;
680 unsigned int rx_copy;
683 err = xenbus_scanf(XBT_NIL, dev->otherend, "request-rx-copy", "%u",
685 if (err == -ENOENT) {
690 xenbus_dev_fatal(dev, err, "reading %s/request-rx-copy",
697 if (vif->dev->tx_queue_len != 0) {
698 if (xenbus_scanf(XBT_NIL, dev->otherend,
699 "feature-rx-notify", "%d", &val) < 0)
704 /* Must be non-zero for pfifo_fast to work. */
705 vif->dev->tx_queue_len = 1;
708 if (xenbus_scanf(XBT_NIL, dev->otherend, "feature-sg",
714 vif->gso_prefix_mask = 0;
716 if (xenbus_scanf(XBT_NIL, dev->otherend, "feature-gso-tcpv4",
720 vif->gso_mask |= GSO_BIT(TCPV4);
722 if (xenbus_scanf(XBT_NIL, dev->otherend, "feature-gso-tcpv4-prefix",
726 vif->gso_prefix_mask |= GSO_BIT(TCPV4);
728 if (xenbus_scanf(XBT_NIL, dev->otherend, "feature-gso-tcpv6",
732 vif->gso_mask |= GSO_BIT(TCPV6);
734 if (xenbus_scanf(XBT_NIL, dev->otherend, "feature-gso-tcpv6-prefix",
738 vif->gso_prefix_mask |= GSO_BIT(TCPV6);
740 if (vif->gso_mask & vif->gso_prefix_mask) {
741 xenbus_dev_fatal(dev, err,
742 "%s: gso and gso prefix flags are not "
743 "mutually exclusive",
748 if (xenbus_scanf(XBT_NIL, dev->otherend, "feature-no-csum-offload",
753 if (xenbus_scanf(XBT_NIL, dev->otherend, "feature-ipv6-csum-offload",
756 vif->ipv6_csum = !!val;
762 /* ** Driver Registration ** */
765 static const struct xenbus_device_id netback_ids[] = {
771 static DEFINE_XENBUS_DRIVER(netback, ,
772 .probe = netback_probe,
773 .remove = netback_remove,
774 .uevent = netback_uevent,
775 .otherend_changed = frontend_changed,
778 int xenvif_xenbus_init(void)
780 return xenbus_register_backend(&netback_driver);
783 void xenvif_xenbus_fini(void)
785 return xenbus_unregister_driver(&netback_driver);