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 void ovs_vport_record_error(struct vport
*,
38 enum vport_err_type err_type
);
40 static LIST_HEAD(vport_ops_list
);
42 /* Protected by RCU read lock for reading, ovs_mutex for writing. */
43 static struct hlist_head
*dev_table
;
44 #define VPORT_HASH_BUCKETS 1024
47 * ovs_vport_init - initialize vport subsystem
49 * Called at module load time to initialize the vport subsystem.
51 int ovs_vport_init(void)
53 dev_table
= kzalloc(VPORT_HASH_BUCKETS
* sizeof(struct hlist_head
),
62 * ovs_vport_exit - shutdown vport subsystem
64 * Called at module exit time to shutdown the vport subsystem.
66 void ovs_vport_exit(void)
71 static struct hlist_head
*hash_bucket(const struct net
*net
, const char *name
)
73 unsigned int hash
= jhash(name
, strlen(name
), (unsigned long) net
);
74 return &dev_table
[hash
& (VPORT_HASH_BUCKETS
- 1)];
77 int ovs_vport_ops_register(struct vport_ops
*ops
)
83 list_for_each_entry(o
, &vport_ops_list
, list
)
84 if (ops
->type
== o
->type
)
87 list_add_tail(&ops
->list
, &vport_ops_list
);
93 EXPORT_SYMBOL_GPL(ovs_vport_ops_register
);
95 void ovs_vport_ops_unregister(struct vport_ops
*ops
)
101 EXPORT_SYMBOL_GPL(ovs_vport_ops_unregister
);
104 * ovs_vport_locate - find a port that has already been created
106 * @name: name of port to find
108 * Must be called with ovs or RCU read lock.
110 struct vport
*ovs_vport_locate(const struct net
*net
, const char *name
)
112 struct hlist_head
*bucket
= hash_bucket(net
, name
);
115 hlist_for_each_entry_rcu(vport
, bucket
, hash_node
)
116 if (!strcmp(name
, vport
->ops
->get_name(vport
)) &&
117 net_eq(ovs_dp_get_net(vport
->dp
), net
))
124 * ovs_vport_alloc - allocate and initialize new vport
126 * @priv_size: Size of private data area to allocate.
127 * @ops: vport device ops
129 * Allocate and initialize a new vport defined by @ops. The vport will contain
130 * a private data area of size @priv_size that can be accessed using
131 * vport_priv(). vports that are no longer needed should be released with
134 struct vport
*ovs_vport_alloc(int priv_size
, const struct vport_ops
*ops
,
135 const struct vport_parms
*parms
)
140 alloc_size
= sizeof(struct vport
);
142 alloc_size
= ALIGN(alloc_size
, VPORT_ALIGN
);
143 alloc_size
+= priv_size
;
146 vport
= kzalloc(alloc_size
, GFP_KERNEL
);
148 return ERR_PTR(-ENOMEM
);
150 vport
->dp
= parms
->dp
;
151 vport
->port_no
= parms
->port_no
;
153 INIT_HLIST_NODE(&vport
->dp_hash_node
);
155 if (ovs_vport_set_upcall_portids(vport
, parms
->upcall_portids
)) {
157 return ERR_PTR(-EINVAL
);
160 vport
->percpu_stats
= netdev_alloc_pcpu_stats(struct pcpu_sw_netstats
);
161 if (!vport
->percpu_stats
) {
163 return ERR_PTR(-ENOMEM
);
168 EXPORT_SYMBOL_GPL(ovs_vport_alloc
);
171 * ovs_vport_free - uninitialize and free vport
173 * @vport: vport to free
175 * Frees a vport allocated with vport_alloc() when it is no longer needed.
177 * The caller must ensure that an RCU grace period has passed since the last
178 * time @vport was in a datapath.
180 void ovs_vport_free(struct vport
*vport
)
182 /* vport is freed from RCU callback or error path, Therefore
183 * it is safe to use raw dereference.
185 kfree(rcu_dereference_raw(vport
->upcall_portids
));
186 free_percpu(vport
->percpu_stats
);
189 EXPORT_SYMBOL_GPL(ovs_vport_free
);
191 static struct vport_ops
*ovs_vport_lookup(const struct vport_parms
*parms
)
193 struct vport_ops
*ops
;
195 list_for_each_entry(ops
, &vport_ops_list
, list
)
196 if (ops
->type
== parms
->type
)
203 * ovs_vport_add - add vport device (for kernel callers)
205 * @parms: Information about new vport.
207 * Creates a new vport with the specified configuration (which is dependent on
208 * device type). ovs_mutex must be held.
210 struct vport
*ovs_vport_add(const struct vport_parms
*parms
)
212 struct vport_ops
*ops
;
215 ops
= ovs_vport_lookup(parms
);
217 struct hlist_head
*bucket
;
219 if (!try_module_get(ops
->owner
))
220 return ERR_PTR(-EAFNOSUPPORT
);
222 vport
= ops
->create(parms
);
224 module_put(ops
->owner
);
228 bucket
= hash_bucket(ovs_dp_get_net(vport
->dp
),
229 vport
->ops
->get_name(vport
));
230 hlist_add_head_rcu(&vport
->hash_node
, bucket
);
234 /* Unlock to attempt module load and return -EAGAIN if load
235 * was successful as we need to restart the port addition
239 request_module("vport-type-%d", parms
->type
);
242 if (!ovs_vport_lookup(parms
))
243 return ERR_PTR(-EAFNOSUPPORT
);
245 return ERR_PTR(-EAGAIN
);
249 * ovs_vport_set_options - modify existing vport device (for kernel callers)
251 * @vport: vport to modify.
252 * @options: New configuration.
254 * Modifies an existing device with the specified configuration (which is
255 * dependent on device type). ovs_mutex must be held.
257 int ovs_vport_set_options(struct vport
*vport
, struct nlattr
*options
)
259 if (!vport
->ops
->set_options
)
261 return vport
->ops
->set_options(vport
, options
);
265 * ovs_vport_del - delete existing vport device
267 * @vport: vport to delete.
269 * Detaches @vport from its datapath and destroys it. It is possible to fail
270 * for reasons such as lack of memory. ovs_mutex must be held.
272 void ovs_vport_del(struct vport
*vport
)
276 hlist_del_rcu(&vport
->hash_node
);
277 module_put(vport
->ops
->owner
);
278 vport
->ops
->destroy(vport
);
282 * ovs_vport_get_stats - retrieve device stats
284 * @vport: vport from which to retrieve the stats
285 * @stats: location to store stats
287 * Retrieves transmit, receive, and error stats for the given device.
289 * Must be called with ovs_mutex or rcu_read_lock.
291 void ovs_vport_get_stats(struct vport
*vport
, struct ovs_vport_stats
*stats
)
295 memset(stats
, 0, sizeof(*stats
));
297 /* We potentially have 2 sources of stats that need to be combined:
298 * those we have collected (split into err_stats and percpu_stats) from
299 * set_stats() and device error stats from netdev->get_stats() (for
300 * errors that happen downstream and therefore aren't reported through
301 * our vport_record_error() function).
302 * Stats from first source are reported by ovs (OVS_VPORT_ATTR_STATS).
303 * netdev-stats can be directly read over netlink-ioctl.
306 stats
->rx_errors
= atomic_long_read(&vport
->err_stats
.rx_errors
);
307 stats
->tx_errors
= atomic_long_read(&vport
->err_stats
.tx_errors
);
308 stats
->tx_dropped
= atomic_long_read(&vport
->err_stats
.tx_dropped
);
309 stats
->rx_dropped
= atomic_long_read(&vport
->err_stats
.rx_dropped
);
311 for_each_possible_cpu(i
) {
312 const struct pcpu_sw_netstats
*percpu_stats
;
313 struct pcpu_sw_netstats local_stats
;
316 percpu_stats
= per_cpu_ptr(vport
->percpu_stats
, i
);
319 start
= u64_stats_fetch_begin_irq(&percpu_stats
->syncp
);
320 local_stats
= *percpu_stats
;
321 } while (u64_stats_fetch_retry_irq(&percpu_stats
->syncp
, start
));
323 stats
->rx_bytes
+= local_stats
.rx_bytes
;
324 stats
->rx_packets
+= local_stats
.rx_packets
;
325 stats
->tx_bytes
+= local_stats
.tx_bytes
;
326 stats
->tx_packets
+= local_stats
.tx_packets
;
331 * ovs_vport_get_options - retrieve device options
333 * @vport: vport from which to retrieve the options.
334 * @skb: sk_buff where options should be appended.
336 * Retrieves the configuration of the given device, appending an
337 * %OVS_VPORT_ATTR_OPTIONS attribute that in turn contains nested
338 * vport-specific attributes to @skb.
340 * Returns 0 if successful, -EMSGSIZE if @skb has insufficient room, or another
341 * negative error code if a real error occurred. If an error occurs, @skb is
344 * Must be called with ovs_mutex or rcu_read_lock.
346 int ovs_vport_get_options(const struct vport
*vport
, struct sk_buff
*skb
)
351 if (!vport
->ops
->get_options
)
354 nla
= nla_nest_start(skb
, OVS_VPORT_ATTR_OPTIONS
);
358 err
= vport
->ops
->get_options(vport
, skb
);
360 nla_nest_cancel(skb
, nla
);
364 nla_nest_end(skb
, nla
);
369 * ovs_vport_set_upcall_portids - set upcall portids of @vport.
371 * @vport: vport to modify.
372 * @ids: new configuration, an array of port ids.
374 * Sets the vport's upcall_portids to @ids.
376 * Returns 0 if successful, -EINVAL if @ids is zero length or cannot be parsed
377 * as an array of U32.
379 * Must be called with ovs_mutex.
381 int ovs_vport_set_upcall_portids(struct vport
*vport
, const struct nlattr
*ids
)
383 struct vport_portids
*old
, *vport_portids
;
385 if (!nla_len(ids
) || nla_len(ids
) % sizeof(u32
))
388 old
= ovsl_dereference(vport
->upcall_portids
);
390 vport_portids
= kmalloc(sizeof(*vport_portids
) + nla_len(ids
),
395 vport_portids
->n_ids
= nla_len(ids
) / sizeof(u32
);
396 vport_portids
->rn_ids
= reciprocal_value(vport_portids
->n_ids
);
397 nla_memcpy(vport_portids
->ids
, ids
, nla_len(ids
));
399 rcu_assign_pointer(vport
->upcall_portids
, vport_portids
);
407 * ovs_vport_get_upcall_portids - get the upcall_portids of @vport.
409 * @vport: vport from which to retrieve the portids.
410 * @skb: sk_buff where portids should be appended.
412 * Retrieves the configuration of the given vport, appending the
413 * %OVS_VPORT_ATTR_UPCALL_PID attribute which is the array of upcall
416 * Returns 0 if successful, -EMSGSIZE if @skb has insufficient room.
417 * If an error occurs, @skb is left unmodified. Must be called with
418 * ovs_mutex or rcu_read_lock.
420 int ovs_vport_get_upcall_portids(const struct vport
*vport
,
423 struct vport_portids
*ids
;
425 ids
= rcu_dereference_ovsl(vport
->upcall_portids
);
427 if (vport
->dp
->user_features
& OVS_DP_F_VPORT_PIDS
)
428 return nla_put(skb
, OVS_VPORT_ATTR_UPCALL_PID
,
429 ids
->n_ids
* sizeof(u32
), (void *)ids
->ids
);
431 return nla_put_u32(skb
, OVS_VPORT_ATTR_UPCALL_PID
, ids
->ids
[0]);
435 * ovs_vport_find_upcall_portid - find the upcall portid to send upcall.
437 * @vport: vport from which the missed packet is received.
438 * @skb: skb that the missed packet was received.
440 * Uses the skb_get_hash() to select the upcall portid to send the
443 * Returns the portid of the target socket. Must be called with rcu_read_lock.
445 u32
ovs_vport_find_upcall_portid(const struct vport
*vport
, struct sk_buff
*skb
)
447 struct vport_portids
*ids
;
451 ids
= rcu_dereference(vport
->upcall_portids
);
453 if (ids
->n_ids
== 1 && ids
->ids
[0] == 0)
456 hash
= skb_get_hash(skb
);
457 ids_index
= hash
- ids
->n_ids
* reciprocal_divide(hash
, ids
->rn_ids
);
458 return ids
->ids
[ids_index
];
462 * ovs_vport_receive - pass up received packet to the datapath for processing
464 * @vport: vport that received the packet
465 * @skb: skb that was received
466 * @tun_key: tunnel (if any) that carried packet
468 * Must be called with rcu_read_lock. The packet cannot be shared and
469 * skb->data should point to the Ethernet header.
471 void ovs_vport_receive(struct vport
*vport
, struct sk_buff
*skb
,
472 const struct ovs_tunnel_info
*tun_info
)
474 struct pcpu_sw_netstats
*stats
;
475 struct sw_flow_key key
;
478 stats
= this_cpu_ptr(vport
->percpu_stats
);
479 u64_stats_update_begin(&stats
->syncp
);
481 stats
->rx_bytes
+= skb
->len
+
482 (skb_vlan_tag_present(skb
) ? VLAN_HLEN
: 0);
483 u64_stats_update_end(&stats
->syncp
);
485 OVS_CB(skb
)->input_vport
= vport
;
486 OVS_CB(skb
)->egress_tun_info
= NULL
;
487 /* Extract flow from 'skb' into 'key'. */
488 error
= ovs_flow_key_extract(tun_info
, skb
, &key
);
489 if (unlikely(error
)) {
493 ovs_dp_process_packet(skb
, &key
);
495 EXPORT_SYMBOL_GPL(ovs_vport_receive
);
498 * ovs_vport_send - send a packet on a device
500 * @vport: vport on which to send the packet
503 * Sends the given packet and returns the length of data sent. Either ovs
504 * lock or rcu_read_lock must be held.
506 int ovs_vport_send(struct vport
*vport
, struct sk_buff
*skb
)
508 int sent
= vport
->ops
->send(vport
, skb
);
510 if (likely(sent
> 0)) {
511 struct pcpu_sw_netstats
*stats
;
513 stats
= this_cpu_ptr(vport
->percpu_stats
);
515 u64_stats_update_begin(&stats
->syncp
);
517 stats
->tx_bytes
+= sent
;
518 u64_stats_update_end(&stats
->syncp
);
519 } else if (sent
< 0) {
520 ovs_vport_record_error(vport
, VPORT_E_TX_ERROR
);
522 ovs_vport_record_error(vport
, VPORT_E_TX_DROPPED
);
528 * ovs_vport_record_error - indicate device error to generic stats layer
530 * @vport: vport that encountered the error
531 * @err_type: one of enum vport_err_type types to indicate the error type
533 * If using the vport generic stats layer indicate that an error of the given
536 static void ovs_vport_record_error(struct vport
*vport
,
537 enum vport_err_type err_type
)
540 case VPORT_E_RX_DROPPED
:
541 atomic_long_inc(&vport
->err_stats
.rx_dropped
);
544 case VPORT_E_RX_ERROR
:
545 atomic_long_inc(&vport
->err_stats
.rx_errors
);
548 case VPORT_E_TX_DROPPED
:
549 atomic_long_inc(&vport
->err_stats
.tx_dropped
);
552 case VPORT_E_TX_ERROR
:
553 atomic_long_inc(&vport
->err_stats
.tx_errors
);
559 static void free_vport_rcu(struct rcu_head
*rcu
)
561 struct vport
*vport
= container_of(rcu
, struct vport
, rcu
);
563 ovs_vport_free(vport
);
566 void ovs_vport_deferred_free(struct vport
*vport
)
571 call_rcu(&vport
->rcu
, free_vport_rcu
);
573 EXPORT_SYMBOL_GPL(ovs_vport_deferred_free
);
575 int ovs_tunnel_get_egress_info(struct ovs_tunnel_info
*egress_tun_info
,
577 const struct ovs_tunnel_info
*tun_info
,
583 const struct ovs_key_ipv4_tunnel
*tun_key
;
587 if (unlikely(!tun_info
))
590 tun_key
= &tun_info
->tunnel
;
592 /* Route lookup to get srouce IP address.
593 * The process may need to be changed if the corresponding process
594 * in vports ops changed.
596 rt
= ovs_tunnel_route_lookup(net
, tun_key
, skb_mark
, &fl
, ipproto
);
602 /* Generate egress_tun_info based on tun_info,
603 * saddr, tp_src and tp_dst
605 __ovs_flow_tun_info_init(egress_tun_info
,
606 fl
.saddr
, tun_key
->ipv4_dst
,
613 tun_info
->options_len
);
617 EXPORT_SYMBOL_GPL(ovs_tunnel_get_egress_info
);
619 int ovs_vport_get_egress_tun_info(struct vport
*vport
, struct sk_buff
*skb
,
620 struct ovs_tunnel_info
*info
)
622 /* get_egress_tun_info() is only implemented on tunnel ports. */
623 if (unlikely(!vport
->ops
->get_egress_tun_info
))
626 return vport
->ops
->get_egress_tun_info(vport
, skb
, info
);