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->ops = ops;
 140         INIT_HLIST_NODE(&vport->dp_hash_node);
 141
 142         if (ovs_vport_set_upcall_portids(vport, parms->upcall_portids))
 143                 return ERR_PTR(-EINVAL);
 144
 145         vport->percpu_stats = alloc_percpu(struct pcpu_sw_netstats);
 146         if (!vport->percpu_stats) {
 147                 kfree(vport);
 148                 return ERR_PTR(-ENOMEM);
 149         }
 150
 151         for_each_possible_cpu(i) {
 152                 struct pcpu_sw_netstats *vport_stats;
 153                 vport_stats = per_cpu_ptr(vport->percpu_stats, i);
 154                 u64_stats_init(&vport_stats->syncp);
 155         }
 156
 157         spin_lock_init(&vport->stats_lock);
 158
 159         return vport;
 160 }
 161
 162 /**
 163  *      ovs_vport_free - uninitialize and free vport
 164  *
 165  * @vport: vport to free
 166  *
 167  * Frees a vport allocated with ovs_vport_alloc() when it is no longer needed.
 168  *
 169  * The caller must ensure that an RCU grace period has passed since the last
 170  * time @vport was in a datapath.
 171  */
 172 void ovs_vport_free(struct vport *vport)
 173 {
 174         kfree((struct vport_portids __force *)vport->upcall_portids);
 175         free_percpu(vport->percpu_stats);
 176         kfree(vport);
 177 }
 178
 179 /**
 180  *      ovs_vport_add - add vport device (for kernel callers)
 181  *
 182  * @parms: Information about new vport.
 183  *
 184  * Creates a new vport with the specified configuration (which is dependent on
 185  * device type).  ovs_mutex must be held.
 186  */
 187 struct vport *ovs_vport_add(const struct vport_parms *parms)
 188 {
 189         struct vport *vport;
 190         int err = 0;
 191         int i;
 192
 193         for (i = 0; i < ARRAY_SIZE(vport_ops_list); i++) {
 194                 if (vport_ops_list[i]->type == parms->type) {
 195                         struct hlist_head *bucket;
 196
 197                         vport = vport_ops_list[i]->create(parms);
 198                         if (IS_ERR(vport)) {
 199                                 err = PTR_ERR(vport);
 200                                 goto out;
 201                         }
 202
 203                         bucket = hash_bucket(ovs_dp_get_net(vport->dp),
 204                                              vport->ops->get_name(vport));
 205                         hlist_add_head_rcu(&vport->hash_node, bucket);
 206                         return vport;
 207                 }
 208         }
 209
 210         err = -EAFNOSUPPORT;
 211
 212 out:
 213         return ERR_PTR(err);
 214 }
 215
 216 /**
 217  *      ovs_vport_set_options - modify existing vport device (for kernel callers)
 218  *
 219  * @vport: vport to modify.
 220  * @options: New configuration.
 221  *
 222  * Modifies an existing device with the specified configuration (which is
 223  * dependent on device type).  ovs_mutex must be held.
 224  */
 225 int ovs_vport_set_options(struct vport *vport, struct nlattr *options)
 226 {
 227         if (!vport->ops->set_options)
 228                 return -EOPNOTSUPP;
 229         return vport->ops->set_options(vport, options);
 230 }
 231
 232 /**
 233  *      ovs_vport_del - delete existing vport device
 234  *
 235  * @vport: vport to delete.
 236  *
 237  * Detaches @vport from its datapath and destroys it.  It is possible to fail
 238  * for reasons such as lack of memory.  ovs_mutex must be held.
 239  */
 240 void ovs_vport_del(struct vport *vport)
 241 {
 242         ASSERT_OVSL();
 243
 244         hlist_del_rcu(&vport->hash_node);
 245         vport->ops->destroy(vport);
 246 }
 247
 248 /**
 249  *      ovs_vport_set_stats - sets offset device stats
 250  *
 251  * @vport: vport on which to set stats
 252  * @stats: stats to set
 253  *
 254  * Provides a set of transmit, receive, and error stats to be added as an
 255  * offset to the collected data when stats are retrieved.  Some devices may not
 256  * support setting the stats, in which case the result will always be
 257  * -EOPNOTSUPP.
 258  *
 259  * Must be called with ovs_mutex.
 260  */
 261 void ovs_vport_set_stats(struct vport *vport, struct ovs_vport_stats *stats)
 262 {
 263         spin_lock_bh(&vport->stats_lock);
 264         vport->offset_stats = *stats;
 265         spin_unlock_bh(&vport->stats_lock);
 266 }
 267
 268 /**
 269  *      ovs_vport_get_stats - retrieve device stats
 270  *
 271  * @vport: vport from which to retrieve the stats
 272  * @stats: location to store stats
 273  *
 274  * Retrieves transmit, receive, and error stats for the given device.
 275  *
 276  * Must be called with ovs_mutex or rcu_read_lock.
 277  */
 278 void ovs_vport_get_stats(struct vport *vport, struct ovs_vport_stats *stats)
 279 {
 280         int i;
 281
 282         /* We potentially have 3 sources of stats that need to be
 283          * combined: those we have collected (split into err_stats and
 284          * percpu_stats), offset_stats from set_stats(), and device
 285          * error stats from netdev->get_stats() (for errors that happen
 286          * downstream and therefore aren't reported through our
 287          * vport_record_error() function).
 288          * Stats from first two sources are merged and reported by ovs over
 289          * OVS_VPORT_ATTR_STATS.
 290          * netdev-stats can be directly read over netlink-ioctl.
 291          */
 292
 293         spin_lock_bh(&vport->stats_lock);
 294
 295         *stats = vport->offset_stats;
 296
 297         stats->rx_errors        += vport->err_stats.rx_errors;
 298         stats->tx_errors        += vport->err_stats.tx_errors;
 299         stats->tx_dropped       += vport->err_stats.tx_dropped;
 300         stats->rx_dropped       += vport->err_stats.rx_dropped;
 301
 302         spin_unlock_bh(&vport->stats_lock);
 303
 304         for_each_possible_cpu(i) {
 305                 const struct pcpu_sw_netstats *percpu_stats;
 306                 struct pcpu_sw_netstats local_stats;
 307                 unsigned int start;
 308
 309                 percpu_stats = per_cpu_ptr(vport->percpu_stats, i);
 310
 311                 do {
 312                         start = u64_stats_fetch_begin_irq(&percpu_stats->syncp);
 313                         local_stats = *percpu_stats;
 314                 } while (u64_stats_fetch_retry_irq(&percpu_stats->syncp, start));
 315
 316                 stats->rx_bytes         += local_stats.rx_bytes;
 317                 stats->rx_packets       += local_stats.rx_packets;
 318                 stats->tx_bytes         += local_stats.tx_bytes;
 319                 stats->tx_packets       += local_stats.tx_packets;
 320         }
 321 }
 322
 323 /**
 324  *      ovs_vport_get_options - retrieve device options
 325  *
 326  * @vport: vport from which to retrieve the options.
 327  * @skb: sk_buff where options should be appended.
 328  *
 329  * Retrieves the configuration of the given device, appending an
 330  * %OVS_VPORT_ATTR_OPTIONS attribute that in turn contains nested
 331  * vport-specific attributes to @skb.
 332  *
 333  * Returns 0 if successful, -EMSGSIZE if @skb has insufficient room, or another
 334  * negative error code if a real error occurred.  If an error occurs, @skb is
 335  * left unmodified.
 336  *
 337  * Must be called with ovs_mutex or rcu_read_lock.
 338  */
 339 int ovs_vport_get_options(const struct vport *vport, struct sk_buff *skb)
 340 {
 341         struct nlattr *nla;
 342         int err;
 343
 344         if (!vport->ops->get_options)
 345                 return 0;
 346
 347         nla = nla_nest_start(skb, OVS_VPORT_ATTR_OPTIONS);
 348         if (!nla)
 349                 return -EMSGSIZE;
 350
 351         err = vport->ops->get_options(vport, skb);
 352         if (err) {
 353                 nla_nest_cancel(skb, nla);
 354                 return err;
 355         }
 356
 357         nla_nest_end(skb, nla);
 358         return 0;
 359 }
 360
 361 static void vport_portids_destroy_rcu_cb(struct rcu_head *rcu)
 362 {
 363         struct vport_portids *ids = container_of(rcu, struct vport_portids,
 364                                                  rcu);
 365
 366         kfree(ids);
 367 }
 368
 369 /**
 370  *      ovs_vport_set_upcall_portids - set upcall portids of @vport.
 371  *
 372  * @vport: vport to modify.
 373  * @ids: new configuration, an array of port ids.
 374  *
 375  * Sets the vport's upcall_portids to @ids.
 376  *
 377  * Returns 0 if successful, -EINVAL if @ids is zero length or cannot be parsed
 378  * as an array of U32.
 379  *
 380  * Must be called with ovs_mutex.
 381  */
 382 int ovs_vport_set_upcall_portids(struct vport *vport,  struct nlattr *ids)
 383 {
 384         struct vport_portids *old, *vport_portids;
 385
 386         if (!nla_len(ids) || nla_len(ids) % sizeof(u32))
 387                 return -EINVAL;
 388
 389         old = ovsl_dereference(vport->upcall_portids);
 390
 391         vport_portids = kmalloc(sizeof *vport_portids + nla_len(ids),
 392                                 GFP_KERNEL);
 393         if (!vport_portids)
 394                 return -ENOMEM;
 395
 396         vport_portids->n_ids = nla_len(ids) / sizeof(u32);
 397         vport_portids->rn_ids = reciprocal_value(vport_portids->n_ids);
 398         nla_memcpy(vport_portids->ids, ids, nla_len(ids));
 399
 400         rcu_assign_pointer(vport->upcall_portids, vport_portids);
 401
 402         if (old)
 403                 call_rcu(&old->rcu, vport_portids_destroy_rcu_cb);
 404
 405         return 0;
 406 }
 407
 408 /**
 409  *      ovs_vport_get_upcall_portids - get the upcall_portids of @vport.
 410  *
 411  * @vport: vport from which to retrieve the portids.
 412  * @skb: sk_buff where portids should be appended.
 413  *
 414  * Retrieves the configuration of the given vport, appending the
 415  * %OVS_VPORT_ATTR_UPCALL_PID attribute which is the array of upcall
 416  * portids to @skb.
 417  *
 418  * Returns 0 if successful, -EMSGSIZE if @skb has insufficient room.
 419  * If an error occurs, @skb is left unmodified.  Must be called with
 420  * ovs_mutex or rcu_read_lock.
 421  */
 422 int ovs_vport_get_upcall_portids(const struct vport *vport,
 423                                  struct sk_buff *skb)
 424 {
 425         struct vport_portids *ids;
 426
 427         ids = rcu_dereference_ovsl(vport->upcall_portids);
 428
 429         if (vport->dp->user_features & OVS_DP_F_VPORT_PIDS)
 430                 return nla_put(skb, OVS_VPORT_ATTR_UPCALL_PID,
 431                                ids->n_ids * sizeof(u32), (void *) ids->ids);
 432         else
 433                 return nla_put_u32(skb, OVS_VPORT_ATTR_UPCALL_PID, ids->ids[0]);
 434 }
 435
 436 /**
 437  *      ovs_vport_find_upcall_portid - find the upcall portid to send upcall.
 438  *
 439  * @vport: vport from which the missed packet is received.
 440  * @skb: skb that the missed packet was received.
 441  *
 442  * Uses the skb_get_hash() to select the upcall portid to send the
 443  * upcall.
 444  *
 445  * Returns the portid of the target socket.  Must be called with rcu_read_lock.
 446  */
 447 u32 ovs_vport_find_upcall_portid(const struct vport *p, struct sk_buff *skb)
 448 {
 449         struct vport_portids *ids;
 450         u32 hash;
 451
 452         ids = rcu_dereference(p->upcall_portids);
 453
 454         if (ids->n_ids == 1 && ids->ids[0] == 0)
 455                 return 0;
 456
 457         hash = skb_get_hash(skb);
 458         return ids->ids[hash - ids->n_ids * reciprocal_divide(hash, ids->rn_ids)];
 459 }
 460
 461 /**
 462  *      ovs_vport_receive - pass up received packet to the datapath for processing
 463  *
 464  * @vport: vport that received the packet
 465  * @skb: skb that was received
 466  * @tun_key: tunnel (if any) that carried packet
 467  *
 468  * Must be called with rcu_read_lock.  The packet cannot be shared and
 469  * skb->data should point to the Ethernet header.  The caller must have already
 470  * called compute_ip_summed() to initialize the checksumming fields.
 471  */
 472 void ovs_vport_receive(struct vport *vport, struct sk_buff *skb,
 473                        struct ovs_key_ipv4_tunnel *tun_key)
 474 {
 475         struct pcpu_sw_netstats *stats;
 476
 477         stats = this_cpu_ptr(vport->percpu_stats);
 478         u64_stats_update_begin(&stats->syncp);
 479         stats->rx_packets++;
 480         stats->rx_bytes += skb->len;
 481         u64_stats_update_end(&stats->syncp);
 482
 483         OVS_CB(skb)->tun_key = tun_key;
 484         ovs_dp_process_received_packet(vport, skb);
 485 }
 486
 487 /**
 488  *      ovs_vport_send - send a packet on a device
 489  *
 490  * @vport: vport on which to send the packet
 491  * @skb: skb to send
 492  *
 493  * Sends the given packet and returns the length of data sent.  Either ovs
 494  * lock or rcu_read_lock must be held.
 495  */
 496 int ovs_vport_send(struct vport *vport, struct sk_buff *skb)
 497 {
 498         int sent = vport->ops->send(vport, skb);
 499
 500         if (likely(sent > 0)) {
 501                 struct pcpu_sw_netstats *stats;
 502
 503                 stats = this_cpu_ptr(vport->percpu_stats);
 504
 505                 u64_stats_update_begin(&stats->syncp);
 506                 stats->tx_packets++;
 507                 stats->tx_bytes += sent;
 508                 u64_stats_update_end(&stats->syncp);
 509         } else if (sent < 0) {
 510                 ovs_vport_record_error(vport, VPORT_E_TX_ERROR);
 511                 kfree_skb(skb);
 512         } else
 513                 ovs_vport_record_error(vport, VPORT_E_TX_DROPPED);
 514
 515         return sent;
 516 }
 517
 518 /**
 519  *      ovs_vport_record_error - indicate device error to generic stats layer
 520  *
 521  * @vport: vport that encountered the error
 522  * @err_type: one of enum vport_err_type types to indicate the error type
 523  *
 524  * If using the vport generic stats layer indicate that an error of the given
 525  * type has occurred.
 526  */
 527 static void ovs_vport_record_error(struct vport *vport,
 528                                    enum vport_err_type err_type)
 529 {
 530         spin_lock(&vport->stats_lock);
 531
 532         switch (err_type) {
 533         case VPORT_E_RX_DROPPED:
 534                 vport->err_stats.rx_dropped++;
 535                 break;
 536
 537         case VPORT_E_RX_ERROR:
 538                 vport->err_stats.rx_errors++;
 539                 break;
 540
 541         case VPORT_E_TX_DROPPED:
 542                 vport->err_stats.tx_dropped++;
 543                 break;
 544
 545         case VPORT_E_TX_ERROR:
 546                 vport->err_stats.tx_errors++;
 547                 break;
 548         }
 549
 550         spin_unlock(&vport->stats_lock);
 551 }
 552
 553 static void free_vport_rcu(struct rcu_head *rcu)
 554 {
 555         struct vport *vport = container_of(rcu, struct vport, rcu);
 556
 557         ovs_vport_free(vport);
 558 }
 559
 560 void ovs_vport_deferred_free(struct vport *vport)
 561 {
 562         if (!vport)
 563                 return;
 564
 565         call_rcu(&vport->rcu, free_vport_rcu);
 566 }