datapath/vport.c

   1 /*
   2  * Copyright (c) 2010 Nicira Networks.
   3  * Distributed under the terms of the GNU GPL version 2.
   4  *
   5  * Significant portions of this file may be copied from parts of the Linux
   6  * kernel, by Linus Torvalds and others.
   7  */
   8
   9 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
  10
  11 #include <linux/dcache.h>
  12 #include <linux/etherdevice.h>
  13 #include <linux/if.h>
  14 #include <linux/if_vlan.h>
  15 #include <linux/kernel.h>
  16 #include <linux/list.h>
  17 #include <linux/mutex.h>
  18 #include <linux/percpu.h>
  19 #include <linux/rtnetlink.h>
  20 #include <linux/compat.h>
  21 #include <linux/version.h>
  22
  23 #include "vport.h"
  24 #include "vport-internal_dev.h"
  25
  26 /* List of statically compiled vport implementations.  Don't forget to also
  27  * add yours to the list at the bottom of vport.h. */
  28 static const struct vport_ops *base_vport_ops_list[] = {
  29         &netdev_vport_ops,
  30         &internal_vport_ops,
  31         &patch_vport_ops,
  32         &gre_vport_ops,
  33 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,26)
  34         &capwap_vport_ops,
  35 #endif
  36 };
  37
  38 static const struct vport_ops **vport_ops_list;
  39 static int n_vport_types;
  40
  41 static struct hlist_head *dev_table;
  42 #define VPORT_HASH_BUCKETS 1024
  43
  44 /* Both RTNL lock and vport_mutex need to be held when updating dev_table.
  45  *
  46  * If you use vport_locate and then perform some operations, you need to hold
  47  * one of these locks if you don't want the vport to be deleted out from under
  48  * you.
  49  *
  50  * If you get a reference to a vport through a dp_port, it is protected
  51  * by RCU and you need to hold rcu_read_lock instead when reading.
  52  *
  53  * If multiple locks are taken, the hierarchy is:
  54  * 1. RTNL
  55  * 2. DP
  56  * 3. vport
  57  */
  58 static DEFINE_MUTEX(vport_mutex);
  59
  60 /**
  61  *      vport_lock - acquire vport lock
  62  *
  63  * Acquire global vport lock.  See above comment about locking requirements
  64  * and specific function definitions.  May sleep.
  65  */
  66 void vport_lock(void)
  67 {
  68         mutex_lock(&vport_mutex);
  69 }
  70
  71 /**
  72  *      vport_unlock - release vport lock
  73  *
  74  * Release lock acquired with vport_lock.
  75  */
  76 void vport_unlock(void)
  77 {
  78         mutex_unlock(&vport_mutex);
  79 }
  80
  81 #define ASSERT_VPORT()                                          \
  82 do {                                                            \
  83         if (unlikely(!mutex_is_locked(&vport_mutex))) {         \
  84                 pr_err("vport lock not held at %s (%d)\n",      \
  85                        __FILE__, __LINE__);                     \
  86                 dump_stack();                                   \
  87         }                                                       \
  88 } while (0)
  89
  90 /**
  91  *      vport_init - initialize vport subsystem
  92  *
  93  * Called at module load time to initialize the vport subsystem and any
  94  * compiled in vport types.
  95  */
  96 int vport_init(void)
  97 {
  98         int err;
  99         int i;
 100
 101         dev_table = kzalloc(VPORT_HASH_BUCKETS * sizeof(struct hlist_head),
 102                             GFP_KERNEL);
 103         if (!dev_table) {
 104                 err = -ENOMEM;
 105                 goto error;
 106         }
 107
 108         vport_ops_list = kmalloc(ARRAY_SIZE(base_vport_ops_list) *
 109                                  sizeof(struct vport_ops *), GFP_KERNEL);
 110         if (!vport_ops_list) {
 111                 err = -ENOMEM;
 112                 goto error_dev_table;
 113         }
 114
 115         for (i = 0; i < ARRAY_SIZE(base_vport_ops_list); i++) {
 116                 const struct vport_ops *new_ops = base_vport_ops_list[i];
 117
 118                 if (new_ops->init)
 119                         err = new_ops->init();
 120                 else
 121                         err = 0;
 122
 123                 if (!err)
 124                         vport_ops_list[n_vport_types++] = new_ops;
 125                 else if (new_ops->flags & VPORT_F_REQUIRED) {
 126                         vport_exit();
 127                         goto error;
 128                 }
 129         }
 130
 131         return 0;
 132
 133 error_dev_table:
 134         kfree(dev_table);
 135 error:
 136         return err;
 137 }
 138
 139 static void vport_del_all(void)
 140 {
 141         int i;
 142
 143         rtnl_lock();
 144         vport_lock();
 145
 146         for (i = 0; i < VPORT_HASH_BUCKETS; i++) {
 147                 struct hlist_head *bucket = &dev_table[i];
 148                 struct vport *vport;
 149                 struct hlist_node *node, *next;
 150
 151                 hlist_for_each_entry_safe(vport, node, next, bucket, hash_node)
 152                         vport_del(vport);
 153         }
 154
 155         vport_unlock();
 156         rtnl_unlock();
 157 }
 158
 159 /**
 160  *      vport_exit - shutdown vport subsystem
 161  *
 162  * Called at module exit time to shutdown the vport subsystem and any
 163  * initialized vport types.
 164  */
 165 void vport_exit(void)
 166 {
 167         int i;
 168
 169         vport_del_all();
 170
 171         for (i = 0; i < n_vport_types; i++) {
 172                 if (vport_ops_list[i]->exit)
 173                         vport_ops_list[i]->exit();
 174         }
 175
 176         kfree(vport_ops_list);
 177         kfree(dev_table);
 178 }
 179
 180 static int do_vport_add(struct odp_vport_add *vport_config)
 181 {
 182         struct vport_parms parms;
 183         struct vport *vport;
 184         int err = 0;
 185
 186         vport_config->port_type[VPORT_TYPE_SIZE - 1] = '\0';
 187         vport_config->devname[IFNAMSIZ - 1] = '\0';
 188
 189         rtnl_lock();
 190
 191         vport = vport_locate(vport_config->devname);
 192         if (vport) {
 193                 err = -EBUSY;
 194                 goto out;
 195         }
 196
 197         parms.name = vport_config->devname;
 198         parms.type = vport_config->port_type;
 199         parms.config = vport_config->config;
 200
 201         vport_lock();
 202         vport = vport_add(&parms);
 203         vport_unlock();
 204
 205         if (IS_ERR(vport))
 206                 err = PTR_ERR(vport);
 207
 208 out:
 209         rtnl_unlock();
 210         return err;
 211 }
 212
 213 /**
 214  *      vport_user_add - add vport device (for userspace callers)
 215  *
 216  * @uvport_config: New port configuration.
 217  *
 218  * Creates a new vport with the specified configuration (which is dependent
 219  * on device type).  This function is for userspace callers and assumes no
 220  * locks are held.
 221  */
 222 int vport_user_add(const struct odp_vport_add __user *uvport_config)
 223 {
 224         struct odp_vport_add vport_config;
 225
 226         if (copy_from_user(&vport_config, uvport_config, sizeof(struct odp_vport_add)))
 227                 return -EFAULT;
 228
 229         return do_vport_add(&vport_config);
 230 }
 231
 232 #ifdef CONFIG_COMPAT
 233 int compat_vport_user_add(struct compat_odp_vport_add *ucompat)
 234 {
 235         struct compat_odp_vport_add compat;
 236         struct odp_vport_add vport_config;
 237
 238         if (copy_from_user(&compat, ucompat, sizeof(struct compat_odp_vport_add)))
 239                 return -EFAULT;
 240
 241         memcpy(vport_config.port_type, compat.port_type, VPORT_TYPE_SIZE);
 242         memcpy(vport_config.devname, compat.devname, IFNAMSIZ);
 243         vport_config.config = compat_ptr(compat.config);
 244
 245         return do_vport_add(&vport_config);
 246 }
 247 #endif
 248
 249 static int do_vport_mod(struct odp_vport_mod *vport_config)
 250 {
 251         struct vport *vport;
 252         int err;
 253
 254         vport_config->devname[IFNAMSIZ - 1] = '\0';
 255
 256         rtnl_lock();
 257
 258         vport = vport_locate(vport_config->devname);
 259         if (!vport) {
 260                 err = -ENODEV;
 261                 goto out;
 262         }
 263
 264         vport_lock();
 265         err = vport_mod(vport, vport_config->config);
 266         vport_unlock();
 267
 268 out:
 269         rtnl_unlock();
 270         return err;
 271 }
 272
 273 /**
 274  *      vport_user_mod - modify existing vport device (for userspace callers)
 275  *
 276  * @uvport_config: New configuration for vport
 277  *
 278  * Modifies an existing device with the specified configuration (which is
 279  * dependent on device type).  This function is for userspace callers and
 280  * assumes no locks are held.
 281  */
 282 int vport_user_mod(const struct odp_vport_mod __user *uvport_config)
 283 {
 284         struct odp_vport_mod vport_config;
 285
 286         if (copy_from_user(&vport_config, uvport_config, sizeof(struct odp_vport_mod)))
 287                 return -EFAULT;
 288
 289         return do_vport_mod(&vport_config);
 290 }
 291
 292 #ifdef CONFIG_COMPAT
 293 int compat_vport_user_mod(struct compat_odp_vport_mod *ucompat)
 294 {
 295         struct compat_odp_vport_mod compat;
 296         struct odp_vport_mod vport_config;
 297
 298         if (copy_from_user(&compat, ucompat, sizeof(struct compat_odp_vport_mod)))
 299                 return -EFAULT;
 300
 301         memcpy(vport_config.devname, compat.devname, IFNAMSIZ);
 302         vport_config.config = compat_ptr(compat.config);
 303
 304         return do_vport_mod(&vport_config);
 305 }
 306 #endif
 307
 308 /**
 309  *      vport_user_del - delete existing vport device (for userspace callers)
 310  *
 311  * @udevname: Name of device to delete
 312  *
 313  * Deletes the specified device.  Detaches the device from a datapath first
 314  * if it is attached.  Deleting the device will fail if it does not exist or it
 315  * is the datapath local port.  It is also possible to fail for less obvious
 316  * reasons, such as lack of memory.  This function is for userspace callers and
 317  * assumes no locks are held.
 318  */
 319 int vport_user_del(const char __user *udevname)
 320 {
 321         char devname[IFNAMSIZ];
 322         struct vport *vport;
 323         struct dp_port *dp_port;
 324         int err = 0;
 325         int retval;
 326
 327         retval = strncpy_from_user(devname, udevname, IFNAMSIZ);
 328         if (retval < 0)
 329                 return -EFAULT;
 330         else if (retval >= IFNAMSIZ)
 331                 return -ENAMETOOLONG;
 332
 333         rtnl_lock();
 334
 335         vport = vport_locate(devname);
 336         if (!vport) {
 337                 err = -ENODEV;
 338                 goto out;
 339         }
 340
 341         dp_port = vport_get_dp_port(vport);
 342         if (dp_port) {
 343                 struct datapath *dp = dp_port->dp;
 344
 345                 mutex_lock(&dp->mutex);
 346
 347                 if (!strcmp(dp_name(dp), devname)) {
 348                         err = -EINVAL;
 349                         goto dp_port_out;
 350                 }
 351
 352                 err = dp_detach_port(dp_port, 0);
 353
 354 dp_port_out:
 355                 mutex_unlock(&dp->mutex);
 356
 357                 if (err)
 358                         goto out;
 359         }
 360
 361         vport_lock();
 362         err = vport_del(vport);
 363         vport_unlock();
 364
 365 out:
 366         rtnl_unlock();
 367         return err;
 368 }
 369
 370 /**
 371  *      vport_user_stats_get - retrieve device stats (for userspace callers)
 372  *
 373  * @ustats_req: Stats request parameters.
 374  *
 375  * Retrieves transmit, receive, and error stats for the given device.  This
 376  * function is for userspace callers and assumes no locks are held.
 377  */
 378 int vport_user_stats_get(struct odp_vport_stats_req __user *ustats_req)
 379 {
 380         struct odp_vport_stats_req stats_req;
 381         struct vport *vport;
 382         int err;
 383
 384         if (copy_from_user(&stats_req, ustats_req, sizeof(struct odp_vport_stats_req)))
 385                 return -EFAULT;
 386
 387         stats_req.devname[IFNAMSIZ - 1] = '\0';
 388
 389         vport_lock();
 390
 391         vport = vport_locate(stats_req.devname);
 392         if (!vport) {
 393                 err = -ENODEV;
 394                 goto out;
 395         }
 396
 397         err = vport_get_stats(vport, &stats_req.stats);
 398
 399 out:
 400         vport_unlock();
 401
 402         if (!err)
 403                 if (copy_to_user(ustats_req, &stats_req, sizeof(struct odp_vport_stats_req)))
 404                         err = -EFAULT;
 405
 406         return err;
 407 }
 408
 409 /**
 410  *      vport_user_stats_set - sets offset device stats (for userspace callers)
 411  *
 412  * @ustats_req: Stats set parameters.
 413  *
 414  * Provides a set of transmit, receive, and error stats to be added as an
 415  * offset to the collect data when stats are retreived.  Some devices may not
 416  * support setting the stats, in which case the result will always be
 417  * -EOPNOTSUPP.  This function is for userspace callers and assumes no locks
 418  * are held.
 419  */
 420 int vport_user_stats_set(struct odp_vport_stats_req __user *ustats_req)
 421 {
 422         struct odp_vport_stats_req stats_req;
 423         struct vport *vport;
 424         int err;
 425
 426         if (copy_from_user(&stats_req, ustats_req, sizeof(struct odp_vport_stats_req)))
 427                 return -EFAULT;
 428
 429         stats_req.devname[IFNAMSIZ - 1] = '\0';
 430
 431         rtnl_lock();
 432         vport_lock();
 433
 434         vport = vport_locate(stats_req.devname);
 435         if (!vport) {
 436                 err = -ENODEV;
 437                 goto out;
 438         }
 439
 440         err = vport_set_stats(vport, &stats_req.stats);
 441
 442 out:
 443         vport_unlock();
 444         rtnl_unlock();
 445         return err;
 446 }
 447
 448
 449 /**
 450  *      vport_user_ether_get - retrieve device Ethernet address (for userspace callers)
 451  *
 452  * @uvport_ether: Ethernet address request parameters.
 453  *
 454  * Retrieves the Ethernet address of the given device.  This function is for
 455  * userspace callers and assumes no locks are held.
 456  */
 457 int vport_user_ether_get(struct odp_vport_ether __user *uvport_ether)
 458 {
 459         struct odp_vport_ether vport_ether;
 460         struct vport *vport;
 461         int err = 0;
 462
 463         if (copy_from_user(&vport_ether, uvport_ether, sizeof(struct odp_vport_ether)))
 464                 return -EFAULT;
 465
 466         vport_ether.devname[IFNAMSIZ - 1] = '\0';
 467
 468         vport_lock();
 469
 470         vport = vport_locate(vport_ether.devname);
 471         if (!vport) {
 472                 err = -ENODEV;
 473                 goto out;
 474         }
 475
 476         rcu_read_lock();
 477         memcpy(vport_ether.ether_addr, vport_get_addr(vport), ETH_ALEN);
 478         rcu_read_unlock();
 479
 480 out:
 481         vport_unlock();
 482
 483         if (!err)
 484                 if (copy_to_user(uvport_ether, &vport_ether, sizeof(struct odp_vport_ether)))
 485                         err = -EFAULT;
 486
 487         return err;
 488 }
 489
 490 /**
 491  *      vport_user_ether_set - set device Ethernet address (for userspace callers)
 492  *
 493  * @uvport_ether: Ethernet address request parameters.
 494  *
 495  * Sets the Ethernet address of the given device.  Some devices may not support
 496  * setting the Ethernet address, in which case the result will always be
 497  * -EOPNOTSUPP.  This function is for userspace callers and assumes no locks
 498  * are held.
 499  */
 500 int vport_user_ether_set(struct odp_vport_ether __user *uvport_ether)
 501 {
 502         struct odp_vport_ether vport_ether;
 503         struct vport *vport;
 504         int err;
 505
 506         if (copy_from_user(&vport_ether, uvport_ether, sizeof(struct odp_vport_ether)))
 507                 return -EFAULT;
 508
 509         vport_ether.devname[IFNAMSIZ - 1] = '\0';
 510
 511         rtnl_lock();
 512         vport_lock();
 513
 514         vport = vport_locate(vport_ether.devname);
 515         if (!vport) {
 516                 err = -ENODEV;
 517                 goto out;
 518         }
 519
 520         err = vport_set_addr(vport, vport_ether.ether_addr);
 521
 522 out:
 523         vport_unlock();
 524         rtnl_unlock();
 525         return err;
 526 }
 527
 528 /**
 529  *      vport_user_mtu_get - retrieve device MTU (for userspace callers)
 530  *
 531  * @uvport_mtu: MTU request parameters.
 532  *
 533  * Retrieves the MTU of the given device.  This function is for userspace
 534  * callers and assumes no locks are held.
 535  */
 536 int vport_user_mtu_get(struct odp_vport_mtu __user *uvport_mtu)
 537 {
 538         struct odp_vport_mtu vport_mtu;
 539         struct vport *vport;
 540         int err = 0;
 541
 542         if (copy_from_user(&vport_mtu, uvport_mtu, sizeof(struct odp_vport_mtu)))
 543                 return -EFAULT;
 544
 545         vport_mtu.devname[IFNAMSIZ - 1] = '\0';
 546
 547         vport_lock();
 548
 549         vport = vport_locate(vport_mtu.devname);
 550         if (!vport) {
 551                 err = -ENODEV;
 552                 goto out;
 553         }
 554
 555         vport_mtu.mtu = vport_get_mtu(vport);
 556
 557 out:
 558         vport_unlock();
 559
 560         if (!err)
 561                 if (copy_to_user(uvport_mtu, &vport_mtu, sizeof(struct odp_vport_mtu)))
 562                         err = -EFAULT;
 563
 564         return err;
 565 }
 566
 567 /**
 568  *      vport_user_mtu_set - set device MTU (for userspace callers)
 569  *
 570  * @uvport_mtu: MTU request parameters.
 571  *
 572  * Sets the MTU of the given device.  Some devices may not support setting the
 573  * MTU, in which case the result will always be -EOPNOTSUPP.  This function is
 574  * for userspace callers and assumes no locks are held.
 575  */
 576 int vport_user_mtu_set(struct odp_vport_mtu __user *uvport_mtu)
 577 {
 578         struct odp_vport_mtu vport_mtu;
 579         struct vport *vport;
 580         int err;
 581
 582         if (copy_from_user(&vport_mtu, uvport_mtu, sizeof(struct odp_vport_mtu)))
 583                 return -EFAULT;
 584
 585         vport_mtu.devname[IFNAMSIZ - 1] = '\0';
 586
 587         rtnl_lock();
 588         vport_lock();
 589
 590         vport = vport_locate(vport_mtu.devname);
 591         if (!vport) {
 592                 err = -ENODEV;
 593                 goto out;
 594         }
 595
 596         err = vport_set_mtu(vport, vport_mtu.mtu);
 597
 598 out:
 599         vport_unlock();
 600         rtnl_unlock();
 601         return err;
 602 }
 603
 604 static struct hlist_head *hash_bucket(const char *name)
 605 {
 606         unsigned int hash = full_name_hash(name, strlen(name));
 607         return &dev_table[hash & (VPORT_HASH_BUCKETS - 1)];
 608 }
 609
 610 /**
 611  *      vport_locate - find a port that has already been created
 612  *
 613  * @name: name of port to find
 614  *
 615  * Either RTNL or vport lock must be acquired before calling this function
 616  * and held while using the found port.  See the locking comments at the
 617  * top of the file.
 618  */
 619 struct vport *vport_locate(const char *name)
 620 {
 621         struct hlist_head *bucket = hash_bucket(name);
 622         struct vport *vport;
 623         struct hlist_node *node;
 624
 625         if (unlikely(!mutex_is_locked(&vport_mutex) && !rtnl_is_locked())) {
 626                 pr_err("neither RTNL nor vport lock held in vport_locate\n");
 627                 dump_stack();
 628         }
 629
 630         rcu_read_lock();
 631
 632         hlist_for_each_entry(vport, node, bucket, hash_node)
 633                 if (!strcmp(name, vport_get_name(vport)))
 634                         goto out;
 635
 636         vport = NULL;
 637
 638 out:
 639         rcu_read_unlock();
 640         return vport;
 641 }
 642
 643 static void register_vport(struct vport *vport)
 644 {
 645         hlist_add_head(&vport->hash_node, hash_bucket(vport_get_name(vport)));
 646 }
 647
 648 static void unregister_vport(struct vport *vport)
 649 {
 650         hlist_del(&vport->hash_node);
 651 }
 652
 653 /**
 654  *      vport_alloc - allocate and initialize new vport
 655  *
 656  * @priv_size: Size of private data area to allocate.
 657  * @ops: vport device ops
 658  *
 659  * Allocate and initialize a new vport defined by @ops.  The vport will contain
 660  * a private data area of size @priv_size that can be accessed using
 661  * vport_priv().  vports that are no longer needed should be released with
 662  * vport_free().
 663  */
 664 struct vport *vport_alloc(int priv_size, const struct vport_ops *ops)
 665 {
 666         struct vport *vport;
 667         size_t alloc_size;
 668
 669         alloc_size = sizeof(struct vport);
 670         if (priv_size) {
 671                 alloc_size = ALIGN(alloc_size, VPORT_ALIGN);
 672                 alloc_size += priv_size;
 673         }
 674
 675         vport = kzalloc(alloc_size, GFP_KERNEL);
 676         if (!vport)
 677                 return ERR_PTR(-ENOMEM);
 678
 679         vport->ops = ops;
 680
 681         if (vport->ops->flags & VPORT_F_GEN_STATS) {
 682                 vport->percpu_stats = alloc_percpu(struct vport_percpu_stats);
 683                 if (!vport->percpu_stats)
 684                         return ERR_PTR(-ENOMEM);
 685
 686                 spin_lock_init(&vport->stats_lock);
 687         }
 688
 689         return vport;
 690 }
 691
 692 /**
 693  *      vport_free - uninitialize and free vport
 694  *
 695  * @vport: vport to free
 696  *
 697  * Frees a vport allocated with vport_alloc() when it is no longer needed.
 698  */
 699 void vport_free(struct vport *vport)
 700 {
 701         if (vport->ops->flags & VPORT_F_GEN_STATS)
 702                 free_percpu(vport->percpu_stats);
 703
 704         kfree(vport);
 705 }
 706
 707 /**
 708  *      vport_add - add vport device (for kernel callers)
 709  *
 710  * @parms: Information about new vport.
 711  *
 712  * Creates a new vport with the specified configuration (which is dependent
 713  * on device type).  Both RTNL and vport locks must be held.
 714  */
 715 struct vport *vport_add(const struct vport_parms *parms)
 716 {
 717         struct vport *vport;
 718         int err = 0;
 719         int i;
 720
 721         ASSERT_RTNL();
 722         ASSERT_VPORT();
 723
 724         for (i = 0; i < n_vport_types; i++) {
 725                 if (!strcmp(vport_ops_list[i]->type, parms->type)) {
 726                         vport = vport_ops_list[i]->create(parms);
 727                         if (IS_ERR(vport)) {
 728                                 err = PTR_ERR(vport);
 729                                 goto out;
 730                         }
 731
 732                         register_vport(vport);
 733                         return vport;
 734                 }
 735         }
 736
 737         err = -EAFNOSUPPORT;
 738
 739 out:
 740         return ERR_PTR(err);
 741 }
 742
 743 /**
 744  *      vport_mod - modify existing vport device (for kernel callers)
 745  *
 746  * @vport: vport to modify.
 747  * @config: Device type specific configuration.  Userspace pointer.
 748  *
 749  * Modifies an existing device with the specified configuration (which is
 750  * dependent on device type).  Both RTNL and vport locks must be held.
 751  */
 752 int vport_mod(struct vport *vport, const void __user *config)
 753 {
 754         ASSERT_RTNL();
 755         ASSERT_VPORT();
 756
 757         if (vport->ops->modify)
 758                 return vport->ops->modify(vport, config);
 759         else
 760                 return -EOPNOTSUPP;
 761 }
 762
 763 /**
 764  *      vport_del - delete existing vport device (for kernel callers)
 765  *
 766  * @vport: vport to delete.
 767  *
 768  * Deletes the specified device.  The device must not be currently attached to
 769  * a datapath.  It is possible to fail for reasons such as lack of memory.
 770  * Both RTNL and vport locks must be held.
 771  */
 772 int vport_del(struct vport *vport)
 773 {
 774         ASSERT_RTNL();
 775         ASSERT_VPORT();
 776         BUG_ON(vport_get_dp_port(vport));
 777
 778         unregister_vport(vport);
 779
 780         return vport->ops->destroy(vport);
 781 }
 782
 783 /**
 784  *      vport_attach - attach a vport to a datapath
 785  *
 786  * @vport: vport to attach.
 787  * @dp_port: Datapath port to attach the vport to.
 788  *
 789  * Attaches a vport to a specific datapath so that packets may be exchanged.
 790  * Both ports must be currently unattached.  @dp_port must be successfully
 791  * attached to a vport before it is connected to a datapath and must not be
 792  * modified while connected.  RTNL lock and the appropriate DP mutex must be held.
 793  */
 794 int vport_attach(struct vport *vport, struct dp_port *dp_port)
 795 {
 796         ASSERT_RTNL();
 797
 798         if (vport_get_dp_port(vport))
 799                 return -EBUSY;
 800
 801         if (vport->ops->attach) {
 802                 int err;
 803
 804                 err = vport->ops->attach(vport);
 805                 if (err)
 806                         return err;
 807         }
 808
 809         rcu_assign_pointer(vport->dp_port, dp_port);
 810
 811         return 0;
 812 }
 813
 814 /**
 815  *      vport_detach - detach a vport from a datapath
 816  *
 817  * @vport: vport to detach.
 818  *
 819  * Detaches a vport from a datapath.  May fail for a variety of reasons,
 820  * including lack of memory.  RTNL lock and the appropriate DP mutex must be held.
 821  */
 822 int vport_detach(struct vport *vport)
 823 {
 824         struct dp_port *dp_port;
 825
 826         ASSERT_RTNL();
 827
 828         dp_port = vport_get_dp_port(vport);
 829         if (!dp_port)
 830                 return -EINVAL;
 831
 832         rcu_assign_pointer(vport->dp_port, NULL);
 833
 834         if (vport->ops->detach)
 835                 return vport->ops->detach(vport);
 836         else
 837                 return 0;
 838 }
 839
 840 /**
 841  *      vport_set_mtu - set device MTU (for kernel callers)
 842  *
 843  * @vport: vport on which to set MTU.
 844  * @mtu: New MTU.
 845  *
 846  * Sets the MTU of the given device.  Some devices may not support setting the
 847  * MTU, in which case the result will always be -EOPNOTSUPP.  RTNL lock must
 848  * be held.
 849  */
 850 int vport_set_mtu(struct vport *vport, int mtu)
 851 {
 852         ASSERT_RTNL();
 853
 854         if (mtu < 68)
 855                 return -EINVAL;
 856
 857         if (vport->ops->set_mtu) {
 858                 int ret;
 859
 860                 ret = vport->ops->set_mtu(vport, mtu);
 861
 862                 if (!ret && !is_internal_vport(vport)) {
 863                         struct dp_port *dp_port = vport_get_dp_port(vport);
 864
 865                         if (dp_port)
 866                                 set_internal_devs_mtu(dp_port->dp);
 867                 }
 868
 869                 return ret;
 870         } else
 871                 return -EOPNOTSUPP;
 872 }
 873
 874 /**
 875  *      vport_set_addr - set device Ethernet address (for kernel callers)
 876  *
 877  * @vport: vport on which to set Ethernet address.
 878  * @addr: New address.
 879  *
 880  * Sets the Ethernet address of the given device.  Some devices may not support
 881  * setting the Ethernet address, in which case the result will always be
 882  * -EOPNOTSUPP.  RTNL lock must be held.
 883  */
 884 int vport_set_addr(struct vport *vport, const unsigned char *addr)
 885 {
 886         ASSERT_RTNL();
 887
 888         if (!is_valid_ether_addr(addr))
 889                 return -EADDRNOTAVAIL;
 890
 891         if (vport->ops->set_addr)
 892                 return vport->ops->set_addr(vport, addr);
 893         else
 894                 return -EOPNOTSUPP;
 895 }
 896
 897 /**
 898  *      vport_set_stats - sets offset device stats (for kernel callers)
 899  *
 900  * @vport: vport on which to set stats
 901  * @stats: stats to set
 902  *
 903  * Provides a set of transmit, receive, and error stats to be added as an
 904  * offset to the collect data when stats are retreived.  Some devices may not
 905  * support setting the stats, in which case the result will always be
 906  * -EOPNOTSUPP.  RTNL lock must be held.
 907  */
 908 int vport_set_stats(struct vport *vport, struct rtnl_link_stats64 *stats)
 909 {
 910         ASSERT_RTNL();
 911
 912         if (vport->ops->flags & VPORT_F_GEN_STATS) {
 913                 spin_lock_bh(&vport->stats_lock);
 914                 vport->offset_stats = *stats;
 915                 spin_unlock_bh(&vport->stats_lock);
 916
 917                 return 0;
 918         } else if (vport->ops->set_stats)
 919                 return vport->ops->set_stats(vport, stats);
 920         else
 921                 return -EOPNOTSUPP;
 922 }
 923
 924 /**
 925  *      vport_get_name - retrieve device name
 926  *
 927  * @vport: vport from which to retrieve the name.
 928  *
 929  * Retrieves the name of the given device.  Either RTNL lock or rcu_read_lock
 930  * must be held for the entire duration that the name is in use.
 931  */
 932 const char *vport_get_name(const struct vport *vport)
 933 {
 934         return vport->ops->get_name(vport);
 935 }
 936
 937 /**
 938  *      vport_get_type - retrieve device type
 939  *
 940  * @vport: vport from which to retrieve the type.
 941  *
 942  * Retrieves the type of the given device.  Either RTNL lock or rcu_read_lock
 943  * must be held for the entire duration that the type is in use.
 944  */
 945 const char *vport_get_type(const struct vport *vport)
 946 {
 947         return vport->ops->type;
 948 }
 949
 950 /**
 951  *      vport_get_addr - retrieve device Ethernet address (for kernel callers)
 952  *
 953  * @vport: vport from which to retrieve the Ethernet address.
 954  *
 955  * Retrieves the Ethernet address of the given device.  Either RTNL lock or
 956  * rcu_read_lock must be held for the entire duration that the Ethernet address
 957  * is in use.
 958  */
 959 const unsigned char *vport_get_addr(const struct vport *vport)
 960 {
 961         return vport->ops->get_addr(vport);
 962 }
 963
 964 /**
 965  *      vport_get_dp_port - retrieve attached datapath port
 966  *
 967  * @vport: vport from which to retrieve the datapath port.
 968  *
 969  * Retrieves the attached datapath port or null if not attached.  Either RTNL
 970  * lock or rcu_read_lock must be held for the entire duration that the datapath
 971  * port is being accessed.
 972  */
 973 struct dp_port *vport_get_dp_port(const struct vport *vport)
 974 {
 975         return rcu_dereference(vport->dp_port);
 976 }
 977
 978 /**
 979  *      vport_get_kobj - retrieve associated kobj
 980  *
 981  * @vport: vport from which to retrieve the associated kobj
 982  *
 983  * Retrieves the associated kobj or null if no kobj.  The returned kobj is
 984  * valid for as long as the vport exists.
 985  */
 986 struct kobject *vport_get_kobj(const struct vport *vport)
 987 {
 988         if (vport->ops->get_kobj)
 989                 return vport->ops->get_kobj(vport);
 990         else
 991                 return NULL;
 992 }
 993
 994 /**
 995  *      vport_get_stats - retrieve device stats (for kernel callers)
 996  *
 997  * @vport: vport from which to retrieve the stats
 998  * @stats: location to store stats
 999  *
1000  * Retrieves transmit, receive, and error stats for the given device.
1001  */
1002 int vport_get_stats(struct vport *vport, struct rtnl_link_stats64 *stats)
1003 {
1004         struct rtnl_link_stats64 dev_stats;
1005         struct rtnl_link_stats64 *dev_statsp = NULL;
1006         int err;
1007
1008         if (vport->ops->get_stats) {
1009                 if (vport->ops->flags & VPORT_F_GEN_STATS)
1010                         dev_statsp = &dev_stats;
1011                 else
1012                         dev_statsp = stats;
1013
1014                 rcu_read_lock();
1015                 err = vport->ops->get_stats(vport, dev_statsp);
1016                 rcu_read_unlock();
1017
1018                 if (err)
1019                         goto out;
1020         }
1021
1022         if (vport->ops->flags & VPORT_F_GEN_STATS) {
1023                 int i;
1024
1025                 /* We potentially have 3 sources of stats that need to be
1026                  * combined: those we have collected (split into err_stats and
1027                  * percpu_stats), offset_stats from set_stats(), and device
1028                  * error stats from get_stats() (for errors that happen
1029                  * downstream and therefore aren't reported through our
1030                  * vport_record_error() function). */
1031
1032                 spin_lock_bh(&vport->stats_lock);
1033
1034                 *stats = vport->offset_stats;
1035
1036                 stats->rx_errors        += vport->err_stats.rx_errors;
1037                 stats->tx_errors        += vport->err_stats.tx_errors;
1038                 stats->tx_dropped       += vport->err_stats.tx_dropped;
1039                 stats->rx_dropped       += vport->err_stats.rx_dropped;
1040
1041                 spin_unlock_bh(&vport->stats_lock);
1042
1043                 if (dev_statsp) {
1044                         stats->rx_packets          += dev_statsp->rx_packets;
1045                         stats->tx_packets          += dev_statsp->tx_packets;
1046                         stats->rx_bytes            += dev_statsp->rx_bytes;
1047                         stats->tx_bytes            += dev_statsp->tx_bytes;
1048                         stats->rx_errors           += dev_statsp->rx_errors;
1049                         stats->tx_errors           += dev_statsp->tx_errors;
1050                         stats->rx_dropped          += dev_statsp->rx_dropped;
1051                         stats->tx_dropped          += dev_statsp->tx_dropped;
1052                         stats->multicast           += dev_statsp->multicast;
1053                         stats->collisions          += dev_statsp->collisions;
1054                         stats->rx_length_errors    += dev_statsp->rx_length_errors;
1055                         stats->rx_over_errors      += dev_statsp->rx_over_errors;
1056                         stats->rx_crc_errors       += dev_statsp->rx_crc_errors;
1057                         stats->rx_frame_errors     += dev_statsp->rx_frame_errors;
1058                         stats->rx_fifo_errors      += dev_statsp->rx_fifo_errors;
1059                         stats->rx_missed_errors    += dev_statsp->rx_missed_errors;
1060                         stats->tx_aborted_errors   += dev_statsp->tx_aborted_errors;
1061                         stats->tx_carrier_errors   += dev_statsp->tx_carrier_errors;
1062                         stats->tx_fifo_errors      += dev_statsp->tx_fifo_errors;
1063                         stats->tx_heartbeat_errors += dev_statsp->tx_heartbeat_errors;
1064                         stats->tx_window_errors    += dev_statsp->tx_window_errors;
1065                         stats->rx_compressed       += dev_statsp->rx_compressed;
1066                         stats->tx_compressed       += dev_statsp->tx_compressed;
1067                 }
1068
1069                 for_each_possible_cpu(i) {
1070                         const struct vport_percpu_stats *percpu_stats;
1071                         struct vport_percpu_stats local_stats;
1072                         unsigned seqcount;
1073
1074                         percpu_stats = per_cpu_ptr(vport->percpu_stats, i);
1075
1076                         do {
1077                                 seqcount = read_seqcount_begin(&percpu_stats->seqlock);
1078                                 local_stats = *percpu_stats;
1079                         } while (read_seqcount_retry(&percpu_stats->seqlock, seqcount));
1080
1081                         stats->rx_bytes         += local_stats.rx_bytes;
1082                         stats->rx_packets       += local_stats.rx_packets;
1083                         stats->tx_bytes         += local_stats.tx_bytes;
1084                         stats->tx_packets       += local_stats.tx_packets;
1085                 }
1086
1087                 err = 0;
1088         } else
1089                 err = -EOPNOTSUPP;
1090
1091 out:
1092         return err;
1093 }
1094
1095 /**
1096  *      vport_get_flags - retrieve device flags
1097  *
1098  * @vport: vport from which to retrieve the flags
1099  *
1100  * Retrieves the flags of the given device.  Either RTNL lock or rcu_read_lock
1101  * must be held.
1102  */
1103 unsigned vport_get_flags(const struct vport *vport)
1104 {
1105         return vport->ops->get_dev_flags(vport);
1106 }
1107
1108 /**
1109  *      vport_get_flags - check whether device is running
1110  *
1111  * @vport: vport on which to check status.
1112  *
1113  * Checks whether the given device is running.  Either RTNL lock or
1114  * rcu_read_lock must be held.
1115  */
1116 int vport_is_running(const struct vport *vport)
1117 {
1118         return vport->ops->is_running(vport);
1119 }
1120
1121 /**
1122  *      vport_get_flags - retrieve device operating state
1123  *
1124  * @vport: vport from which to check status
1125  *
1126  * Retrieves the RFC2863 operstate of the given device.  Either RTNL lock or
1127  * rcu_read_lock must be held.
1128  */
1129 unsigned char vport_get_operstate(const struct vport *vport)
1130 {
1131         return vport->ops->get_operstate(vport);
1132 }
1133
1134 /**
1135  *      vport_get_ifindex - retrieve device system interface index
1136  *
1137  * @vport: vport from which to retrieve index
1138  *
1139  * Retrieves the system interface index of the given device.  Not all devices
1140  * will have system indexes, in which case the index of the datapath local
1141  * port is returned.  Returns a negative index on error.  Either RTNL lock or
1142  * rcu_read_lock must be held.
1143  */
1144 int vport_get_ifindex(const struct vport *vport)
1145 {
1146         const struct dp_port *dp_port;
1147
1148         if (vport->ops->get_ifindex)
1149                 return vport->ops->get_ifindex(vport);
1150
1151         /* If we don't actually have an ifindex, use the local port's.
1152          * Userspace doesn't check it anyways. */
1153         dp_port = vport_get_dp_port(vport);
1154         if (!dp_port)
1155                 return -EAGAIN;
1156
1157         return vport_get_ifindex(dp_port->dp->ports[ODPP_LOCAL]->vport);
1158 }
1159
1160 /**
1161  *      vport_get_iflink - retrieve device system link index
1162  *
1163  * @vport: vport from which to retrieve index
1164  *
1165  * Retrieves the system link index of the given device.  The link is the index
1166  * of the interface on which the packet will actually be sent.  In most cases
1167  * this is the same as the ifindex but may be different for tunnel devices.
1168  * Returns a negative index on error.  Either RTNL lock or rcu_read_lock must
1169  * be held.
1170  */
1171 int vport_get_iflink(const struct vport *vport)
1172 {
1173         if (vport->ops->get_iflink)
1174                 return vport->ops->get_iflink(vport);
1175
1176         /* If we don't have an iflink, use the ifindex.  In most cases they
1177          * are the same. */
1178         return vport_get_ifindex(vport);
1179 }
1180
1181 /**
1182  *      vport_get_mtu - retrieve device MTU (for kernel callers)
1183  *
1184  * @vport: vport from which to retrieve MTU
1185  *
1186  * Retrieves the MTU of the given device.  Either RTNL lock or rcu_read_lock
1187  * must be held.
1188  */
1189 int vport_get_mtu(const struct vport *vport)
1190 {
1191         return vport->ops->get_mtu(vport);
1192 }
1193
1194 /**
1195  *      vport_receive - pass up received packet to the datapath for processing
1196  *
1197  * @vport: vport that received the packet
1198  * @skb: skb that was received
1199  *
1200  * Must be called with rcu_read_lock.  The packet cannot be shared and
1201  * skb->data should point to the Ethernet header.  The caller must have already
1202  * called compute_ip_summed() to initialize the checksumming fields.
1203  */
1204 void vport_receive(struct vport *vport, struct sk_buff *skb)
1205 {
1206         struct dp_port *dp_port = vport_get_dp_port(vport);
1207
1208         if (!dp_port) {
1209                 vport_record_error(vport, VPORT_E_RX_DROPPED);
1210                 kfree_skb(skb);
1211
1212                 return;
1213         }
1214
1215         if (vport->ops->flags & VPORT_F_GEN_STATS) {
1216                 struct vport_percpu_stats *stats;
1217
1218                 local_bh_disable();
1219                 stats = per_cpu_ptr(vport->percpu_stats, smp_processor_id());
1220
1221                 write_seqcount_begin(&stats->seqlock);
1222                 stats->rx_packets++;
1223                 stats->rx_bytes += skb->len;
1224                 write_seqcount_end(&stats->seqlock);
1225
1226                 local_bh_enable();
1227         }
1228
1229         if (!(vport->ops->flags & VPORT_F_FLOW))
1230                 OVS_CB(skb)->flow = NULL;
1231
1232         if (!(vport->ops->flags & VPORT_F_TUN_ID))
1233                 OVS_CB(skb)->tun_id = 0;
1234
1235         dp_process_received_packet(dp_port, skb);
1236 }
1237
1238 static inline unsigned packet_length(const struct sk_buff *skb)
1239 {
1240         unsigned length = skb->len - ETH_HLEN;
1241
1242         if (skb->protocol == htons(ETH_P_8021Q))
1243                 length -= VLAN_HLEN;
1244
1245         return length;
1246 }
1247
1248 /**
1249  *      vport_send - send a packet on a device
1250  *
1251  * @vport: vport on which to send the packet
1252  * @skb: skb to send
1253  *
1254  * Sends the given packet and returns the length of data sent.  Either RTNL
1255  * lock or rcu_read_lock must be held.
1256  */
1257 int vport_send(struct vport *vport, struct sk_buff *skb)
1258 {
1259         int mtu;
1260         int sent;
1261
1262         mtu = vport_get_mtu(vport);
1263         if (unlikely(packet_length(skb) > mtu && !skb_is_gso(skb))) {
1264                 if (net_ratelimit())
1265                         pr_warn("%s: dropped over-mtu packet: %d > %d\n",
1266                                 dp_name(vport_get_dp_port(vport)->dp),
1267                                 packet_length(skb), mtu);
1268                 goto error;
1269         }
1270
1271         sent = vport->ops->send(vport, skb);
1272
1273         if (vport->ops->flags & VPORT_F_GEN_STATS && sent > 0) {
1274                 struct vport_percpu_stats *stats;
1275
1276                 local_bh_disable();
1277                 stats = per_cpu_ptr(vport->percpu_stats, smp_processor_id());
1278
1279                 write_seqcount_begin(&stats->seqlock);
1280                 stats->tx_packets++;
1281                 stats->tx_bytes += sent;
1282                 write_seqcount_end(&stats->seqlock);
1283
1284                 local_bh_enable();
1285         }
1286
1287         return sent;
1288
1289 error:
1290         kfree_skb(skb);
1291         vport_record_error(vport, VPORT_E_TX_DROPPED);
1292         return 0;
1293 }
1294
1295 /**
1296  *      vport_record_error - indicate device error to generic stats layer
1297  *
1298  * @vport: vport that encountered the error
1299  * @err_type: one of enum vport_err_type types to indicate the error type
1300  *
1301  * If using the vport generic stats layer indicate that an error of the given
1302  * type has occured.
1303  */
1304 void vport_record_error(struct vport *vport, enum vport_err_type err_type)
1305 {
1306         if (vport->ops->flags & VPORT_F_GEN_STATS) {
1307
1308                 spin_lock_bh(&vport->stats_lock);
1309
1310                 switch (err_type) {
1311                 case VPORT_E_RX_DROPPED:
1312                         vport->err_stats.rx_dropped++;
1313                         break;
1314
1315                 case VPORT_E_RX_ERROR:
1316                         vport->err_stats.rx_errors++;
1317                         break;
1318
1319                 case VPORT_E_TX_DROPPED:
1320                         vport->err_stats.tx_dropped++;
1321                         break;
1322
1323                 case VPORT_E_TX_ERROR:
1324                         vport->err_stats.tx_errors++;
1325                         break;
1326                 };
1327
1328                 spin_unlock_bh(&vport->stats_lock);
1329         }
1330 }