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 | ||
39 | int ovs_vport_init(void); | |
40 | void ovs_vport_exit(void); | |
41 | ||
42 | struct vport *ovs_vport_add(const struct vport_parms *); | |
43 | void ovs_vport_del(struct vport *); | |
44 | ||
12eb18f7 | 45 | struct vport *ovs_vport_locate(const struct net *net, const char *name); |
ccb1352e JG |
46 | |
47 | void ovs_vport_get_stats(struct vport *, struct ovs_vport_stats *); | |
48 | ||
49 | int ovs_vport_set_options(struct vport *, struct nlattr *options); | |
50 | int ovs_vport_get_options(const struct vport *, struct sk_buff *); | |
51 | ||
12eb18f7 | 52 | int ovs_vport_set_upcall_portids(struct vport *, const struct nlattr *pids); |
5cd667b0 AW |
53 | int ovs_vport_get_upcall_portids(const struct vport *, struct sk_buff *); |
54 | u32 ovs_vport_find_upcall_portid(const struct vport *, struct sk_buff *); | |
55 | ||
4c222798 | 56 | int ovs_tunnel_get_egress_info(struct dp_upcall_info *upcall, |
8f0aad6f | 57 | struct net *net, |
3eedb41f | 58 | struct sk_buff *, |
8f0aad6f | 59 | u8 ipproto, |
8f0aad6f WZ |
60 | __be16 tp_src, |
61 | __be16 tp_dst); | |
4c222798 | 62 | |
8f0aad6f | 63 | int ovs_vport_get_egress_tun_info(struct vport *vport, struct sk_buff *skb, |
4c222798 | 64 | struct dp_upcall_info *upcall); |
8f0aad6f | 65 | |
5cd667b0 AW |
66 | /** |
67 | * struct vport_portids - array of netlink portids of a vport. | |
68 | * must be protected by rcu. | |
69 | * @rn_ids: The reciprocal value of @n_ids. | |
70 | * @rcu: RCU callback head for deferred destruction. | |
71 | * @n_ids: Size of @ids array. | |
72 | * @ids: Array storing the Netlink socket pids to be used for packets received | |
73 | * on this port that miss the flow table. | |
74 | */ | |
75 | struct vport_portids { | |
76 | struct reciprocal_value rn_ids; | |
77 | struct rcu_head rcu; | |
78 | u32 n_ids; | |
79 | u32 ids[]; | |
80 | }; | |
ccb1352e JG |
81 | |
82 | /** | |
83 | * struct vport - one port within a datapath | |
84 | * @rcu: RCU callback head for deferred destruction. | |
ccb1352e | 85 | * @dp: Datapath to which this port belongs. |
5cd667b0 | 86 | * @upcall_portids: RCU protected 'struct vport_portids'. |
03599c94 | 87 | * @port_no: Index into @dp's @ports array. |
ccb1352e | 88 | * @hash_node: Element in @dev_table hash table in vport.c. |
15eac2a7 | 89 | * @dp_hash_node: Element in @datapath->ports hash table in datapath.c. |
ccb1352e | 90 | * @ops: Class structure. |
7b4577a9 | 91 | * @detach_list: list used for detaching vport in net-exit call. |
ccb1352e JG |
92 | */ |
93 | struct vport { | |
be4ace6e | 94 | struct net_device *dev; |
ccb1352e | 95 | struct datapath *dp; |
5cd667b0 | 96 | struct vport_portids __rcu *upcall_portids; |
03599c94 | 97 | u16 port_no; |
ccb1352e JG |
98 | |
99 | struct hlist_node hash_node; | |
15eac2a7 | 100 | struct hlist_node dp_hash_node; |
ccb1352e JG |
101 | const struct vport_ops *ops; |
102 | ||
7b4577a9 | 103 | struct list_head detach_list; |
be4ace6e | 104 | struct rcu_head rcu; |
ccb1352e JG |
105 | }; |
106 | ||
107 | /** | |
108 | * struct vport_parms - parameters for creating a new vport | |
109 | * | |
110 | * @name: New vport's name. | |
111 | * @type: New vport's type. | |
112 | * @options: %OVS_VPORT_ATTR_OPTIONS attribute from Netlink message, %NULL if | |
113 | * none was supplied. | |
114 | * @dp: New vport's datapath. | |
115 | * @port_no: New vport's port number. | |
116 | */ | |
117 | struct vport_parms { | |
118 | const char *name; | |
119 | enum ovs_vport_type type; | |
120 | struct nlattr *options; | |
121 | ||
122 | /* For ovs_vport_alloc(). */ | |
123 | struct datapath *dp; | |
124 | u16 port_no; | |
5cd667b0 | 125 | struct nlattr *upcall_portids; |
ccb1352e JG |
126 | }; |
127 | ||
128 | /** | |
129 | * struct vport_ops - definition of a type of virtual port | |
130 | * | |
131 | * @type: %OVS_VPORT_TYPE_* value for this type of virtual port. | |
132 | * @create: Create a new vport configured as specified. On success returns | |
133 | * a new vport allocated with ovs_vport_alloc(), otherwise an ERR_PTR() value. | |
134 | * @destroy: Destroys a vport. Must call vport_free() on the vport but not | |
135 | * before an RCU grace period has elapsed. | |
136 | * @set_options: Modify the configuration of an existing vport. May be %NULL | |
137 | * if modification is not supported. | |
138 | * @get_options: Appends vport-specific attributes for the configuration of an | |
139 | * existing vport to a &struct sk_buff. May be %NULL for a vport that does not | |
140 | * have any configuration. | |
8c876639 | 141 | * @send: Send a packet on the device. |
91b7514c | 142 | * zero for dropped packets or negative for error. |
8f0aad6f WZ |
143 | * @get_egress_tun_info: Get the egress tunnel 5-tuple and other info for |
144 | * a packet. | |
ccb1352e JG |
145 | */ |
146 | struct vport_ops { | |
147 | enum ovs_vport_type type; | |
148 | ||
8e4e1713 | 149 | /* Called with ovs_mutex. */ |
ccb1352e JG |
150 | struct vport *(*create)(const struct vport_parms *); |
151 | void (*destroy)(struct vport *); | |
152 | ||
153 | int (*set_options)(struct vport *, struct nlattr *); | |
154 | int (*get_options)(const struct vport *, struct sk_buff *); | |
155 | ||
8c876639 | 156 | void (*send)(struct vport *, struct sk_buff *); |
8f0aad6f | 157 | int (*get_egress_tun_info)(struct vport *, struct sk_buff *, |
4c222798 | 158 | struct dp_upcall_info *upcall); |
62b9c8d0 TG |
159 | |
160 | struct module *owner; | |
161 | struct list_head list; | |
ccb1352e JG |
162 | }; |
163 | ||
ccb1352e JG |
164 | struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *, |
165 | const struct vport_parms *); | |
166 | void ovs_vport_free(struct vport *); | |
aa310701 | 167 | void ovs_vport_deferred_free(struct vport *vport); |
ccb1352e JG |
168 | |
169 | #define VPORT_ALIGN 8 | |
170 | ||
171 | /** | |
172 | * vport_priv - access private data area of vport | |
173 | * | |
174 | * @vport: vport to access | |
175 | * | |
176 | * If a nonzero size was passed in priv_size of vport_alloc() a private data | |
177 | * area was allocated on creation. This allows that area to be accessed and | |
178 | * used for any purpose needed by the vport implementer. | |
179 | */ | |
180 | static inline void *vport_priv(const struct vport *vport) | |
181 | { | |
07dc0602 | 182 | return (u8 *)(uintptr_t)vport + ALIGN(sizeof(struct vport), VPORT_ALIGN); |
ccb1352e JG |
183 | } |
184 | ||
185 | /** | |
186 | * vport_from_priv - lookup vport from private data pointer | |
187 | * | |
188 | * @priv: Start of private data area. | |
189 | * | |
190 | * It is sometimes useful to translate from a pointer to the private data | |
191 | * area to the vport, such as in the case where the private data pointer is | |
192 | * the result of a hash table lookup. @priv must point to the start of the | |
193 | * private data area. | |
194 | */ | |
d0b4da13 | 195 | static inline struct vport *vport_from_priv(void *priv) |
ccb1352e | 196 | { |
d0b4da13 | 197 | return (struct vport *)((u8 *)priv - ALIGN(sizeof(struct vport), VPORT_ALIGN)); |
ccb1352e JG |
198 | } |
199 | ||
8c876639 PS |
200 | int ovs_vport_receive(struct vport *, struct sk_buff *, |
201 | const struct ip_tunnel_info *); | |
ccb1352e | 202 | |
b34df5e8 PS |
203 | static inline void ovs_skb_postpush_rcsum(struct sk_buff *skb, |
204 | const void *start, unsigned int len) | |
205 | { | |
206 | if (skb->ip_summed == CHECKSUM_COMPLETE) | |
207 | skb->csum = csum_add(skb->csum, csum_partial(start, len, 0)); | |
208 | } | |
209 | ||
c9db965c TG |
210 | static inline const char *ovs_vport_name(struct vport *vport) |
211 | { | |
24d43f32 | 212 | return vport->dev->name; |
c9db965c TG |
213 | } |
214 | ||
62b9c8d0 TG |
215 | int ovs_vport_ops_register(struct vport_ops *ops); |
216 | void ovs_vport_ops_unregister(struct vport_ops *ops); | |
217 | ||
3f4c1d87 | 218 | static inline struct rtable *ovs_tunnel_route_lookup(struct net *net, |
1d8fff90 | 219 | const struct ip_tunnel_key *key, |
3f4c1d87 FD |
220 | u32 mark, |
221 | struct flowi4 *fl, | |
222 | u8 protocol) | |
223 | { | |
224 | struct rtable *rt; | |
225 | ||
226 | memset(fl, 0, sizeof(*fl)); | |
c1ea5d67 JB |
227 | fl->daddr = key->u.ipv4.dst; |
228 | fl->saddr = key->u.ipv4.src; | |
7c383fb2 | 229 | fl->flowi4_tos = RT_TOS(key->tos); |
3f4c1d87 FD |
230 | fl->flowi4_mark = mark; |
231 | fl->flowi4_proto = protocol; | |
232 | ||
233 | rt = ip_route_output_key(net, fl); | |
234 | return rt; | |
235 | } | |
8c876639 PS |
236 | |
237 | static inline void ovs_vport_send(struct vport *vport, struct sk_buff *skb) | |
238 | { | |
239 | vport->ops->send(vport, skb); | |
240 | } | |
241 | ||
ccb1352e | 242 | #endif /* vport.h */ |