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         &ovs_vxlan_vport_ops,
  49 #endif
  50 };
  51
  52 static const struct vport_ops **vport_ops_list;
  53 static int n_vport_types;
  54
  55 /* Protected by RCU read lock for reading, RTNL lock for writing. */
  56 static struct hlist_head *dev_table;
  57 #define VPORT_HASH_BUCKETS 1024
  58
  59 /**
  60  *      ovs_vport_init - initialize vport subsystem
  61  *
  62  * Called at module load time to initialize the vport subsystem and any
  63  * compiled in vport types.
  64  */
  65 int ovs_vport_init(void)
  66 {
  67         int err;
  68         int i;
  69
  70         dev_table = kzalloc(VPORT_HASH_BUCKETS * sizeof(struct hlist_head),
  71                             GFP_KERNEL);
  72         if (!dev_table) {
  73                 err = -ENOMEM;
  74                 goto error;
  75         }
  76
  77         vport_ops_list = kmalloc(ARRAY_SIZE(base_vport_ops_list) *
  78                                  sizeof(struct vport_ops *), GFP_KERNEL);
  79         if (!vport_ops_list) {
  80                 err = -ENOMEM;
  81                 goto error_dev_table;
  82         }
  83
  84         for (i = 0; i < ARRAY_SIZE(base_vport_ops_list); i++) {
  85                 const struct vport_ops *new_ops = base_vport_ops_list[i];
  86
  87                 if (new_ops->init)
  88                         err = new_ops->init();
  89                 else
  90                         err = 0;
  91
  92                 if (!err)
  93                         vport_ops_list[n_vport_types++] = new_ops;
  94                 else if (new_ops->flags & VPORT_F_REQUIRED) {
  95                         ovs_vport_exit();
  96                         goto error;
  97                 }
  98         }
  99
 100         return 0;
 101
 102 error_dev_table:
 103         kfree(dev_table);
 104 error:
 105         return err;
 106 }
 107
 108 /**
 109  *      ovs_vport_exit - shutdown vport subsystem
 110  *
 111  * Called at module exit time to shutdown the vport subsystem and any
 112  * initialized vport types.
 113  */
 114 void ovs_vport_exit(void)
 115 {
 116         int i;
 117
 118         for (i = 0; i < n_vport_types; i++) {
 119                 if (vport_ops_list[i]->exit)
 120                         vport_ops_list[i]->exit();
 121         }
 122
 123         kfree(vport_ops_list);
 124         kfree(dev_table);
 125 }
 126
 127 static struct hlist_head *hash_bucket(struct net *net, const char *name)
 128 {
 129         unsigned int hash = jhash(name, strlen(name), (unsigned long) net);
 130         return &dev_table[hash & (VPORT_HASH_BUCKETS - 1)];
 131 }
 132
 133 /**
 134  *      ovs_vport_locate - find a port that has already been created
 135  *
 136  * @name: name of port to find
 137  *
 138  * Must be called with RTNL or RCU read lock.
 139  */
 140 struct vport *ovs_vport_locate(struct net *net, const char *name)
 141 {
 142         struct hlist_head *bucket = hash_bucket(net, name);
 143         struct vport *vport;
 144         struct hlist_node *node;
 145
 146         hlist_for_each_entry_rcu(vport, node, bucket, hash_node)
 147                 if (!strcmp(name, vport->ops->get_name(vport)) &&
 148                     net_eq(ovs_dp_get_net(vport->dp), net))
 149                         return vport;
 150
 151         return NULL;
 152 }
 153
 154 static void release_vport(struct kobject *kobj)
 155 {
 156         struct vport *p = container_of(kobj, struct vport, kobj);
 157         kfree(p);
 158 }
 159
 160 static struct kobj_type brport_ktype = {
 161 #ifdef CONFIG_SYSFS
 162         .sysfs_ops = &ovs_brport_sysfs_ops,
 163 #endif
 164         .release = release_vport
 165 };
 166
 167 /**
 168  *      ovs_vport_alloc - allocate and initialize new vport
 169  *
 170  * @priv_size: Size of private data area to allocate.
 171  * @ops: vport device ops
 172  *
 173  * Allocate and initialize a new vport defined by @ops.  The vport will contain
 174  * a private data area of size @priv_size that can be accessed using
 175  * vport_priv().  vports that are no longer needed should be released with
 176  * ovs_vport_free().
 177  */
 178 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *ops,
 179                               const struct vport_parms *parms)
 180 {
 181         struct vport *vport;
 182         size_t alloc_size;
 183
 184         alloc_size = sizeof(struct vport);
 185         if (priv_size) {
 186                 alloc_size = ALIGN(alloc_size, VPORT_ALIGN);
 187                 alloc_size += priv_size;
 188         }
 189
 190         vport = kzalloc(alloc_size, GFP_KERNEL);
 191         if (!vport)
 192                 return ERR_PTR(-ENOMEM);
 193
 194         vport->dp = parms->dp;
 195         vport->port_no = parms->port_no;
 196         vport->upcall_portid = parms->upcall_portid;
 197         vport->ops = ops;
 198         INIT_HLIST_NODE(&vport->dp_hash_node);
 199
 200         /* Initialize kobject for bridge.  This will be added as
 201          * /sys/class/net/<devname>/brport later, if sysfs is enabled. */
 202         vport->kobj.kset = NULL;
 203         kobject_init(&vport->kobj, &brport_ktype);
 204
 205         vport->percpu_stats = alloc_percpu(struct vport_percpu_stats);
 206         if (!vport->percpu_stats) {
 207                 kfree(vport);
 208                 return ERR_PTR(-ENOMEM);
 209         }
 210
 211         spin_lock_init(&vport->stats_lock);
 212
 213         return vport;
 214 }
 215
 216 /**
 217  *      ovs_vport_free - uninitialize and free vport
 218  *
 219  * @vport: vport to free
 220  *
 221  * Frees a vport allocated with ovs_vport_alloc() when it is no longer needed.
 222  *
 223  * The caller must ensure that an RCU grace period has passed since the last
 224  * time @vport was in a datapath.
 225  */
 226 void ovs_vport_free(struct vport *vport)
 227 {
 228         free_percpu(vport->percpu_stats);
 229
 230         kobject_put(&vport->kobj);
 231 }
 232
 233 /**
 234  *      ovs_vport_add - add vport device (for kernel callers)
 235  *
 236  * @parms: Information about new vport.
 237  *
 238  * Creates a new vport with the specified configuration (which is dependent on
 239  * device type).  RTNL lock must be held.
 240  */
 241 struct vport *ovs_vport_add(const struct vport_parms *parms)
 242 {
 243         struct vport *vport;
 244         int err = 0;
 245         int i;
 246
 247         ASSERT_RTNL();
 248
 249         for (i = 0; i < n_vport_types; i++) {
 250                 if (vport_ops_list[i]->type == parms->type) {
 251                         struct hlist_head *bucket;
 252
 253                         vport = vport_ops_list[i]->create(parms);
 254                         if (IS_ERR(vport)) {
 255                                 err = PTR_ERR(vport);
 256                                 goto out;
 257                         }
 258
 259                         bucket = hash_bucket(ovs_dp_get_net(vport->dp),
 260                                              vport->ops->get_name(vport));
 261                         hlist_add_head_rcu(&vport->hash_node, bucket);
 262                         return vport;
 263                 }
 264         }
 265
 266         err = -EAFNOSUPPORT;
 267
 268 out:
 269         return ERR_PTR(err);
 270 }
 271
 272 /**
 273  *      ovs_vport_set_options - modify existing vport device (for kernel callers)
 274  *
 275  * @vport: vport to modify.
 276  * @port: New configuration.
 277  *
 278  * Modifies an existing device with the specified configuration (which is
 279  * dependent on device type).  RTNL lock must be held.
 280  */
 281 int ovs_vport_set_options(struct vport *vport, struct nlattr *options)
 282 {
 283         ASSERT_RTNL();
 284
 285         if (!vport->ops->set_options)
 286                 return -EOPNOTSUPP;
 287         return vport->ops->set_options(vport, options);
 288 }
 289
 290 /**
 291  *      ovs_vport_del - delete existing vport device
 292  *
 293  * @vport: vport to delete.
 294  *
 295  * Detaches @vport from its datapath and destroys it.  It is possible to fail
 296  * for reasons such as lack of memory.  RTNL lock must be held.
 297  */
 298 void ovs_vport_del(struct vport *vport)
 299 {
 300         ASSERT_RTNL();
 301
 302         hlist_del_rcu(&vport->hash_node);
 303
 304         vport->ops->destroy(vport);
 305 }
 306
 307 /**
 308  *      ovs_vport_set_addr - set device Ethernet address (for kernel callers)
 309  *
 310  * @vport: vport on which to set Ethernet address.
 311  * @addr: New address.
 312  *
 313  * Sets the Ethernet address of the given device.  Some devices may not support
 314  * setting the Ethernet address, in which case the result will always be
 315  * -EOPNOTSUPP.  RTNL lock must be held.
 316  */
 317 int ovs_vport_set_addr(struct vport *vport, const unsigned char *addr)
 318 {
 319         ASSERT_RTNL();
 320
 321         if (!is_valid_ether_addr(addr))
 322                 return -EADDRNOTAVAIL;
 323
 324         if (vport->ops->set_addr)
 325                 return vport->ops->set_addr(vport, addr);
 326         else
 327                 return -EOPNOTSUPP;
 328 }
 329
 330 /**
 331  *      ovs_vport_set_stats - sets offset device stats
 332  *
 333  * @vport: vport on which to set stats
 334  * @stats: stats to set
 335  *
 336  * Provides a set of transmit, receive, and error stats to be added as an
 337  * offset to the collect data when stats are retreived.  Some devices may not
 338  * support setting the stats, in which case the result will always be
 339  * -EOPNOTSUPP.
 340  *
 341  * Must be called with RTNL lock.
 342  */
 343 void ovs_vport_set_stats(struct vport *vport, struct ovs_vport_stats *stats)
 344 {
 345         ASSERT_RTNL();
 346
 347         spin_lock_bh(&vport->stats_lock);
 348         vport->offset_stats = *stats;
 349         spin_unlock_bh(&vport->stats_lock);
 350 }
 351
 352 /**
 353  *      ovs_vport_get_stats - retrieve device stats
 354  *
 355  * @vport: vport from which to retrieve the stats
 356  * @stats: location to store stats
 357  *
 358  * Retrieves transmit, receive, and error stats for the given device.
 359  *
 360  * Must be called with RTNL lock or rcu_read_lock.
 361  */
 362 void ovs_vport_get_stats(struct vport *vport, struct ovs_vport_stats *stats)
 363 {
 364         int i;
 365
 366         /* We potentially have 3 sources of stats that need to be
 367          * combined: those we have collected (split into err_stats and
 368          * percpu_stats), offset_stats from set_stats(), and device
 369          * error stats from netdev->get_stats() (for errors that happen
 370          * downstream and therefore aren't reported through our
 371          * vport_record_error() function).
 372          * Stats from first two sources are merged and reported by ovs over
 373          * OVS_VPORT_ATTR_STATS.
 374          * netdev-stats can be directly read over netlink-ioctl.
 375          */
 376
 377         spin_lock_bh(&vport->stats_lock);
 378
 379         *stats = vport->offset_stats;
 380
 381         stats->rx_errors        += vport->err_stats.rx_errors;
 382         stats->tx_errors        += vport->err_stats.tx_errors;
 383         stats->tx_dropped       += vport->err_stats.tx_dropped;
 384         stats->rx_dropped       += vport->err_stats.rx_dropped;
 385
 386         spin_unlock_bh(&vport->stats_lock);
 387
 388         for_each_possible_cpu(i) {
 389                 const struct vport_percpu_stats *percpu_stats;
 390                 struct vport_percpu_stats local_stats;
 391                 unsigned int start;
 392
 393                 percpu_stats = per_cpu_ptr(vport->percpu_stats, i);
 394
 395                 do {
 396                         start = u64_stats_fetch_begin_bh(&percpu_stats->sync);
 397                         local_stats = *percpu_stats;
 398                 } while (u64_stats_fetch_retry_bh(&percpu_stats->sync, start));
 399
 400                 stats->rx_bytes         += local_stats.rx_bytes;
 401                 stats->rx_packets       += local_stats.rx_packets;
 402                 stats->tx_bytes         += local_stats.tx_bytes;
 403                 stats->tx_packets       += local_stats.tx_packets;
 404         }
 405 }
 406
 407 /**
 408  *      ovs_vport_get_options - retrieve device options
 409  *
 410  * @vport: vport from which to retrieve the options.
 411  * @skb: sk_buff where options should be appended.
 412  *
 413  * Retrieves the configuration of the given device, appending an
 414  * %OVS_VPORT_ATTR_OPTIONS attribute that in turn contains nested
 415  * vport-specific attributes to @skb.
 416  *
 417  * Returns 0 if successful, -EMSGSIZE if @skb has insufficient room, or another
 418  * negative error code if a real error occurred.  If an error occurs, @skb is
 419  * left unmodified.
 420  *
 421  * Must be called with RTNL lock or rcu_read_lock.
 422  */
 423 int ovs_vport_get_options(const struct vport *vport, struct sk_buff *skb)
 424 {
 425         struct nlattr *nla;
 426
 427         nla = nla_nest_start(skb, OVS_VPORT_ATTR_OPTIONS);
 428         if (!nla)
 429                 return -EMSGSIZE;
 430
 431         if (vport->ops->get_options) {
 432                 int err = vport->ops->get_options(vport, skb);
 433                 if (err) {
 434                         nla_nest_cancel(skb, nla);
 435                         return err;
 436                 }
 437         }
 438
 439         nla_nest_end(skb, nla);
 440         return 0;
 441 }
 442
 443 /**
 444  *      ovs_vport_receive - pass up received packet to the datapath for processing
 445  *
 446  * @vport: vport that received the packet
 447  * @skb: skb that was received
 448  *
 449  * Must be called with rcu_read_lock.  The packet cannot be shared and
 450  * skb->data should point to the Ethernet header.  The caller must have already
 451  * called compute_ip_summed() to initialize the checksumming fields.
 452  */
 453 void ovs_vport_receive(struct vport *vport, struct sk_buff *skb)
 454 {
 455         struct vport_percpu_stats *stats;
 456
 457         stats = this_cpu_ptr(vport->percpu_stats);
 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 = this_cpu_ptr(vport->percpu_stats);
 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 }