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 <net/net_namespace.h>
34 #include "vport-internal_dev.h"
36 /* List of statically compiled vport implementations. Don't forget to also
37 * add yours to the list at the bottom of vport.h. */
38 static const struct vport_ops
*vport_ops_list
[] = {
39 &ovs_netdev_vport_ops
,
40 &ovs_internal_vport_ops
,
42 #ifdef CONFIG_OPENVSWITCH_GRE
45 #ifdef CONFIG_OPENVSWITCH_VXLAN
50 /* Protected by RCU read lock for reading, ovs_mutex for writing. */
51 static struct hlist_head
*dev_table
;
52 #define VPORT_HASH_BUCKETS 1024
55 * ovs_vport_init - initialize vport subsystem
57 * Called at module load time to initialize the vport subsystem.
59 int ovs_vport_init(void)
61 dev_table
= kzalloc(VPORT_HASH_BUCKETS
* sizeof(struct hlist_head
),
70 * ovs_vport_exit - shutdown vport subsystem
72 * Called at module exit time to shutdown the vport subsystem.
74 void ovs_vport_exit(void)
79 static struct hlist_head
*hash_bucket(struct net
*net
, const char *name
)
81 unsigned int hash
= jhash(name
, strlen(name
), (unsigned long) net
);
82 return &dev_table
[hash
& (VPORT_HASH_BUCKETS
- 1)];
86 * ovs_vport_locate - find a port that has already been created
88 * @name: name of port to find
90 * Must be called with ovs or RCU read lock.
92 struct vport
*ovs_vport_locate(struct net
*net
, const char *name
)
94 struct hlist_head
*bucket
= hash_bucket(net
, name
);
97 hlist_for_each_entry_rcu(vport
, bucket
, hash_node
)
98 if (!strcmp(name
, vport
->ops
->get_name(vport
)) &&
99 net_eq(ovs_dp_get_net(vport
->dp
), net
))
106 * ovs_vport_alloc - allocate and initialize new vport
108 * @priv_size: Size of private data area to allocate.
109 * @ops: vport device ops
111 * Allocate and initialize a new vport defined by @ops. The vport will contain
112 * a private data area of size @priv_size that can be accessed using
113 * vport_priv(). vports that are no longer needed should be released with
116 struct vport
*ovs_vport_alloc(int priv_size
, const struct vport_ops
*ops
,
117 const struct vport_parms
*parms
)
123 alloc_size
= sizeof(struct vport
);
125 alloc_size
= ALIGN(alloc_size
, VPORT_ALIGN
);
126 alloc_size
+= priv_size
;
129 vport
= kzalloc(alloc_size
, GFP_KERNEL
);
131 return ERR_PTR(-ENOMEM
);
133 vport
->dp
= parms
->dp
;
134 vport
->port_no
= parms
->port_no
;
135 vport
->upcall_portid
= parms
->upcall_portid
;
137 INIT_HLIST_NODE(&vport
->dp_hash_node
);
139 vport
->percpu_stats
= alloc_percpu(struct pcpu_tstats
);
140 if (!vport
->percpu_stats
) {
142 return ERR_PTR(-ENOMEM
);
145 for_each_possible_cpu(i
) {
146 struct pcpu_tstats
*vport_stats
;
147 vport_stats
= per_cpu_ptr(vport
->percpu_stats
, i
);
148 u64_stats_init(&vport_stats
->syncp
);
152 spin_lock_init(&vport
->stats_lock
);
158 * ovs_vport_free - uninitialize and free vport
160 * @vport: vport to free
162 * Frees a vport allocated with vport_alloc() when it is no longer needed.
164 * The caller must ensure that an RCU grace period has passed since the last
165 * time @vport was in a datapath.
167 void ovs_vport_free(struct vport
*vport
)
169 free_percpu(vport
->percpu_stats
);
174 * ovs_vport_add - add vport device (for kernel callers)
176 * @parms: Information about new vport.
178 * Creates a new vport with the specified configuration (which is dependent on
179 * device type). ovs_mutex must be held.
181 struct vport
*ovs_vport_add(const struct vport_parms
*parms
)
187 for (i
= 0; i
< ARRAY_SIZE(vport_ops_list
); i
++) {
188 if (vport_ops_list
[i
]->type
== parms
->type
) {
189 struct hlist_head
*bucket
;
191 vport
= vport_ops_list
[i
]->create(parms
);
193 err
= PTR_ERR(vport
);
197 bucket
= hash_bucket(ovs_dp_get_net(vport
->dp
),
198 vport
->ops
->get_name(vport
));
199 hlist_add_head_rcu(&vport
->hash_node
, bucket
);
211 * ovs_vport_set_options - modify existing vport device (for kernel callers)
213 * @vport: vport to modify.
214 * @options: New configuration.
216 * Modifies an existing device with the specified configuration (which is
217 * dependent on device type). ovs_mutex must be held.
219 int ovs_vport_set_options(struct vport
*vport
, struct nlattr
*options
)
221 if (!vport
->ops
->set_options
)
223 return vport
->ops
->set_options(vport
, options
);
227 * ovs_vport_del - delete existing vport device
229 * @vport: vport to delete.
231 * Detaches @vport from its datapath and destroys it. It is possible to fail
232 * for reasons such as lack of memory. ovs_mutex must be held.
234 void ovs_vport_del(struct vport
*vport
)
238 hlist_del_rcu(&vport
->hash_node
);
240 vport
->ops
->destroy(vport
);
244 * ovs_vport_get_stats - retrieve device stats
246 * @vport: vport from which to retrieve the stats
247 * @stats: location to store stats
249 * Retrieves transmit, receive, and error stats for the given device.
251 * Must be called with ovs_mutex or rcu_read_lock.
253 void ovs_vport_get_stats(struct vport
*vport
, struct ovs_vport_stats
*stats
)
257 memset(stats
, 0, sizeof(*stats
));
259 /* We potentially have 2 sources of stats that need to be combined:
260 * those we have collected (split into err_stats and percpu_stats) from
261 * set_stats() and device error stats from netdev->get_stats() (for
262 * errors that happen downstream and therefore aren't reported through
263 * our vport_record_error() function).
264 * Stats from first source are reported by ovs (OVS_VPORT_ATTR_STATS).
265 * netdev-stats can be directly read over netlink-ioctl.
268 spin_lock_bh(&vport
->stats_lock
);
270 stats
->rx_errors
= vport
->err_stats
.rx_errors
;
271 stats
->tx_errors
= vport
->err_stats
.tx_errors
;
272 stats
->tx_dropped
= vport
->err_stats
.tx_dropped
;
273 stats
->rx_dropped
= vport
->err_stats
.rx_dropped
;
275 spin_unlock_bh(&vport
->stats_lock
);
277 for_each_possible_cpu(i
) {
278 const struct pcpu_tstats
*percpu_stats
;
279 struct pcpu_tstats local_stats
;
282 percpu_stats
= per_cpu_ptr(vport
->percpu_stats
, i
);
285 start
= u64_stats_fetch_begin_bh(&percpu_stats
->syncp
);
286 local_stats
= *percpu_stats
;
287 } while (u64_stats_fetch_retry_bh(&percpu_stats
->syncp
, start
));
289 stats
->rx_bytes
+= local_stats
.rx_bytes
;
290 stats
->rx_packets
+= local_stats
.rx_packets
;
291 stats
->tx_bytes
+= local_stats
.tx_bytes
;
292 stats
->tx_packets
+= local_stats
.tx_packets
;
297 * ovs_vport_get_options - retrieve device options
299 * @vport: vport from which to retrieve the options.
300 * @skb: sk_buff where options should be appended.
302 * Retrieves the configuration of the given device, appending an
303 * %OVS_VPORT_ATTR_OPTIONS attribute that in turn contains nested
304 * vport-specific attributes to @skb.
306 * Returns 0 if successful, -EMSGSIZE if @skb has insufficient room, or another
307 * negative error code if a real error occurred. If an error occurs, @skb is
310 * Must be called with ovs_mutex or rcu_read_lock.
312 int ovs_vport_get_options(const struct vport
*vport
, struct sk_buff
*skb
)
317 if (!vport
->ops
->get_options
)
320 nla
= nla_nest_start(skb
, OVS_VPORT_ATTR_OPTIONS
);
324 err
= vport
->ops
->get_options(vport
, skb
);
326 nla_nest_cancel(skb
, nla
);
330 nla_nest_end(skb
, nla
);
335 * ovs_vport_receive - pass up received packet to the datapath for processing
337 * @vport: vport that received the packet
338 * @skb: skb that was received
339 * @tun_key: tunnel (if any) that carried packet
341 * Must be called with rcu_read_lock. The packet cannot be shared and
342 * skb->data should point to the Ethernet header.
344 void ovs_vport_receive(struct vport
*vport
, struct sk_buff
*skb
,
345 struct ovs_key_ipv4_tunnel
*tun_key
)
347 struct pcpu_tstats
*stats
;
349 stats
= this_cpu_ptr(vport
->percpu_stats
);
350 u64_stats_update_begin(&stats
->syncp
);
352 stats
->rx_bytes
+= skb
->len
;
353 u64_stats_update_end(&stats
->syncp
);
355 OVS_CB(skb
)->tun_key
= tun_key
;
356 ovs_dp_process_received_packet(vport
, skb
);
360 * ovs_vport_send - send a packet on a device
362 * @vport: vport on which to send the packet
365 * Sends the given packet and returns the length of data sent. Either ovs
366 * lock or rcu_read_lock must be held.
368 int ovs_vport_send(struct vport
*vport
, struct sk_buff
*skb
)
370 int sent
= vport
->ops
->send(vport
, skb
);
372 if (likely(sent
> 0)) {
373 struct pcpu_tstats
*stats
;
375 stats
= this_cpu_ptr(vport
->percpu_stats
);
377 u64_stats_update_begin(&stats
->syncp
);
379 stats
->tx_bytes
+= sent
;
380 u64_stats_update_end(&stats
->syncp
);
381 } else if (sent
< 0) {
382 ovs_vport_record_error(vport
, VPORT_E_TX_ERROR
);
385 ovs_vport_record_error(vport
, VPORT_E_TX_DROPPED
);
391 * ovs_vport_record_error - indicate device error to generic stats layer
393 * @vport: vport that encountered the error
394 * @err_type: one of enum vport_err_type types to indicate the error type
396 * If using the vport generic stats layer indicate that an error of the given
399 void ovs_vport_record_error(struct vport
*vport
, enum vport_err_type err_type
)
401 spin_lock(&vport
->stats_lock
);
404 case VPORT_E_RX_DROPPED
:
405 vport
->err_stats
.rx_dropped
++;
408 case VPORT_E_RX_ERROR
:
409 vport
->err_stats
.rx_errors
++;
412 case VPORT_E_TX_DROPPED
:
413 vport
->err_stats
.tx_dropped
++;
416 case VPORT_E_TX_ERROR
:
417 vport
->err_stats
.tx_errors
++;
421 spin_unlock(&vport
->stats_lock
);
424 static void free_vport_rcu(struct rcu_head
*rcu
)
426 struct vport
*vport
= container_of(rcu
, struct vport
, rcu
);
428 ovs_vport_free(vport
);
431 void ovs_vport_deferred_free(struct vport
*vport
)
436 call_rcu(&vport
->rcu
, free_vport_rcu
);