2 * Copyright (c) 2007-2011 Nicira Networks.
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/dcache.h>
20 #include <linux/etherdevice.h>
22 #include <linux/if_vlan.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>
32 #include "vport-internal_dev.h"
34 /* List of statically compiled vport implementations. Don't forget to also
35 * add yours to the list at the bottom of vport.h. */
36 static const struct vport_ops *vport_ops_list[] = {
37 &ovs_netdev_vport_ops,
38 &ovs_internal_vport_ops,
41 /* Protected by RCU read lock for reading, RTNL lock for writing. */
42 static struct hlist_head *dev_table;
43 #define VPORT_HASH_BUCKETS 1024
46 * ovs_vport_init - initialize vport subsystem
48 * Called at module load time to initialize the vport subsystem.
50 int ovs_vport_init(void)
52 dev_table = kzalloc(VPORT_HASH_BUCKETS * sizeof(struct hlist_head),
61 * ovs_vport_exit - shutdown vport subsystem
63 * Called at module exit time to shutdown the vport subsystem.
65 void ovs_vport_exit(void)
70 static struct hlist_head *hash_bucket(const char *name)
72 unsigned int hash = full_name_hash(name, strlen(name));
73 return &dev_table[hash & (VPORT_HASH_BUCKETS - 1)];
77 * ovs_vport_locate - find a port that has already been created
79 * @name: name of port to find
81 * Must be called with RTNL or RCU read lock.
83 struct vport *ovs_vport_locate(const char *name)
85 struct hlist_head *bucket = hash_bucket(name);
87 struct hlist_node *node;
89 hlist_for_each_entry_rcu(vport, node, bucket, hash_node)
90 if (!strcmp(name, vport->ops->get_name(vport)))
97 * ovs_vport_alloc - allocate and initialize new vport
99 * @priv_size: Size of private data area to allocate.
100 * @ops: vport device ops
102 * Allocate and initialize a new vport defined by @ops. The vport will contain
103 * a private data area of size @priv_size that can be accessed using
104 * vport_priv(). vports that are no longer needed should be released with
107 struct vport *ovs_vport_alloc(int priv_size, const struct vport_ops *ops,
108 const struct vport_parms *parms)
113 alloc_size = sizeof(struct vport);
115 alloc_size = ALIGN(alloc_size, VPORT_ALIGN);
116 alloc_size += priv_size;
119 vport = kzalloc(alloc_size, GFP_KERNEL);
121 return ERR_PTR(-ENOMEM);
123 vport->dp = parms->dp;
124 vport->port_no = parms->port_no;
125 vport->upcall_pid = parms->upcall_pid;
128 vport->percpu_stats = alloc_percpu(struct vport_percpu_stats);
129 if (!vport->percpu_stats) {
131 return ERR_PTR(-ENOMEM);
134 spin_lock_init(&vport->stats_lock);
140 * ovs_vport_free - uninitialize and free vport
142 * @vport: vport to free
144 * Frees a vport allocated with vport_alloc() when it is no longer needed.
146 * The caller must ensure that an RCU grace period has passed since the last
147 * time @vport was in a datapath.
149 void ovs_vport_free(struct vport *vport)
151 free_percpu(vport->percpu_stats);
156 * ovs_vport_add - add vport device (for kernel callers)
158 * @parms: Information about new vport.
160 * Creates a new vport with the specified configuration (which is dependent on
161 * device type). RTNL lock must be held.
163 struct vport *ovs_vport_add(const struct vport_parms *parms)
171 for (i = 0; i < ARRAY_SIZE(vport_ops_list); i++) {
172 if (vport_ops_list[i]->type == parms->type) {
173 vport = vport_ops_list[i]->create(parms);
175 err = PTR_ERR(vport);
179 hlist_add_head_rcu(&vport->hash_node,
180 hash_bucket(vport->ops->get_name(vport)));
192 * ovs_vport_set_options - modify existing vport device (for kernel callers)
194 * @vport: vport to modify.
195 * @port: New configuration.
197 * Modifies an existing device with the specified configuration (which is
198 * dependent on device type). RTNL lock must be held.
200 int ovs_vport_set_options(struct vport *vport, struct nlattr *options)
204 if (!vport->ops->set_options)
206 return vport->ops->set_options(vport, options);
210 * ovs_vport_del - delete existing vport device
212 * @vport: vport to delete.
214 * Detaches @vport from its datapath and destroys it. It is possible to fail
215 * for reasons such as lack of memory. RTNL lock must be held.
217 void ovs_vport_del(struct vport *vport)
221 hlist_del_rcu(&vport->hash_node);
223 vport->ops->destroy(vport);
227 * ovs_vport_get_stats - retrieve device stats
229 * @vport: vport from which to retrieve the stats
230 * @stats: location to store stats
232 * Retrieves transmit, receive, and error stats for the given device.
234 * Must be called with RTNL lock or rcu_read_lock.
236 void ovs_vport_get_stats(struct vport *vport, struct ovs_vport_stats *stats)
240 memset(stats, 0, sizeof(*stats));
242 /* We potentially have 2 sources of stats that need to be combined:
243 * those we have collected (split into err_stats and percpu_stats) from
244 * set_stats() and device error stats from netdev->get_stats() (for
245 * errors that happen downstream and therefore aren't reported through
246 * our vport_record_error() function).
247 * Stats from first source are reported by ovs (OVS_VPORT_ATTR_STATS).
248 * netdev-stats can be directly read over netlink-ioctl.
251 spin_lock_bh(&vport->stats_lock);
253 stats->rx_errors = vport->err_stats.rx_errors;
254 stats->tx_errors = vport->err_stats.tx_errors;
255 stats->tx_dropped = vport->err_stats.tx_dropped;
256 stats->rx_dropped = vport->err_stats.rx_dropped;
258 spin_unlock_bh(&vport->stats_lock);
260 for_each_possible_cpu(i) {
261 const struct vport_percpu_stats *percpu_stats;
262 struct vport_percpu_stats local_stats;
265 percpu_stats = per_cpu_ptr(vport->percpu_stats, i);
268 start = u64_stats_fetch_begin_bh(&percpu_stats->sync);
269 local_stats = *percpu_stats;
270 } while (u64_stats_fetch_retry_bh(&percpu_stats->sync, start));
272 stats->rx_bytes += local_stats.rx_bytes;
273 stats->rx_packets += local_stats.rx_packets;
274 stats->tx_bytes += local_stats.tx_bytes;
275 stats->tx_packets += local_stats.tx_packets;
280 * ovs_vport_get_options - retrieve device options
282 * @vport: vport from which to retrieve the options.
283 * @skb: sk_buff where options should be appended.
285 * Retrieves the configuration of the given device, appending an
286 * %OVS_VPORT_ATTR_OPTIONS attribute that in turn contains nested
287 * vport-specific attributes to @skb.
289 * Returns 0 if successful, -EMSGSIZE if @skb has insufficient room, or another
290 * negative error code if a real error occurred. If an error occurs, @skb is
293 * Must be called with RTNL lock or rcu_read_lock.
295 int ovs_vport_get_options(const struct vport *vport, struct sk_buff *skb)
299 nla = nla_nest_start(skb, OVS_VPORT_ATTR_OPTIONS);
303 if (vport->ops->get_options) {
304 int err = vport->ops->get_options(vport, skb);
306 nla_nest_cancel(skb, nla);
311 nla_nest_end(skb, nla);
316 * ovs_vport_receive - pass up received packet to the datapath for processing
318 * @vport: vport that received the packet
319 * @skb: skb that was received
321 * Must be called with rcu_read_lock. The packet cannot be shared and
322 * skb->data should point to the Ethernet header. The caller must have already
323 * called compute_ip_summed() to initialize the checksumming fields.
325 void ovs_vport_receive(struct vport *vport, struct sk_buff *skb)
327 struct vport_percpu_stats *stats;
329 stats = per_cpu_ptr(vport->percpu_stats, smp_processor_id());
331 u64_stats_update_begin(&stats->sync);
333 stats->rx_bytes += skb->len;
334 u64_stats_update_end(&stats->sync);
336 ovs_dp_process_received_packet(vport, skb);
340 * ovs_vport_send - send a packet on a device
342 * @vport: vport on which to send the packet
345 * Sends the given packet and returns the length of data sent. Either RTNL
346 * lock or rcu_read_lock must be held.
348 int ovs_vport_send(struct vport *vport, struct sk_buff *skb)
350 int sent = vport->ops->send(vport, skb);
353 struct vport_percpu_stats *stats;
355 stats = per_cpu_ptr(vport->percpu_stats, smp_processor_id());
357 u64_stats_update_begin(&stats->sync);
359 stats->tx_bytes += sent;
360 u64_stats_update_end(&stats->sync);
366 * ovs_vport_record_error - indicate device error to generic stats layer
368 * @vport: vport that encountered the error
369 * @err_type: one of enum vport_err_type types to indicate the error type
371 * If using the vport generic stats layer indicate that an error of the given
374 void ovs_vport_record_error(struct vport *vport, enum vport_err_type err_type)
376 spin_lock(&vport->stats_lock);
379 case VPORT_E_RX_DROPPED:
380 vport->err_stats.rx_dropped++;
383 case VPORT_E_RX_ERROR:
384 vport->err_stats.rx_errors++;
387 case VPORT_E_TX_DROPPED:
388 vport->err_stats.tx_dropped++;
391 case VPORT_E_TX_ERROR:
392 vport->err_stats.tx_errors++;
396 spin_unlock(&vport->stats_lock);