datapath/vport.c

   1 /*
   2  * Copyright (c) 2010, 2011 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 #include <linux/dcache.h>
  10 #include <linux/etherdevice.h>
  11 #include <linux/if.h>
  12 #include <linux/if_vlan.h>
  13 #include <linux/kernel.h>
  14 #include <linux/list.h>
  15 #include <linux/mutex.h>
  16 #include <linux/percpu.h>
  17 #include <linux/rcupdate.h>
  18 #include <linux/rtnetlink.h>
  19 #include <linux/compat.h>
  20 #include <linux/version.h>
  21
  22 #include "vport.h"
  23 #include "vport-internal_dev.h"
  24
  25 /* List of statically compiled vport implementations.  Don't forget to also
  26  * add yours to the list at the bottom of vport.h. */
  27 static const struct vport_ops *base_vport_ops_list[] = {
  28         &netdev_vport_ops,
  29         &internal_vport_ops,
  30         &patch_vport_ops,
  31         &gre_vport_ops,
  32 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,26)
  33         &capwap_vport_ops,
  34 #endif
  35 };
  36
  37 static const struct vport_ops **vport_ops_list;
  38 static int n_vport_types;
  39
  40 /* Protected by RCU read lock for reading, RTNL lock for writing. */
  41 static struct hlist_head *dev_table;
  42 #define VPORT_HASH_BUCKETS 1024
  43
  44 /**
  45  *      vport_init - initialize vport subsystem
  46  *
  47  * Called at module load time to initialize the vport subsystem and any
  48  * compiled in vport types.
  49  */
  50 int vport_init(void)
  51 {
  52         int err;
  53         int i;
  54
  55         dev_table = kzalloc(VPORT_HASH_BUCKETS * sizeof(struct hlist_head),
  56                             GFP_KERNEL);
  57         if (!dev_table) {
  58                 err = -ENOMEM;
  59                 goto error;
  60         }
  61
  62         vport_ops_list = kmalloc(ARRAY_SIZE(base_vport_ops_list) *
  63                                  sizeof(struct vport_ops *), GFP_KERNEL);
  64         if (!vport_ops_list) {
  65                 err = -ENOMEM;
  66                 goto error_dev_table;
  67         }
  68
  69         for (i = 0; i < ARRAY_SIZE(base_vport_ops_list); i++) {
  70                 const struct vport_ops *new_ops = base_vport_ops_list[i];
  71
  72                 if (new_ops->init)
  73                         err = new_ops->init();
  74                 else
  75                         err = 0;
  76
  77                 if (!err)
  78                         vport_ops_list[n_vport_types++] = new_ops;
  79                 else if (new_ops->flags & VPORT_F_REQUIRED) {
  80                         vport_exit();
  81                         goto error;
  82                 }
  83         }
  84
  85         return 0;
  86
  87 error_dev_table:
  88         kfree(dev_table);
  89 error:
  90         return err;
  91 }
  92
  93 /**
  94  *      vport_exit - shutdown vport subsystem
  95  *
  96  * Called at module exit time to shutdown the vport subsystem and any
  97  * initialized vport types.
  98  */
  99 void vport_exit(void)
 100 {
 101         int i;
 102
 103         for (i = 0; i < n_vport_types; i++) {
 104                 if (vport_ops_list[i]->exit)
 105                         vport_ops_list[i]->exit();
 106         }
 107
 108         kfree(vport_ops_list);
 109         kfree(dev_table);
 110 }
 111
 112 static struct hlist_head *hash_bucket(const char *name)
 113 {
 114         unsigned int hash = full_name_hash(name, strlen(name));
 115         return &dev_table[hash & (VPORT_HASH_BUCKETS - 1)];
 116 }
 117
 118 /**
 119  *      vport_locate - find a port that has already been created
 120  *
 121  * @name: name of port to find
 122  *
 123  * Must be called with RTNL or RCU read lock.
 124  */
 125 struct vport *vport_locate(const char *name)
 126 {
 127         struct hlist_head *bucket = hash_bucket(name);
 128         struct vport *vport;
 129         struct hlist_node *node;
 130
 131         hlist_for_each_entry_rcu(vport, node, bucket, hash_node)
 132                 if (!strcmp(name, vport_get_name(vport)))
 133                         return vport;
 134
 135         return NULL;
 136 }
 137
 138 static void release_vport(struct kobject *kobj)
 139 {
 140         struct vport *p = container_of(kobj, struct vport, kobj);
 141         kfree(p);
 142 }
 143
 144 static struct kobj_type brport_ktype = {
 145 #ifdef CONFIG_SYSFS
 146         .sysfs_ops = &brport_sysfs_ops,
 147 #endif
 148         .release = release_vport
 149 };
 150
 151 /**
 152  *      vport_alloc - allocate and initialize new vport
 153  *
 154  * @priv_size: Size of private data area to allocate.
 155  * @ops: vport device ops
 156  *
 157  * Allocate and initialize a new vport defined by @ops.  The vport will contain
 158  * a private data area of size @priv_size that can be accessed using
 159  * vport_priv().  vports that are no longer needed should be released with
 160  * vport_free().
 161  */
 162 struct vport *vport_alloc(int priv_size, const struct vport_ops *ops, const struct vport_parms *parms)
 163 {
 164         struct vport *vport;
 165         size_t alloc_size;
 166
 167         alloc_size = sizeof(struct vport);
 168         if (priv_size) {
 169                 alloc_size = ALIGN(alloc_size, VPORT_ALIGN);
 170                 alloc_size += priv_size;
 171         }
 172
 173         vport = kzalloc(alloc_size, GFP_KERNEL);
 174         if (!vport)
 175                 return ERR_PTR(-ENOMEM);
 176
 177         vport->dp = parms->dp;
 178         vport->port_no = parms->port_no;
 179         atomic_set(&vport->sflow_pool, 0);
 180         vport->ops = ops;
 181
 182         /* Initialize kobject for bridge.  This will be added as
 183          * /sys/class/net/<devname>/brport later, if sysfs is enabled. */
 184         vport->kobj.kset = NULL;
 185         kobject_init(&vport->kobj, &brport_ktype);
 186
 187         if (vport->ops->flags & VPORT_F_GEN_STATS) {
 188                 vport->percpu_stats = alloc_percpu(struct vport_percpu_stats);
 189                 if (!vport->percpu_stats)
 190                         return ERR_PTR(-ENOMEM);
 191
 192                 spin_lock_init(&vport->stats_lock);
 193         }
 194
 195         return vport;
 196 }
 197
 198 /**
 199  *      vport_free - uninitialize and free vport
 200  *
 201  * @vport: vport to free
 202  *
 203  * Frees a vport allocated with vport_alloc() when it is no longer needed.
 204  *
 205  * The caller must ensure that an RCU grace period has passed since the last
 206  * time @vport was in a datapath.
 207  */
 208 void vport_free(struct vport *vport)
 209 {
 210         if (vport->ops->flags & VPORT_F_GEN_STATS)
 211                 free_percpu(vport->percpu_stats);
 212
 213         kobject_put(&vport->kobj);
 214 }
 215
 216 /**
 217  *      vport_add - add vport device (for kernel callers)
 218  *
 219  * @parms: Information about new vport.
 220  *
 221  * Creates a new vport with the specified configuration (which is dependent on
 222  * device type).  RTNL lock must be held.
 223  */
 224 struct vport *vport_add(const struct vport_parms *parms)
 225 {
 226         struct vport *vport;
 227         int err = 0;
 228         int i;
 229
 230         ASSERT_RTNL();
 231
 232         for (i = 0; i < n_vport_types; i++) {
 233                 if (vport_ops_list[i]->type == parms->type) {
 234                         vport = vport_ops_list[i]->create(parms);
 235                         if (IS_ERR(vport)) {
 236                                 err = PTR_ERR(vport);
 237                                 goto out;
 238                         }
 239
 240                         hlist_add_head_rcu(&vport->hash_node,
 241                                            hash_bucket(vport_get_name(vport)));
 242                         return vport;
 243                 }
 244         }
 245
 246         err = -EAFNOSUPPORT;
 247
 248 out:
 249         return ERR_PTR(err);
 250 }
 251
 252 /**
 253  *      vport_set_options - modify existing vport device (for kernel callers)
 254  *
 255  * @vport: vport to modify.
 256  * @port: New configuration.
 257  *
 258  * Modifies an existing device with the specified configuration (which is
 259  * dependent on device type).  RTNL lock must be held.
 260  */
 261 int vport_set_options(struct vport *vport, struct nlattr *options)
 262 {
 263         ASSERT_RTNL();
 264
 265         if (!vport->ops->set_options)
 266                 return -EOPNOTSUPP;
 267         return vport->ops->set_options(vport, options);
 268 }
 269
 270 /**
 271  *      vport_del - delete existing vport device
 272  *
 273  * @vport: vport to delete.
 274  *
 275  * Detaches @vport from its datapath and destroys it.  It is possible to fail
 276  * for reasons such as lack of memory.  RTNL lock must be held.
 277  */
 278 void vport_del(struct vport *vport)
 279 {
 280         ASSERT_RTNL();
 281
 282         hlist_del_rcu(&vport->hash_node);
 283
 284         vport->ops->destroy(vport);
 285 }
 286
 287 /**
 288  *      vport_set_addr - set device Ethernet address (for kernel callers)
 289  *
 290  * @vport: vport on which to set Ethernet address.
 291  * @addr: New address.
 292  *
 293  * Sets the Ethernet address of the given device.  Some devices may not support
 294  * setting the Ethernet address, in which case the result will always be
 295  * -EOPNOTSUPP.  RTNL lock must be held.
 296  */
 297 int vport_set_addr(struct vport *vport, const unsigned char *addr)
 298 {
 299         ASSERT_RTNL();
 300
 301         if (!is_valid_ether_addr(addr))
 302                 return -EADDRNOTAVAIL;
 303
 304         if (vport->ops->set_addr)
 305                 return vport->ops->set_addr(vport, addr);
 306         else
 307                 return -EOPNOTSUPP;
 308 }
 309
 310 /**
 311  *      vport_set_stats - sets offset device stats
 312  *
 313  * @vport: vport on which to set stats
 314  * @stats: stats to set
 315  *
 316  * Provides a set of transmit, receive, and error stats to be added as an
 317  * offset to the collect data when stats are retreived.  Some devices may not
 318  * support setting the stats, in which case the result will always be
 319  * -EOPNOTSUPP.
 320  *
 321  * Must be called with RTNL lock.
 322  */
 323 int vport_set_stats(struct vport *vport, struct rtnl_link_stats64 *stats)
 324 {
 325         ASSERT_RTNL();
 326
 327         if (vport->ops->flags & VPORT_F_GEN_STATS) {
 328                 spin_lock_bh(&vport->stats_lock);
 329                 vport->offset_stats = *stats;
 330                 spin_unlock_bh(&vport->stats_lock);
 331
 332                 return 0;
 333         } else
 334                 return -EOPNOTSUPP;
 335 }
 336
 337 /**
 338  *      vport_get_name - retrieve device name
 339  *
 340  * @vport: vport from which to retrieve the name.
 341  *
 342  * Retrieves the name of the given device.  Either RTNL lock or rcu_read_lock
 343  * must be held for the entire duration that the name is in use.
 344  */
 345 const char *vport_get_name(const struct vport *vport)
 346 {
 347         return vport->ops->get_name(vport);
 348 }
 349
 350 /**
 351  *      vport_get_type - retrieve device type
 352  *
 353  * @vport: vport from which to retrieve the type.
 354  *
 355  * Retrieves the type of the given device.
 356  */
 357 enum ovs_vport_type vport_get_type(const struct vport *vport)
 358 {
 359         return vport->ops->type;
 360 }
 361
 362 /**
 363  *      vport_get_addr - retrieve device Ethernet address (for kernel callers)
 364  *
 365  * @vport: vport from which to retrieve the Ethernet address.
 366  *
 367  * Retrieves the Ethernet address of the given device.  Either RTNL lock or
 368  * rcu_read_lock must be held for the entire duration that the Ethernet address
 369  * is in use.
 370  */
 371 const unsigned char *vport_get_addr(const struct vport *vport)
 372 {
 373         return vport->ops->get_addr(vport);
 374 }
 375
 376 /**
 377  *      vport_get_kobj - retrieve associated kobj
 378  *
 379  * @vport: vport from which to retrieve the associated kobj
 380  *
 381  * Retrieves the associated kobj or null if no kobj.  The returned kobj is
 382  * valid for as long as the vport exists.
 383  */
 384 struct kobject *vport_get_kobj(const struct vport *vport)
 385 {
 386         if (vport->ops->get_kobj)
 387                 return vport->ops->get_kobj(vport);
 388         else
 389                 return NULL;
 390 }
 391
 392 static int vport_call_get_stats(struct vport *vport, struct rtnl_link_stats64 *stats)
 393 {
 394         int err;
 395
 396         rcu_read_lock();
 397         err = vport->ops->get_stats(vport, stats);
 398         rcu_read_unlock();
 399
 400         return err;
 401 }
 402
 403 /**
 404  *      vport_get_stats - retrieve device stats
 405  *
 406  * @vport: vport from which to retrieve the stats
 407  * @stats: location to store stats
 408  *
 409  * Retrieves transmit, receive, and error stats for the given device.
 410  *
 411  * Must be called with RTNL lock or rcu_read_lock.
 412  */
 413 int vport_get_stats(struct vport *vport, struct rtnl_link_stats64 *stats)
 414 {
 415         int i;
 416
 417         if (!(vport->ops->flags & VPORT_F_GEN_STATS))
 418                 return vport_call_get_stats(vport, stats);
 419
 420         /* We potentially have 3 sources of stats that need to be
 421          * combined: those we have collected (split into err_stats and
 422          * percpu_stats), offset_stats from set_stats(), and device
 423          * error stats from get_stats() (for errors that happen
 424          * downstream and therefore aren't reported through our
 425          * vport_record_error() function). */
 426
 427         spin_lock_bh(&vport->stats_lock);
 428
 429         *stats = vport->offset_stats;
 430
 431         stats->rx_errors        += vport->err_stats.rx_errors;
 432         stats->tx_errors        += vport->err_stats.tx_errors;
 433         stats->tx_dropped       += vport->err_stats.tx_dropped;
 434         stats->rx_dropped       += vport->err_stats.rx_dropped;
 435
 436         spin_unlock_bh(&vport->stats_lock);
 437
 438         if (vport->ops->get_stats) {
 439                 struct rtnl_link_stats64 dev_stats;
 440                 int err;
 441
 442                 err = vport_call_get_stats(vport, &dev_stats);
 443                 if (err)
 444                         return err;
 445
 446                 stats->rx_errors           += dev_stats.rx_errors;
 447                 stats->tx_errors           += dev_stats.tx_errors;
 448                 stats->rx_dropped          += dev_stats.rx_dropped;
 449                 stats->tx_dropped          += dev_stats.tx_dropped;
 450                 stats->multicast           += dev_stats.multicast;
 451                 stats->collisions          += dev_stats.collisions;
 452                 stats->rx_length_errors    += dev_stats.rx_length_errors;
 453                 stats->rx_over_errors      += dev_stats.rx_over_errors;
 454                 stats->rx_crc_errors       += dev_stats.rx_crc_errors;
 455                 stats->rx_frame_errors     += dev_stats.rx_frame_errors;
 456                 stats->rx_fifo_errors      += dev_stats.rx_fifo_errors;
 457                 stats->rx_missed_errors    += dev_stats.rx_missed_errors;
 458                 stats->tx_aborted_errors   += dev_stats.tx_aborted_errors;
 459                 stats->tx_carrier_errors   += dev_stats.tx_carrier_errors;
 460                 stats->tx_fifo_errors      += dev_stats.tx_fifo_errors;
 461                 stats->tx_heartbeat_errors += dev_stats.tx_heartbeat_errors;
 462                 stats->tx_window_errors    += dev_stats.tx_window_errors;
 463                 stats->rx_compressed       += dev_stats.rx_compressed;
 464                 stats->tx_compressed       += dev_stats.tx_compressed;
 465         }
 466
 467         for_each_possible_cpu(i) {
 468                 const struct vport_percpu_stats *percpu_stats;
 469                 struct vport_percpu_stats local_stats;
 470                 unsigned seqcount;
 471
 472                 percpu_stats = per_cpu_ptr(vport->percpu_stats, i);
 473
 474                 do {
 475                         seqcount = read_seqcount_begin(&percpu_stats->seqlock);
 476                         local_stats = *percpu_stats;
 477                 } while (read_seqcount_retry(&percpu_stats->seqlock, seqcount));
 478
 479                 stats->rx_bytes         += local_stats.rx_bytes;
 480                 stats->rx_packets       += local_stats.rx_packets;
 481                 stats->tx_bytes         += local_stats.tx_bytes;
 482                 stats->tx_packets       += local_stats.tx_packets;
 483         }
 484
 485         return 0;
 486 }
 487
 488 /**
 489  *      vport_get_flags - retrieve device flags
 490  *
 491  * @vport: vport from which to retrieve the flags
 492  *
 493  * Retrieves the flags of the given device.
 494  *
 495  * Must be called with RTNL lock or rcu_read_lock.
 496  */
 497 unsigned vport_get_flags(const struct vport *vport)
 498 {
 499         return vport->ops->get_dev_flags(vport);
 500 }
 501
 502 /**
 503  *      vport_get_flags - check whether device is running
 504  *
 505  * @vport: vport on which to check status.
 506  *
 507  * Checks whether the given device is running.
 508  *
 509  * Must be called with RTNL lock or rcu_read_lock.
 510  */
 511 int vport_is_running(const struct vport *vport)
 512 {
 513         return vport->ops->is_running(vport);
 514 }
 515
 516 /**
 517  *      vport_get_flags - retrieve device operating state
 518  *
 519  * @vport: vport from which to check status
 520  *
 521  * Retrieves the RFC2863 operstate of the given device.
 522  *
 523  * Must be called with RTNL lock or rcu_read_lock.
 524  */
 525 unsigned char vport_get_operstate(const struct vport *vport)
 526 {
 527         return vport->ops->get_operstate(vport);
 528 }
 529
 530 /**
 531  *      vport_get_ifindex - retrieve device system interface index
 532  *
 533  * @vport: vport from which to retrieve index
 534  *
 535  * Retrieves the system interface index of the given device or 0 if
 536  * the device does not have one (in the case of virtual ports).
 537  * Returns a negative index on error.
 538  *
 539  * Must be called with RTNL lock or rcu_read_lock.
 540  */
 541 int vport_get_ifindex(const struct vport *vport)
 542 {
 543         if (vport->ops->get_ifindex)
 544                 return vport->ops->get_ifindex(vport);
 545         else
 546                 return 0;
 547 }
 548
 549 /**
 550  *      vport_get_mtu - retrieve device MTU
 551  *
 552  * @vport: vport from which to retrieve MTU
 553  *
 554  * Retrieves the MTU of the given device.  Returns 0 if @vport does not have an
 555  * MTU (as e.g. some tunnels do not).  Either RTNL lock or rcu_read_lock must
 556  * be held.
 557  */
 558 int vport_get_mtu(const struct vport *vport)
 559 {
 560         if (!vport->ops->get_mtu)
 561                 return 0;
 562         return vport->ops->get_mtu(vport);
 563 }
 564
 565 /**
 566  *      vport_get_options - retrieve device options
 567  *
 568  * @vport: vport from which to retrieve the options.
 569  * @skb: sk_buff where options should be appended.
 570  *
 571  * Retrieves the configuration of the given device, appending an
 572  * %OVS_VPORT_ATTR_OPTIONS attribute that in turn contains nested
 573  * vport-specific attributes to @skb.
 574  *
 575  * Returns 0 if successful, -EMSGSIZE if @skb has insufficient room, or another
 576  * negative error code if a real error occurred.  If an error occurs, @skb is
 577  * left unmodified.
 578  *
 579  * Must be called with RTNL lock or rcu_read_lock.
 580  */
 581 int vport_get_options(const struct vport *vport, struct sk_buff *skb)
 582 {
 583         struct nlattr *nla;
 584
 585         nla = nla_nest_start(skb, OVS_VPORT_ATTR_OPTIONS);
 586         if (!nla)
 587                 return -EMSGSIZE;
 588
 589         if (vport->ops->get_options) {
 590                 int err = vport->ops->get_options(vport, skb);
 591                 if (err) {
 592                         nla_nest_cancel(skb, nla);
 593                         return err;
 594                 }
 595         }
 596
 597         nla_nest_end(skb, nla);
 598         return 0;
 599 }
 600
 601 /**
 602  *      vport_receive - pass up received packet to the datapath for processing
 603  *
 604  * @vport: vport that received the packet
 605  * @skb: skb that was received
 606  *
 607  * Must be called with rcu_read_lock.  The packet cannot be shared and
 608  * skb->data should point to the Ethernet header.  The caller must have already
 609  * called compute_ip_summed() to initialize the checksumming fields.
 610  */
 611 void vport_receive(struct vport *vport, struct sk_buff *skb)
 612 {
 613         if (vport->ops->flags & VPORT_F_GEN_STATS) {
 614                 struct vport_percpu_stats *stats;
 615
 616                 local_bh_disable();
 617                 stats = per_cpu_ptr(vport->percpu_stats, smp_processor_id());
 618
 619                 write_seqcount_begin(&stats->seqlock);
 620                 stats->rx_packets++;
 621                 stats->rx_bytes += skb->len;
 622                 write_seqcount_end(&stats->seqlock);
 623
 624                 local_bh_enable();
 625         }
 626
 627         if (!(vport->ops->flags & VPORT_F_FLOW))
 628                 OVS_CB(skb)->flow = NULL;
 629
 630         if (!(vport->ops->flags & VPORT_F_TUN_ID))
 631                 OVS_CB(skb)->tun_id = 0;
 632
 633         dp_process_received_packet(vport, skb);
 634 }
 635
 636 /**
 637  *      vport_send - send a packet on a device
 638  *
 639  * @vport: vport on which to send the packet
 640  * @skb: skb to send
 641  *
 642  * Sends the given packet and returns the length of data sent.  Either RTNL
 643  * lock or rcu_read_lock must be held.
 644  */
 645 int vport_send(struct vport *vport, struct sk_buff *skb)
 646 {
 647         int sent = vport->ops->send(vport, skb);
 648
 649         if (vport->ops->flags & VPORT_F_GEN_STATS && sent > 0) {
 650                 struct vport_percpu_stats *stats;
 651
 652                 local_bh_disable();
 653                 stats = per_cpu_ptr(vport->percpu_stats, smp_processor_id());
 654
 655                 write_seqcount_begin(&stats->seqlock);
 656                 stats->tx_packets++;
 657                 stats->tx_bytes += sent;
 658                 write_seqcount_end(&stats->seqlock);
 659
 660                 local_bh_enable();
 661         }
 662
 663         return sent;
 664 }
 665
 666 /**
 667  *      vport_record_error - indicate device error to generic stats layer
 668  *
 669  * @vport: vport that encountered the error
 670  * @err_type: one of enum vport_err_type types to indicate the error type
 671  *
 672  * If using the vport generic stats layer indicate that an error of the given
 673  * type has occured.
 674  */
 675 void vport_record_error(struct vport *vport, enum vport_err_type err_type)
 676 {
 677         if (vport->ops->flags & VPORT_F_GEN_STATS) {
 678
 679                 spin_lock_bh(&vport->stats_lock);
 680
 681                 switch (err_type) {
 682                 case VPORT_E_RX_DROPPED:
 683                         vport->err_stats.rx_dropped++;
 684                         break;
 685
 686                 case VPORT_E_RX_ERROR:
 687                         vport->err_stats.rx_errors++;
 688                         break;
 689
 690                 case VPORT_E_TX_DROPPED:
 691                         vport->err_stats.tx_dropped++;
 692                         break;
 693
 694                 case VPORT_E_TX_ERROR:
 695                         vport->err_stats.tx_errors++;
 696                         break;
 697                 };
 698
 699                 spin_unlock_bh(&vport->stats_lock);
 700         }
 701 }