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_gre64_vport_ops,
  45 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,26)
  46         &ovs_capwap_vport_ops,
  47         &ovs_vxlan_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 /**
 154  *      ovs_vport_alloc - allocate and initialize new vport
 155  *
 156  * @priv_size: Size of private data area to allocate.
 157  * @ops: vport device ops
 158  *
 159  * Allocate and initialize a new vport defined by @ops.  The vport will contain
 160  * a private data area of size @priv_size that can be accessed using
 161  * vport_priv().  vports that are no longer needed should be released with
 162  * ovs_vport_free().
 163  */
 164 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *ops,
 165                               const struct vport_parms *parms)
 166 {
 167         struct vport *vport;
 168         size_t alloc_size;
 169
 170         alloc_size = sizeof(struct vport);
 171         if (priv_size) {
 172                 alloc_size = ALIGN(alloc_size, VPORT_ALIGN);
 173                 alloc_size += priv_size;
 174         }
 175
 176         vport = kzalloc(alloc_size, GFP_KERNEL);
 177         if (!vport)
 178                 return ERR_PTR(-ENOMEM);
 179
 180         vport->dp = parms->dp;
 181         vport->port_no = parms->port_no;
 182         vport->upcall_portid = parms->upcall_portid;
 183         vport->ops = ops;
 184         INIT_HLIST_NODE(&vport->dp_hash_node);
 185
 186         vport->percpu_stats = alloc_percpu(struct vport_percpu_stats);
 187         if (!vport->percpu_stats) {
 188                 kfree(vport);
 189                 return ERR_PTR(-ENOMEM);
 190         }
 191
 192         spin_lock_init(&vport->stats_lock);
 193
 194         return vport;
 195 }
 196
 197 /**
 198  *      ovs_vport_free - uninitialize and free vport
 199  *
 200  * @vport: vport to free
 201  *
 202  * Frees a vport allocated with ovs_vport_alloc() when it is no longer needed.
 203  *
 204  * The caller must ensure that an RCU grace period has passed since the last
 205  * time @vport was in a datapath.
 206  */
 207 void ovs_vport_free(struct vport *vport)
 208 {
 209         free_percpu(vport->percpu_stats);
 210         kfree(vport);
 211 }
 212
 213 /**
 214  *      ovs_vport_add - add vport device (for kernel callers)
 215  *
 216  * @parms: Information about new vport.
 217  *
 218  * Creates a new vport with the specified configuration (which is dependent on
 219  * device type).  RTNL lock must be held.
 220  */
 221 struct vport *ovs_vport_add(const struct vport_parms *parms)
 222 {
 223         struct vport *vport;
 224         int err = 0;
 225         int i;
 226
 227         ASSERT_RTNL();
 228
 229         for (i = 0; i < n_vport_types; i++) {
 230                 if (vport_ops_list[i]->type == parms->type) {
 231                         struct hlist_head *bucket;
 232
 233                         vport = vport_ops_list[i]->create(parms);
 234                         if (IS_ERR(vport)) {
 235                                 err = PTR_ERR(vport);
 236                                 goto out;
 237                         }
 238
 239                         bucket = hash_bucket(ovs_dp_get_net(vport->dp),
 240                                              vport->ops->get_name(vport));
 241                         hlist_add_head_rcu(&vport->hash_node, bucket);
 242                         return vport;
 243                 }
 244         }
 245
 246         err = -EAFNOSUPPORT;
 247
 248 out:
 249         return ERR_PTR(err);
 250 }
 251
 252 /**
 253  *      ovs_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 ovs_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  *      ovs_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 ovs_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  *      ovs_vport_set_stats - sets offset device stats
 289  *
 290  * @vport: vport on which to set stats
 291  * @stats: stats to set
 292  *
 293  * Provides a set of transmit, receive, and error stats to be added as an
 294  * offset to the collect data when stats are retreived.  Some devices may not
 295  * support setting the stats, in which case the result will always be
 296  * -EOPNOTSUPP.
 297  *
 298  * Must be called with RTNL lock.
 299  */
 300 void ovs_vport_set_stats(struct vport *vport, struct ovs_vport_stats *stats)
 301 {
 302         ASSERT_RTNL();
 303
 304         spin_lock_bh(&vport->stats_lock);
 305         vport->offset_stats = *stats;
 306         spin_unlock_bh(&vport->stats_lock);
 307 }
 308
 309 /**
 310  *      ovs_vport_get_stats - retrieve device stats
 311  *
 312  * @vport: vport from which to retrieve the stats
 313  * @stats: location to store stats
 314  *
 315  * Retrieves transmit, receive, and error stats for the given device.
 316  *
 317  * Must be called with RTNL lock or rcu_read_lock.
 318  */
 319 void ovs_vport_get_stats(struct vport *vport, struct ovs_vport_stats *stats)
 320 {
 321         int i;
 322
 323         /* We potentially have 3 sources of stats that need to be
 324          * combined: those we have collected (split into err_stats and
 325          * percpu_stats), offset_stats from set_stats(), and device
 326          * error stats from netdev->get_stats() (for errors that happen
 327          * downstream and therefore aren't reported through our
 328          * vport_record_error() function).
 329          * Stats from first two sources are merged and reported by ovs over
 330          * OVS_VPORT_ATTR_STATS.
 331          * netdev-stats can be directly read over netlink-ioctl.
 332          */
 333
 334         spin_lock_bh(&vport->stats_lock);
 335
 336         *stats = vport->offset_stats;
 337
 338         stats->rx_errors        += vport->err_stats.rx_errors;
 339         stats->tx_errors        += vport->err_stats.tx_errors;
 340         stats->tx_dropped       += vport->err_stats.tx_dropped;
 341         stats->rx_dropped       += vport->err_stats.rx_dropped;
 342
 343         spin_unlock_bh(&vport->stats_lock);
 344
 345         for_each_possible_cpu(i) {
 346                 const struct vport_percpu_stats *percpu_stats;
 347                 struct vport_percpu_stats local_stats;
 348                 unsigned int start;
 349
 350                 percpu_stats = per_cpu_ptr(vport->percpu_stats, i);
 351
 352                 do {
 353                         start = u64_stats_fetch_begin_bh(&percpu_stats->sync);
 354                         local_stats = *percpu_stats;
 355                 } while (u64_stats_fetch_retry_bh(&percpu_stats->sync, start));
 356
 357                 stats->rx_bytes         += local_stats.rx_bytes;
 358                 stats->rx_packets       += local_stats.rx_packets;
 359                 stats->tx_bytes         += local_stats.tx_bytes;
 360                 stats->tx_packets       += local_stats.tx_packets;
 361         }
 362 }
 363
 364 /**
 365  *      ovs_vport_get_options - retrieve device options
 366  *
 367  * @vport: vport from which to retrieve the options.
 368  * @skb: sk_buff where options should be appended.
 369  *
 370  * Retrieves the configuration of the given device, appending an
 371  * %OVS_VPORT_ATTR_OPTIONS attribute that in turn contains nested
 372  * vport-specific attributes to @skb.
 373  *
 374  * Returns 0 if successful, -EMSGSIZE if @skb has insufficient room, or another
 375  * negative error code if a real error occurred.  If an error occurs, @skb is
 376  * left unmodified.
 377  *
 378  * Must be called with RTNL lock or rcu_read_lock.
 379  */
 380 int ovs_vport_get_options(const struct vport *vport, struct sk_buff *skb)
 381 {
 382         struct nlattr *nla;
 383
 384         nla = nla_nest_start(skb, OVS_VPORT_ATTR_OPTIONS);
 385         if (!nla)
 386                 return -EMSGSIZE;
 387
 388         if (vport->ops->get_options) {
 389                 int err = vport->ops->get_options(vport, skb);
 390                 if (err) {
 391                         nla_nest_cancel(skb, nla);
 392                         return err;
 393                 }
 394         }
 395
 396         nla_nest_end(skb, nla);
 397         return 0;
 398 }
 399
 400 /**
 401  *      ovs_vport_receive - pass up received packet to the datapath for processing
 402  *
 403  * @vport: vport that received the packet
 404  * @skb: skb that was received
 405  *
 406  * Must be called with rcu_read_lock.  The packet cannot be shared and
 407  * skb->data should point to the Ethernet header.  The caller must have already
 408  * called compute_ip_summed() to initialize the checksumming fields.
 409  */
 410 void ovs_vport_receive(struct vport *vport, struct sk_buff *skb)
 411 {
 412         struct vport_percpu_stats *stats;
 413
 414         stats = this_cpu_ptr(vport->percpu_stats);
 415         u64_stats_update_begin(&stats->sync);
 416         stats->rx_packets++;
 417         stats->rx_bytes += skb->len;
 418         u64_stats_update_end(&stats->sync);
 419
 420         if (!(vport->ops->flags & VPORT_F_FLOW))
 421                 OVS_CB(skb)->flow = NULL;
 422
 423         if (!(vport->ops->flags & VPORT_F_TUN_ID))
 424                 OVS_CB(skb)->tun_key = NULL;
 425
 426         ovs_dp_process_received_packet(vport, skb);
 427 }
 428
 429 /**
 430  *      ovs_vport_send - send a packet on a device
 431  *
 432  * @vport: vport on which to send the packet
 433  * @skb: skb to send
 434  *
 435  * Sends the given packet and returns the length of data sent.  Either RTNL
 436  * lock or rcu_read_lock must be held.
 437  */
 438 int ovs_vport_send(struct vport *vport, struct sk_buff *skb)
 439 {
 440         int sent = vport->ops->send(vport, skb);
 441
 442         if (likely(sent)) {
 443                 struct vport_percpu_stats *stats;
 444
 445                 stats = this_cpu_ptr(vport->percpu_stats);
 446
 447                 u64_stats_update_begin(&stats->sync);
 448                 stats->tx_packets++;
 449                 stats->tx_bytes += sent;
 450                 u64_stats_update_end(&stats->sync);
 451         }
 452         return sent;
 453 }
 454
 455 /**
 456  *      ovs_vport_record_error - indicate device error to generic stats layer
 457  *
 458  * @vport: vport that encountered the error
 459  * @err_type: one of enum vport_err_type types to indicate the error type
 460  *
 461  * If using the vport generic stats layer indicate that an error of the given
 462  * type has occured.
 463  */
 464 void ovs_vport_record_error(struct vport *vport, enum vport_err_type err_type)
 465 {
 466         spin_lock(&vport->stats_lock);
 467
 468         switch (err_type) {
 469         case VPORT_E_RX_DROPPED:
 470                 vport->err_stats.rx_dropped++;
 471                 break;
 472
 473         case VPORT_E_RX_ERROR:
 474                 vport->err_stats.rx_errors++;
 475                 break;
 476
 477         case VPORT_E_TX_DROPPED:
 478                 vport->err_stats.tx_dropped++;
 479                 break;
 480
 481         case VPORT_E_TX_ERROR:
 482                 vport->err_stats.tx_errors++;
 483                 break;
 484         }
 485
 486         spin_unlock(&vport->stats_lock);
 487 }