2 * Copyright (c) 2007-2012 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 <linux/version.h>
31 #include <net/net_namespace.h>
35 #include "vport-internal_dev.h"
37 /* List of statically compiled vport implementations. Don't forget to also
38 * add yours to the list at the bottom of vport.h. */
39 static const struct vport_ops *base_vport_ops_list[] = {
40 &ovs_netdev_vport_ops,
41 &ovs_internal_vport_ops,
45 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,26)
46 &ovs_capwap_vport_ops,
51 static const struct vport_ops **vport_ops_list;
52 static int n_vport_types;
54 /* Protected by RCU read lock for reading, RTNL lock for writing. */
55 static struct hlist_head *dev_table;
56 #define VPORT_HASH_BUCKETS 1024
59 * ovs_vport_init - initialize vport subsystem
61 * Called at module load time to initialize the vport subsystem and any
62 * compiled in vport types.
64 int ovs_vport_init(void)
69 dev_table = kzalloc(VPORT_HASH_BUCKETS * sizeof(struct hlist_head),
76 vport_ops_list = kmalloc(ARRAY_SIZE(base_vport_ops_list) *
77 sizeof(struct vport_ops *), GFP_KERNEL);
78 if (!vport_ops_list) {
83 for (i = 0; i < ARRAY_SIZE(base_vport_ops_list); i++) {
84 const struct vport_ops *new_ops = base_vport_ops_list[i];
87 err = new_ops->init();
92 vport_ops_list[n_vport_types++] = new_ops;
93 else if (new_ops->flags & VPORT_F_REQUIRED) {
108 * ovs_vport_exit - shutdown vport subsystem
110 * Called at module exit time to shutdown the vport subsystem and any
111 * initialized vport types.
113 void ovs_vport_exit(void)
117 for (i = 0; i < n_vport_types; i++) {
118 if (vport_ops_list[i]->exit)
119 vport_ops_list[i]->exit();
122 kfree(vport_ops_list);
126 static struct hlist_head *hash_bucket(struct net *net, const char *name)
128 unsigned int hash = jhash(name, strlen(name), (unsigned long) net);
129 return &dev_table[hash & (VPORT_HASH_BUCKETS - 1)];
133 * ovs_vport_locate - find a port that has already been created
135 * @name: name of port to find
137 * Must be called with RTNL or RCU read lock.
139 struct vport *ovs_vport_locate(struct net *net, const char *name)
141 struct hlist_head *bucket = hash_bucket(net, name);
143 struct hlist_node *node;
145 hlist_for_each_entry_rcu(vport, node, bucket, hash_node)
146 if (!strcmp(name, vport->ops->get_name(vport)) &&
147 net_eq(ovs_dp_get_net(vport->dp), net))
154 * ovs_vport_alloc - allocate and initialize new vport
156 * @priv_size: Size of private data area to allocate.
157 * @ops: vport device ops
159 * Allocate and initialize a new vport defined by @ops. The vport will contain
160 * a private data area of size @priv_size that can be accessed using
161 * vport_priv(). vports that are no longer needed should be released with
164 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *ops,
165 const struct vport_parms *parms)
170 alloc_size = sizeof(struct vport);
172 alloc_size = ALIGN(alloc_size, VPORT_ALIGN);
173 alloc_size += priv_size;
176 vport = kzalloc(alloc_size, GFP_KERNEL);
178 return ERR_PTR(-ENOMEM);
180 vport->dp = parms->dp;
181 vport->port_no = parms->port_no;
182 vport->upcall_portid = parms->upcall_portid;
184 INIT_HLIST_NODE(&vport->dp_hash_node);
186 vport->percpu_stats = alloc_percpu(struct vport_percpu_stats);
187 if (!vport->percpu_stats) {
189 return ERR_PTR(-ENOMEM);
192 spin_lock_init(&vport->stats_lock);
198 * ovs_vport_free - uninitialize and free vport
200 * @vport: vport to free
202 * Frees a vport allocated with ovs_vport_alloc() when it is no longer needed.
204 * The caller must ensure that an RCU grace period has passed since the last
205 * time @vport was in a datapath.
207 void ovs_vport_free(struct vport *vport)
209 free_percpu(vport->percpu_stats);
214 * ovs_vport_add - add vport device (for kernel callers)
216 * @parms: Information about new vport.
218 * Creates a new vport with the specified configuration (which is dependent on
219 * device type). RTNL lock must be held.
221 struct vport *ovs_vport_add(const struct vport_parms *parms)
229 for (i = 0; i < n_vport_types; i++) {
230 if (vport_ops_list[i]->type == parms->type) {
231 struct hlist_head *bucket;
233 vport = vport_ops_list[i]->create(parms);
235 err = PTR_ERR(vport);
239 bucket = hash_bucket(ovs_dp_get_net(vport->dp),
240 vport->ops->get_name(vport));
241 hlist_add_head_rcu(&vport->hash_node, bucket);
253 * ovs_vport_set_options - modify existing vport device (for kernel callers)
255 * @vport: vport to modify.
256 * @port: New configuration.
258 * Modifies an existing device with the specified configuration (which is
259 * dependent on device type). RTNL lock must be held.
261 int ovs_vport_set_options(struct vport *vport, struct nlattr *options)
265 if (!vport->ops->set_options)
267 return vport->ops->set_options(vport, options);
271 * ovs_vport_del - delete existing vport device
273 * @vport: vport to delete.
275 * Detaches @vport from its datapath and destroys it. It is possible to fail
276 * for reasons such as lack of memory. RTNL lock must be held.
278 void ovs_vport_del(struct vport *vport)
282 hlist_del_rcu(&vport->hash_node);
284 vport->ops->destroy(vport);
288 * ovs_vport_set_stats - sets offset device stats
290 * @vport: vport on which to set stats
291 * @stats: stats to set
293 * Provides a set of transmit, receive, and error stats to be added as an
294 * offset to the collect data when stats are retreived. Some devices may not
295 * support setting the stats, in which case the result will always be
298 * Must be called with RTNL lock.
300 void ovs_vport_set_stats(struct vport *vport, struct ovs_vport_stats *stats)
304 spin_lock_bh(&vport->stats_lock);
305 vport->offset_stats = *stats;
306 spin_unlock_bh(&vport->stats_lock);
310 * ovs_vport_get_stats - retrieve device stats
312 * @vport: vport from which to retrieve the stats
313 * @stats: location to store stats
315 * Retrieves transmit, receive, and error stats for the given device.
317 * Must be called with RTNL lock or rcu_read_lock.
319 void ovs_vport_get_stats(struct vport *vport, struct ovs_vport_stats *stats)
323 /* We potentially have 3 sources of stats that need to be
324 * combined: those we have collected (split into err_stats and
325 * percpu_stats), offset_stats from set_stats(), and device
326 * error stats from netdev->get_stats() (for errors that happen
327 * downstream and therefore aren't reported through our
328 * vport_record_error() function).
329 * Stats from first two sources are merged and reported by ovs over
330 * OVS_VPORT_ATTR_STATS.
331 * netdev-stats can be directly read over netlink-ioctl.
334 spin_lock_bh(&vport->stats_lock);
336 *stats = vport->offset_stats;
338 stats->rx_errors += vport->err_stats.rx_errors;
339 stats->tx_errors += vport->err_stats.tx_errors;
340 stats->tx_dropped += vport->err_stats.tx_dropped;
341 stats->rx_dropped += vport->err_stats.rx_dropped;
343 spin_unlock_bh(&vport->stats_lock);
345 for_each_possible_cpu(i) {
346 const struct vport_percpu_stats *percpu_stats;
347 struct vport_percpu_stats local_stats;
350 percpu_stats = per_cpu_ptr(vport->percpu_stats, i);
353 start = u64_stats_fetch_begin_bh(&percpu_stats->sync);
354 local_stats = *percpu_stats;
355 } while (u64_stats_fetch_retry_bh(&percpu_stats->sync, start));
357 stats->rx_bytes += local_stats.rx_bytes;
358 stats->rx_packets += local_stats.rx_packets;
359 stats->tx_bytes += local_stats.tx_bytes;
360 stats->tx_packets += local_stats.tx_packets;
365 * ovs_vport_get_options - retrieve device options
367 * @vport: vport from which to retrieve the options.
368 * @skb: sk_buff where options should be appended.
370 * Retrieves the configuration of the given device, appending an
371 * %OVS_VPORT_ATTR_OPTIONS attribute that in turn contains nested
372 * vport-specific attributes to @skb.
374 * Returns 0 if successful, -EMSGSIZE if @skb has insufficient room, or another
375 * negative error code if a real error occurred. If an error occurs, @skb is
378 * Must be called with RTNL lock or rcu_read_lock.
380 int ovs_vport_get_options(const struct vport *vport, struct sk_buff *skb)
384 nla = nla_nest_start(skb, OVS_VPORT_ATTR_OPTIONS);
388 if (vport->ops->get_options) {
389 int err = vport->ops->get_options(vport, skb);
391 nla_nest_cancel(skb, nla);
396 nla_nest_end(skb, nla);
401 * ovs_vport_receive - pass up received packet to the datapath for processing
403 * @vport: vport that received the packet
404 * @skb: skb that was received
406 * Must be called with rcu_read_lock. The packet cannot be shared and
407 * skb->data should point to the Ethernet header. The caller must have already
408 * called compute_ip_summed() to initialize the checksumming fields.
410 void ovs_vport_receive(struct vport *vport, struct sk_buff *skb)
412 struct vport_percpu_stats *stats;
414 stats = this_cpu_ptr(vport->percpu_stats);
415 u64_stats_update_begin(&stats->sync);
417 stats->rx_bytes += skb->len;
418 u64_stats_update_end(&stats->sync);
420 if (!(vport->ops->flags & VPORT_F_FLOW))
421 OVS_CB(skb)->flow = NULL;
423 if (!(vport->ops->flags & VPORT_F_TUN_ID))
424 OVS_CB(skb)->tun_key = NULL;
426 ovs_dp_process_received_packet(vport, skb);
430 * ovs_vport_send - send a packet on a device
432 * @vport: vport on which to send the packet
435 * Sends the given packet and returns the length of data sent. Either RTNL
436 * lock or rcu_read_lock must be held.
438 int ovs_vport_send(struct vport *vport, struct sk_buff *skb)
440 int sent = vport->ops->send(vport, skb);
443 struct vport_percpu_stats *stats;
445 stats = this_cpu_ptr(vport->percpu_stats);
447 u64_stats_update_begin(&stats->sync);
449 stats->tx_bytes += sent;
450 u64_stats_update_end(&stats->sync);
456 * ovs_vport_record_error - indicate device error to generic stats layer
458 * @vport: vport that encountered the error
459 * @err_type: one of enum vport_err_type types to indicate the error type
461 * If using the vport generic stats layer indicate that an error of the given
464 void ovs_vport_record_error(struct vport *vport, enum vport_err_type err_type)
466 spin_lock(&vport->stats_lock);
469 case VPORT_E_RX_DROPPED:
470 vport->err_stats.rx_dropped++;
473 case VPORT_E_RX_ERROR:
474 vport->err_stats.rx_errors++;
477 case VPORT_E_TX_DROPPED:
478 vport->err_stats.tx_dropped++;
481 case VPORT_E_TX_ERROR:
482 vport->err_stats.tx_errors++;
486 spin_unlock(&vport->stats_lock);