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