2 * Copyright (c) 2007-2012 Nicira, Inc.
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.
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.
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
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>
34 /* The following definitions are for users of the vport subsytem: */
36 struct vport __rcu
*gre_vport
;
37 struct vport __rcu
*gre64_vport
;
40 int ovs_vport_init(void);
41 void ovs_vport_exit(void);
43 struct vport
*ovs_vport_add(const struct vport_parms
*);
44 void ovs_vport_del(struct vport
*);
46 struct vport
*ovs_vport_locate(struct net
*net
, const char *name
);
48 void ovs_vport_set_stats(struct vport
*, struct ovs_vport_stats
*);
49 void ovs_vport_get_stats(struct vport
*, struct ovs_vport_stats
*);
51 int ovs_vport_set_options(struct vport
*, struct nlattr
*options
);
52 int ovs_vport_get_options(const struct vport
*, struct sk_buff
*);
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
*);
58 int ovs_vport_send(struct vport
*, struct sk_buff
*);
60 /* The following definitions are for implementers of vport devices: */
62 struct vport_err_stats
{
69 * struct vport_portids - array of netlink portids of a vport.
70 * must be protected by rcu.
71 * @rn_ids: The reciprocal value of @n_ids.
72 * @rcu: RCU callback head for deferred destruction.
73 * @n_ids: Size of @ids array.
74 * @ids: Array storing the Netlink socket pids to be used for packets received
75 * on this port that miss the flow table.
77 struct vport_portids
{
78 struct reciprocal_value rn_ids
;
85 * struct vport - one port within a datapath
86 * @rcu: RCU callback head for deferred destruction.
87 * @dp: Datapath to which this port belongs.
88 * @upcall_portids: RCU protected 'struct vport_portids'.
89 * @port_no: Index into @dp's @ports array.
90 * @hash_node: Element in @dev_table hash table in vport.c.
91 * @dp_hash_node: Element in @datapath->ports hash table in datapath.c.
92 * @ops: Class structure.
93 * @percpu_stats: Points to per-CPU statistics used and maintained by vport
94 * @stats_lock: Protects @err_stats and @offset_stats.
95 * @err_stats: Points to error statistics used and maintained by vport
96 * @offset_stats: Added to actual statistics as a sop to compatibility with
97 * XAPI for Citrix XenServer. Deprecated.
102 struct vport_portids __rcu
*upcall_portids
;
105 struct hlist_node hash_node
;
106 struct hlist_node dp_hash_node
;
107 const struct vport_ops
*ops
;
109 struct pcpu_sw_netstats __percpu
*percpu_stats
;
111 spinlock_t stats_lock
;
112 struct vport_err_stats err_stats
;
113 struct ovs_vport_stats offset_stats
;
117 * struct vport_parms - parameters for creating a new vport
119 * @name: New vport's name.
120 * @type: New vport's type.
121 * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if
123 * @dp: New vport's datapath.
124 * @port_no: New vport's port number.
128 enum ovs_vport_type type
;
129 struct nlattr
*options
;
131 /* For ovs_vport_alloc(). */
134 struct nlattr
*upcall_portids
;
138 * struct vport_ops - definition of a type of virtual port
140 * @type: %OVS_VPORT_TYPE_* value for this type of virtual port.
141 * @create: Create a new vport configured as specified. On success returns
142 * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value.
143 * @destroy: Destroys a vport. Must call vport_free() on the vport but not
144 * before an RCU grace period has elapsed.
145 * @set_options: Modify the configuration of an existing vport. May be %NULL
146 * if modification is not supported.
147 * @get_options: Appends vport-specific attributes for the configuration of an
148 * existing vport to a &struct sk_buff. May be %NULL for a vport that does not
149 * have any configuration.
150 * @get_name: Get the device's name.
151 * @send: Send a packet on the device. Returns the length of the packet sent,
152 * zero for dropped packets or negative for error.
155 enum ovs_vport_type type
;
157 /* Called with ovs_mutex. */
158 struct vport
*(*create
)(const struct vport_parms
*);
159 void (*destroy
)(struct vport
*);
161 int (*set_options
)(struct vport
*, struct nlattr
*);
162 int (*get_options
)(const struct vport
*, struct sk_buff
*);
164 /* Called with rcu_read_lock or ovs_mutex. */
165 const char *(*get_name
)(const struct vport
*);
167 int (*send
)(struct vport
*, struct sk_buff
*);
170 enum vport_err_type
{
177 struct vport
*ovs_vport_alloc(int priv_size
, const struct vport_ops
*,
178 const struct vport_parms
*);
179 void ovs_vport_free(struct vport
*);
180 void ovs_vport_deferred_free(struct vport
*vport
);
182 #define VPORT_ALIGN 8
185 * vport_priv - access private data area of vport
187 * @vport: vport to access
189 * If a nonzero size was passed in priv_size of vport_alloc() a private data
190 * area was allocated on creation. This allows that area to be accessed and
191 * used for any purpose needed by the vport implementer.
193 static inline void *vport_priv(const struct vport
*vport
)
195 return (u8
*)(uintptr_t)vport
+ ALIGN(sizeof(struct vport
), VPORT_ALIGN
);
199 * vport_from_priv - lookup vport from private data pointer
201 * @priv: Start of private data area.
203 * It is sometimes useful to translate from a pointer to the private data
204 * area to the vport, such as in the case where the private data pointer is
205 * the result of a hash table lookup. @priv must point to the start of the
208 static inline struct vport
*vport_from_priv(void *priv
)
210 return (struct vport
*)((u8
*)priv
- ALIGN(sizeof(struct vport
), VPORT_ALIGN
));
213 void ovs_vport_receive(struct vport
*, struct sk_buff
*,
214 struct ovs_tunnel_info
*);
216 /* List of statically compiled vport implementations. Don't forget to also
217 * add yours to the list at the top of vport.c. */
218 extern const struct vport_ops ovs_netdev_vport_ops
;
219 extern const struct vport_ops ovs_internal_vport_ops
;
220 extern const struct vport_ops ovs_gre_vport_ops
;
221 extern const struct vport_ops ovs_gre64_vport_ops
;
222 extern const struct vport_ops ovs_vxlan_vport_ops
;
223 extern const struct vport_ops ovs_lisp_vport_ops
;
225 static inline void ovs_skb_postpush_rcsum(struct sk_buff
*skb
,
226 const void *start
, unsigned int len
)
228 if (skb
->ip_summed
== CHECKSUM_COMPLETE
)
229 skb
->csum
= csum_add(skb
->csum
, csum_partial(start
, len
, 0));