net/openvswitch/vport.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * Copyright (c) 2007-2012 Nicira, Inc.
   4  */
   5
   6 #ifndef VPORT_H
   7 #define VPORT_H 1
   8
   9 #include <linux/if_tunnel.h>
  10 #include <linux/list.h>
  11 #include <linux/netlink.h>
  12 #include <linux/openvswitch.h>
  13 #include <linux/reciprocal_div.h>
  14 #include <linux/skbuff.h>
  15 #include <linux/spinlock.h>
  16 #include <linux/u64_stats_sync.h>
  17
  18 #include "datapath.h"
  19
  20 struct vport;
  21 struct vport_parms;
  22
  23 /* The following definitions are for users of the vport subsystem: */
  24
  25 int ovs_vport_init(void);
  26 void ovs_vport_exit(void);
  27
  28 struct vport *ovs_vport_add(const struct vport_parms *);
  29 void ovs_vport_del(struct vport *);
  30
  31 struct vport *ovs_vport_locate(const struct net *net, const char *name);
  32
  33 void ovs_vport_get_stats(struct vport *, struct ovs_vport_stats *);
  34
  35 int ovs_vport_set_options(struct vport *, struct nlattr *options);
  36 int ovs_vport_get_options(const struct vport *, struct sk_buff *);
  37
  38 int ovs_vport_set_upcall_portids(struct vport *, const struct nlattr *pids);
  39 int ovs_vport_get_upcall_portids(const struct vport *, struct sk_buff *);
  40 u32 ovs_vport_find_upcall_portid(const struct vport *, struct sk_buff *);
  41
  42 /**
  43  * struct vport_portids - array of netlink portids of a vport.
  44  *                        must be protected by rcu.
  45  * @rn_ids: The reciprocal value of @n_ids.
  46  * @rcu: RCU callback head for deferred destruction.
  47  * @n_ids: Size of @ids array.
  48  * @ids: Array storing the Netlink socket pids to be used for packets received
  49  * on this port that miss the flow table.
  50  */
  51 struct vport_portids {
  52         struct reciprocal_value rn_ids;
  53         struct rcu_head rcu;
  54         u32 n_ids;
  55         u32 ids[];
  56 };
  57
  58 /**
  59  * struct vport - one port within a datapath
  60  * @dev: Pointer to net_device.
  61  * @dev_tracker: refcount tracker for @dev reference
  62  * @dp: Datapath to which this port belongs.
  63  * @upcall_portids: RCU protected 'struct vport_portids'.
  64  * @port_no: Index into @dp's @ports array.
  65  * @hash_node: Element in @dev_table hash table in vport.c.
  66  * @dp_hash_node: Element in @datapath->ports hash table in datapath.c.
  67  * @ops: Class structure.
  68  * @detach_list: list used for detaching vport in net-exit call.
  69  * @rcu: RCU callback head for deferred destruction.
  70  */
  71 struct vport {
  72         struct net_device *dev;
  73         netdevice_tracker dev_tracker;
  74         struct datapath *dp;
  75         struct vport_portids __rcu *upcall_portids;
  76         u16 port_no;
  77
  78         struct hlist_node hash_node;
  79         struct hlist_node dp_hash_node;
  80         const struct vport_ops *ops;
  81
  82         struct list_head detach_list;
  83         struct rcu_head rcu;
  84 };
  85
  86 /**
  87  * struct vport_parms - parameters for creating a new vport
  88  *
  89  * @name: New vport's name.
  90  * @type: New vport's type.
  91  * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if
  92  * none was supplied.
  93  * @dp: New vport's datapath.
  94  * @port_no: New vport's port number.
  95  */
  96 struct vport_parms {
  97         const char *name;
  98         enum ovs_vport_type type;
  99         struct nlattr *options;
 100
 101         /* For ovs_vport_alloc(). */
 102         struct datapath *dp;
 103         u16 port_no;
 104         struct nlattr *upcall_portids;
 105 };
 106
 107 /**
 108  * struct vport_ops - definition of a type of virtual port
 109  *
 110  * @type: %OVS_VPORT_TYPE_* value for this type of virtual port.
 111  * @create: Create a new vport configured as specified.  On success returns
 112  * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value.
 113  * @destroy: Destroys a vport.  Must call vport_free() on the vport but not
 114  * before an RCU grace period has elapsed.
 115  * @set_options: Modify the configuration of an existing vport.  May be %NULL
 116  * if modification is not supported.
 117  * @get_options: Appends vport-specific attributes for the configuration of an
 118  * existing vport to a &struct sk_buff.  May be %NULL for a vport that does not
 119  * have any configuration.
 120  * @send: Send a packet on the device.
 121  * zero for dropped packets or negative for error.
 122  */
 123 struct vport_ops {
 124         enum ovs_vport_type type;
 125
 126         /* Called with ovs_mutex. */
 127         struct vport *(*create)(const struct vport_parms *);
 128         void (*destroy)(struct vport *);
 129
 130         int (*set_options)(struct vport *, struct nlattr *);
 131         int (*get_options)(const struct vport *, struct sk_buff *);
 132
 133         netdev_tx_t (*send) (struct sk_buff *skb);
 134         struct module *owner;
 135         struct list_head list;
 136 };
 137
 138 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *,
 139                               const struct vport_parms *);
 140 void ovs_vport_free(struct vport *);
 141
 142 #define VPORT_ALIGN 8
 143
 144 /**
 145  *      vport_priv - access private data area of vport
 146  *
 147  * @vport: vport to access
 148  *
 149  * If a nonzero size was passed in priv_size of vport_alloc() a private data
 150  * area was allocated on creation.  This allows that area to be accessed and
 151  * used for any purpose needed by the vport implementer.
 152  */
 153 static inline void *vport_priv(const struct vport *vport)
 154 {
 155         return (u8 *)(uintptr_t)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
 156 }
 157
 158 /**
 159  *      vport_from_priv - lookup vport from private data pointer
 160  *
 161  * @priv: Start of private data area.
 162  *
 163  * It is sometimes useful to translate from a pointer to the private data
 164  * area to the vport, such as in the case where the private data pointer is
 165  * the result of a hash table lookup.  @priv must point to the start of the
 166  * private data area.
 167  */
 168 static inline struct vport *vport_from_priv(void *priv)
 169 {
 170         return (struct vport *)((u8 *)priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
 171 }
 172
 173 int ovs_vport_receive(struct vport *, struct sk_buff *,
 174                       const struct ip_tunnel_info *);
 175
 176 static inline const char *ovs_vport_name(struct vport *vport)
 177 {
 178         return vport->dev->name;
 179 }
 180
 181 int __ovs_vport_ops_register(struct vport_ops *ops);
 182 #define ovs_vport_ops_register(ops)             \
 183         ({                                      \
 184                 (ops)->owner = THIS_MODULE;     \
 185                 __ovs_vport_ops_register(ops);  \
 186         })
 187
 188 void ovs_vport_ops_unregister(struct vport_ops *ops);
 189 void ovs_vport_send(struct vport *vport, struct sk_buff *skb, u8 mac_proto);
 190
 191 #endif /* vport.h */