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> | |
3093fbe7 | 30 | #include <net/route.h> |
ccb1352e JG |
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 | ||
aa310701 PS |
39 | struct vport_net { |
40 | struct vport __rcu *gre_vport; | |
41 | }; | |
42 | ||
ccb1352e JG |
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 | ||
12eb18f7 | 49 | struct vport *ovs_vport_locate(const struct net *net, const char *name); |
ccb1352e JG |
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 | ||
12eb18f7 | 56 | int ovs_vport_set_upcall_portids(struct vport *, const struct nlattr *pids); |
5cd667b0 AW |
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 | ||
ccb1352e JG |
60 | int ovs_vport_send(struct vport *, struct sk_buff *); |
61 | ||
1d8fff90 | 62 | int ovs_tunnel_get_egress_info(struct ip_tunnel_info *egress_tun_info, |
8f0aad6f | 63 | struct net *net, |
3eedb41f | 64 | struct sk_buff *, |
8f0aad6f | 65 | u8 ipproto, |
8f0aad6f WZ |
66 | __be16 tp_src, |
67 | __be16 tp_dst); | |
68 | int ovs_vport_get_egress_tun_info(struct vport *vport, struct sk_buff *skb, | |
1d8fff90 | 69 | struct ip_tunnel_info *info); |
8f0aad6f | 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 | 105 | * @err_stats: Points to error statistics used and maintained by vport |
7b4577a9 | 106 | * @detach_list: list used for detaching vport in net-exit call. |
ccb1352e JG |
107 | */ |
108 | struct vport { | |
be4ace6e | 109 | struct net_device *dev; |
ccb1352e | 110 | struct datapath *dp; |
5cd667b0 | 111 | struct vport_portids __rcu *upcall_portids; |
03599c94 | 112 | u16 port_no; |
ccb1352e JG |
113 | |
114 | struct hlist_node hash_node; | |
15eac2a7 | 115 | struct hlist_node dp_hash_node; |
ccb1352e JG |
116 | const struct vport_ops *ops; |
117 | ||
8f84985f | 118 | struct pcpu_sw_netstats __percpu *percpu_stats; |
ccb1352e | 119 | |
ccb1352e | 120 | struct vport_err_stats err_stats; |
7b4577a9 | 121 | struct list_head detach_list; |
be4ace6e | 122 | struct rcu_head rcu; |
ccb1352e JG |
123 | }; |
124 | ||
125 | /** | |
126 | * struct vport_parms - parameters for creating a new vport | |
127 | * | |
128 | * @name: New vport's name. | |
129 | * @type: New vport's type. | |
130 | * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if | |
131 | * none was supplied. | |
132 | * @dp: New vport's datapath. | |
133 | * @port_no: New vport's port number. | |
134 | */ | |
135 | struct vport_parms { | |
136 | const char *name; | |
137 | enum ovs_vport_type type; | |
138 | struct nlattr *options; | |
139 | ||
140 | /* For ovs_vport_alloc(). */ | |
141 | struct datapath *dp; | |
142 | u16 port_no; | |
5cd667b0 | 143 | struct nlattr *upcall_portids; |
ccb1352e JG |
144 | }; |
145 | ||
146 | /** | |
147 | * struct vport_ops - definition of a type of virtual port | |
148 | * | |
149 | * @type: %OVS_VPORT_TYPE_* value for this type of virtual port. | |
150 | * @create: Create a new vport configured as specified. On success returns | |
151 | * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value. | |
152 | * @destroy: Destroys a vport. Must call vport_free() on the vport but not | |
153 | * before an RCU grace period has elapsed. | |
154 | * @set_options: Modify the configuration of an existing vport. May be %NULL | |
155 | * if modification is not supported. | |
156 | * @get_options: Appends vport-specific attributes for the configuration of an | |
157 | * existing vport to a &struct sk_buff. May be %NULL for a vport that does not | |
158 | * have any configuration. | |
91b7514c PS |
159 | * @send: Send a packet on the device. Returns the length of the packet sent, |
160 | * zero for dropped packets or negative for error. | |
8f0aad6f WZ |
161 | * @get_egress_tun_info: Get the egress tunnel 5-tuple and other info for |
162 | * a packet. | |
ccb1352e JG |
163 | */ |
164 | struct vport_ops { | |
165 | enum ovs_vport_type type; | |
166 | ||
8e4e1713 | 167 | /* Called with ovs_mutex. */ |
ccb1352e JG |
168 | struct vport *(*create)(const struct vport_parms *); |
169 | void (*destroy)(struct vport *); | |
170 | ||
171 | int (*set_options)(struct vport *, struct nlattr *); | |
172 | int (*get_options)(const struct vport *, struct sk_buff *); | |
173 | ||
ccb1352e | 174 | int (*send)(struct vport *, struct sk_buff *); |
8f0aad6f | 175 | int (*get_egress_tun_info)(struct vport *, struct sk_buff *, |
1d8fff90 | 176 | struct ip_tunnel_info *); |
62b9c8d0 TG |
177 | |
178 | struct module *owner; | |
179 | struct list_head list; | |
ccb1352e JG |
180 | }; |
181 | ||
182 | enum vport_err_type { | |
183 | VPORT_E_RX_DROPPED, | |
184 | VPORT_E_RX_ERROR, | |
185 | VPORT_E_TX_DROPPED, | |
186 | VPORT_E_TX_ERROR, | |
187 | }; | |
188 | ||
189 | struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *, | |
190 | const struct vport_parms *); | |
191 | void ovs_vport_free(struct vport *); | |
aa310701 | 192 | void ovs_vport_deferred_free(struct vport *vport); |
ccb1352e JG |
193 | |
194 | #define VPORT_ALIGN 8 | |
195 | ||
196 | /** | |
197 | * vport_priv - access private data area of vport | |
198 | * | |
199 | * @vport: vport to access | |
200 | * | |
201 | * If a nonzero size was passed in priv_size of vport_alloc() a private data | |
202 | * area was allocated on creation. This allows that area to be accessed and | |
203 | * used for any purpose needed by the vport implementer. | |
204 | */ | |
205 | static inline void *vport_priv(const struct vport *vport) | |
206 | { | |
07dc0602 | 207 | return (u8 *)(uintptr_t)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN); |
ccb1352e JG |
208 | } |
209 | ||
210 | /** | |
211 | * vport_from_priv - lookup vport from private data pointer | |
212 | * | |
213 | * @priv: Start of private data area. | |
214 | * | |
215 | * It is sometimes useful to translate from a pointer to the private data | |
216 | * area to the vport, such as in the case where the private data pointer is | |
217 | * the result of a hash table lookup. @priv must point to the start of the | |
218 | * private data area. | |
219 | */ | |
d0b4da13 | 220 | static inline struct vport *vport_from_priv(void *priv) |
ccb1352e | 221 | { |
d0b4da13 | 222 | return (struct vport *)((u8 *)priv - ALIGN(sizeof(struct vport), VPORT_ALIGN)); |
ccb1352e JG |
223 | } |
224 | ||
7d5437c7 | 225 | void ovs_vport_receive(struct vport *, struct sk_buff *, |
1d8fff90 | 226 | const struct ip_tunnel_info *); |
ccb1352e | 227 | |
b34df5e8 PS |
228 | static inline void ovs_skb_postpush_rcsum(struct sk_buff *skb, |
229 | const void *start, unsigned int len) | |
230 | { | |
231 | if (skb->ip_summed == CHECKSUM_COMPLETE) | |
232 | skb->csum = csum_add(skb->csum, csum_partial(start, len, 0)); | |
233 | } | |
234 | ||
c9db965c TG |
235 | static inline const char *ovs_vport_name(struct vport *vport) |
236 | { | |
24d43f32 | 237 | return vport->dev->name; |
c9db965c TG |
238 | } |
239 | ||
62b9c8d0 TG |
240 | int ovs_vport_ops_register(struct vport_ops *ops); |
241 | void ovs_vport_ops_unregister(struct vport_ops *ops); | |
242 | ||
3f4c1d87 | 243 | static inline struct rtable *ovs_tunnel_route_lookup(struct net *net, |
1d8fff90 | 244 | const struct ip_tunnel_key *key, |
3f4c1d87 FD |
245 | u32 mark, |
246 | struct flowi4 *fl, | |
247 | u8 protocol) | |
248 | { | |
249 | struct rtable *rt; | |
250 | ||
251 | memset(fl, 0, sizeof(*fl)); | |
c1ea5d67 JB |
252 | fl->daddr = key->u.ipv4.dst; |
253 | fl->saddr = key->u.ipv4.src; | |
7c383fb2 | 254 | fl->flowi4_tos = RT_TOS(key->tos); |
3f4c1d87 FD |
255 | fl->flowi4_mark = mark; |
256 | fl->flowi4_proto = protocol; | |
257 | ||
258 | rt = ip_route_output_key(net, fl); | |
259 | return rt; | |
260 | } | |
ccb1352e | 261 | #endif /* vport.h */ |