net/openvswitch/vport.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * Copyright (c) 2007-2014 Nicira, Inc.
   4  */
   5
   6 #include <linux/etherdevice.h>
   7 #include <linux/if.h>
   8 #include <linux/if_vlan.h>
   9 #include <linux/jhash.h>
  10 #include <linux/kernel.h>
  11 #include <linux/list.h>
  12 #include <linux/mutex.h>
  13 #include <linux/percpu.h>
  14 #include <linux/rcupdate.h>
  15 #include <linux/rtnetlink.h>
  16 #include <linux/compat.h>
  17 #include <net/net_namespace.h>
  18 #include <linux/module.h>
  19
  20 #include "datapath.h"
  21 #include "vport.h"
  22 #include "vport-internal_dev.h"
  23
  24 static LIST_HEAD(vport_ops_list);
  25
  26 /* Protected by RCU read lock for reading, ovs_mutex for writing. */
  27 static struct hlist_head *dev_table;
  28 #define VPORT_HASH_BUCKETS 1024
  29
  30 /**
  31  *      ovs_vport_init - initialize vport subsystem
  32  *
  33  * Called at module load time to initialize the vport subsystem.
  34  */
  35 int ovs_vport_init(void)
  36 {
  37         dev_table = kcalloc(VPORT_HASH_BUCKETS, sizeof(struct hlist_head),
  38                             GFP_KERNEL);
  39         if (!dev_table)
  40                 return -ENOMEM;
  41
  42         return 0;
  43 }
  44
  45 /**
  46  *      ovs_vport_exit - shutdown vport subsystem
  47  *
  48  * Called at module exit time to shutdown the vport subsystem.
  49  */
  50 void ovs_vport_exit(void)
  51 {
  52         kfree(dev_table);
  53 }
  54
  55 static struct hlist_head *hash_bucket(const struct net *net, const char *name)
  56 {
  57         unsigned int hash = jhash(name, strlen(name), (unsigned long) net);
  58         return &dev_table[hash & (VPORT_HASH_BUCKETS - 1)];
  59 }
  60
  61 int __ovs_vport_ops_register(struct vport_ops *ops)
  62 {
  63         int err = -EEXIST;
  64         struct vport_ops *o;
  65
  66         ovs_lock();
  67         list_for_each_entry(o, &vport_ops_list, list)
  68                 if (ops->type == o->type)
  69                         goto errout;
  70
  71         list_add_tail(&ops->list, &vport_ops_list);
  72         err = 0;
  73 errout:
  74         ovs_unlock();
  75         return err;
  76 }
  77 EXPORT_SYMBOL_GPL(__ovs_vport_ops_register);
  78
  79 void ovs_vport_ops_unregister(struct vport_ops *ops)
  80 {
  81         ovs_lock();
  82         list_del(&ops->list);
  83         ovs_unlock();
  84 }
  85 EXPORT_SYMBOL_GPL(ovs_vport_ops_unregister);
  86
  87 /**
  88  *      ovs_vport_locate - find a port that has already been created
  89  *
  90  * @name: name of port to find
  91  *
  92  * Must be called with ovs or RCU read lock.
  93  */
  94 struct vport *ovs_vport_locate(const struct net *net, const char *name)
  95 {
  96         struct hlist_head *bucket = hash_bucket(net, name);
  97         struct vport *vport;
  98
  99         hlist_for_each_entry_rcu(vport, bucket, hash_node,
 100                                 lockdep_ovsl_is_held())
 101                 if (!strcmp(name, ovs_vport_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                 kfree(vport);
 142                 return ERR_PTR(-EINVAL);
 143         }
 144
 145         return vport;
 146 }
 147 EXPORT_SYMBOL_GPL(ovs_vport_alloc);
 148
 149 /**
 150  *      ovs_vport_free - uninitialize and free vport
 151  *
 152  * @vport: vport to free
 153  *
 154  * Frees a vport allocated with vport_alloc() when it is no longer needed.
 155  *
 156  * The caller must ensure that an RCU grace period has passed since the last
 157  * time @vport was in a datapath.
 158  */
 159 void ovs_vport_free(struct vport *vport)
 160 {
 161         /* vport is freed from RCU callback or error path, Therefore
 162          * it is safe to use raw dereference.
 163          */
 164         kfree(rcu_dereference_raw(vport->upcall_portids));
 165         kfree(vport);
 166 }
 167 EXPORT_SYMBOL_GPL(ovs_vport_free);
 168
 169 static struct vport_ops *ovs_vport_lookup(const struct vport_parms *parms)
 170 {
 171         struct vport_ops *ops;
 172
 173         list_for_each_entry(ops, &vport_ops_list, list)
 174                 if (ops->type == parms->type)
 175                         return ops;
 176
 177         return NULL;
 178 }
 179
 180 /**
 181  *      ovs_vport_add - add vport device (for kernel callers)
 182  *
 183  * @parms: Information about new vport.
 184  *
 185  * Creates a new vport with the specified configuration (which is dependent on
 186  * device type).  ovs_mutex must be held.
 187  */
 188 struct vport *ovs_vport_add(const struct vport_parms *parms)
 189 {
 190         struct vport_ops *ops;
 191         struct vport *vport;
 192
 193         ops = ovs_vport_lookup(parms);
 194         if (ops) {
 195                 struct hlist_head *bucket;
 196
 197                 if (!try_module_get(ops->owner))
 198                         return ERR_PTR(-EAFNOSUPPORT);
 199
 200                 vport = ops->create(parms);
 201                 if (IS_ERR(vport)) {
 202                         module_put(ops->owner);
 203                         return vport;
 204                 }
 205
 206                 bucket = hash_bucket(ovs_dp_get_net(vport->dp),
 207                                      ovs_vport_name(vport));
 208                 hlist_add_head_rcu(&vport->hash_node, bucket);
 209                 return vport;
 210         }
 211
 212         /* Unlock to attempt module load and return -EAGAIN if load
 213          * was successful as we need to restart the port addition
 214          * workflow.
 215          */
 216         ovs_unlock();
 217         request_module("vport-type-%d", parms->type);
 218         ovs_lock();
 219
 220         if (!ovs_vport_lookup(parms))
 221                 return ERR_PTR(-EAFNOSUPPORT);
 222         else
 223                 return ERR_PTR(-EAGAIN);
 224 }
 225
 226 /**
 227  *      ovs_vport_set_options - modify existing vport device (for kernel callers)
 228  *
 229  * @vport: vport to modify.
 230  * @options: New configuration.
 231  *
 232  * Modifies an existing device with the specified configuration (which is
 233  * dependent on device type).  ovs_mutex must be held.
 234  */
 235 int ovs_vport_set_options(struct vport *vport, struct nlattr *options)
 236 {
 237         if (!vport->ops->set_options)
 238                 return -EOPNOTSUPP;
 239         return vport->ops->set_options(vport, options);
 240 }
 241
 242 /**
 243  *      ovs_vport_del - delete existing vport device
 244  *
 245  * @vport: vport to delete.
 246  *
 247  * Detaches @vport from its datapath and destroys it.  ovs_mutex must
 248  * be held.
 249  */
 250 void ovs_vport_del(struct vport *vport)
 251 {
 252         hlist_del_rcu(&vport->hash_node);
 253         module_put(vport->ops->owner);
 254         vport->ops->destroy(vport);
 255 }
 256
 257 /**
 258  *      ovs_vport_get_stats - retrieve device stats
 259  *
 260  * @vport: vport from which to retrieve the stats
 261  * @stats: location to store stats
 262  *
 263  * Retrieves transmit, receive, and error stats for the given device.
 264  *
 265  * Must be called with ovs_mutex or rcu_read_lock.
 266  */
 267 void ovs_vport_get_stats(struct vport *vport, struct ovs_vport_stats *stats)
 268 {
 269         const struct rtnl_link_stats64 *dev_stats;
 270         struct rtnl_link_stats64 temp;
 271
 272         dev_stats = dev_get_stats(vport->dev, &temp);
 273         stats->rx_errors  = dev_stats->rx_errors;
 274         stats->tx_errors  = dev_stats->tx_errors;
 275         stats->tx_dropped = dev_stats->tx_dropped;
 276         stats->rx_dropped = dev_stats->rx_dropped;
 277
 278         stats->rx_bytes   = dev_stats->rx_bytes;
 279         stats->rx_packets = dev_stats->rx_packets;
 280         stats->tx_bytes   = dev_stats->tx_bytes;
 281         stats->tx_packets = dev_stats->tx_packets;
 282 }
 283
 284 /**
 285  *      ovs_vport_get_options - retrieve device options
 286  *
 287  * @vport: vport from which to retrieve the options.
 288  * @skb: sk_buff where options should be appended.
 289  *
 290  * Retrieves the configuration of the given device, appending an
 291  * %OVS_VPORT_ATTR_OPTIONS attribute that in turn contains nested
 292  * vport-specific attributes to @skb.
 293  *
 294  * Returns 0 if successful, -EMSGSIZE if @skb has insufficient room, or another
 295  * negative error code if a real error occurred.  If an error occurs, @skb is
 296  * left unmodified.
 297  *
 298  * Must be called with ovs_mutex or rcu_read_lock.
 299  */
 300 int ovs_vport_get_options(const struct vport *vport, struct sk_buff *skb)
 301 {
 302         struct nlattr *nla;
 303         int err;
 304
 305         if (!vport->ops->get_options)
 306                 return 0;
 307
 308         nla = nla_nest_start_noflag(skb, OVS_VPORT_ATTR_OPTIONS);
 309         if (!nla)
 310                 return -EMSGSIZE;
 311
 312         err = vport->ops->get_options(vport, skb);
 313         if (err) {
 314                 nla_nest_cancel(skb, nla);
 315                 return err;
 316         }
 317
 318         nla_nest_end(skb, nla);
 319         return 0;
 320 }
 321
 322 /**
 323  *      ovs_vport_set_upcall_portids - set upcall portids of @vport.
 324  *
 325  * @vport: vport to modify.
 326  * @ids: new configuration, an array of port ids.
 327  *
 328  * Sets the vport's upcall_portids to @ids.
 329  *
 330  * Returns 0 if successful, -EINVAL if @ids is zero length or cannot be parsed
 331  * as an array of U32.
 332  *
 333  * Must be called with ovs_mutex.
 334  */
 335 int ovs_vport_set_upcall_portids(struct vport *vport, const struct nlattr *ids)
 336 {
 337         struct vport_portids *old, *vport_portids;
 338
 339         if (!nla_len(ids) || nla_len(ids) % sizeof(u32))
 340                 return -EINVAL;
 341
 342         old = ovsl_dereference(vport->upcall_portids);
 343
 344         vport_portids = kmalloc(sizeof(*vport_portids) + nla_len(ids),
 345                                 GFP_KERNEL);
 346         if (!vport_portids)
 347                 return -ENOMEM;
 348
 349         vport_portids->n_ids = nla_len(ids) / sizeof(u32);
 350         vport_portids->rn_ids = reciprocal_value(vport_portids->n_ids);
 351         nla_memcpy(vport_portids->ids, ids, nla_len(ids));
 352
 353         rcu_assign_pointer(vport->upcall_portids, vport_portids);
 354
 355         if (old)
 356                 kfree_rcu(old, rcu);
 357         return 0;
 358 }
 359
 360 /**
 361  *      ovs_vport_get_upcall_portids - get the upcall_portids of @vport.
 362  *
 363  * @vport: vport from which to retrieve the portids.
 364  * @skb: sk_buff where portids should be appended.
 365  *
 366  * Retrieves the configuration of the given vport, appending the
 367  * %OVS_VPORT_ATTR_UPCALL_PID attribute which is the array of upcall
 368  * portids to @skb.
 369  *
 370  * Returns 0 if successful, -EMSGSIZE if @skb has insufficient room.
 371  * If an error occurs, @skb is left unmodified.  Must be called with
 372  * ovs_mutex or rcu_read_lock.
 373  */
 374 int ovs_vport_get_upcall_portids(const struct vport *vport,
 375                                  struct sk_buff *skb)
 376 {
 377         struct vport_portids *ids;
 378
 379         ids = rcu_dereference_ovsl(vport->upcall_portids);
 380
 381         if (vport->dp->user_features & OVS_DP_F_VPORT_PIDS)
 382                 return nla_put(skb, OVS_VPORT_ATTR_UPCALL_PID,
 383                                ids->n_ids * sizeof(u32), (void *)ids->ids);
 384         else
 385                 return nla_put_u32(skb, OVS_VPORT_ATTR_UPCALL_PID, ids->ids[0]);
 386 }
 387
 388 /**
 389  *      ovs_vport_find_upcall_portid - find the upcall portid to send upcall.
 390  *
 391  * @vport: vport from which the missed packet is received.
 392  * @skb: skb that the missed packet was received.
 393  *
 394  * Uses the skb_get_hash() to select the upcall portid to send the
 395  * upcall.
 396  *
 397  * Returns the portid of the target socket.  Must be called with rcu_read_lock.
 398  */
 399 u32 ovs_vport_find_upcall_portid(const struct vport *vport, struct sk_buff *skb)
 400 {
 401         struct vport_portids *ids;
 402         u32 ids_index;
 403         u32 hash;
 404
 405         ids = rcu_dereference(vport->upcall_portids);
 406
 407         /* If there is only one portid, select it in the fast-path. */
 408         if (ids->n_ids == 1)
 409                 return ids->ids[0];
 410
 411         hash = skb_get_hash(skb);
 412         ids_index = hash - ids->n_ids * reciprocal_divide(hash, ids->rn_ids);
 413         return ids->ids[ids_index];
 414 }
 415
 416 /**
 417  *      ovs_vport_receive - pass up received packet to the datapath for processing
 418  *
 419  * @vport: vport that received the packet
 420  * @skb: skb that was received
 421  * @tun_key: tunnel (if any) that carried packet
 422  *
 423  * Must be called with rcu_read_lock.  The packet cannot be shared and
 424  * skb->data should point to the Ethernet header.
 425  */
 426 int ovs_vport_receive(struct vport *vport, struct sk_buff *skb,
 427                       const struct ip_tunnel_info *tun_info)
 428 {
 429         struct sw_flow_key key;
 430         int error;
 431
 432         OVS_CB(skb)->input_vport = vport;
 433         OVS_CB(skb)->mru = 0;
 434         OVS_CB(skb)->cutlen = 0;
 435         if (unlikely(dev_net(skb->dev) != ovs_dp_get_net(vport->dp))) {
 436                 u32 mark;
 437
 438                 mark = skb->mark;
 439                 skb_scrub_packet(skb, true);
 440                 skb->mark = mark;
 441                 tun_info = NULL;
 442         }
 443
 444         /* Extract flow from 'skb' into 'key'. */
 445         error = ovs_flow_key_extract(tun_info, skb, &key);
 446         if (unlikely(error)) {
 447                 kfree_skb(skb);
 448                 return error;
 449         }
 450         ovs_dp_process_packet(skb, &key);
 451         return 0;
 452 }
 453
 454 static int packet_length(const struct sk_buff *skb,
 455                          struct net_device *dev)
 456 {
 457         int length = skb->len - dev->hard_header_len;
 458
 459         if (!skb_vlan_tag_present(skb) &&
 460             eth_type_vlan(skb->protocol))
 461                 length -= VLAN_HLEN;
 462
 463         /* Don't subtract for multiple VLAN tags. Most (all?) drivers allow
 464          * (ETH_LEN + VLAN_HLEN) in addition to the mtu value, but almost none
 465          * account for 802.1ad. e.g. is_skb_forwardable().
 466          */
 467
 468         return length > 0 ? length : 0;
 469 }
 470
 471 void ovs_vport_send(struct vport *vport, struct sk_buff *skb, u8 mac_proto)
 472 {
 473         int mtu = vport->dev->mtu;
 474
 475         switch (vport->dev->type) {
 476         case ARPHRD_NONE:
 477                 if (mac_proto == MAC_PROTO_ETHERNET) {
 478                         skb_reset_network_header(skb);
 479                         skb_reset_mac_len(skb);
 480                         skb->protocol = htons(ETH_P_TEB);
 481                 } else if (mac_proto != MAC_PROTO_NONE) {
 482                         WARN_ON_ONCE(1);
 483                         goto drop;
 484                 }
 485                 break;
 486         case ARPHRD_ETHER:
 487                 if (mac_proto != MAC_PROTO_ETHERNET)
 488                         goto drop;
 489                 break;
 490         default:
 491                 goto drop;
 492         }
 493
 494         if (unlikely(packet_length(skb, vport->dev) > mtu &&
 495                      !skb_is_gso(skb))) {
 496                 net_warn_ratelimited("%s: dropped over-mtu packet: %d > %d\n",
 497                                      vport->dev->name,
 498                                      packet_length(skb, vport->dev), mtu);
 499                 vport->dev->stats.tx_errors++;
 500                 goto drop;
 501         }
 502
 503         skb->dev = vport->dev;
 504         vport->ops->send(skb);
 505         return;
 506
 507 drop:
 508         kfree_skb(skb);
 509 }