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