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