net/openvswitch/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 <net/net_namespace.h>
  31
  32 #include "datapath.h"
  33 #include "vport.h"
  34 #include "vport-internal_dev.h"
  35
  36 static void ovs_vport_record_error(struct vport *,
  37                                    enum vport_err_type err_type);
  38
  39 /* List of statically compiled vport implementations.  Don't forget to also
  40  * add yours to the list at the bottom of vport.h. */
  41 static const struct vport_ops *vport_ops_list[] = {
  42         &ovs_netdev_vport_ops,
  43         &ovs_internal_vport_ops,
  44
  45 #ifdef CONFIG_OPENVSWITCH_GRE
  46         &ovs_gre_vport_ops,
  47 #endif
  48 #ifdef CONFIG_OPENVSWITCH_VXLAN
  49         &ovs_vxlan_vport_ops,
  50 #endif
  51 };
  52
  53 /* Protected by RCU read lock for reading, ovs_mutex 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.
  61  */
  62 int ovs_vport_init(void)
  63 {
  64         dev_table = kzalloc(VPORT_HASH_BUCKETS * sizeof(struct hlist_head),
  65                             GFP_KERNEL);
  66         if (!dev_table)
  67                 return -ENOMEM;
  68
  69         return 0;
  70 }
  71
  72 /**
  73  *      ovs_vport_exit - shutdown vport subsystem
  74  *
  75  * Called at module exit time to shutdown the vport subsystem.
  76  */
  77 void ovs_vport_exit(void)
  78 {
  79         kfree(dev_table);
  80 }
  81
  82 static struct hlist_head *hash_bucket(struct net *net, const char *name)
  83 {
  84         unsigned int hash = jhash(name, strlen(name), (unsigned long) net);
  85         return &dev_table[hash & (VPORT_HASH_BUCKETS - 1)];
  86 }
  87
  88 /**
  89  *      ovs_vport_locate - find a port that has already been created
  90  *
  91  * @name: name of port to find
  92  *
  93  * Must be called with ovs or RCU read lock.
  94  */
  95 struct vport *ovs_vport_locate(struct net *net, const char *name)
  96 {
  97         struct hlist_head *bucket = hash_bucket(net, name);
  98         struct vport *vport;
  99
 100         hlist_for_each_entry_rcu(vport, bucket, hash_node)
 101                 if (!strcmp(name, vport->ops->get_name(vport)) &&
 102                     net_eq(ovs_dp_get_net(vport->dp), net))
 103                         return vport;
 104
 105         return NULL;
 106 }
 107
 108 /**
 109  *      ovs_vport_alloc - allocate and initialize new vport
 110  *
 111  * @priv_size: Size of private data area to allocate.
 112  * @ops: vport device ops
 113  *
 114  * Allocate and initialize a new vport defined by @ops.  The vport will contain
 115  * a private data area of size @priv_size that can be accessed using
 116  * vport_priv().  vports that are no longer needed should be released with
 117  * vport_free().
 118  */
 119 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *ops,
 120                           const struct vport_parms *parms)
 121 {
 122         struct vport *vport;
 123         size_t alloc_size;
 124
 125         alloc_size = sizeof(struct vport);
 126         if (priv_size) {
 127                 alloc_size = ALIGN(alloc_size, VPORT_ALIGN);
 128                 alloc_size += priv_size;
 129         }
 130
 131         vport = kzalloc(alloc_size, GFP_KERNEL);
 132         if (!vport)
 133                 return ERR_PTR(-ENOMEM);
 134
 135         vport->dp = parms->dp;
 136         vport->port_no = parms->port_no;
 137         vport->ops = ops;
 138         INIT_HLIST_NODE(&vport->dp_hash_node);
 139
 140         if (ovs_vport_set_upcall_portids(vport, parms->upcall_portids))
 141                 return ERR_PTR(-EINVAL);
 142
 143         vport->percpu_stats = netdev_alloc_pcpu_stats(struct pcpu_sw_netstats);
 144         if (!vport->percpu_stats) {
 145                 kfree(vport);
 146                 return ERR_PTR(-ENOMEM);
 147         }
 148
 149         spin_lock_init(&vport->stats_lock);
 150
 151         return vport;
 152 }
 153
 154 /**
 155  *      ovs_vport_free - uninitialize and free vport
 156  *
 157  * @vport: vport to free
 158  *
 159  * Frees a vport allocated with vport_alloc() when it is no longer needed.
 160  *
 161  * The caller must ensure that an RCU grace period has passed since the last
 162  * time @vport was in a datapath.
 163  */
 164 void ovs_vport_free(struct vport *vport)
 165 {
 166         /* vport is freed from RCU callback or error path, Therefore
 167          * it is safe to use raw dereference.
 168          */
 169         kfree(rcu_dereference_raw(vport->upcall_portids));
 170         free_percpu(vport->percpu_stats);
 171         kfree(vport);
 172 }
 173
 174 /**
 175  *      ovs_vport_add - add vport device (for kernel callers)
 176  *
 177  * @parms: Information about new vport.
 178  *
 179  * Creates a new vport with the specified configuration (which is dependent on
 180  * device type).  ovs_mutex must be held.
 181  */
 182 struct vport *ovs_vport_add(const struct vport_parms *parms)
 183 {
 184         struct vport *vport;
 185         int err = 0;
 186         int i;
 187
 188         for (i = 0; i < ARRAY_SIZE(vport_ops_list); i++) {
 189                 if (vport_ops_list[i]->type == parms->type) {
 190                         struct hlist_head *bucket;
 191
 192                         vport = vport_ops_list[i]->create(parms);
 193                         if (IS_ERR(vport)) {
 194                                 err = PTR_ERR(vport);
 195                                 goto out;
 196                         }
 197
 198                         bucket = hash_bucket(ovs_dp_get_net(vport->dp),
 199                                              vport->ops->get_name(vport));
 200                         hlist_add_head_rcu(&vport->hash_node, bucket);
 201                         return vport;
 202                 }
 203         }
 204
 205         err = -EAFNOSUPPORT;
 206
 207 out:
 208         return ERR_PTR(err);
 209 }
 210
 211 /**
 212  *      ovs_vport_set_options - modify existing vport device (for kernel callers)
 213  *
 214  * @vport: vport to modify.
 215  * @options: New configuration.
 216  *
 217  * Modifies an existing device with the specified configuration (which is
 218  * dependent on device type).  ovs_mutex must be held.
 219  */
 220 int ovs_vport_set_options(struct vport *vport, struct nlattr *options)
 221 {
 222         if (!vport->ops->set_options)
 223                 return -EOPNOTSUPP;
 224         return vport->ops->set_options(vport, options);
 225 }
 226
 227 /**
 228  *      ovs_vport_del - delete existing vport device
 229  *
 230  * @vport: vport to delete.
 231  *
 232  * Detaches @vport from its datapath and destroys it.  It is possible to fail
 233  * for reasons such as lack of memory.  ovs_mutex must be held.
 234  */
 235 void ovs_vport_del(struct vport *vport)
 236 {
 237         ASSERT_OVSL();
 238
 239         hlist_del_rcu(&vport->hash_node);
 240
 241         vport->ops->destroy(vport);
 242 }
 243
 244 /**
 245  *      ovs_vport_get_stats - retrieve device stats
 246  *
 247  * @vport: vport from which to retrieve the stats
 248  * @stats: location to store stats
 249  *
 250  * Retrieves transmit, receive, and error stats for the given device.
 251  *
 252  * Must be called with ovs_mutex or rcu_read_lock.
 253  */
 254 void ovs_vport_get_stats(struct vport *vport, struct ovs_vport_stats *stats)
 255 {
 256         int i;
 257
 258         memset(stats, 0, sizeof(*stats));
 259
 260         /* We potentially have 2 sources of stats that need to be combined:
 261          * those we have collected (split into err_stats and percpu_stats) from
 262          * set_stats() and device error stats from netdev->get_stats() (for
 263          * errors that happen  downstream and therefore aren't reported through
 264          * our vport_record_error() function).
 265          * Stats from first source are reported by ovs (OVS_VPORT_ATTR_STATS).
 266          * netdev-stats can be directly read over netlink-ioctl.
 267          */
 268
 269         spin_lock_bh(&vport->stats_lock);
 270
 271         stats->rx_errors        = vport->err_stats.rx_errors;
 272         stats->tx_errors        = vport->err_stats.tx_errors;
 273         stats->tx_dropped       = vport->err_stats.tx_dropped;
 274         stats->rx_dropped       = vport->err_stats.rx_dropped;
 275
 276         spin_unlock_bh(&vport->stats_lock);
 277
 278         for_each_possible_cpu(i) {
 279                 const struct pcpu_sw_netstats *percpu_stats;
 280                 struct pcpu_sw_netstats local_stats;
 281                 unsigned int start;
 282
 283                 percpu_stats = per_cpu_ptr(vport->percpu_stats, i);
 284
 285                 do {
 286                         start = u64_stats_fetch_begin_irq(&percpu_stats->syncp);
 287                         local_stats = *percpu_stats;
 288                 } while (u64_stats_fetch_retry_irq(&percpu_stats->syncp, start));
 289
 290                 stats->rx_bytes         += local_stats.rx_bytes;
 291                 stats->rx_packets       += local_stats.rx_packets;
 292                 stats->tx_bytes         += local_stats.tx_bytes;
 293                 stats->tx_packets       += local_stats.tx_packets;
 294         }
 295 }
 296
 297 /**
 298  *      ovs_vport_get_options - retrieve device options
 299  *
 300  * @vport: vport from which to retrieve the options.
 301  * @skb: sk_buff where options should be appended.
 302  *
 303  * Retrieves the configuration of the given device, appending an
 304  * %OVS_VPORT_ATTR_OPTIONS attribute that in turn contains nested
 305  * vport-specific attributes to @skb.
 306  *
 307  * Returns 0 if successful, -EMSGSIZE if @skb has insufficient room, or another
 308  * negative error code if a real error occurred.  If an error occurs, @skb is
 309  * left unmodified.
 310  *
 311  * Must be called with ovs_mutex or rcu_read_lock.
 312  */
 313 int ovs_vport_get_options(const struct vport *vport, struct sk_buff *skb)
 314 {
 315         struct nlattr *nla;
 316         int err;
 317
 318         if (!vport->ops->get_options)
 319                 return 0;
 320
 321         nla = nla_nest_start(skb, OVS_VPORT_ATTR_OPTIONS);
 322         if (!nla)
 323                 return -EMSGSIZE;
 324
 325         err = vport->ops->get_options(vport, skb);
 326         if (err) {
 327                 nla_nest_cancel(skb, nla);
 328                 return err;
 329         }
 330
 331         nla_nest_end(skb, nla);
 332         return 0;
 333 }
 334
 335 /**
 336  *      ovs_vport_set_upcall_portids - set upcall portids of @vport.
 337  *
 338  * @vport: vport to modify.
 339  * @ids: new configuration, an array of port ids.
 340  *
 341  * Sets the vport's upcall_portids to @ids.
 342  *
 343  * Returns 0 if successful, -EINVAL if @ids is zero length or cannot be parsed
 344  * as an array of U32.
 345  *
 346  * Must be called with ovs_mutex.
 347  */
 348 int ovs_vport_set_upcall_portids(struct vport *vport,  struct nlattr *ids)
 349 {
 350         struct vport_portids *old, *vport_portids;
 351
 352         if (!nla_len(ids) || nla_len(ids) % sizeof(u32))
 353                 return -EINVAL;
 354
 355         old = ovsl_dereference(vport->upcall_portids);
 356
 357         vport_portids = kmalloc(sizeof(*vport_portids) + nla_len(ids),
 358                                 GFP_KERNEL);
 359         if (!vport_portids)
 360                 return -ENOMEM;
 361
 362         vport_portids->n_ids = nla_len(ids) / sizeof(u32);
 363         vport_portids->rn_ids = reciprocal_value(vport_portids->n_ids);
 364         nla_memcpy(vport_portids->ids, ids, nla_len(ids));
 365
 366         rcu_assign_pointer(vport->upcall_portids, vport_portids);
 367
 368         if (old)
 369                 kfree_rcu(old, rcu);
 370         return 0;
 371 }
 372
 373 /**
 374  *      ovs_vport_get_upcall_portids - get the upcall_portids of @vport.
 375  *
 376  * @vport: vport from which to retrieve the portids.
 377  * @skb: sk_buff where portids should be appended.
 378  *
 379  * Retrieves the configuration of the given vport, appending the
 380  * %OVS_VPORT_ATTR_UPCALL_PID attribute which is the array of upcall
 381  * portids to @skb.
 382  *
 383  * Returns 0 if successful, -EMSGSIZE if @skb has insufficient room.
 384  * If an error occurs, @skb is left unmodified.  Must be called with
 385  * ovs_mutex or rcu_read_lock.
 386  */
 387 int ovs_vport_get_upcall_portids(const struct vport *vport,
 388                                  struct sk_buff *skb)
 389 {
 390         struct vport_portids *ids;
 391
 392         ids = rcu_dereference_ovsl(vport->upcall_portids);
 393
 394         if (vport->dp->user_features & OVS_DP_F_VPORT_PIDS)
 395                 return nla_put(skb, OVS_VPORT_ATTR_UPCALL_PID,
 396                                ids->n_ids * sizeof(u32), (void *)ids->ids);
 397         else
 398                 return nla_put_u32(skb, OVS_VPORT_ATTR_UPCALL_PID, ids->ids[0]);
 399 }
 400
 401 /**
 402  *      ovs_vport_find_upcall_portid - find the upcall portid to send upcall.
 403  *
 404  * @vport: vport from which the missed packet is received.
 405  * @skb: skb that the missed packet was received.
 406  *
 407  * Uses the skb_get_hash() to select the upcall portid to send the
 408  * upcall.
 409  *
 410  * Returns the portid of the target socket.  Must be called with rcu_read_lock.
 411  */
 412 u32 ovs_vport_find_upcall_portid(const struct vport *p, struct sk_buff *skb)
 413 {
 414         struct vport_portids *ids;
 415         u32 ids_index;
 416         u32 hash;
 417
 418         ids = rcu_dereference(p->upcall_portids);
 419
 420         if (ids->n_ids == 1 && ids->ids[0] == 0)
 421                 return 0;
 422
 423         hash = skb_get_hash(skb);
 424         ids_index = hash - ids->n_ids * reciprocal_divide(hash, ids->rn_ids);
 425         return ids->ids[ids_index];
 426 }
 427
 428 /**
 429  *      ovs_vport_receive - pass up received packet to the datapath for processing
 430  *
 431  * @vport: vport that received the packet
 432  * @skb: skb that was received
 433  * @tun_key: tunnel (if any) that carried packet
 434  *
 435  * Must be called with rcu_read_lock.  The packet cannot be shared and
 436  * skb->data should point to the Ethernet header.
 437  */
 438 void ovs_vport_receive(struct vport *vport, struct sk_buff *skb,
 439                        struct ovs_key_ipv4_tunnel *tun_key)
 440 {
 441         struct pcpu_sw_netstats *stats;
 442
 443         stats = this_cpu_ptr(vport->percpu_stats);
 444         u64_stats_update_begin(&stats->syncp);
 445         stats->rx_packets++;
 446         stats->rx_bytes += skb->len;
 447         u64_stats_update_end(&stats->syncp);
 448
 449         OVS_CB(skb)->tun_key = tun_key;
 450         ovs_dp_process_received_packet(vport, skb);
 451 }
 452
 453 /**
 454  *      ovs_vport_send - send a packet on a device
 455  *
 456  * @vport: vport on which to send the packet
 457  * @skb: skb to send
 458  *
 459  * Sends the given packet and returns the length of data sent.  Either ovs
 460  * lock or rcu_read_lock must be held.
 461  */
 462 int ovs_vport_send(struct vport *vport, struct sk_buff *skb)
 463 {
 464         int sent = vport->ops->send(vport, skb);
 465
 466         if (likely(sent > 0)) {
 467                 struct pcpu_sw_netstats *stats;
 468
 469                 stats = this_cpu_ptr(vport->percpu_stats);
 470
 471                 u64_stats_update_begin(&stats->syncp);
 472                 stats->tx_packets++;
 473                 stats->tx_bytes += sent;
 474                 u64_stats_update_end(&stats->syncp);
 475         } else if (sent < 0) {
 476                 ovs_vport_record_error(vport, VPORT_E_TX_ERROR);
 477                 kfree_skb(skb);
 478         } else
 479                 ovs_vport_record_error(vport, VPORT_E_TX_DROPPED);
 480
 481         return sent;
 482 }
 483
 484 /**
 485  *      ovs_vport_record_error - indicate device error to generic stats layer
 486  *
 487  * @vport: vport that encountered the error
 488  * @err_type: one of enum vport_err_type types to indicate the error type
 489  *
 490  * If using the vport generic stats layer indicate that an error of the given
 491  * type has occurred.
 492  */
 493 static void ovs_vport_record_error(struct vport *vport,
 494                                    enum vport_err_type err_type)
 495 {
 496         spin_lock(&vport->stats_lock);
 497
 498         switch (err_type) {
 499         case VPORT_E_RX_DROPPED:
 500                 vport->err_stats.rx_dropped++;
 501                 break;
 502
 503         case VPORT_E_RX_ERROR:
 504                 vport->err_stats.rx_errors++;
 505                 break;
 506
 507         case VPORT_E_TX_DROPPED:
 508                 vport->err_stats.tx_dropped++;
 509                 break;
 510
 511         case VPORT_E_TX_ERROR:
 512                 vport->err_stats.tx_errors++;
 513                 break;
 514         }
 515
 516         spin_unlock(&vport->stats_lock);
 517 }
 518
 519 static void free_vport_rcu(struct rcu_head *rcu)
 520 {
 521         struct vport *vport = container_of(rcu, struct vport, rcu);
 522
 523         ovs_vport_free(vport);
 524 }
 525
 526 void ovs_vport_deferred_free(struct vport *vport)
 527 {
 528         if (!vport)
 529                 return;
 530
 531         call_rcu(&vport->rcu, free_vport_rcu);
 532 }