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