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
 126         alloc_size = sizeof(struct vport);
 127         if (priv_size) {
 128                 alloc_size = ALIGN(alloc_size, VPORT_ALIGN);
 129                 alloc_size += priv_size;
 130         }
 131
 132         vport = kzalloc(alloc_size, GFP_KERNEL);
 133         if (!vport)
 134                 return ERR_PTR(-ENOMEM);
 135
 136         vport->dp = parms->dp;
 137         vport->port_no = parms->port_no;
 138         vport->upcall_portid = parms->upcall_portid;
 139         vport->ops = ops;
 140         INIT_HLIST_NODE(&vport->dp_hash_node);
 141
 142         vport->percpu_stats = alloc_percpu(struct pcpu_tstats);
 143         if (!vport->percpu_stats) {
 144                 kfree(vport);
 145                 return ERR_PTR(-ENOMEM);
 146         }
 147
 148         spin_lock_init(&vport->stats_lock);
 149
 150         return vport;
 151 }
 152
 153 /**
 154  *      ovs_vport_free - uninitialize and free vport
 155  *
 156  * @vport: vport to free
 157  *
 158  * Frees a vport allocated with ovs_vport_alloc() when it is no longer needed.
 159  *
 160  * The caller must ensure that an RCU grace period has passed since the last
 161  * time @vport was in a datapath.
 162  */
 163 void ovs_vport_free(struct vport *vport)
 164 {
 165         free_percpu(vport->percpu_stats);
 166         kfree(vport);
 167 }
 168
 169 /**
 170  *      ovs_vport_add - add vport device (for kernel callers)
 171  *
 172  * @parms: Information about new vport.
 173  *
 174  * Creates a new vport with the specified configuration (which is dependent on
 175  * device type).  ovs_mutex must be held.
 176  */
 177 struct vport *ovs_vport_add(const struct vport_parms *parms)
 178 {
 179         struct vport *vport;
 180         int err = 0;
 181         int i;
 182
 183         for (i = 0; i < ARRAY_SIZE(vport_ops_list); i++) {
 184                 if (vport_ops_list[i]->type == parms->type) {
 185                         struct hlist_head *bucket;
 186
 187                         vport = vport_ops_list[i]->create(parms);
 188                         if (IS_ERR(vport)) {
 189                                 err = PTR_ERR(vport);
 190                                 goto out;
 191                         }
 192
 193                         bucket = hash_bucket(ovs_dp_get_net(vport->dp),
 194                                              vport->ops->get_name(vport));
 195                         hlist_add_head_rcu(&vport->hash_node, bucket);
 196                         return vport;
 197                 }
 198         }
 199
 200         err = -EAFNOSUPPORT;
 201
 202 out:
 203         return ERR_PTR(err);
 204 }
 205
 206 /**
 207  *      ovs_vport_set_options - modify existing vport device (for kernel callers)
 208  *
 209  * @vport: vport to modify.
 210  * @options: New configuration.
 211  *
 212  * Modifies an existing device with the specified configuration (which is
 213  * dependent on device type).  ovs_mutex must be held.
 214  */
 215 int ovs_vport_set_options(struct vport *vport, struct nlattr *options)
 216 {
 217         if (!vport->ops->set_options)
 218                 return -EOPNOTSUPP;
 219         return vport->ops->set_options(vport, options);
 220 }
 221
 222 /**
 223  *      ovs_vport_del - delete existing vport device
 224  *
 225  * @vport: vport to delete.
 226  *
 227  * Detaches @vport from its datapath and destroys it.  It is possible to fail
 228  * for reasons such as lack of memory.  ovs_mutex must be held.
 229  */
 230 void ovs_vport_del(struct vport *vport)
 231 {
 232         ASSERT_OVSL();
 233
 234         hlist_del_rcu(&vport->hash_node);
 235         vport->ops->destroy(vport);
 236 }
 237
 238 /**
 239  *      ovs_vport_set_stats - sets offset device stats
 240  *
 241  * @vport: vport on which to set stats
 242  * @stats: stats to set
 243  *
 244  * Provides a set of transmit, receive, and error stats to be added as an
 245  * offset to the collected data when stats are retrieved.  Some devices may not
 246  * support setting the stats, in which case the result will always be
 247  * -EOPNOTSUPP.
 248  *
 249  * Must be called with ovs_mutex.
 250  */
 251 void ovs_vport_set_stats(struct vport *vport, struct ovs_vport_stats *stats)
 252 {
 253         spin_lock_bh(&vport->stats_lock);
 254         vport->offset_stats = *stats;
 255         spin_unlock_bh(&vport->stats_lock);
 256 }
 257
 258 /**
 259  *      ovs_vport_get_stats - retrieve device stats
 260  *
 261  * @vport: vport from which to retrieve the stats
 262  * @stats: location to store stats
 263  *
 264  * Retrieves transmit, receive, and error stats for the given device.
 265  *
 266  * Must be called with ovs_mutex or rcu_read_lock.
 267  */
 268 void ovs_vport_get_stats(struct vport *vport, struct ovs_vport_stats *stats)
 269 {
 270         int i;
 271
 272         /* We potentially have 3 sources of stats that need to be
 273          * combined: those we have collected (split into err_stats and
 274          * percpu_stats), offset_stats from set_stats(), and device
 275          * error stats from netdev->get_stats() (for errors that happen
 276          * downstream and therefore aren't reported through our
 277          * vport_record_error() function).
 278          * Stats from first two sources are merged and reported by ovs over
 279          * OVS_VPORT_ATTR_STATS.
 280          * netdev-stats can be directly read over netlink-ioctl.
 281          */
 282
 283         spin_lock_bh(&vport->stats_lock);
 284
 285         *stats = vport->offset_stats;
 286
 287         stats->rx_errors        += vport->err_stats.rx_errors;
 288         stats->tx_errors        += vport->err_stats.tx_errors;
 289         stats->tx_dropped       += vport->err_stats.tx_dropped;
 290         stats->rx_dropped       += vport->err_stats.rx_dropped;
 291
 292         spin_unlock_bh(&vport->stats_lock);
 293
 294         for_each_possible_cpu(i) {
 295                 const struct pcpu_tstats *percpu_stats;
 296                 struct pcpu_tstats local_stats;
 297                 unsigned int start;
 298
 299                 percpu_stats = per_cpu_ptr(vport->percpu_stats, i);
 300
 301                 do {
 302                         start = u64_stats_fetch_begin_bh(&percpu_stats->syncp);
 303                         local_stats = *percpu_stats;
 304                 } while (u64_stats_fetch_retry_bh(&percpu_stats->syncp, start));
 305
 306                 stats->rx_bytes         += local_stats.rx_bytes;
 307                 stats->rx_packets       += local_stats.rx_packets;
 308                 stats->tx_bytes         += local_stats.tx_bytes;
 309                 stats->tx_packets       += local_stats.tx_packets;
 310         }
 311 }
 312
 313 /**
 314  *      ovs_vport_get_options - retrieve device options
 315  *
 316  * @vport: vport from which to retrieve the options.
 317  * @skb: sk_buff where options should be appended.
 318  *
 319  * Retrieves the configuration of the given device, appending an
 320  * %OVS_VPORT_ATTR_OPTIONS attribute that in turn contains nested
 321  * vport-specific attributes to @skb.
 322  *
 323  * Returns 0 if successful, -EMSGSIZE if @skb has insufficient room, or another
 324  * negative error code if a real error occurred.  If an error occurs, @skb is
 325  * left unmodified.
 326  *
 327  * Must be called with ovs_mutex or rcu_read_lock.
 328  */
 329 int ovs_vport_get_options(const struct vport *vport, struct sk_buff *skb)
 330 {
 331         struct nlattr *nla;
 332         int err;
 333
 334         if (!vport->ops->get_options)
 335                 return 0;
 336
 337         nla = nla_nest_start(skb, OVS_VPORT_ATTR_OPTIONS);
 338         if (!nla)
 339                 return -EMSGSIZE;
 340
 341         err = vport->ops->get_options(vport, skb);
 342         if (err) {
 343                 nla_nest_cancel(skb, nla);
 344                 return err;
 345         }
 346
 347         nla_nest_end(skb, nla);
 348         return 0;
 349 }
 350
 351 /**
 352  *      ovs_vport_receive - pass up received packet to the datapath for processing
 353  *
 354  * @vport: vport that received the packet
 355  * @skb: skb that was received
 356  * @tun_key: tunnel (if any) that carried packet
 357  *
 358  * Must be called with rcu_read_lock.  The packet cannot be shared and
 359  * skb->data should point to the Ethernet header.  The caller must have already
 360  * called compute_ip_summed() to initialize the checksumming fields.
 361  */
 362 void ovs_vport_receive(struct vport *vport, struct sk_buff *skb,
 363                        struct ovs_key_ipv4_tunnel *tun_key)
 364 {
 365         struct pcpu_tstats *stats;
 366
 367         stats = this_cpu_ptr(vport->percpu_stats);
 368         u64_stats_update_begin(&stats->syncp);
 369         stats->rx_packets++;
 370         stats->rx_bytes += skb->len;
 371         u64_stats_update_end(&stats->syncp);
 372
 373         OVS_CB(skb)->tun_key = tun_key;
 374         ovs_dp_process_received_packet(vport, skb);
 375 }
 376
 377 /**
 378  *      ovs_vport_send - send a packet on a device
 379  *
 380  * @vport: vport on which to send the packet
 381  * @skb: skb to send
 382  *
 383  * Sends the given packet and returns the length of data sent.  Either ovs
 384  * lock or rcu_read_lock must be held.
 385  */
 386 int ovs_vport_send(struct vport *vport, struct sk_buff *skb)
 387 {
 388         int sent = vport->ops->send(vport, skb);
 389
 390         if (likely(sent > 0)) {
 391                 struct pcpu_tstats *stats;
 392
 393                 stats = this_cpu_ptr(vport->percpu_stats);
 394
 395                 u64_stats_update_begin(&stats->syncp);
 396                 stats->tx_packets++;
 397                 stats->tx_bytes += sent;
 398                 u64_stats_update_end(&stats->syncp);
 399         } else if (sent < 0) {
 400                 ovs_vport_record_error(vport, VPORT_E_TX_ERROR);
 401                 kfree_skb(skb);
 402         } else
 403                 ovs_vport_record_error(vport, VPORT_E_TX_DROPPED);
 404
 405         return sent;
 406 }
 407
 408 /**
 409  *      ovs_vport_record_error - indicate device error to generic stats layer
 410  *
 411  * @vport: vport that encountered the error
 412  * @err_type: one of enum vport_err_type types to indicate the error type
 413  *
 414  * If using the vport generic stats layer indicate that an error of the given
 415  * type has occurred.
 416  */
 417 static void ovs_vport_record_error(struct vport *vport,
 418                                    enum vport_err_type err_type)
 419 {
 420         spin_lock(&vport->stats_lock);
 421
 422         switch (err_type) {
 423         case VPORT_E_RX_DROPPED:
 424                 vport->err_stats.rx_dropped++;
 425                 break;
 426
 427         case VPORT_E_RX_ERROR:
 428                 vport->err_stats.rx_errors++;
 429                 break;
 430
 431         case VPORT_E_TX_DROPPED:
 432                 vport->err_stats.tx_dropped++;
 433                 break;
 434
 435         case VPORT_E_TX_ERROR:
 436                 vport->err_stats.tx_errors++;
 437                 break;
 438         }
 439
 440         spin_unlock(&vport->stats_lock);
 441 }
 442
 443 static void free_vport_rcu(struct rcu_head *rcu)
 444 {
 445         struct vport *vport = container_of(rcu, struct vport, rcu);
 446
 447         ovs_vport_free(vport);
 448 }
 449
 450 void ovs_vport_deferred_free(struct vport *vport)
 451 {
 452         if (!vport)
 453                 return;
 454
 455         call_rcu(&vport->rcu, free_vport_rcu);
 456 }