net/openvswitch/vport.h

   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 #ifndef VPORT_H
  20 #define VPORT_H 1
  21
  22 #include <linux/if_tunnel.h>
  23 #include <linux/list.h>
  24 #include <linux/netlink.h>
  25 #include <linux/openvswitch.h>
  26 #include <linux/reciprocal_div.h>
  27 #include <linux/skbuff.h>
  28 #include <linux/spinlock.h>
  29 #include <linux/u64_stats_sync.h>
  30
  31 #include "datapath.h"
  32
  33 struct vport;
  34 struct vport_parms;
  35
  36 /* The following definitions are for users of the vport subsytem: */
  37
  38 /* The following definitions are for users of the vport subsytem: */
  39 struct vport_net {
  40         struct vport __rcu *gre_vport;
  41 };
  42
  43 int ovs_vport_init(void);
  44 void ovs_vport_exit(void);
  45
  46 struct vport *ovs_vport_add(const struct vport_parms *);
  47 void ovs_vport_del(struct vport *);
  48
  49 struct vport *ovs_vport_locate(struct net *net, const char *name);
  50
  51 void ovs_vport_get_stats(struct vport *, struct ovs_vport_stats *);
  52
  53 int ovs_vport_set_options(struct vport *, struct nlattr *options);
  54 int ovs_vport_get_options(const struct vport *, struct sk_buff *);
  55
  56 int ovs_vport_set_upcall_portids(struct vport *, struct nlattr *pids);
  57 int ovs_vport_get_upcall_portids(const struct vport *, struct sk_buff *);
  58 u32 ovs_vport_find_upcall_portid(const struct vport *, struct sk_buff *);
  59
  60 int ovs_vport_send(struct vport *, struct sk_buff *);
  61
  62 /* The following definitions are for implementers of vport devices: */
  63
  64 struct vport_err_stats {
  65         u64 rx_dropped;
  66         u64 rx_errors;
  67         u64 tx_dropped;
  68         u64 tx_errors;
  69 };
  70 /**
  71  * struct vport_portids - array of netlink portids of a vport.
  72  *                        must be protected by rcu.
  73  * @rn_ids: The reciprocal value of @n_ids.
  74  * @rcu: RCU callback head for deferred destruction.
  75  * @n_ids: Size of @ids array.
  76  * @ids: Array storing the Netlink socket pids to be used for packets received
  77  * on this port that miss the flow table.
  78  */
  79 struct vport_portids {
  80         struct reciprocal_value rn_ids;
  81         struct rcu_head rcu;
  82         u32 n_ids;
  83         u32 ids[];
  84 };
  85
  86 /**
  87  * struct vport - one port within a datapath
  88  * @rcu: RCU callback head for deferred destruction.
  89  * @dp: Datapath to which this port belongs.
  90  * @upcall_portids: RCU protected 'struct vport_portids'.
  91  * @port_no: Index into @dp's @ports array.
  92  * @hash_node: Element in @dev_table hash table in vport.c.
  93  * @dp_hash_node: Element in @datapath->ports hash table in datapath.c.
  94  * @ops: Class structure.
  95  * @percpu_stats: Points to per-CPU statistics used and maintained by vport
  96  * @stats_lock: Protects @err_stats;
  97  * @err_stats: Points to error statistics used and maintained by vport
  98  */
  99 struct vport {
 100         struct rcu_head rcu;
 101         struct datapath *dp;
 102         struct vport_portids __rcu *upcall_portids;
 103         u16 port_no;
 104
 105         struct hlist_node hash_node;
 106         struct hlist_node dp_hash_node;
 107         const struct vport_ops *ops;
 108
 109         struct pcpu_sw_netstats __percpu *percpu_stats;
 110
 111         spinlock_t stats_lock;
 112         struct vport_err_stats err_stats;
 113 };
 114
 115 /**
 116  * struct vport_parms - parameters for creating a new vport
 117  *
 118  * @name: New vport's name.
 119  * @type: New vport's type.
 120  * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if
 121  * none was supplied.
 122  * @dp: New vport's datapath.
 123  * @port_no: New vport's port number.
 124  */
 125 struct vport_parms {
 126         const char *name;
 127         enum ovs_vport_type type;
 128         struct nlattr *options;
 129
 130         /* For ovs_vport_alloc(). */
 131         struct datapath *dp;
 132         u16 port_no;
 133         struct nlattr *upcall_portids;
 134 };
 135
 136 /**
 137  * struct vport_ops - definition of a type of virtual port
 138  *
 139  * @type: %OVS_VPORT_TYPE_* value for this type of virtual port.
 140  * @create: Create a new vport configured as specified.  On success returns
 141  * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value.
 142  * @destroy: Destroys a vport.  Must call vport_free() on the vport but not
 143  * before an RCU grace period has elapsed.
 144  * @set_options: Modify the configuration of an existing vport.  May be %NULL
 145  * if modification is not supported.
 146  * @get_options: Appends vport-specific attributes for the configuration of an
 147  * existing vport to a &struct sk_buff.  May be %NULL for a vport that does not
 148  * have any configuration.
 149  * @get_name: Get the device's name.
 150  * @send: Send a packet on the device.  Returns the length of the packet sent,
 151  * zero for dropped packets or negative for error.
 152  */
 153 struct vport_ops {
 154         enum ovs_vport_type type;
 155
 156         /* Called with ovs_mutex. */
 157         struct vport *(*create)(const struct vport_parms *);
 158         void (*destroy)(struct vport *);
 159
 160         int (*set_options)(struct vport *, struct nlattr *);
 161         int (*get_options)(const struct vport *, struct sk_buff *);
 162
 163         /* Called with rcu_read_lock or ovs_mutex. */
 164         const char *(*get_name)(const struct vport *);
 165
 166         int (*send)(struct vport *, struct sk_buff *);
 167 };
 168
 169 enum vport_err_type {
 170         VPORT_E_RX_DROPPED,
 171         VPORT_E_RX_ERROR,
 172         VPORT_E_TX_DROPPED,
 173         VPORT_E_TX_ERROR,
 174 };
 175
 176 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *,
 177                               const struct vport_parms *);
 178 void ovs_vport_free(struct vport *);
 179 void ovs_vport_deferred_free(struct vport *vport);
 180
 181 #define VPORT_ALIGN 8
 182
 183 /**
 184  *      vport_priv - access private data area of vport
 185  *
 186  * @vport: vport to access
 187  *
 188  * If a nonzero size was passed in priv_size of vport_alloc() a private data
 189  * area was allocated on creation.  This allows that area to be accessed and
 190  * used for any purpose needed by the vport implementer.
 191  */
 192 static inline void *vport_priv(const struct vport *vport)
 193 {
 194         return (u8 *)(uintptr_t)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
 195 }
 196
 197 /**
 198  *      vport_from_priv - lookup vport from private data pointer
 199  *
 200  * @priv: Start of private data area.
 201  *
 202  * It is sometimes useful to translate from a pointer to the private data
 203  * area to the vport, such as in the case where the private data pointer is
 204  * the result of a hash table lookup.  @priv must point to the start of the
 205  * private data area.
 206  */
 207 static inline struct vport *vport_from_priv(void *priv)
 208 {
 209         return (struct vport *)((u8 *)priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
 210 }
 211
 212 void ovs_vport_receive(struct vport *, struct sk_buff *,
 213                        struct ovs_key_ipv4_tunnel *);
 214
 215 /* List of statically compiled vport implementations.  Don't forget to also
 216  * add yours to the list at the top of vport.c. */
 217 extern const struct vport_ops ovs_netdev_vport_ops;
 218 extern const struct vport_ops ovs_internal_vport_ops;
 219 extern const struct vport_ops ovs_gre_vport_ops;
 220 extern const struct vport_ops ovs_vxlan_vport_ops;
 221
 222 static inline void ovs_skb_postpush_rcsum(struct sk_buff *skb,
 223                                       const void *start, unsigned int len)
 224 {
 225         if (skb->ip_summed == CHECKSUM_COMPLETE)
 226                 skb->csum = csum_add(skb->csum, csum_partial(start, len, 0));
 227 }
 228
 229 #endif /* vport.h */