Commit | Line | Data |
---|---|---|
ccb1352e | 1 | /* |
caf2ee14 | 2 | * Copyright (c) 2007-2012 Nicira, Inc. |
ccb1352e JG |
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 | ||
e0f0ecf3 | 22 | #include <linux/if_tunnel.h> |
ccb1352e | 23 | #include <linux/list.h> |
46df7b81 | 24 | #include <linux/netlink.h> |
ccb1352e | 25 | #include <linux/openvswitch.h> |
5cd667b0 | 26 | #include <linux/reciprocal_div.h> |
ccb1352e JG |
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 | ||
aa310701 PS |
38 | struct vport_net { |
39 | struct vport __rcu *gre_vport; | |
40 | }; | |
41 | ||
ccb1352e JG |
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 | ||
12eb18f7 | 48 | struct vport *ovs_vport_locate(const struct net *net, const char *name); |
ccb1352e JG |
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 | ||
12eb18f7 | 55 | int ovs_vport_set_upcall_portids(struct vport *, const struct nlattr *pids); |
5cd667b0 AW |
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 | ||
ccb1352e JG |
59 | int ovs_vport_send(struct vport *, struct sk_buff *); |
60 | ||
8f0aad6f WZ |
61 | int ovs_tunnel_get_egress_info(struct ovs_tunnel_info *egress_tun_info, |
62 | struct net *net, | |
63 | const struct ovs_tunnel_info *tun_info, | |
64 | u8 ipproto, | |
65 | u32 skb_mark, | |
66 | __be16 tp_src, | |
67 | __be16 tp_dst); | |
68 | int ovs_vport_get_egress_tun_info(struct vport *vport, struct sk_buff *skb, | |
69 | struct ovs_tunnel_info *info); | |
70 | ||
ccb1352e JG |
71 | /* The following definitions are for implementers of vport devices: */ |
72 | ||
ccb1352e | 73 | struct vport_err_stats { |
e403aded LR |
74 | atomic_long_t rx_dropped; |
75 | atomic_long_t rx_errors; | |
76 | atomic_long_t tx_dropped; | |
77 | atomic_long_t tx_errors; | |
ccb1352e | 78 | }; |
5cd667b0 AW |
79 | /** |
80 | * struct vport_portids - array of netlink portids of a vport. | |
81 | * must be protected by rcu. | |
82 | * @rn_ids: The reciprocal value of @n_ids. | |
83 | * @rcu: RCU callback head for deferred destruction. | |
84 | * @n_ids: Size of @ids array. | |
85 | * @ids: Array storing the Netlink socket pids to be used for packets received | |
86 | * on this port that miss the flow table. | |
87 | */ | |
88 | struct vport_portids { | |
89 | struct reciprocal_value rn_ids; | |
90 | struct rcu_head rcu; | |
91 | u32 n_ids; | |
92 | u32 ids[]; | |
93 | }; | |
ccb1352e JG |
94 | |
95 | /** | |
96 | * struct vport - one port within a datapath | |
97 | * @rcu: RCU callback head for deferred destruction. | |
ccb1352e | 98 | * @dp: Datapath to which this port belongs. |
5cd667b0 | 99 | * @upcall_portids: RCU protected 'struct vport_portids'. |
03599c94 | 100 | * @port_no: Index into @dp's @ports array. |
ccb1352e | 101 | * @hash_node: Element in @dev_table hash table in vport.c. |
15eac2a7 | 102 | * @dp_hash_node: Element in @datapath->ports hash table in datapath.c. |
ccb1352e JG |
103 | * @ops: Class structure. |
104 | * @percpu_stats: Points to per-CPU statistics used and maintained by vport | |
ccb1352e JG |
105 | * @err_stats: Points to error statistics used and maintained by vport |
106 | */ | |
107 | struct vport { | |
108 | struct rcu_head rcu; | |
ccb1352e | 109 | struct datapath *dp; |
5cd667b0 | 110 | struct vport_portids __rcu *upcall_portids; |
03599c94 | 111 | u16 port_no; |
ccb1352e JG |
112 | |
113 | struct hlist_node hash_node; | |
15eac2a7 | 114 | struct hlist_node dp_hash_node; |
ccb1352e JG |
115 | const struct vport_ops *ops; |
116 | ||
8f84985f | 117 | struct pcpu_sw_netstats __percpu *percpu_stats; |
ccb1352e | 118 | |
ccb1352e JG |
119 | struct vport_err_stats err_stats; |
120 | }; | |
121 | ||
122 | /** | |
123 | * struct vport_parms - parameters for creating a new vport | |
124 | * | |
125 | * @name: New vport's name. | |
126 | * @type: New vport's type. | |
127 | * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if | |
128 | * none was supplied. | |
129 | * @dp: New vport's datapath. | |
130 | * @port_no: New vport's port number. | |
131 | */ | |
132 | struct vport_parms { | |
133 | const char *name; | |
134 | enum ovs_vport_type type; | |
135 | struct nlattr *options; | |
136 | ||
137 | /* For ovs_vport_alloc(). */ | |
138 | struct datapath *dp; | |
139 | u16 port_no; | |
5cd667b0 | 140 | struct nlattr *upcall_portids; |
ccb1352e JG |
141 | }; |
142 | ||
143 | /** | |
144 | * struct vport_ops - definition of a type of virtual port | |
145 | * | |
146 | * @type: %OVS_VPORT_TYPE_* value for this type of virtual port. | |
147 | * @create: Create a new vport configured as specified. On success returns | |
148 | * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value. | |
149 | * @destroy: Destroys a vport. Must call vport_free() on the vport but not | |
150 | * before an RCU grace period has elapsed. | |
151 | * @set_options: Modify the configuration of an existing vport. May be %NULL | |
152 | * if modification is not supported. | |
153 | * @get_options: Appends vport-specific attributes for the configuration of an | |
154 | * existing vport to a &struct sk_buff. May be %NULL for a vport that does not | |
155 | * have any configuration. | |
156 | * @get_name: Get the device's name. | |
91b7514c PS |
157 | * @send: Send a packet on the device. Returns the length of the packet sent, |
158 | * zero for dropped packets or negative for error. | |
8f0aad6f WZ |
159 | * @get_egress_tun_info: Get the egress tunnel 5-tuple and other info for |
160 | * a packet. | |
ccb1352e JG |
161 | */ |
162 | struct vport_ops { | |
163 | enum ovs_vport_type type; | |
164 | ||
8e4e1713 | 165 | /* Called with ovs_mutex. */ |
ccb1352e JG |
166 | struct vport *(*create)(const struct vport_parms *); |
167 | void (*destroy)(struct vport *); | |
168 | ||
169 | int (*set_options)(struct vport *, struct nlattr *); | |
170 | int (*get_options)(const struct vport *, struct sk_buff *); | |
171 | ||
8e4e1713 | 172 | /* Called with rcu_read_lock or ovs_mutex. */ |
ccb1352e | 173 | const char *(*get_name)(const struct vport *); |
ccb1352e JG |
174 | |
175 | int (*send)(struct vport *, struct sk_buff *); | |
8f0aad6f WZ |
176 | int (*get_egress_tun_info)(struct vport *, struct sk_buff *, |
177 | struct ovs_tunnel_info *); | |
62b9c8d0 TG |
178 | |
179 | struct module *owner; | |
180 | struct list_head list; | |
ccb1352e JG |
181 | }; |
182 | ||
183 | enum vport_err_type { | |
184 | VPORT_E_RX_DROPPED, | |
185 | VPORT_E_RX_ERROR, | |
186 | VPORT_E_TX_DROPPED, | |
187 | VPORT_E_TX_ERROR, | |
188 | }; | |
189 | ||
190 | struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *, | |
191 | const struct vport_parms *); | |
192 | void ovs_vport_free(struct vport *); | |
aa310701 | 193 | void ovs_vport_deferred_free(struct vport *vport); |
ccb1352e JG |
194 | |
195 | #define VPORT_ALIGN 8 | |
196 | ||
197 | /** | |
198 | * vport_priv - access private data area of vport | |
199 | * | |
200 | * @vport: vport to access | |
201 | * | |
202 | * If a nonzero size was passed in priv_size of vport_alloc() a private data | |
203 | * area was allocated on creation. This allows that area to be accessed and | |
204 | * used for any purpose needed by the vport implementer. | |
205 | */ | |
206 | static inline void *vport_priv(const struct vport *vport) | |
207 | { | |
07dc0602 | 208 | return (u8 *)(uintptr_t)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN); |
ccb1352e JG |
209 | } |
210 | ||
211 | /** | |
212 | * vport_from_priv - lookup vport from private data pointer | |
213 | * | |
214 | * @priv: Start of private data area. | |
215 | * | |
216 | * It is sometimes useful to translate from a pointer to the private data | |
217 | * area to the vport, such as in the case where the private data pointer is | |
218 | * the result of a hash table lookup. @priv must point to the start of the | |
219 | * private data area. | |
220 | */ | |
d0b4da13 | 221 | static inline struct vport *vport_from_priv(void *priv) |
ccb1352e | 222 | { |
d0b4da13 | 223 | return (struct vport *)((u8 *)priv - ALIGN(sizeof(struct vport), VPORT_ALIGN)); |
ccb1352e JG |
224 | } |
225 | ||
7d5437c7 | 226 | void ovs_vport_receive(struct vport *, struct sk_buff *, |
12eb18f7 | 227 | const struct ovs_tunnel_info *); |
ccb1352e | 228 | |
b34df5e8 PS |
229 | static inline void ovs_skb_postpush_rcsum(struct sk_buff *skb, |
230 | const void *start, unsigned int len) | |
231 | { | |
232 | if (skb->ip_summed == CHECKSUM_COMPLETE) | |
233 | skb->csum = csum_add(skb->csum, csum_partial(start, len, 0)); | |
234 | } | |
235 | ||
62b9c8d0 TG |
236 | int ovs_vport_ops_register(struct vport_ops *ops); |
237 | void ovs_vport_ops_unregister(struct vport_ops *ops); | |
238 | ||
3f4c1d87 FD |
239 | static inline struct rtable *ovs_tunnel_route_lookup(struct net *net, |
240 | const struct ovs_key_ipv4_tunnel *key, | |
241 | u32 mark, | |
242 | struct flowi4 *fl, | |
243 | u8 protocol) | |
244 | { | |
245 | struct rtable *rt; | |
246 | ||
247 | memset(fl, 0, sizeof(*fl)); | |
248 | fl->daddr = key->ipv4_dst; | |
249 | fl->saddr = key->ipv4_src; | |
250 | fl->flowi4_tos = RT_TOS(key->ipv4_tos); | |
251 | fl->flowi4_mark = mark; | |
252 | fl->flowi4_proto = protocol; | |
253 | ||
254 | rt = ip_route_output_key(net, fl); | |
255 | return rt; | |
256 | } | |
ccb1352e | 257 | #endif /* vport.h */ |