2 * Copyright (c) 2007-2014 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
19 #include <linux/etherdevice.h>
21 #include <linux/if_vlan.h>
22 #include <linux/jhash.h>
23 #include <linux/kernel.h>
24 #include <linux/list.h>
25 #include <linux/mutex.h>
26 #include <linux/percpu.h>
27 #include <linux/rcupdate.h>
28 #include <linux/rtnetlink.h>
29 #include <linux/compat.h>
30 #include <net/net_namespace.h>
31 #include <linux/module.h>
35 #include "vport-internal_dev.h"
37 static LIST_HEAD(vport_ops_list
);
39 /* Protected by RCU read lock for reading, ovs_mutex for writing. */
40 static struct hlist_head
*dev_table
;
41 #define VPORT_HASH_BUCKETS 1024
44 * ovs_vport_init - initialize vport subsystem
46 * Called at module load time to initialize the vport subsystem.
48 int ovs_vport_init(void)
50 dev_table
= kzalloc(VPORT_HASH_BUCKETS
* sizeof(struct hlist_head
),
59 * ovs_vport_exit - shutdown vport subsystem
61 * Called at module exit time to shutdown the vport subsystem.
63 void ovs_vport_exit(void)
68 static struct hlist_head
*hash_bucket(const struct net
*net
, const char *name
)
70 unsigned int hash
= jhash(name
, strlen(name
), (unsigned long) net
);
71 return &dev_table
[hash
& (VPORT_HASH_BUCKETS
- 1)];
74 int __ovs_vport_ops_register(struct vport_ops
*ops
)
80 list_for_each_entry(o
, &vport_ops_list
, list
)
81 if (ops
->type
== o
->type
)
84 list_add_tail(&ops
->list
, &vport_ops_list
);
90 EXPORT_SYMBOL_GPL(__ovs_vport_ops_register
);
92 void ovs_vport_ops_unregister(struct vport_ops
*ops
)
98 EXPORT_SYMBOL_GPL(ovs_vport_ops_unregister
);
101 * ovs_vport_locate - find a port that has already been created
103 * @name: name of port to find
105 * Must be called with ovs or RCU read lock.
107 struct vport
*ovs_vport_locate(const struct net
*net
, const char *name
)
109 struct hlist_head
*bucket
= hash_bucket(net
, name
);
112 hlist_for_each_entry_rcu(vport
, bucket
, hash_node
)
113 if (!strcmp(name
, ovs_vport_name(vport
)) &&
114 net_eq(ovs_dp_get_net(vport
->dp
), net
))
121 * ovs_vport_alloc - allocate and initialize new vport
123 * @priv_size: Size of private data area to allocate.
124 * @ops: vport device ops
126 * Allocate and initialize a new vport defined by @ops. The vport will contain
127 * a private data area of size @priv_size that can be accessed using
128 * vport_priv(). vports that are no longer needed should be released with
131 struct vport
*ovs_vport_alloc(int priv_size
, const struct vport_ops
*ops
,
132 const struct vport_parms
*parms
)
137 alloc_size
= sizeof(struct vport
);
139 alloc_size
= ALIGN(alloc_size
, VPORT_ALIGN
);
140 alloc_size
+= priv_size
;
143 vport
= kzalloc(alloc_size
, GFP_KERNEL
);
145 return ERR_PTR(-ENOMEM
);
147 vport
->dp
= parms
->dp
;
148 vport
->port_no
= parms
->port_no
;
150 INIT_HLIST_NODE(&vport
->dp_hash_node
);
152 if (ovs_vport_set_upcall_portids(vport
, parms
->upcall_portids
)) {
154 return ERR_PTR(-EINVAL
);
159 EXPORT_SYMBOL_GPL(ovs_vport_alloc
);
162 * ovs_vport_free - uninitialize and free vport
164 * @vport: vport to free
166 * Frees a vport allocated with vport_alloc() when it is no longer needed.
168 * The caller must ensure that an RCU grace period has passed since the last
169 * time @vport was in a datapath.
171 void ovs_vport_free(struct vport
*vport
)
173 /* vport is freed from RCU callback or error path, Therefore
174 * it is safe to use raw dereference.
176 kfree(rcu_dereference_raw(vport
->upcall_portids
));
179 EXPORT_SYMBOL_GPL(ovs_vport_free
);
181 static struct vport_ops
*ovs_vport_lookup(const struct vport_parms
*parms
)
183 struct vport_ops
*ops
;
185 list_for_each_entry(ops
, &vport_ops_list
, list
)
186 if (ops
->type
== parms
->type
)
193 * ovs_vport_add - add vport device (for kernel callers)
195 * @parms: Information about new vport.
197 * Creates a new vport with the specified configuration (which is dependent on
198 * device type). ovs_mutex must be held.
200 struct vport
*ovs_vport_add(const struct vport_parms
*parms
)
202 struct vport_ops
*ops
;
205 ops
= ovs_vport_lookup(parms
);
207 struct hlist_head
*bucket
;
209 if (!try_module_get(ops
->owner
))
210 return ERR_PTR(-EAFNOSUPPORT
);
212 vport
= ops
->create(parms
);
214 module_put(ops
->owner
);
218 bucket
= hash_bucket(ovs_dp_get_net(vport
->dp
),
219 ovs_vport_name(vport
));
220 hlist_add_head_rcu(&vport
->hash_node
, bucket
);
224 /* Unlock to attempt module load and return -EAGAIN if load
225 * was successful as we need to restart the port addition
229 request_module("vport-type-%d", parms
->type
);
232 if (!ovs_vport_lookup(parms
))
233 return ERR_PTR(-EAFNOSUPPORT
);
235 return ERR_PTR(-EAGAIN
);
239 * ovs_vport_set_options - modify existing vport device (for kernel callers)
241 * @vport: vport to modify.
242 * @options: New configuration.
244 * Modifies an existing device with the specified configuration (which is
245 * dependent on device type). ovs_mutex must be held.
247 int ovs_vport_set_options(struct vport
*vport
, struct nlattr
*options
)
249 if (!vport
->ops
->set_options
)
251 return vport
->ops
->set_options(vport
, options
);
255 * ovs_vport_del - delete existing vport device
257 * @vport: vport to delete.
259 * Detaches @vport from its datapath and destroys it. ovs_mutex must
262 void ovs_vport_del(struct vport
*vport
)
266 hlist_del_rcu(&vport
->hash_node
);
267 module_put(vport
->ops
->owner
);
268 vport
->ops
->destroy(vport
);
272 * ovs_vport_get_stats - retrieve device stats
274 * @vport: vport from which to retrieve the stats
275 * @stats: location to store stats
277 * Retrieves transmit, receive, and error stats for the given device.
279 * Must be called with ovs_mutex or rcu_read_lock.
281 void ovs_vport_get_stats(struct vport
*vport
, struct ovs_vport_stats
*stats
)
283 const struct rtnl_link_stats64
*dev_stats
;
284 struct rtnl_link_stats64 temp
;
286 dev_stats
= dev_get_stats(vport
->dev
, &temp
);
287 stats
->rx_errors
= dev_stats
->rx_errors
;
288 stats
->tx_errors
= dev_stats
->tx_errors
;
289 stats
->tx_dropped
= dev_stats
->tx_dropped
;
290 stats
->rx_dropped
= dev_stats
->rx_dropped
;
292 stats
->rx_bytes
= dev_stats
->rx_bytes
;
293 stats
->rx_packets
= dev_stats
->rx_packets
;
294 stats
->tx_bytes
= dev_stats
->tx_bytes
;
295 stats
->tx_packets
= dev_stats
->tx_packets
;
299 * ovs_vport_get_options - retrieve device options
301 * @vport: vport from which to retrieve the options.
302 * @skb: sk_buff where options should be appended.
304 * Retrieves the configuration of the given device, appending an
305 * %OVS_VPORT_ATTR_OPTIONS attribute that in turn contains nested
306 * vport-specific attributes to @skb.
308 * Returns 0 if successful, -EMSGSIZE if @skb has insufficient room, or another
309 * negative error code if a real error occurred. If an error occurs, @skb is
312 * Must be called with ovs_mutex or rcu_read_lock.
314 int ovs_vport_get_options(const struct vport
*vport
, struct sk_buff
*skb
)
319 if (!vport
->ops
->get_options
)
322 nla
= nla_nest_start(skb
, OVS_VPORT_ATTR_OPTIONS
);
326 err
= vport
->ops
->get_options(vport
, skb
);
328 nla_nest_cancel(skb
, nla
);
332 nla_nest_end(skb
, nla
);
337 * ovs_vport_set_upcall_portids - set upcall portids of @vport.
339 * @vport: vport to modify.
340 * @ids: new configuration, an array of port ids.
342 * Sets the vport's upcall_portids to @ids.
344 * Returns 0 if successful, -EINVAL if @ids is zero length or cannot be parsed
345 * as an array of U32.
347 * Must be called with ovs_mutex.
349 int ovs_vport_set_upcall_portids(struct vport
*vport
, const struct nlattr
*ids
)
351 struct vport_portids
*old
, *vport_portids
;
353 if (!nla_len(ids
) || nla_len(ids
) % sizeof(u32
))
356 old
= ovsl_dereference(vport
->upcall_portids
);
358 vport_portids
= kmalloc(sizeof(*vport_portids
) + nla_len(ids
),
363 vport_portids
->n_ids
= nla_len(ids
) / sizeof(u32
);
364 vport_portids
->rn_ids
= reciprocal_value(vport_portids
->n_ids
);
365 nla_memcpy(vport_portids
->ids
, ids
, nla_len(ids
));
367 rcu_assign_pointer(vport
->upcall_portids
, vport_portids
);
375 * ovs_vport_get_upcall_portids - get the upcall_portids of @vport.
377 * @vport: vport from which to retrieve the portids.
378 * @skb: sk_buff where portids should be appended.
380 * Retrieves the configuration of the given vport, appending the
381 * %OVS_VPORT_ATTR_UPCALL_PID attribute which is the array of upcall
384 * Returns 0 if successful, -EMSGSIZE if @skb has insufficient room.
385 * If an error occurs, @skb is left unmodified. Must be called with
386 * ovs_mutex or rcu_read_lock.
388 int ovs_vport_get_upcall_portids(const struct vport
*vport
,
391 struct vport_portids
*ids
;
393 ids
= rcu_dereference_ovsl(vport
->upcall_portids
);
395 if (vport
->dp
->user_features
& OVS_DP_F_VPORT_PIDS
)
396 return nla_put(skb
, OVS_VPORT_ATTR_UPCALL_PID
,
397 ids
->n_ids
* sizeof(u32
), (void *)ids
->ids
);
399 return nla_put_u32(skb
, OVS_VPORT_ATTR_UPCALL_PID
, ids
->ids
[0]);
403 * ovs_vport_find_upcall_portid - find the upcall portid to send upcall.
405 * @vport: vport from which the missed packet is received.
406 * @skb: skb that the missed packet was received.
408 * Uses the skb_get_hash() to select the upcall portid to send the
411 * Returns the portid of the target socket. Must be called with rcu_read_lock.
413 u32
ovs_vport_find_upcall_portid(const struct vport
*vport
, struct sk_buff
*skb
)
415 struct vport_portids
*ids
;
419 ids
= rcu_dereference(vport
->upcall_portids
);
421 if (ids
->n_ids
== 1 && ids
->ids
[0] == 0)
424 hash
= skb_get_hash(skb
);
425 ids_index
= hash
- ids
->n_ids
* reciprocal_divide(hash
, ids
->rn_ids
);
426 return ids
->ids
[ids_index
];
430 * ovs_vport_receive - pass up received packet to the datapath for processing
432 * @vport: vport that received the packet
433 * @skb: skb that was received
434 * @tun_key: tunnel (if any) that carried packet
436 * Must be called with rcu_read_lock. The packet cannot be shared and
437 * skb->data should point to the Ethernet header.
439 int ovs_vport_receive(struct vport
*vport
, struct sk_buff
*skb
,
440 const struct ip_tunnel_info
*tun_info
)
442 struct sw_flow_key key
;
445 OVS_CB(skb
)->input_vport
= vport
;
446 OVS_CB(skb
)->mru
= 0;
447 OVS_CB(skb
)->cutlen
= 0;
448 if (unlikely(dev_net(skb
->dev
) != ovs_dp_get_net(vport
->dp
))) {
452 skb_scrub_packet(skb
, true);
457 /* Extract flow from 'skb' into 'key'. */
458 error
= ovs_flow_key_extract(tun_info
, skb
, &key
);
459 if (unlikely(error
)) {
463 ovs_dp_process_packet(skb
, &key
);
466 EXPORT_SYMBOL_GPL(ovs_vport_receive
);
468 static void free_vport_rcu(struct rcu_head
*rcu
)
470 struct vport
*vport
= container_of(rcu
, struct vport
, rcu
);
472 ovs_vport_free(vport
);
475 void ovs_vport_deferred_free(struct vport
*vport
)
480 call_rcu(&vport
->rcu
, free_vport_rcu
);
482 EXPORT_SYMBOL_GPL(ovs_vport_deferred_free
);
484 static unsigned int packet_length(const struct sk_buff
*skb
)
486 unsigned int length
= skb
->len
- ETH_HLEN
;
488 if (!skb_vlan_tag_present(skb
) &&
489 eth_type_vlan(skb
->protocol
))
492 /* Don't subtract for multiple VLAN tags. Most (all?) drivers allow
493 * (ETH_LEN + VLAN_HLEN) in addition to the mtu value, but almost none
494 * account for 802.1ad. e.g. is_skb_forwardable().
500 void ovs_vport_send(struct vport
*vport
, struct sk_buff
*skb
)
502 int mtu
= vport
->dev
->mtu
;
504 if (unlikely(packet_length(skb
) > mtu
&& !skb_is_gso(skb
))) {
505 net_warn_ratelimited("%s: dropped over-mtu packet: %d > %d\n",
507 packet_length(skb
), mtu
);
508 vport
->dev
->stats
.tx_errors
++;
512 skb
->dev
= vport
->dev
;
513 vport
->ops
->send(skb
);