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         vport->upcall_pid = parms->upcall_pid;
 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         vport->percpu_stats = alloc_percpu(struct vport_percpu_stats);
 188         if (!vport->percpu_stats) {
 189                 kfree(vport);
 190                 return ERR_PTR(-ENOMEM);
 191         }
 192
 193         spin_lock_init(&vport->stats_lock);
 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         free_percpu(vport->percpu_stats);
 211
 212         kobject_put(&vport->kobj);
 213 }
 214
 215 /**
 216  *      vport_add - add vport device (for kernel callers)
 217  *
 218  * @parms: Information about new vport.
 219  *
 220  * Creates a new vport with the specified configuration (which is dependent on
 221  * device type).  RTNL lock must be held.
 222  */
 223 struct vport *vport_add(const struct vport_parms *parms)
 224 {
 225         struct vport *vport;
 226         int err = 0;
 227         int i;
 228
 229         ASSERT_RTNL();
 230
 231         for (i = 0; i < n_vport_types; i++) {
 232                 if (vport_ops_list[i]->type == parms->type) {
 233                         vport = vport_ops_list[i]->create(parms);
 234                         if (IS_ERR(vport)) {
 235                                 err = PTR_ERR(vport);
 236                                 goto out;
 237                         }
 238
 239                         hlist_add_head_rcu(&vport->hash_node,
 240                                            hash_bucket(vport_get_name(vport)));
 241                         return vport;
 242                 }
 243         }
 244
 245         err = -EAFNOSUPPORT;
 246
 247 out:
 248         return ERR_PTR(err);
 249 }
 250
 251 /**
 252  *      vport_set_options - modify existing vport device (for kernel callers)
 253  *
 254  * @vport: vport to modify.
 255  * @port: New configuration.
 256  *
 257  * Modifies an existing device with the specified configuration (which is
 258  * dependent on device type).  RTNL lock must be held.
 259  */
 260 int vport_set_options(struct vport *vport, struct nlattr *options)
 261 {
 262         ASSERT_RTNL();
 263
 264         if (!vport->ops->set_options)
 265                 return -EOPNOTSUPP;
 266         return vport->ops->set_options(vport, options);
 267 }
 268
 269 /**
 270  *      vport_del - delete existing vport device
 271  *
 272  * @vport: vport to delete.
 273  *
 274  * Detaches @vport from its datapath and destroys it.  It is possible to fail
 275  * for reasons such as lack of memory.  RTNL lock must be held.
 276  */
 277 void vport_del(struct vport *vport)
 278 {
 279         ASSERT_RTNL();
 280
 281         hlist_del_rcu(&vport->hash_node);
 282
 283         vport->ops->destroy(vport);
 284 }
 285
 286 /**
 287  *      vport_set_addr - set device Ethernet address (for kernel callers)
 288  *
 289  * @vport: vport on which to set Ethernet address.
 290  * @addr: New address.
 291  *
 292  * Sets the Ethernet address of the given device.  Some devices may not support
 293  * setting the Ethernet address, in which case the result will always be
 294  * -EOPNOTSUPP.  RTNL lock must be held.
 295  */
 296 int vport_set_addr(struct vport *vport, const unsigned char *addr)
 297 {
 298         ASSERT_RTNL();
 299
 300         if (!is_valid_ether_addr(addr))
 301                 return -EADDRNOTAVAIL;
 302
 303         if (vport->ops->set_addr)
 304                 return vport->ops->set_addr(vport, addr);
 305         else
 306                 return -EOPNOTSUPP;
 307 }
 308
 309 /**
 310  *      vport_set_stats - sets offset device stats
 311  *
 312  * @vport: vport on which to set stats
 313  * @stats: stats to set
 314  *
 315  * Provides a set of transmit, receive, and error stats to be added as an
 316  * offset to the collect data when stats are retreived.  Some devices may not
 317  * support setting the stats, in which case the result will always be
 318  * -EOPNOTSUPP.
 319  *
 320  * Must be called with RTNL lock.
 321  */
 322 void vport_set_stats(struct vport *vport, struct ovs_vport_stats *stats)
 323 {
 324         ASSERT_RTNL();
 325
 326         spin_lock_bh(&vport->stats_lock);
 327         vport->offset_stats = *stats;
 328         spin_unlock_bh(&vport->stats_lock);
 329 }
 330
 331 /**
 332  *      vport_get_name - retrieve device name
 333  *
 334  * @vport: vport from which to retrieve the name.
 335  *
 336  * Retrieves the name of the given device.  Either RTNL lock or rcu_read_lock
 337  * must be held for the entire duration that the name is in use.
 338  */
 339 const char *vport_get_name(const struct vport *vport)
 340 {
 341         return vport->ops->get_name(vport);
 342 }
 343
 344 /**
 345  *      vport_get_type - retrieve device type
 346  *
 347  * @vport: vport from which to retrieve the type.
 348  *
 349  * Retrieves the type of the given device.
 350  */
 351 enum ovs_vport_type vport_get_type(const struct vport *vport)
 352 {
 353         return vport->ops->type;
 354 }
 355
 356 /**
 357  *      vport_get_addr - retrieve device Ethernet address (for kernel callers)
 358  *
 359  * @vport: vport from which to retrieve the Ethernet address.
 360  *
 361  * Retrieves the Ethernet address of the given device.  Either RTNL lock or
 362  * rcu_read_lock must be held for the entire duration that the Ethernet address
 363  * is in use.
 364  */
 365 const unsigned char *vport_get_addr(const struct vport *vport)
 366 {
 367         return vport->ops->get_addr(vport);
 368 }
 369
 370 /**
 371  *      vport_get_kobj - retrieve associated kobj
 372  *
 373  * @vport: vport from which to retrieve the associated kobj
 374  *
 375  * Retrieves the associated kobj or null if no kobj.  The returned kobj is
 376  * valid for as long as the vport exists.
 377  */
 378 struct kobject *vport_get_kobj(const struct vport *vport)
 379 {
 380         if (vport->ops->get_kobj)
 381                 return vport->ops->get_kobj(vport);
 382         else
 383                 return NULL;
 384 }
 385
 386 /**
 387  *      vport_get_stats - retrieve device stats
 388  *
 389  * @vport: vport from which to retrieve the stats
 390  * @stats: location to store stats
 391  *
 392  * Retrieves transmit, receive, and error stats for the given device.
 393  *
 394  * Must be called with RTNL lock or rcu_read_lock.
 395  */
 396 void vport_get_stats(struct vport *vport, struct ovs_vport_stats *stats)
 397 {
 398         int i;
 399
 400         /* We potentially have 3 sources of stats that need to be
 401          * combined: those we have collected (split into err_stats and
 402          * percpu_stats), offset_stats from set_stats(), and device
 403          * error stats from netdev->get_stats() (for errors that happen
 404          * downstream and therefore aren't reported through our
 405          * vport_record_error() function).
 406          * Stats from first two sources are merged and reported by ovs over
 407          * OVS_VPORT_ATTR_STATS.
 408          * netdev-stats can be directly read over netlink-ioctl.
 409          */
 410
 411         spin_lock_bh(&vport->stats_lock);
 412
 413         *stats = vport->offset_stats;
 414
 415         stats->rx_errors        += vport->err_stats.rx_errors;
 416         stats->tx_errors        += vport->err_stats.tx_errors;
 417         stats->tx_dropped       += vport->err_stats.tx_dropped;
 418         stats->rx_dropped       += vport->err_stats.rx_dropped;
 419
 420         spin_unlock_bh(&vport->stats_lock);
 421
 422         for_each_possible_cpu(i) {
 423                 const struct vport_percpu_stats *percpu_stats;
 424                 struct vport_percpu_stats local_stats;
 425                 unsigned seqcount;
 426
 427                 percpu_stats = per_cpu_ptr(vport->percpu_stats, i);
 428
 429                 do {
 430                         seqcount = read_seqcount_begin(&percpu_stats->seqlock);
 431                         local_stats = *percpu_stats;
 432                 } while (read_seqcount_retry(&percpu_stats->seqlock, seqcount));
 433
 434                 stats->rx_bytes         += local_stats.rx_bytes;
 435                 stats->rx_packets       += local_stats.rx_packets;
 436                 stats->tx_bytes         += local_stats.tx_bytes;
 437                 stats->tx_packets       += local_stats.tx_packets;
 438         }
 439 }
 440
 441 /**
 442  *      vport_get_flags - retrieve device flags
 443  *
 444  * @vport: vport from which to retrieve the flags
 445  *
 446  * Retrieves the flags of the given device.
 447  *
 448  * Must be called with RTNL lock or rcu_read_lock.
 449  */
 450 unsigned vport_get_flags(const struct vport *vport)
 451 {
 452         return vport->ops->get_dev_flags(vport);
 453 }
 454
 455 /**
 456  *      vport_get_flags - check whether device is running
 457  *
 458  * @vport: vport on which to check status.
 459  *
 460  * Checks whether the given device is running.
 461  *
 462  * Must be called with RTNL lock or rcu_read_lock.
 463  */
 464 int vport_is_running(const struct vport *vport)
 465 {
 466         return vport->ops->is_running(vport);
 467 }
 468
 469 /**
 470  *      vport_get_flags - retrieve device operating state
 471  *
 472  * @vport: vport from which to check status
 473  *
 474  * Retrieves the RFC2863 operstate of the given device.
 475  *
 476  * Must be called with RTNL lock or rcu_read_lock.
 477  */
 478 unsigned char vport_get_operstate(const struct vport *vport)
 479 {
 480         return vport->ops->get_operstate(vport);
 481 }
 482
 483 /**
 484  *      vport_get_ifindex - retrieve device system interface index
 485  *
 486  * @vport: vport from which to retrieve index
 487  *
 488  * Retrieves the system interface index of the given device or 0 if
 489  * the device does not have one (in the case of virtual ports).
 490  * Returns a negative index on error.
 491  *
 492  * Must be called with RTNL lock or rcu_read_lock.
 493  */
 494 int vport_get_ifindex(const struct vport *vport)
 495 {
 496         if (vport->ops->get_ifindex)
 497                 return vport->ops->get_ifindex(vport);
 498         else
 499                 return 0;
 500 }
 501
 502 /**
 503  *      vport_get_mtu - retrieve device MTU
 504  *
 505  * @vport: vport from which to retrieve MTU
 506  *
 507  * Retrieves the MTU of the given device.  Returns 0 if @vport does not have an
 508  * MTU (as e.g. some tunnels do not).  Either RTNL lock or rcu_read_lock must
 509  * be held.
 510  */
 511 int vport_get_mtu(const struct vport *vport)
 512 {
 513         if (!vport->ops->get_mtu)
 514                 return 0;
 515         return vport->ops->get_mtu(vport);
 516 }
 517
 518 /**
 519  *      vport_get_options - retrieve device options
 520  *
 521  * @vport: vport from which to retrieve the options.
 522  * @skb: sk_buff where options should be appended.
 523  *
 524  * Retrieves the configuration of the given device, appending an
 525  * %OVS_VPORT_ATTR_OPTIONS attribute that in turn contains nested
 526  * vport-specific attributes to @skb.
 527  *
 528  * Returns 0 if successful, -EMSGSIZE if @skb has insufficient room, or another
 529  * negative error code if a real error occurred.  If an error occurs, @skb is
 530  * left unmodified.
 531  *
 532  * Must be called with RTNL lock or rcu_read_lock.
 533  */
 534 int vport_get_options(const struct vport *vport, struct sk_buff *skb)
 535 {
 536         struct nlattr *nla;
 537
 538         nla = nla_nest_start(skb, OVS_VPORT_ATTR_OPTIONS);
 539         if (!nla)
 540                 return -EMSGSIZE;
 541
 542         if (vport->ops->get_options) {
 543                 int err = vport->ops->get_options(vport, skb);
 544                 if (err) {
 545                         nla_nest_cancel(skb, nla);
 546                         return err;
 547                 }
 548         }
 549
 550         nla_nest_end(skb, nla);
 551         return 0;
 552 }
 553
 554 /**
 555  *      vport_receive - pass up received packet to the datapath for processing
 556  *
 557  * @vport: vport that received the packet
 558  * @skb: skb that was received
 559  *
 560  * Must be called with rcu_read_lock.  The packet cannot be shared and
 561  * skb->data should point to the Ethernet header.  The caller must have already
 562  * called compute_ip_summed() to initialize the checksumming fields.
 563  */
 564 void vport_receive(struct vport *vport, struct sk_buff *skb)
 565 {
 566         struct vport_percpu_stats *stats;
 567
 568         stats = per_cpu_ptr(vport->percpu_stats, smp_processor_id());
 569
 570         write_seqcount_begin(&stats->seqlock);
 571         stats->rx_packets++;
 572         stats->rx_bytes += skb->len;
 573         write_seqcount_end(&stats->seqlock);
 574
 575         if (!(vport->ops->flags & VPORT_F_FLOW))
 576                 OVS_CB(skb)->flow = NULL;
 577
 578         if (!(vport->ops->flags & VPORT_F_TUN_ID))
 579                 OVS_CB(skb)->tun_id = 0;
 580
 581         dp_process_received_packet(vport, skb);
 582 }
 583
 584 /**
 585  *      vport_send - send a packet on a device
 586  *
 587  * @vport: vport on which to send the packet
 588  * @skb: skb to send
 589  *
 590  * Sends the given packet and returns the length of data sent.  Either RTNL
 591  * lock or rcu_read_lock must be held.
 592  */
 593 int vport_send(struct vport *vport, struct sk_buff *skb)
 594 {
 595         struct vport_percpu_stats *stats;
 596         int sent = vport->ops->send(vport, skb);
 597
 598         stats = per_cpu_ptr(vport->percpu_stats, smp_processor_id());
 599
 600         write_seqcount_begin(&stats->seqlock);
 601         stats->tx_packets++;
 602         stats->tx_bytes += sent;
 603         write_seqcount_end(&stats->seqlock);
 604
 605         return sent;
 606 }
 607
 608 /**
 609  *      vport_record_error - indicate device error to generic stats layer
 610  *
 611  * @vport: vport that encountered the error
 612  * @err_type: one of enum vport_err_type types to indicate the error type
 613  *
 614  * If using the vport generic stats layer indicate that an error of the given
 615  * type has occured.
 616  */
 617 void vport_record_error(struct vport *vport, enum vport_err_type err_type)
 618 {
 619         spin_lock(&vport->stats_lock);
 620
 621         switch (err_type) {
 622         case VPORT_E_RX_DROPPED:
 623                 vport->err_stats.rx_dropped++;
 624                 break;
 625
 626         case VPORT_E_RX_ERROR:
 627                 vport->err_stats.rx_errors++;
 628                 break;
 629
 630         case VPORT_E_TX_DROPPED:
 631                 vport->err_stats.tx_dropped++;
 632                 break;
 633
 634         case VPORT_E_TX_ERROR:
 635                 vport->err_stats.tx_errors++;
 636                 break;
 637         };
 638
 639         spin_unlock(&vport->stats_lock);
 640 }