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 #include <net/route.h>
  31
  32 #include "datapath.h"
  33
  34 struct vport;
  35 struct vport_parms;
  36
  37 /* The following definitions are for users of the vport subsytem: */
  38
  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(const 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 *, const 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 int ovs_tunnel_get_egress_info(struct ip_tunnel_info *egress_tun_info,
  63                                struct net *net,
  64                                const struct ip_tunnel_info *tun_info,
  65                                u8 ipproto,
  66                                u32 skb_mark,
  67                                __be16 tp_src,
  68                                __be16 tp_dst);
  69 int ovs_vport_get_egress_tun_info(struct vport *vport, struct sk_buff *skb,
  70                                   struct ip_tunnel_info *info);
  71
  72 /* The following definitions are for implementers of vport devices: */
  73
  74 struct vport_err_stats {
  75         atomic_long_t rx_dropped;
  76         atomic_long_t rx_errors;
  77         atomic_long_t tx_dropped;
  78         atomic_long_t tx_errors;
  79 };
  80 /**
  81  * struct vport_portids - array of netlink portids of a vport.
  82  *                        must be protected by rcu.
  83  * @rn_ids: The reciprocal value of @n_ids.
  84  * @rcu: RCU callback head for deferred destruction.
  85  * @n_ids: Size of @ids array.
  86  * @ids: Array storing the Netlink socket pids to be used for packets received
  87  * on this port that miss the flow table.
  88  */
  89 struct vport_portids {
  90         struct reciprocal_value rn_ids;
  91         struct rcu_head rcu;
  92         u32 n_ids;
  93         u32 ids[];
  94 };
  95
  96 /**
  97  * struct vport - one port within a datapath
  98  * @rcu: RCU callback head for deferred destruction.
  99  * @dp: Datapath to which this port belongs.
 100  * @upcall_portids: RCU protected 'struct vport_portids'.
 101  * @port_no: Index into @dp's @ports array.
 102  * @hash_node: Element in @dev_table hash table in vport.c.
 103  * @dp_hash_node: Element in @datapath->ports hash table in datapath.c.
 104  * @ops: Class structure.
 105  * @percpu_stats: Points to per-CPU statistics used and maintained by vport
 106  * @err_stats: Points to error statistics used and maintained by vport
 107  * @detach_list: list used for detaching vport in net-exit call.
 108  */
 109 struct vport {
 110         struct net_device *dev;
 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         struct vport_err_stats err_stats;
 122         struct list_head detach_list;
 123         struct rcu_head rcu;
 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
 164  * a packet.
 165  */
 166 struct vport_ops {
 167         enum ovs_vport_type type;
 168
 169         /* Called with ovs_mutex. */
 170         struct vport *(*create)(const struct vport_parms *);
 171         void (*destroy)(struct vport *);
 172
 173         int (*set_options)(struct vport *, struct nlattr *);
 174         int (*get_options)(const struct vport *, struct sk_buff *);
 175
 176         /* Called with rcu_read_lock or ovs_mutex. */
 177         const char *(*get_name)(const struct vport *);
 178
 179         int (*send)(struct vport *, struct sk_buff *);
 180         int (*get_egress_tun_info)(struct vport *, struct sk_buff *,
 181                                    struct ip_tunnel_info *);
 182
 183         struct module *owner;
 184         struct list_head list;
 185 };
 186
 187 enum vport_err_type {
 188         VPORT_E_RX_DROPPED,
 189         VPORT_E_RX_ERROR,
 190         VPORT_E_TX_DROPPED,
 191         VPORT_E_TX_ERROR,
 192 };
 193
 194 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *,
 195                               const struct vport_parms *);
 196 void ovs_vport_free(struct vport *);
 197 void ovs_vport_deferred_free(struct vport *vport);
 198
 199 #define VPORT_ALIGN 8
 200
 201 /**
 202  *      vport_priv - access private data area of vport
 203  *
 204  * @vport: vport to access
 205  *
 206  * If a nonzero size was passed in priv_size of vport_alloc() a private data
 207  * area was allocated on creation.  This allows that area to be accessed and
 208  * used for any purpose needed by the vport implementer.
 209  */
 210 static inline void *vport_priv(const struct vport *vport)
 211 {
 212         return (u8 *)(uintptr_t)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN);
 213 }
 214
 215 /**
 216  *      vport_from_priv - lookup vport from private data pointer
 217  *
 218  * @priv: Start of private data area.
 219  *
 220  * It is sometimes useful to translate from a pointer to the private data
 221  * area to the vport, such as in the case where the private data pointer is
 222  * the result of a hash table lookup.  @priv must point to the start of the
 223  * private data area.
 224  */
 225 static inline struct vport *vport_from_priv(void *priv)
 226 {
 227         return (struct vport *)((u8 *)priv - ALIGN(sizeof(struct vport), VPORT_ALIGN));
 228 }
 229
 230 void ovs_vport_receive(struct vport *, struct sk_buff *,
 231                        const struct ip_tunnel_info *);
 232
 233 static inline void ovs_skb_postpush_rcsum(struct sk_buff *skb,
 234                                       const void *start, unsigned int len)
 235 {
 236         if (skb->ip_summed == CHECKSUM_COMPLETE)
 237                 skb->csum = csum_add(skb->csum, csum_partial(start, len, 0));
 238 }
 239
 240 static inline const char *ovs_vport_name(struct vport *vport)
 241 {
 242         return vport->dev ? vport->dev->name : vport->ops->get_name(vport);
 243 }
 244
 245 int ovs_vport_ops_register(struct vport_ops *ops);
 246 void ovs_vport_ops_unregister(struct vport_ops *ops);
 247
 248 static inline struct rtable *ovs_tunnel_route_lookup(struct net *net,
 249                                                      const struct ip_tunnel_key *key,
 250                                                      u32 mark,
 251                                                      struct flowi4 *fl,
 252                                                      u8 protocol)
 253 {
 254         struct rtable *rt;
 255
 256         memset(fl, 0, sizeof(*fl));
 257         fl->daddr = key->ipv4_dst;
 258         fl->saddr = key->ipv4_src;
 259         fl->flowi4_tos = RT_TOS(key->ipv4_tos);
 260         fl->flowi4_mark = mark;
 261         fl->flowi4_proto = protocol;
 262
 263         rt = ip_route_output_key(net, fl);
 264         return rt;
 265 }
 266 #endif /* vport.h */