datapath/vport.c

   1 /*
   2  * Copyright (c) 2007-2012 Nicira, Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of version 2 of the GNU General Public
   6  * License as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  11  * General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program; if not, write to the Free Software
  15  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  16  * 02110-1301, USA
  17  */
  18
  19 #include <linux/etherdevice.h>
  20 #include <linux/if.h>
  21 #include <linux/if_vlan.h>
  22 #include <linux/jhash.h>
  23 #include <linux/kernel.h>
  24 #include <linux/list.h>
  25 #include <linux/mutex.h>
  26 #include <linux/percpu.h>
  27 #include <linux/rcupdate.h>
  28 #include <linux/rtnetlink.h>
  29 #include <linux/compat.h>
  30 #include <linux/version.h>
  31 #include <net/net_namespace.h>
  32
  33 #include "datapath.h"
  34 #include "vport.h"
  35 #include "vport-internal_dev.h"
  36
  37 /* List of statically compiled vport implementations.  Don't forget to also
  38  * add yours to the list at the bottom of vport.h. */
  39 static const struct vport_ops *base_vport_ops_list[] = {
  40         &ovs_netdev_vport_ops,
  41         &ovs_internal_vport_ops,
  42         &ovs_patch_vport_ops,
  43         &ovs_gre_vport_ops,
  44         &ovs_gre_ft_vport_ops,
  45         &ovs_gre64_vport_ops,
  46 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,26)
  47         &ovs_capwap_vport_ops,
  48 #endif
  49 };
  50
  51 static const struct vport_ops **vport_ops_list;
  52 static int n_vport_types;
  53
  54 /* Protected by RCU read lock for reading, RTNL lock for writing. */
  55 static struct hlist_head *dev_table;
  56 #define VPORT_HASH_BUCKETS 1024
  57
  58 /**
  59  *      ovs_vport_init - initialize vport subsystem
  60  *
  61  * Called at module load time to initialize the vport subsystem and any
  62  * compiled in vport types.
  63  */
  64 int ovs_vport_init(void)
  65 {
  66         int err;
  67         int i;
  68
  69         dev_table = kzalloc(VPORT_HASH_BUCKETS * sizeof(struct hlist_head),
  70                             GFP_KERNEL);
  71         if (!dev_table) {
  72                 err = -ENOMEM;
  73                 goto error;
  74         }
  75
  76         vport_ops_list = kmalloc(ARRAY_SIZE(base_vport_ops_list) *
  77                                  sizeof(struct vport_ops *), GFP_KERNEL);
  78         if (!vport_ops_list) {
  79                 err = -ENOMEM;
  80                 goto error_dev_table;
  81         }
  82
  83         for (i = 0; i < ARRAY_SIZE(base_vport_ops_list); i++) {
  84                 const struct vport_ops *new_ops = base_vport_ops_list[i];
  85
  86                 if (new_ops->init)
  87                         err = new_ops->init();
  88                 else
  89                         err = 0;
  90
  91                 if (!err)
  92                         vport_ops_list[n_vport_types++] = new_ops;
  93                 else if (new_ops->flags & VPORT_F_REQUIRED) {
  94                         ovs_vport_exit();
  95                         goto error;
  96                 }
  97         }
  98
  99         return 0;
 100
 101 error_dev_table:
 102         kfree(dev_table);
 103 error:
 104         return err;
 105 }
 106
 107 /**
 108  *      ovs_vport_exit - shutdown vport subsystem
 109  *
 110  * Called at module exit time to shutdown the vport subsystem and any
 111  * initialized vport types.
 112  */
 113 void ovs_vport_exit(void)
 114 {
 115         int i;
 116
 117         for (i = 0; i < n_vport_types; i++) {
 118                 if (vport_ops_list[i]->exit)
 119                         vport_ops_list[i]->exit();
 120         }
 121
 122         kfree(vport_ops_list);
 123         kfree(dev_table);
 124 }
 125
 126 static struct hlist_head *hash_bucket(struct net *net, const char *name)
 127 {
 128         unsigned int hash = jhash(name, strlen(name), (unsigned long) net);
 129         return &dev_table[hash & (VPORT_HASH_BUCKETS - 1)];
 130 }
 131
 132 /**
 133  *      ovs_vport_locate - find a port that has already been created
 134  *
 135  * @name: name of port to find
 136  *
 137  * Must be called with RTNL or RCU read lock.
 138  */
 139 struct vport *ovs_vport_locate(struct net *net, const char *name)
 140 {
 141         struct hlist_head *bucket = hash_bucket(net, name);
 142         struct vport *vport;
 143         struct hlist_node *node;
 144
 145         hlist_for_each_entry_rcu(vport, node, bucket, hash_node)
 146                 if (!strcmp(name, vport->ops->get_name(vport)) &&
 147                     net_eq(ovs_dp_get_net(vport->dp), net))
 148                         return vport;
 149
 150         return NULL;
 151 }
 152
 153 static void release_vport(struct kobject *kobj)
 154 {
 155         struct vport *p = container_of(kobj, struct vport, kobj);
 156         kfree(p);
 157 }
 158
 159 static struct kobj_type brport_ktype = {
 160 #ifdef CONFIG_SYSFS
 161         .sysfs_ops = &ovs_brport_sysfs_ops,
 162 #endif
 163         .release = release_vport
 164 };
 165
 166 /**
 167  *      ovs_vport_alloc - allocate and initialize new vport
 168  *
 169  * @priv_size: Size of private data area to allocate.
 170  * @ops: vport device ops
 171  *
 172  * Allocate and initialize a new vport defined by @ops.  The vport will contain
 173  * a private data area of size @priv_size that can be accessed using
 174  * vport_priv().  vports that are no longer needed should be released with
 175  * ovs_vport_free().
 176  */
 177 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *ops,
 178                               const struct vport_parms *parms)
 179 {
 180         struct vport *vport;
 181         size_t alloc_size;
 182
 183         alloc_size = sizeof(struct vport);
 184         if (priv_size) {
 185                 alloc_size = ALIGN(alloc_size, VPORT_ALIGN);
 186                 alloc_size += priv_size;
 187         }
 188
 189         vport = kzalloc(alloc_size, GFP_KERNEL);
 190         if (!vport)
 191                 return ERR_PTR(-ENOMEM);
 192
 193         vport->dp = parms->dp;
 194         vport->port_no = parms->port_no;
 195         vport->upcall_pid = parms->upcall_pid;
 196         vport->ops = ops;
 197         INIT_HLIST_NODE(&vport->dp_hash_node);
 198
 199         /* Initialize kobject for bridge.  This will be added as
 200          * /sys/class/net/<devname>/brport later, if sysfs is enabled. */
 201         vport->kobj.kset = NULL;
 202         kobject_init(&vport->kobj, &brport_ktype);
 203
 204         vport->percpu_stats = alloc_percpu(struct vport_percpu_stats);
 205         if (!vport->percpu_stats) {
 206                 kfree(vport);
 207                 return ERR_PTR(-ENOMEM);
 208         }
 209
 210         spin_lock_init(&vport->stats_lock);
 211
 212         return vport;
 213 }
 214
 215 /**
 216  *      ovs_vport_free - uninitialize and free vport
 217  *
 218  * @vport: vport to free
 219  *
 220  * Frees a vport allocated with ovs_vport_alloc() when it is no longer needed.
 221  *
 222  * The caller must ensure that an RCU grace period has passed since the last
 223  * time @vport was in a datapath.
 224  */
 225 void ovs_vport_free(struct vport *vport)
 226 {
 227         free_percpu(vport->percpu_stats);
 228
 229         kobject_put(&vport->kobj);
 230 }
 231
 232 /**
 233  *      ovs_vport_add - add vport device (for kernel callers)
 234  *
 235  * @parms: Information about new vport.
 236  *
 237  * Creates a new vport with the specified configuration (which is dependent on
 238  * device type).  RTNL lock must be held.
 239  */
 240 struct vport *ovs_vport_add(const struct vport_parms *parms)
 241 {
 242         struct vport *vport;
 243         int err = 0;
 244         int i;
 245
 246         ASSERT_RTNL();
 247
 248         for (i = 0; i < n_vport_types; i++) {
 249                 if (vport_ops_list[i]->type == parms->type) {
 250                         struct hlist_head *bucket;
 251
 252                         vport = vport_ops_list[i]->create(parms);
 253                         if (IS_ERR(vport)) {
 254                                 err = PTR_ERR(vport);
 255                                 goto out;
 256                         }
 257
 258                         bucket = hash_bucket(ovs_dp_get_net(vport->dp),
 259                                              vport->ops->get_name(vport));
 260                         hlist_add_head_rcu(&vport->hash_node, bucket);
 261                         return vport;
 262                 }
 263         }
 264
 265         err = -EAFNOSUPPORT;
 266
 267 out:
 268         return ERR_PTR(err);
 269 }
 270
 271 /**
 272  *      ovs_vport_set_options - modify existing vport device (for kernel callers)
 273  *
 274  * @vport: vport to modify.
 275  * @port: New configuration.
 276  *
 277  * Modifies an existing device with the specified configuration (which is
 278  * dependent on device type).  RTNL lock must be held.
 279  */
 280 int ovs_vport_set_options(struct vport *vport, struct nlattr *options)
 281 {
 282         ASSERT_RTNL();
 283
 284         if (!vport->ops->set_options)
 285                 return -EOPNOTSUPP;
 286         return vport->ops->set_options(vport, options);
 287 }
 288
 289 /**
 290  *      ovs_vport_del - delete existing vport device
 291  *
 292  * @vport: vport to delete.
 293  *
 294  * Detaches @vport from its datapath and destroys it.  It is possible to fail
 295  * for reasons such as lack of memory.  RTNL lock must be held.
 296  */
 297 void ovs_vport_del(struct vport *vport)
 298 {
 299         ASSERT_RTNL();
 300
 301         hlist_del_rcu(&vport->hash_node);
 302
 303         vport->ops->destroy(vport);
 304 }
 305
 306 /**
 307  *      ovs_vport_set_addr - set device Ethernet address (for kernel callers)
 308  *
 309  * @vport: vport on which to set Ethernet address.
 310  * @addr: New address.
 311  *
 312  * Sets the Ethernet address of the given device.  Some devices may not support
 313  * setting the Ethernet address, in which case the result will always be
 314  * -EOPNOTSUPP.  RTNL lock must be held.
 315  */
 316 int ovs_vport_set_addr(struct vport *vport, const unsigned char *addr)
 317 {
 318         ASSERT_RTNL();
 319
 320         if (!is_valid_ether_addr(addr))
 321                 return -EADDRNOTAVAIL;
 322
 323         if (vport->ops->set_addr)
 324                 return vport->ops->set_addr(vport, addr);
 325         else
 326                 return -EOPNOTSUPP;
 327 }
 328
 329 /**
 330  *      ovs_vport_set_stats - sets offset device stats
 331  *
 332  * @vport: vport on which to set stats
 333  * @stats: stats to set
 334  *
 335  * Provides a set of transmit, receive, and error stats to be added as an
 336  * offset to the collect data when stats are retreived.  Some devices may not
 337  * support setting the stats, in which case the result will always be
 338  * -EOPNOTSUPP.
 339  *
 340  * Must be called with RTNL lock.
 341  */
 342 void ovs_vport_set_stats(struct vport *vport, struct ovs_vport_stats *stats)
 343 {
 344         ASSERT_RTNL();
 345
 346         spin_lock_bh(&vport->stats_lock);
 347         vport->offset_stats = *stats;
 348         spin_unlock_bh(&vport->stats_lock);
 349 }
 350
 351 /**
 352  *      ovs_vport_get_stats - retrieve device stats
 353  *
 354  * @vport: vport from which to retrieve the stats
 355  * @stats: location to store stats
 356  *
 357  * Retrieves transmit, receive, and error stats for the given device.
 358  *
 359  * Must be called with RTNL lock or rcu_read_lock.
 360  */
 361 void ovs_vport_get_stats(struct vport *vport, struct ovs_vport_stats *stats)
 362 {
 363         int i;
 364
 365         /* We potentially have 3 sources of stats that need to be
 366          * combined: those we have collected (split into err_stats and
 367          * percpu_stats), offset_stats from set_stats(), and device
 368          * error stats from netdev->get_stats() (for errors that happen
 369          * downstream and therefore aren't reported through our
 370          * vport_record_error() function).
 371          * Stats from first two sources are merged and reported by ovs over
 372          * OVS_VPORT_ATTR_STATS.
 373          * netdev-stats can be directly read over netlink-ioctl.
 374          */
 375
 376         spin_lock_bh(&vport->stats_lock);
 377
 378         *stats = vport->offset_stats;
 379
 380         stats->rx_errors        += vport->err_stats.rx_errors;
 381         stats->tx_errors        += vport->err_stats.tx_errors;
 382         stats->tx_dropped       += vport->err_stats.tx_dropped;
 383         stats->rx_dropped       += vport->err_stats.rx_dropped;
 384
 385         spin_unlock_bh(&vport->stats_lock);
 386
 387         for_each_possible_cpu(i) {
 388                 const struct vport_percpu_stats *percpu_stats;
 389                 struct vport_percpu_stats local_stats;
 390                 unsigned int start;
 391
 392                 percpu_stats = per_cpu_ptr(vport->percpu_stats, i);
 393
 394                 do {
 395                         start = u64_stats_fetch_begin_bh(&percpu_stats->sync);
 396                         local_stats = *percpu_stats;
 397                 } while (u64_stats_fetch_retry_bh(&percpu_stats->sync, start));
 398
 399                 stats->rx_bytes         += local_stats.rx_bytes;
 400                 stats->rx_packets       += local_stats.rx_packets;
 401                 stats->tx_bytes         += local_stats.tx_bytes;
 402                 stats->tx_packets       += local_stats.tx_packets;
 403         }
 404 }
 405
 406 /**
 407  *      ovs_vport_get_options - retrieve device options
 408  *
 409  * @vport: vport from which to retrieve the options.
 410  * @skb: sk_buff where options should be appended.
 411  *
 412  * Retrieves the configuration of the given device, appending an
 413  * %OVS_VPORT_ATTR_OPTIONS attribute that in turn contains nested
 414  * vport-specific attributes to @skb.
 415  *
 416  * Returns 0 if successful, -EMSGSIZE if @skb has insufficient room, or another
 417  * negative error code if a real error occurred.  If an error occurs, @skb is
 418  * left unmodified.
 419  *
 420  * Must be called with RTNL lock or rcu_read_lock.
 421  */
 422 int ovs_vport_get_options(const struct vport *vport, struct sk_buff *skb)
 423 {
 424         struct nlattr *nla;
 425
 426         nla = nla_nest_start(skb, OVS_VPORT_ATTR_OPTIONS);
 427         if (!nla)
 428                 return -EMSGSIZE;
 429
 430         if (vport->ops->get_options) {
 431                 int err = vport->ops->get_options(vport, skb);
 432                 if (err) {
 433                         nla_nest_cancel(skb, nla);
 434                         return err;
 435                 }
 436         }
 437
 438         nla_nest_end(skb, nla);
 439         return 0;
 440 }
 441
 442 /**
 443  *      ovs_vport_receive - pass up received packet to the datapath for processing
 444  *
 445  * @vport: vport that received the packet
 446  * @skb: skb that was received
 447  *
 448  * Must be called with rcu_read_lock.  The packet cannot be shared and
 449  * skb->data should point to the Ethernet header.  The caller must have already
 450  * called compute_ip_summed() to initialize the checksumming fields.
 451  */
 452 void ovs_vport_receive(struct vport *vport, struct sk_buff *skb)
 453 {
 454         struct vport_percpu_stats *stats;
 455
 456         stats = per_cpu_ptr(vport->percpu_stats, smp_processor_id());
 457
 458         u64_stats_update_begin(&stats->sync);
 459         stats->rx_packets++;
 460         stats->rx_bytes += skb->len;
 461         u64_stats_update_end(&stats->sync);
 462
 463         if (!(vport->ops->flags & VPORT_F_FLOW))
 464                 OVS_CB(skb)->flow = NULL;
 465
 466         if (!(vport->ops->flags & VPORT_F_TUN_ID))
 467                 OVS_CB(skb)->tun_key = NULL;
 468
 469         ovs_dp_process_received_packet(vport, skb);
 470 }
 471
 472 /**
 473  *      ovs_vport_send - send a packet on a device
 474  *
 475  * @vport: vport on which to send the packet
 476  * @skb: skb to send
 477  *
 478  * Sends the given packet and returns the length of data sent.  Either RTNL
 479  * lock or rcu_read_lock must be held.
 480  */
 481 int ovs_vport_send(struct vport *vport, struct sk_buff *skb)
 482 {
 483         int sent = vport->ops->send(vport, skb);
 484
 485         if (likely(sent)) {
 486                 struct vport_percpu_stats *stats;
 487
 488                 stats = per_cpu_ptr(vport->percpu_stats, smp_processor_id());
 489
 490                 u64_stats_update_begin(&stats->sync);
 491                 stats->tx_packets++;
 492                 stats->tx_bytes += sent;
 493                 u64_stats_update_end(&stats->sync);
 494         }
 495         return sent;
 496 }
 497
 498 /**
 499  *      ovs_vport_record_error - indicate device error to generic stats layer
 500  *
 501  * @vport: vport that encountered the error
 502  * @err_type: one of enum vport_err_type types to indicate the error type
 503  *
 504  * If using the vport generic stats layer indicate that an error of the given
 505  * type has occured.
 506  */
 507 void ovs_vport_record_error(struct vport *vport, enum vport_err_type err_type)
 508 {
 509         spin_lock(&vport->stats_lock);
 510
 511         switch (err_type) {
 512         case VPORT_E_RX_DROPPED:
 513                 vport->err_stats.rx_dropped++;
 514                 break;
 515
 516         case VPORT_E_RX_ERROR:
 517                 vport->err_stats.rx_errors++;
 518                 break;
 519
 520         case VPORT_E_TX_DROPPED:
 521                 vport->err_stats.tx_dropped++;
 522                 break;
 523
 524         case VPORT_E_TX_ERROR:
 525                 vport->err_stats.tx_errors++;
 526                 break;
 527         }
 528
 529         spin_unlock(&vport->stats_lock);
 530 }