drivers/net/xen-netback/xenbus.c

   1 /*
   2  * Xenbus code for netif backend
   3  *
   4  * Copyright (C) 2005 Rusty Russell <rusty@rustcorp.com.au>
   5  * Copyright (C) 2005 XenSource Ltd
   6  *
   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.
  11  *
  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.
  16  *
  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/>.
  19 */
  20
  21 #include "common.h"
  22 #include <linux/vmalloc.h>
  23 #include <linux/rtnetlink.h>
  24
  25 struct backend_info {
  26         struct xenbus_device *dev;
  27         struct xenvif *vif;
  28
  29         /* This is the state that will be reflected in xenstore when any
  30          * active hotplug script completes.
  31          */
  32         enum xenbus_state state;
  33
  34         enum xenbus_state frontend_state;
  35         struct xenbus_watch hotplug_status_watch;
  36         u8 have_hotplug_status_watch:1;
  37
  38         const char *hotplug_script;
  39 };
  40
  41 static int connect_data_rings(struct backend_info *be,
  42                               struct xenvif_queue *queue);
  43 static void connect(struct backend_info *be);
  44 static int read_xenbus_vif_flags(struct backend_info *be);
  45 static int backend_create_xenvif(struct backend_info *be);
  46 static void unregister_hotplug_status_watch(struct backend_info *be);
  47 static void xen_unregister_watchers(struct xenvif *vif);
  48 static void set_backend_state(struct backend_info *be,
  49                               enum xenbus_state state);
  50
  51 #ifdef CONFIG_DEBUG_FS
  52 struct dentry *xen_netback_dbg_root = NULL;
  53
  54 static int xenvif_read_io_ring(struct seq_file *m, void *v)
  55 {
  56         struct xenvif_queue *queue = m->private;
  57         struct xen_netif_tx_back_ring *tx_ring = &queue->tx;
  58         struct xen_netif_rx_back_ring *rx_ring = &queue->rx;
  59         struct netdev_queue *dev_queue;
  60
  61         if (tx_ring->sring) {
  62                 struct xen_netif_tx_sring *sring = tx_ring->sring;
  63
  64                 seq_printf(m, "Queue %d\nTX: nr_ents %u\n", queue->id,
  65                            tx_ring->nr_ents);
  66                 seq_printf(m, "req prod %u (%d) cons %u (%d) event %u (%d)\n",
  67                            sring->req_prod,
  68                            sring->req_prod - sring->rsp_prod,
  69                            tx_ring->req_cons,
  70                            tx_ring->req_cons - sring->rsp_prod,
  71                            sring->req_event,
  72                            sring->req_event - sring->rsp_prod);
  73                 seq_printf(m, "rsp prod %u (base) pvt %u (%d) event %u (%d)\n",
  74                            sring->rsp_prod,
  75                            tx_ring->rsp_prod_pvt,
  76                            tx_ring->rsp_prod_pvt - sring->rsp_prod,
  77                            sring->rsp_event,
  78                            sring->rsp_event - sring->rsp_prod);
  79                 seq_printf(m, "pending prod %u pending cons %u nr_pending_reqs %u\n",
  80                            queue->pending_prod,
  81                            queue->pending_cons,
  82                            nr_pending_reqs(queue));
  83                 seq_printf(m, "dealloc prod %u dealloc cons %u dealloc_queue %u\n\n",
  84                            queue->dealloc_prod,
  85                            queue->dealloc_cons,
  86                            queue->dealloc_prod - queue->dealloc_cons);
  87         }
  88
  89         if (rx_ring->sring) {
  90                 struct xen_netif_rx_sring *sring = rx_ring->sring;
  91
  92                 seq_printf(m, "RX: nr_ents %u\n", rx_ring->nr_ents);
  93                 seq_printf(m, "req prod %u (%d) cons %u (%d) event %u (%d)\n",
  94                            sring->req_prod,
  95                            sring->req_prod - sring->rsp_prod,
  96                            rx_ring->req_cons,
  97                            rx_ring->req_cons - sring->rsp_prod,
  98                            sring->req_event,
  99                            sring->req_event - sring->rsp_prod);
 100                 seq_printf(m, "rsp prod %u (base) pvt %u (%d) event %u (%d)\n\n",
 101                            sring->rsp_prod,
 102                            rx_ring->rsp_prod_pvt,
 103                            rx_ring->rsp_prod_pvt - sring->rsp_prod,
 104                            sring->rsp_event,
 105                            sring->rsp_event - sring->rsp_prod);
 106         }
 107
 108         seq_printf(m, "NAPI state: %lx NAPI weight: %d TX queue len %u\n"
 109                    "Credit timer_pending: %d, credit: %lu, usec: %lu\n"
 110                    "remaining: %lu, expires: %lu, now: %lu\n",
 111                    queue->napi.state, queue->napi.weight,
 112                    skb_queue_len(&queue->tx_queue),
 113                    timer_pending(&queue->credit_timeout),
 114                    queue->credit_bytes,
 115                    queue->credit_usec,
 116                    queue->remaining_credit,
 117                    queue->credit_timeout.expires,
 118                    jiffies);
 119
 120         dev_queue = netdev_get_tx_queue(queue->vif->dev, queue->id);
 121
 122         seq_printf(m, "\nRx internal queue: len %u max %u pkts %u %s\n",
 123                    queue->rx_queue_len, queue->rx_queue_max,
 124                    skb_queue_len(&queue->rx_queue),
 125                    netif_tx_queue_stopped(dev_queue) ? "stopped" : "running");
 126
 127         return 0;
 128 }
 129
 130 #define XENVIF_KICK_STR "kick"
 131 #define BUFFER_SIZE     32
 132
 133 static ssize_t
 134 xenvif_write_io_ring(struct file *filp, const char __user *buf, size_t count,
 135                      loff_t *ppos)
 136 {
 137         struct xenvif_queue *queue =
 138                 ((struct seq_file *)filp->private_data)->private;
 139         int len;
 140         char write[BUFFER_SIZE];
 141
 142         /* don't allow partial writes and check the length */
 143         if (*ppos != 0)
 144                 return 0;
 145         if (count >= sizeof(write))
 146                 return -ENOSPC;
 147
 148         len = simple_write_to_buffer(write,
 149                                      sizeof(write) - 1,
 150                                      ppos,
 151                                      buf,
 152                                      count);
 153         if (len < 0)
 154                 return len;
 155
 156         write[len] = '\0';
 157
 158         if (!strncmp(write, XENVIF_KICK_STR, sizeof(XENVIF_KICK_STR) - 1))
 159                 xenvif_interrupt(0, (void *)queue);
 160         else {
 161                 pr_warn("Unknown command to io_ring_q%d. Available: kick\n",
 162                         queue->id);
 163                 count = -EINVAL;
 164         }
 165         return count;
 166 }
 167
 168 static int xenvif_io_ring_open(struct inode *inode, struct file *filp)
 169 {
 170         int ret;
 171         void *queue = NULL;
 172
 173         if (inode->i_private)
 174                 queue = inode->i_private;
 175         ret = single_open(filp, xenvif_read_io_ring, queue);
 176         filp->f_mode |= FMODE_PWRITE;
 177         return ret;
 178 }
 179
 180 static const struct file_operations xenvif_dbg_io_ring_ops_fops = {
 181         .owner = THIS_MODULE,
 182         .open = xenvif_io_ring_open,
 183         .read = seq_read,
 184         .llseek = seq_lseek,
 185         .release = single_release,
 186         .write = xenvif_write_io_ring,
 187 };
 188
 189 static int xenvif_read_ctrl(struct seq_file *m, void *v)
 190 {
 191         struct xenvif *vif = m->private;
 192
 193         xenvif_dump_hash_info(vif, m);
 194
 195         return 0;
 196 }
 197
 198 static int xenvif_ctrl_open(struct inode *inode, struct file *filp)
 199 {
 200         return single_open(filp, xenvif_read_ctrl, inode->i_private);
 201 }
 202
 203 static const struct file_operations xenvif_dbg_ctrl_ops_fops = {
 204         .owner = THIS_MODULE,
 205         .open = xenvif_ctrl_open,
 206         .read = seq_read,
 207         .llseek = seq_lseek,
 208         .release = single_release,
 209 };
 210
 211 static void xenvif_debugfs_addif(struct xenvif *vif)
 212 {
 213         struct dentry *pfile;
 214         int i;
 215
 216         if (IS_ERR_OR_NULL(xen_netback_dbg_root))
 217                 return;
 218
 219         vif->xenvif_dbg_root = debugfs_create_dir(vif->dev->name,
 220                                                   xen_netback_dbg_root);
 221         if (!IS_ERR_OR_NULL(vif->xenvif_dbg_root)) {
 222                 for (i = 0; i < vif->num_queues; ++i) {
 223                         char filename[sizeof("io_ring_q") + 4];
 224
 225                         snprintf(filename, sizeof(filename), "io_ring_q%d", i);
 226                         pfile = debugfs_create_file(filename,
 227                                                     0600,
 228                                                     vif->xenvif_dbg_root,
 229                                                     &vif->queues[i],
 230                                                     &xenvif_dbg_io_ring_ops_fops);
 231                         if (IS_ERR_OR_NULL(pfile))
 232                                 pr_warn("Creation of io_ring file returned %ld!\n",
 233                                         PTR_ERR(pfile));
 234                 }
 235
 236                 if (vif->ctrl_irq) {
 237                         pfile = debugfs_create_file("ctrl",
 238                                                     0400,
 239                                                     vif->xenvif_dbg_root,
 240                                                     vif,
 241                                                     &xenvif_dbg_ctrl_ops_fops);
 242                         if (IS_ERR_OR_NULL(pfile))
 243                                 pr_warn("Creation of ctrl file returned %ld!\n",
 244                                         PTR_ERR(pfile));
 245                 }
 246         } else
 247                 netdev_warn(vif->dev,
 248                             "Creation of vif debugfs dir returned %ld!\n",
 249                             PTR_ERR(vif->xenvif_dbg_root));
 250 }
 251
 252 static void xenvif_debugfs_delif(struct xenvif *vif)
 253 {
 254         if (IS_ERR_OR_NULL(xen_netback_dbg_root))
 255                 return;
 256
 257         if (!IS_ERR_OR_NULL(vif->xenvif_dbg_root))
 258                 debugfs_remove_recursive(vif->xenvif_dbg_root);
 259         vif->xenvif_dbg_root = NULL;
 260 }
 261 #endif /* CONFIG_DEBUG_FS */
 262
 263 static int netback_remove(struct xenbus_device *dev)
 264 {
 265         struct backend_info *be = dev_get_drvdata(&dev->dev);
 266
 267         set_backend_state(be, XenbusStateClosed);
 268
 269         unregister_hotplug_status_watch(be);
 270         if (be->vif) {
 271                 kobject_uevent(&dev->dev.kobj, KOBJ_OFFLINE);
 272                 xen_unregister_watchers(be->vif);
 273                 xenbus_rm(XBT_NIL, dev->nodename, "hotplug-status");
 274                 xenvif_free(be->vif);
 275                 be->vif = NULL;
 276         }
 277         kfree(be->hotplug_script);
 278         kfree(be);
 279         dev_set_drvdata(&dev->dev, NULL);
 280         return 0;
 281 }
 282
 283
 284 /**
 285  * Entry point to this code when a new device is created.  Allocate the basic
 286  * structures and switch to InitWait.
 287  */
 288 static int netback_probe(struct xenbus_device *dev,
 289                          const struct xenbus_device_id *id)
 290 {
 291         const char *message;
 292         struct xenbus_transaction xbt;
 293         int err;
 294         int sg;
 295         const char *script;
 296         struct backend_info *be = kzalloc(sizeof(struct backend_info),
 297                                           GFP_KERNEL);
 298         if (!be) {
 299                 xenbus_dev_fatal(dev, -ENOMEM,
 300                                  "allocating backend structure");
 301                 return -ENOMEM;
 302         }
 303
 304         be->dev = dev;
 305         dev_set_drvdata(&dev->dev, be);
 306
 307         be->state = XenbusStateInitialising;
 308         err = xenbus_switch_state(dev, XenbusStateInitialising);
 309         if (err)
 310                 goto fail;
 311
 312         sg = 1;
 313
 314         do {
 315                 err = xenbus_transaction_start(&xbt);
 316                 if (err) {
 317                         xenbus_dev_fatal(dev, err, "starting transaction");
 318                         goto fail;
 319                 }
 320
 321                 err = xenbus_printf(xbt, dev->nodename, "feature-sg", "%d", sg);
 322                 if (err) {
 323                         message = "writing feature-sg";
 324                         goto abort_transaction;
 325                 }
 326
 327                 err = xenbus_printf(xbt, dev->nodename, "feature-gso-tcpv4",
 328                                     "%d", sg);
 329                 if (err) {
 330                         message = "writing feature-gso-tcpv4";
 331                         goto abort_transaction;
 332                 }
 333
 334                 err = xenbus_printf(xbt, dev->nodename, "feature-gso-tcpv6",
 335                                     "%d", sg);
 336                 if (err) {
 337                         message = "writing feature-gso-tcpv6";
 338                         goto abort_transaction;
 339                 }
 340
 341                 /* We support partial checksum setup for IPv6 packets */
 342                 err = xenbus_printf(xbt, dev->nodename,
 343                                     "feature-ipv6-csum-offload",
 344                                     "%d", 1);
 345                 if (err) {
 346                         message = "writing feature-ipv6-csum-offload";
 347                         goto abort_transaction;
 348                 }
 349
 350                 /* We support rx-copy path. */
 351                 err = xenbus_printf(xbt, dev->nodename,
 352                                     "feature-rx-copy", "%d", 1);
 353                 if (err) {
 354                         message = "writing feature-rx-copy";
 355                         goto abort_transaction;
 356                 }
 357
 358                 /*
 359                  * We don't support rx-flip path (except old guests who don't
 360                  * grok this feature flag).
 361                  */
 362                 err = xenbus_printf(xbt, dev->nodename,
 363                                     "feature-rx-flip", "%d", 0);
 364                 if (err) {
 365                         message = "writing feature-rx-flip";
 366                         goto abort_transaction;
 367                 }
 368
 369                 /* We support dynamic multicast-control. */
 370                 err = xenbus_printf(xbt, dev->nodename,
 371                                     "feature-multicast-control", "%d", 1);
 372                 if (err) {
 373                         message = "writing feature-multicast-control";
 374                         goto abort_transaction;
 375                 }
 376
 377                 err = xenbus_printf(xbt, dev->nodename,
 378                                     "feature-dynamic-multicast-control",
 379                                     "%d", 1);
 380                 if (err) {
 381                         message = "writing feature-dynamic-multicast-control";
 382                         goto abort_transaction;
 383                 }
 384
 385                 err = xenbus_transaction_end(xbt, 0);
 386         } while (err == -EAGAIN);
 387
 388         if (err) {
 389                 xenbus_dev_fatal(dev, err, "completing transaction");
 390                 goto fail;
 391         }
 392
 393         /*
 394          * Split event channels support, this is optional so it is not
 395          * put inside the above loop.
 396          */
 397         err = xenbus_printf(XBT_NIL, dev->nodename,
 398                             "feature-split-event-channels",
 399                             "%u", separate_tx_rx_irq);
 400         if (err)
 401                 pr_debug("Error writing feature-split-event-channels\n");
 402
 403         /* Multi-queue support: This is an optional feature. */
 404         err = xenbus_printf(XBT_NIL, dev->nodename,
 405                             "multi-queue-max-queues", "%u", xenvif_max_queues);
 406         if (err)
 407                 pr_debug("Error writing multi-queue-max-queues\n");
 408
 409         err = xenbus_printf(XBT_NIL, dev->nodename,
 410                             "feature-ctrl-ring",
 411                             "%u", true);
 412         if (err)
 413                 pr_debug("Error writing feature-ctrl-ring\n");
 414
 415         script = xenbus_read(XBT_NIL, dev->nodename, "script", NULL);
 416         if (IS_ERR(script)) {
 417                 err = PTR_ERR(script);
 418                 xenbus_dev_fatal(dev, err, "reading script");
 419                 goto fail;
 420         }
 421
 422         be->hotplug_script = script;
 423
 424
 425         /* This kicks hotplug scripts, so do it immediately. */
 426         err = backend_create_xenvif(be);
 427         if (err)
 428                 goto fail;
 429
 430         return 0;
 431
 432 abort_transaction:
 433         xenbus_transaction_end(xbt, 1);
 434         xenbus_dev_fatal(dev, err, "%s", message);
 435 fail:
 436         pr_debug("failed\n");
 437         netback_remove(dev);
 438         return err;
 439 }
 440
 441
 442 /*
 443  * Handle the creation of the hotplug script environment.  We add the script
 444  * and vif variables to the environment, for the benefit of the vif-* hotplug
 445  * scripts.
 446  */
 447 static int netback_uevent(struct xenbus_device *xdev,
 448                           struct kobj_uevent_env *env)
 449 {
 450         struct backend_info *be = dev_get_drvdata(&xdev->dev);
 451
 452         if (!be)
 453                 return 0;
 454
 455         if (add_uevent_var(env, "script=%s", be->hotplug_script))
 456                 return -ENOMEM;
 457
 458         if (!be->vif)
 459                 return 0;
 460
 461         return add_uevent_var(env, "vif=%s", be->vif->dev->name);
 462 }
 463
 464
 465 static int backend_create_xenvif(struct backend_info *be)
 466 {
 467         int err;
 468         long handle;
 469         struct xenbus_device *dev = be->dev;
 470         struct xenvif *vif;
 471
 472         if (be->vif != NULL)
 473                 return 0;
 474
 475         err = xenbus_scanf(XBT_NIL, dev->nodename, "handle", "%li", &handle);
 476         if (err != 1) {
 477                 xenbus_dev_fatal(dev, err, "reading handle");
 478                 return (err < 0) ? err : -EINVAL;
 479         }
 480
 481         vif = xenvif_alloc(&dev->dev, dev->otherend_id, handle);
 482         if (IS_ERR(vif)) {
 483                 err = PTR_ERR(vif);
 484                 xenbus_dev_fatal(dev, err, "creating interface");
 485                 return err;
 486         }
 487         be->vif = vif;
 488
 489         kobject_uevent(&dev->dev.kobj, KOBJ_ONLINE);
 490         return 0;
 491 }
 492
 493 static void backend_disconnect(struct backend_info *be)
 494 {
 495         struct xenvif *vif = be->vif;
 496
 497         if (vif) {
 498                 unsigned int num_queues = vif->num_queues;
 499                 unsigned int queue_index;
 500
 501                 xen_unregister_watchers(vif);
 502                 xenbus_rm(XBT_NIL, be->dev->nodename, "hotplug-status");
 503 #ifdef CONFIG_DEBUG_FS
 504                 xenvif_debugfs_delif(vif);
 505 #endif /* CONFIG_DEBUG_FS */
 506                 xenvif_disconnect_data(vif);
 507
 508                 /* At this point some of the handlers may still be active
 509                  * so we need to have additional synchronization here.
 510                  */
 511                 vif->num_queues = 0;
 512                 synchronize_net();
 513
 514                 for (queue_index = 0; queue_index < num_queues; ++queue_index)
 515                         xenvif_deinit_queue(&vif->queues[queue_index]);
 516
 517                 vfree(vif->queues);
 518                 vif->queues = NULL;
 519
 520                 xenvif_disconnect_ctrl(vif);
 521         }
 522 }
 523
 524 static void backend_connect(struct backend_info *be)
 525 {
 526         if (be->vif)
 527                 connect(be);
 528 }
 529
 530 static inline void backend_switch_state(struct backend_info *be,
 531                                         enum xenbus_state state)
 532 {
 533         struct xenbus_device *dev = be->dev;
 534
 535         pr_debug("%s -> %s\n", dev->nodename, xenbus_strstate(state));
 536         be->state = state;
 537
 538         /* If we are waiting for a hotplug script then defer the
 539          * actual xenbus state change.
 540          */
 541         if (!be->have_hotplug_status_watch)
 542                 xenbus_switch_state(dev, state);
 543 }
 544
 545 /* Handle backend state transitions:
 546  *
 547  * The backend state starts in Initialising and the following transitions are
 548  * allowed.
 549  *
 550  * Initialising -> InitWait -> Connected
 551  *          \
 552  *           \        ^    \         |
 553  *            \       |     \        |
 554  *             \      |      \       |
 555  *              \     |       \      |
 556  *               \    |        \     |
 557  *                \   |         \    |
 558  *                 V  |          V   V
 559  *
 560  *                  Closed  <-> Closing
 561  *
 562  * The state argument specifies the eventual state of the backend and the
 563  * function transitions to that state via the shortest path.
 564  */
 565 static void set_backend_state(struct backend_info *be,
 566                               enum xenbus_state state)
 567 {
 568         while (be->state != state) {
 569                 switch (be->state) {
 570                 case XenbusStateInitialising:
 571                         switch (state) {
 572                         case XenbusStateInitWait:
 573                         case XenbusStateConnected:
 574                         case XenbusStateClosing:
 575                                 backend_switch_state(be, XenbusStateInitWait);
 576                                 break;
 577                         case XenbusStateClosed:
 578                                 backend_switch_state(be, XenbusStateClosed);
 579                                 break;
 580                         default:
 581                                 BUG();
 582                         }
 583                         break;
 584                 case XenbusStateClosed:
 585                         switch (state) {
 586                         case XenbusStateInitWait:
 587                         case XenbusStateConnected:
 588                                 backend_switch_state(be, XenbusStateInitWait);
 589                                 break;
 590                         case XenbusStateClosing:
 591                                 backend_switch_state(be, XenbusStateClosing);
 592                                 break;
 593                         default:
 594                                 BUG();
 595                         }
 596                         break;
 597                 case XenbusStateInitWait:
 598                         switch (state) {
 599                         case XenbusStateConnected:
 600                                 backend_connect(be);
 601                                 backend_switch_state(be, XenbusStateConnected);
 602                                 break;
 603                         case XenbusStateClosing:
 604                         case XenbusStateClosed:
 605                                 backend_switch_state(be, XenbusStateClosing);
 606                                 break;
 607                         default:
 608                                 BUG();
 609                         }
 610                         break;
 611                 case XenbusStateConnected:
 612                         switch (state) {
 613                         case XenbusStateInitWait:
 614                         case XenbusStateClosing:
 615                         case XenbusStateClosed:
 616                                 backend_disconnect(be);
 617                                 backend_switch_state(be, XenbusStateClosing);
 618                                 break;
 619                         default:
 620                                 BUG();
 621                         }
 622                         break;
 623                 case XenbusStateClosing:
 624                         switch (state) {
 625                         case XenbusStateInitWait:
 626                         case XenbusStateConnected:
 627                         case XenbusStateClosed:
 628                                 backend_switch_state(be, XenbusStateClosed);
 629                                 break;
 630                         default:
 631                                 BUG();
 632                         }
 633                         break;
 634                 default:
 635                         BUG();
 636                 }
 637         }
 638 }
 639
 640 /**
 641  * Callback received when the frontend's state changes.
 642  */
 643 static void frontend_changed(struct xenbus_device *dev,
 644                              enum xenbus_state frontend_state)
 645 {
 646         struct backend_info *be = dev_get_drvdata(&dev->dev);
 647
 648         pr_debug("%s -> %s\n", dev->otherend, xenbus_strstate(frontend_state));
 649
 650         be->frontend_state = frontend_state;
 651
 652         switch (frontend_state) {
 653         case XenbusStateInitialising:
 654                 set_backend_state(be, XenbusStateInitWait);
 655                 break;
 656
 657         case XenbusStateInitialised:
 658                 break;
 659
 660         case XenbusStateConnected:
 661                 set_backend_state(be, XenbusStateConnected);
 662                 break;
 663
 664         case XenbusStateClosing:
 665                 set_backend_state(be, XenbusStateClosing);
 666                 break;
 667
 668         case XenbusStateClosed:
 669                 set_backend_state(be, XenbusStateClosed);
 670                 if (xenbus_dev_is_online(dev))
 671                         break;
 672                 /* fall through if not online */
 673         case XenbusStateUnknown:
 674                 set_backend_state(be, XenbusStateClosed);
 675                 device_unregister(&dev->dev);
 676                 break;
 677
 678         default:
 679                 xenbus_dev_fatal(dev, -EINVAL, "saw state %d at frontend",
 680                                  frontend_state);
 681                 break;
 682         }
 683 }
 684
 685
 686 static void xen_net_read_rate(struct xenbus_device *dev,
 687                               unsigned long *bytes, unsigned long *usec)
 688 {
 689         char *s, *e;
 690         unsigned long b, u;
 691         char *ratestr;
 692
 693         /* Default to unlimited bandwidth. */
 694         *bytes = ~0UL;
 695         *usec = 0;
 696
 697         ratestr = xenbus_read(XBT_NIL, dev->nodename, "rate", NULL);
 698         if (IS_ERR(ratestr))
 699                 return;
 700
 701         s = ratestr;
 702         b = simple_strtoul(s, &e, 10);
 703         if ((s == e) || (*e != ','))
 704                 goto fail;
 705
 706         s = e + 1;
 707         u = simple_strtoul(s, &e, 10);
 708         if ((s == e) || (*e != '\0'))
 709                 goto fail;
 710
 711         *bytes = b;
 712         *usec = u;
 713
 714         kfree(ratestr);
 715         return;
 716
 717  fail:
 718         pr_warn("Failed to parse network rate limit. Traffic unlimited.\n");
 719         kfree(ratestr);
 720 }
 721
 722 static int xen_net_read_mac(struct xenbus_device *dev, u8 mac[])
 723 {
 724         char *s, *e, *macstr;
 725         int i;
 726
 727         macstr = s = xenbus_read(XBT_NIL, dev->nodename, "mac", NULL);
 728         if (IS_ERR(macstr))
 729                 return PTR_ERR(macstr);
 730
 731         for (i = 0; i < ETH_ALEN; i++) {
 732                 mac[i] = simple_strtoul(s, &e, 16);
 733                 if ((s == e) || (*e != ((i == ETH_ALEN-1) ? '\0' : ':'))) {
 734                         kfree(macstr);
 735                         return -ENOENT;
 736                 }
 737                 s = e+1;
 738         }
 739
 740         kfree(macstr);
 741         return 0;
 742 }
 743
 744 static void xen_net_rate_changed(struct xenbus_watch *watch,
 745                                  const char *path, const char *token)
 746 {
 747         struct xenvif *vif = container_of(watch, struct xenvif, credit_watch);
 748         struct xenbus_device *dev = xenvif_to_xenbus_device(vif);
 749         unsigned long   credit_bytes;
 750         unsigned long   credit_usec;
 751         unsigned int queue_index;
 752
 753         xen_net_read_rate(dev, &credit_bytes, &credit_usec);
 754         for (queue_index = 0; queue_index < vif->num_queues; queue_index++) {
 755                 struct xenvif_queue *queue = &vif->queues[queue_index];
 756
 757                 queue->credit_bytes = credit_bytes;
 758                 queue->credit_usec = credit_usec;
 759                 if (!mod_timer_pending(&queue->credit_timeout, jiffies) &&
 760                         queue->remaining_credit > queue->credit_bytes) {
 761                         queue->remaining_credit = queue->credit_bytes;
 762                 }
 763         }
 764 }
 765
 766 static int xen_register_credit_watch(struct xenbus_device *dev,
 767                                      struct xenvif *vif)
 768 {
 769         int err = 0;
 770         char *node;
 771         unsigned maxlen = strlen(dev->nodename) + sizeof("/rate");
 772
 773         if (vif->credit_watch.node)
 774                 return -EADDRINUSE;
 775
 776         node = kmalloc(maxlen, GFP_KERNEL);
 777         if (!node)
 778                 return -ENOMEM;
 779         snprintf(node, maxlen, "%s/rate", dev->nodename);
 780         vif->credit_watch.node = node;
 781         vif->credit_watch.will_handle = NULL;
 782         vif->credit_watch.callback = xen_net_rate_changed;
 783         err = register_xenbus_watch(&vif->credit_watch);
 784         if (err) {
 785                 pr_err("Failed to set watcher %s\n", vif->credit_watch.node);
 786                 kfree(node);
 787                 vif->credit_watch.node = NULL;
 788                 vif->credit_watch.will_handle = NULL;
 789                 vif->credit_watch.callback = NULL;
 790         }
 791         return err;
 792 }
 793
 794 static void xen_unregister_credit_watch(struct xenvif *vif)
 795 {
 796         if (vif->credit_watch.node) {
 797                 unregister_xenbus_watch(&vif->credit_watch);
 798                 kfree(vif->credit_watch.node);
 799                 vif->credit_watch.node = NULL;
 800         }
 801 }
 802
 803 static void xen_mcast_ctrl_changed(struct xenbus_watch *watch,
 804                                    const char *path, const char *token)
 805 {
 806         struct xenvif *vif = container_of(watch, struct xenvif,
 807                                           mcast_ctrl_watch);
 808         struct xenbus_device *dev = xenvif_to_xenbus_device(vif);
 809
 810         vif->multicast_control = !!xenbus_read_unsigned(dev->otherend,
 811                                         "request-multicast-control", 0);
 812 }
 813
 814 static int xen_register_mcast_ctrl_watch(struct xenbus_device *dev,
 815                                          struct xenvif *vif)
 816 {
 817         int err = 0;
 818         char *node;
 819         unsigned maxlen = strlen(dev->otherend) +
 820                 sizeof("/request-multicast-control");
 821
 822         if (vif->mcast_ctrl_watch.node) {
 823                 pr_err_ratelimited("Watch is already registered\n");
 824                 return -EADDRINUSE;
 825         }
 826
 827         node = kmalloc(maxlen, GFP_KERNEL);
 828         if (!node) {
 829                 pr_err("Failed to allocate memory for watch\n");
 830                 return -ENOMEM;
 831         }
 832         snprintf(node, maxlen, "%s/request-multicast-control",
 833                  dev->otherend);
 834         vif->mcast_ctrl_watch.node = node;
 835         vif->mcast_ctrl_watch.will_handle = NULL;
 836         vif->mcast_ctrl_watch.callback = xen_mcast_ctrl_changed;
 837         err = register_xenbus_watch(&vif->mcast_ctrl_watch);
 838         if (err) {
 839                 pr_err("Failed to set watcher %s\n",
 840                        vif->mcast_ctrl_watch.node);
 841                 kfree(node);
 842                 vif->mcast_ctrl_watch.node = NULL;
 843                 vif->mcast_ctrl_watch.will_handle = NULL;
 844                 vif->mcast_ctrl_watch.callback = NULL;
 845         }
 846         return err;
 847 }
 848
 849 static void xen_unregister_mcast_ctrl_watch(struct xenvif *vif)
 850 {
 851         if (vif->mcast_ctrl_watch.node) {
 852                 unregister_xenbus_watch(&vif->mcast_ctrl_watch);
 853                 kfree(vif->mcast_ctrl_watch.node);
 854                 vif->mcast_ctrl_watch.node = NULL;
 855         }
 856 }
 857
 858 static void xen_register_watchers(struct xenbus_device *dev,
 859                                   struct xenvif *vif)
 860 {
 861         xen_register_credit_watch(dev, vif);
 862         xen_register_mcast_ctrl_watch(dev, vif);
 863 }
 864
 865 static void xen_unregister_watchers(struct xenvif *vif)
 866 {
 867         xen_unregister_mcast_ctrl_watch(vif);
 868         xen_unregister_credit_watch(vif);
 869 }
 870
 871 static void unregister_hotplug_status_watch(struct backend_info *be)
 872 {
 873         if (be->have_hotplug_status_watch) {
 874                 unregister_xenbus_watch(&be->hotplug_status_watch);
 875                 kfree(be->hotplug_status_watch.node);
 876         }
 877         be->have_hotplug_status_watch = 0;
 878 }
 879
 880 static void hotplug_status_changed(struct xenbus_watch *watch,
 881                                    const char *path,
 882                                    const char *token)
 883 {
 884         struct backend_info *be = container_of(watch,
 885                                                struct backend_info,
 886                                                hotplug_status_watch);
 887         char *str;
 888         unsigned int len;
 889
 890         str = xenbus_read(XBT_NIL, be->dev->nodename, "hotplug-status", &len);
 891         if (IS_ERR(str))
 892                 return;
 893         if (len == sizeof("connected")-1 && !memcmp(str, "connected", len)) {
 894                 /* Complete any pending state change */
 895                 xenbus_switch_state(be->dev, be->state);
 896
 897                 /* Not interested in this watch anymore. */
 898                 unregister_hotplug_status_watch(be);
 899         }
 900         kfree(str);
 901 }
 902
 903 static int connect_ctrl_ring(struct backend_info *be)
 904 {
 905         struct xenbus_device *dev = be->dev;
 906         struct xenvif *vif = be->vif;
 907         unsigned int val;
 908         grant_ref_t ring_ref;
 909         unsigned int evtchn;
 910         int err;
 911
 912         err = xenbus_scanf(XBT_NIL, dev->otherend,
 913                            "ctrl-ring-ref", "%u", &val);
 914         if (err < 0)
 915                 goto done; /* The frontend does not have a control ring */
 916
 917         ring_ref = val;
 918
 919         err = xenbus_scanf(XBT_NIL, dev->otherend,
 920                            "event-channel-ctrl", "%u", &val);
 921         if (err < 0) {
 922                 xenbus_dev_fatal(dev, err,
 923                                  "reading %s/event-channel-ctrl",
 924                                  dev->otherend);
 925                 goto fail;
 926         }
 927
 928         evtchn = val;
 929
 930         err = xenvif_connect_ctrl(vif, ring_ref, evtchn);
 931         if (err) {
 932                 xenbus_dev_fatal(dev, err,
 933                                  "mapping shared-frame %u port %u",
 934                                  ring_ref, evtchn);
 935                 goto fail;
 936         }
 937
 938 done:
 939         return 0;
 940
 941 fail:
 942         return err;
 943 }
 944
 945 static void connect(struct backend_info *be)
 946 {
 947         int err;
 948         struct xenbus_device *dev = be->dev;
 949         unsigned long credit_bytes, credit_usec;
 950         unsigned int queue_index;
 951         unsigned int requested_num_queues;
 952         struct xenvif_queue *queue;
 953
 954         /* Check whether the frontend requested multiple queues
 955          * and read the number requested.
 956          */
 957         requested_num_queues = xenbus_read_unsigned(dev->otherend,
 958                                         "multi-queue-num-queues", 1);
 959         if (requested_num_queues > xenvif_max_queues) {
 960                 /* buggy or malicious guest */
 961                 xenbus_dev_fatal(dev, -EINVAL,
 962                                  "guest requested %u queues, exceeding the maximum of %u.",
 963                                  requested_num_queues, xenvif_max_queues);
 964                 return;
 965         }
 966
 967         err = xen_net_read_mac(dev, be->vif->fe_dev_addr);
 968         if (err) {
 969                 xenbus_dev_fatal(dev, err, "parsing %s/mac", dev->nodename);
 970                 return;
 971         }
 972
 973         xen_net_read_rate(dev, &credit_bytes, &credit_usec);
 974         xen_unregister_watchers(be->vif);
 975         xen_register_watchers(dev, be->vif);
 976         read_xenbus_vif_flags(be);
 977
 978         err = connect_ctrl_ring(be);
 979         if (err) {
 980                 xenbus_dev_fatal(dev, err, "connecting control ring");
 981                 return;
 982         }
 983
 984         /* Use the number of queues requested by the frontend */
 985         be->vif->queues = vzalloc(array_size(requested_num_queues,
 986                                              sizeof(struct xenvif_queue)));
 987         if (!be->vif->queues) {
 988                 xenbus_dev_fatal(dev, -ENOMEM,
 989                                  "allocating queues");
 990                 return;
 991         }
 992
 993         be->vif->num_queues = requested_num_queues;
 994         be->vif->stalled_queues = requested_num_queues;
 995
 996         for (queue_index = 0; queue_index < requested_num_queues; ++queue_index) {
 997                 queue = &be->vif->queues[queue_index];
 998                 queue->vif = be->vif;
 999                 queue->id = queue_index;
1000                 snprintf(queue->name, sizeof(queue->name), "%s-q%u",
1001                                 be->vif->dev->name, queue->id);
1002
1003                 err = xenvif_init_queue(queue);
1004                 if (err) {
1005                         /* xenvif_init_queue() cleans up after itself on
1006                          * failure, but we need to clean up any previously
1007                          * initialised queues. Set num_queues to i so that
1008                          * earlier queues can be destroyed using the regular
1009                          * disconnect logic.
1010                          */
1011                         be->vif->num_queues = queue_index;
1012                         goto err;
1013                 }
1014
1015                 queue->credit_bytes = credit_bytes;
1016                 queue->remaining_credit = credit_bytes;
1017                 queue->credit_usec = credit_usec;
1018
1019                 err = connect_data_rings(be, queue);
1020                 if (err) {
1021                         /* connect_data_rings() cleans up after itself on
1022                          * failure, but we need to clean up after
1023                          * xenvif_init_queue() here, and also clean up any
1024                          * previously initialised queues.
1025                          */
1026                         xenvif_deinit_queue(queue);
1027                         be->vif->num_queues = queue_index;
1028                         goto err;
1029                 }
1030         }
1031
1032 #ifdef CONFIG_DEBUG_FS
1033         xenvif_debugfs_addif(be->vif);
1034 #endif /* CONFIG_DEBUG_FS */
1035
1036         /* Initialisation completed, tell core driver the number of
1037          * active queues.
1038          */
1039         rtnl_lock();
1040         netif_set_real_num_tx_queues(be->vif->dev, requested_num_queues);
1041         netif_set_real_num_rx_queues(be->vif->dev, requested_num_queues);
1042         rtnl_unlock();
1043
1044         xenvif_carrier_on(be->vif);
1045
1046         unregister_hotplug_status_watch(be);
1047         err = xenbus_watch_pathfmt(dev, &be->hotplug_status_watch, NULL,
1048                                    hotplug_status_changed,
1049                                    "%s/%s", dev->nodename, "hotplug-status");
1050         if (!err)
1051                 be->have_hotplug_status_watch = 1;
1052
1053         netif_tx_wake_all_queues(be->vif->dev);
1054
1055         return;
1056
1057 err:
1058         if (be->vif->num_queues > 0)
1059                 xenvif_disconnect_data(be->vif); /* Clean up existing queues */
1060         for (queue_index = 0; queue_index < be->vif->num_queues; ++queue_index)
1061                 xenvif_deinit_queue(&be->vif->queues[queue_index]);
1062         vfree(be->vif->queues);
1063         be->vif->queues = NULL;
1064         be->vif->num_queues = 0;
1065         xenvif_disconnect_ctrl(be->vif);
1066         return;
1067 }
1068
1069
1070 static int connect_data_rings(struct backend_info *be,
1071                               struct xenvif_queue *queue)
1072 {
1073         struct xenbus_device *dev = be->dev;
1074         unsigned int num_queues = queue->vif->num_queues;
1075         unsigned long tx_ring_ref, rx_ring_ref;
1076         unsigned int tx_evtchn, rx_evtchn;
1077         int err;
1078         char *xspath;
1079         size_t xspathsize;
1080         const size_t xenstore_path_ext_size = 11; /* sufficient for "/queue-NNN" */
1081
1082         /* If the frontend requested 1 queue, or we have fallen back
1083          * to single queue due to lack of frontend support for multi-
1084          * queue, expect the remaining XenStore keys in the toplevel
1085          * directory. Otherwise, expect them in a subdirectory called
1086          * queue-N.
1087          */
1088         if (num_queues == 1) {
1089                 xspath = kzalloc(strlen(dev->otherend) + 1, GFP_KERNEL);
1090                 if (!xspath) {
1091                         xenbus_dev_fatal(dev, -ENOMEM,
1092                                          "reading ring references");
1093                         return -ENOMEM;
1094                 }
1095                 strcpy(xspath, dev->otherend);
1096         } else {
1097                 xspathsize = strlen(dev->otherend) + xenstore_path_ext_size;
1098                 xspath = kzalloc(xspathsize, GFP_KERNEL);
1099                 if (!xspath) {
1100                         xenbus_dev_fatal(dev, -ENOMEM,
1101                                          "reading ring references");
1102                         return -ENOMEM;
1103                 }
1104                 snprintf(xspath, xspathsize, "%s/queue-%u", dev->otherend,
1105                          queue->id);
1106         }
1107
1108         err = xenbus_gather(XBT_NIL, xspath,
1109                             "tx-ring-ref", "%lu", &tx_ring_ref,
1110                             "rx-ring-ref", "%lu", &rx_ring_ref, NULL);
1111         if (err) {
1112                 xenbus_dev_fatal(dev, err,
1113                                  "reading %s/ring-ref",
1114                                  xspath);
1115                 goto err;
1116         }
1117
1118         /* Try split event channels first, then single event channel. */
1119         err = xenbus_gather(XBT_NIL, xspath,
1120                             "event-channel-tx", "%u", &tx_evtchn,
1121                             "event-channel-rx", "%u", &rx_evtchn, NULL);
1122         if (err < 0) {
1123                 err = xenbus_scanf(XBT_NIL, xspath,
1124                                    "event-channel", "%u", &tx_evtchn);
1125                 if (err < 0) {
1126                         xenbus_dev_fatal(dev, err,
1127                                          "reading %s/event-channel(-tx/rx)",
1128                                          xspath);
1129                         goto err;
1130                 }
1131                 rx_evtchn = tx_evtchn;
1132         }
1133
1134         /* Map the shared frame, irq etc. */
1135         err = xenvif_connect_data(queue, tx_ring_ref, rx_ring_ref,
1136                                   tx_evtchn, rx_evtchn);
1137         if (err) {
1138                 xenbus_dev_fatal(dev, err,
1139                                  "mapping shared-frames %lu/%lu port tx %u rx %u",
1140                                  tx_ring_ref, rx_ring_ref,
1141                                  tx_evtchn, rx_evtchn);
1142                 goto err;
1143         }
1144
1145         err = 0;
1146 err: /* Regular return falls through with err == 0 */
1147         kfree(xspath);
1148         return err;
1149 }
1150
1151 static int read_xenbus_vif_flags(struct backend_info *be)
1152 {
1153         struct xenvif *vif = be->vif;
1154         struct xenbus_device *dev = be->dev;
1155         unsigned int rx_copy;
1156         int err;
1157
1158         err = xenbus_scanf(XBT_NIL, dev->otherend, "request-rx-copy", "%u",
1159                            &rx_copy);
1160         if (err == -ENOENT) {
1161                 err = 0;
1162                 rx_copy = 0;
1163         }
1164         if (err < 0) {
1165                 xenbus_dev_fatal(dev, err, "reading %s/request-rx-copy",
1166                                  dev->otherend);
1167                 return err;
1168         }
1169         if (!rx_copy)
1170                 return -EOPNOTSUPP;
1171
1172         if (!xenbus_read_unsigned(dev->otherend, "feature-rx-notify", 0)) {
1173                 /* - Reduce drain timeout to poll more frequently for
1174                  *   Rx requests.
1175                  * - Disable Rx stall detection.
1176                  */
1177                 be->vif->drain_timeout = msecs_to_jiffies(30);
1178                 be->vif->stall_timeout = 0;
1179         }
1180
1181         vif->can_sg = !!xenbus_read_unsigned(dev->otherend, "feature-sg", 0);
1182
1183         vif->gso_mask = 0;
1184
1185         if (xenbus_read_unsigned(dev->otherend, "feature-gso-tcpv4", 0))
1186                 vif->gso_mask |= GSO_BIT(TCPV4);
1187
1188         if (xenbus_read_unsigned(dev->otherend, "feature-gso-tcpv6", 0))
1189                 vif->gso_mask |= GSO_BIT(TCPV6);
1190
1191         vif->ip_csum = !xenbus_read_unsigned(dev->otherend,
1192                                              "feature-no-csum-offload", 0);
1193
1194         vif->ipv6_csum = !!xenbus_read_unsigned(dev->otherend,
1195                                                 "feature-ipv6-csum-offload", 0);
1196
1197         return 0;
1198 }
1199
1200 static const struct xenbus_device_id netback_ids[] = {
1201         { "vif" },
1202         { "" }
1203 };
1204
1205 static struct xenbus_driver netback_driver = {
1206         .ids = netback_ids,
1207         .probe = netback_probe,
1208         .remove = netback_remove,
1209         .uevent = netback_uevent,
1210         .otherend_changed = frontend_changed,
1211 };
1212
1213 int xenvif_xenbus_init(void)
1214 {
1215         return xenbus_register_backend(&netback_driver);
1216 }
1217
1218 void xenvif_xenbus_fini(void)
1219 {
1220         return xenbus_unregister_driver(&netback_driver);
1221 }