2 * Copyright (c) 2007-2015 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/module.h>
31 #include <linux/if_link.h>
32 #include <net/net_namespace.h>
35 #include <net/geneve.h>
36 #include <net/vxlan.h>
42 #include "vport-internal_dev.h"
44 static LIST_HEAD(vport_ops_list
);
46 /* Protected by RCU read lock for reading, ovs_mutex for writing. */
47 static struct hlist_head
*dev_table
;
48 #define VPORT_HASH_BUCKETS 1024
51 * ovs_vport_init - initialize vport subsystem
53 * Called at module load time to initialize the vport subsystem.
55 int ovs_vport_init(void)
59 dev_table
= kzalloc(VPORT_HASH_BUCKETS
* sizeof(struct hlist_head
),
64 err
= lisp_init_module();
70 err
= geneve_init_module();
74 err
= vxlan_init_module();
77 err
= ovs_stt_init_module();
83 vxlan_cleanup_module();
85 geneve_cleanup_module();
89 lisp_cleanup_module();
96 * ovs_vport_exit - shutdown vport subsystem
98 * Called at module exit time to shutdown the vport subsystem.
100 void ovs_vport_exit(void)
102 ovs_stt_cleanup_module();
103 vxlan_cleanup_module();
104 geneve_cleanup_module();
106 lisp_cleanup_module();
110 static struct hlist_head
*hash_bucket(const struct net
*net
, const char *name
)
112 unsigned int hash
= jhash(name
, strlen(name
), (unsigned long) net
);
113 return &dev_table
[hash
& (VPORT_HASH_BUCKETS
- 1)];
116 int __ovs_vport_ops_register(struct vport_ops
*ops
)
122 list_for_each_entry(o
, &vport_ops_list
, list
)
123 if (ops
->type
== o
->type
)
126 list_add_tail(&ops
->list
, &vport_ops_list
);
132 EXPORT_SYMBOL_GPL(__ovs_vport_ops_register
);
134 void ovs_vport_ops_unregister(struct vport_ops
*ops
)
137 list_del(&ops
->list
);
140 EXPORT_SYMBOL_GPL(ovs_vport_ops_unregister
);
143 * ovs_vport_locate - find a port that has already been created
145 * @name: name of port to find
147 * Must be called with ovs or RCU read lock.
149 struct vport
*ovs_vport_locate(const struct net
*net
, const char *name
)
151 struct hlist_head
*bucket
= hash_bucket(net
, name
);
154 hlist_for_each_entry_rcu(vport
, bucket
, hash_node
)
155 if (!strcmp(name
, ovs_vport_name(vport
)) &&
156 net_eq(ovs_dp_get_net(vport
->dp
), net
))
163 * ovs_vport_alloc - allocate and initialize new vport
165 * @priv_size: Size of private data area to allocate.
166 * @ops: vport device ops
168 * Allocate and initialize a new vport defined by @ops. The vport will contain
169 * a private data area of size @priv_size that can be accessed using
170 * vport_priv(). vports that are no longer needed should be released with
173 struct vport
*ovs_vport_alloc(int priv_size
, const struct vport_ops
*ops
,
174 const struct vport_parms
*parms
)
179 alloc_size
= sizeof(struct vport
);
181 alloc_size
= ALIGN(alloc_size
, VPORT_ALIGN
);
182 alloc_size
+= priv_size
;
185 vport
= kzalloc(alloc_size
, GFP_KERNEL
);
187 return ERR_PTR(-ENOMEM
);
189 vport
->dp
= parms
->dp
;
190 vport
->port_no
= parms
->port_no
;
192 INIT_HLIST_NODE(&vport
->dp_hash_node
);
194 if (ovs_vport_set_upcall_portids(vport
, parms
->upcall_portids
)) {
196 return ERR_PTR(-EINVAL
);
201 EXPORT_SYMBOL_GPL(ovs_vport_alloc
);
204 * ovs_vport_free - uninitialize and free vport
206 * @vport: vport to free
208 * Frees a vport allocated with vport_alloc() when it is no longer needed.
210 * The caller must ensure that an RCU grace period has passed since the last
211 * time @vport was in a datapath.
213 void ovs_vport_free(struct vport
*vport
)
215 /* vport is freed from RCU callback or error path, Therefore
216 * it is safe to use raw dereference.
218 kfree(rcu_dereference_raw(vport
->upcall_portids
));
221 EXPORT_SYMBOL_GPL(ovs_vport_free
);
223 static struct vport_ops
*ovs_vport_lookup(const struct vport_parms
*parms
)
225 struct vport_ops
*ops
;
227 list_for_each_entry(ops
, &vport_ops_list
, list
)
228 if (ops
->type
== parms
->type
)
235 * ovs_vport_add - add vport device (for kernel callers)
237 * @parms: Information about new vport.
239 * Creates a new vport with the specified configuration (which is dependent on
240 * device type). ovs_mutex must be held.
242 struct vport
*ovs_vport_add(const struct vport_parms
*parms
)
244 struct vport_ops
*ops
;
247 ops
= ovs_vport_lookup(parms
);
249 struct hlist_head
*bucket
;
251 if (!try_module_get(ops
->owner
))
252 return ERR_PTR(-EAFNOSUPPORT
);
254 vport
= ops
->create(parms
);
256 module_put(ops
->owner
);
260 bucket
= hash_bucket(ovs_dp_get_net(vport
->dp
),
261 ovs_vport_name(vport
));
262 hlist_add_head_rcu(&vport
->hash_node
, bucket
);
266 /* Unlock to attempt module load and return -EAGAIN if load
267 * was successful as we need to restart the port addition
271 request_module("vport-type-%d", parms
->type
);
274 if (!ovs_vport_lookup(parms
))
275 return ERR_PTR(-EAFNOSUPPORT
);
277 return ERR_PTR(-EAGAIN
);
281 * ovs_vport_set_options - modify existing vport device (for kernel callers)
283 * @vport: vport to modify.
284 * @options: New configuration.
286 * Modifies an existing device with the specified configuration (which is
287 * dependent on device type). ovs_mutex must be held.
289 int ovs_vport_set_options(struct vport
*vport
, struct nlattr
*options
)
291 if (!vport
->ops
->set_options
)
293 return vport
->ops
->set_options(vport
, options
);
297 * ovs_vport_del - delete existing vport device
299 * @vport: vport to delete.
301 * Detaches @vport from its datapath and destroys it. It is possible to fail
302 * for reasons such as lack of memory. ovs_mutex must be held.
304 void ovs_vport_del(struct vport
*vport
)
308 hlist_del_rcu(&vport
->hash_node
);
309 module_put(vport
->ops
->owner
);
310 vport
->ops
->destroy(vport
);
314 * ovs_vport_get_stats - retrieve device stats
316 * @vport: vport from which to retrieve the stats
317 * @stats: location to store stats
319 * Retrieves transmit, receive, and error stats for the given device.
321 * Must be called with ovs_mutex or rcu_read_lock.
323 void ovs_vport_get_stats(struct vport
*vport
, struct ovs_vport_stats
*stats
)
325 const struct rtnl_link_stats64
*dev_stats
;
326 struct rtnl_link_stats64 temp
;
328 dev_stats
= dev_get_stats(vport
->dev
, &temp
);
329 stats
->rx_errors
= dev_stats
->rx_errors
;
330 stats
->tx_errors
= dev_stats
->tx_errors
;
331 stats
->tx_dropped
= dev_stats
->tx_dropped
;
332 stats
->rx_dropped
= dev_stats
->rx_dropped
;
334 stats
->rx_bytes
= dev_stats
->rx_bytes
;
335 stats
->rx_packets
= dev_stats
->rx_packets
;
336 stats
->tx_bytes
= dev_stats
->tx_bytes
;
337 stats
->tx_packets
= dev_stats
->tx_packets
;
341 * ovs_vport_get_options - retrieve device options
343 * @vport: vport from which to retrieve the options.
344 * @skb: sk_buff where options should be appended.
346 * Retrieves the configuration of the given device, appending an
347 * %OVS_VPORT_ATTR_OPTIONS attribute that in turn contains nested
348 * vport-specific attributes to @skb.
350 * Returns 0 if successful, -EMSGSIZE if @skb has insufficient room, or another
351 * negative error code if a real error occurred. If an error occurs, @skb is
354 * Must be called with ovs_mutex or rcu_read_lock.
356 int ovs_vport_get_options(const struct vport
*vport
, struct sk_buff
*skb
)
361 if (!vport
->ops
->get_options
)
364 nla
= nla_nest_start(skb
, OVS_VPORT_ATTR_OPTIONS
);
368 err
= vport
->ops
->get_options(vport
, skb
);
370 nla_nest_cancel(skb
, nla
);
374 nla_nest_end(skb
, nla
);
378 static void vport_portids_destroy_rcu_cb(struct rcu_head
*rcu
)
380 struct vport_portids
*ids
= container_of(rcu
, struct vport_portids
,
387 * ovs_vport_set_upcall_portids - set upcall portids of @vport.
389 * @vport: vport to modify.
390 * @ids: new configuration, an array of port ids.
392 * Sets the vport's upcall_portids to @ids.
394 * Returns 0 if successful, -EINVAL if @ids is zero length or cannot be parsed
395 * as an array of U32.
397 * Must be called with ovs_mutex.
399 int ovs_vport_set_upcall_portids(struct vport
*vport
, const struct nlattr
*ids
)
401 struct vport_portids
*old
, *vport_portids
;
403 if (!nla_len(ids
) || nla_len(ids
) % sizeof(u32
))
406 old
= ovsl_dereference(vport
->upcall_portids
);
408 vport_portids
= kmalloc(sizeof(*vport_portids
) + nla_len(ids
),
413 vport_portids
->n_ids
= nla_len(ids
) / sizeof(u32
);
414 vport_portids
->rn_ids
= reciprocal_value(vport_portids
->n_ids
);
415 nla_memcpy(vport_portids
->ids
, ids
, nla_len(ids
));
417 rcu_assign_pointer(vport
->upcall_portids
, vport_portids
);
420 call_rcu(&old
->rcu
, vport_portids_destroy_rcu_cb
);
425 * ovs_vport_get_upcall_portids - get the upcall_portids of @vport.
427 * @vport: vport from which to retrieve the portids.
428 * @skb: sk_buff where portids should be appended.
430 * Retrieves the configuration of the given vport, appending the
431 * %OVS_VPORT_ATTR_UPCALL_PID attribute which is the array of upcall
434 * Returns 0 if successful, -EMSGSIZE if @skb has insufficient room.
435 * If an error occurs, @skb is left unmodified. Must be called with
436 * ovs_mutex or rcu_read_lock.
438 int ovs_vport_get_upcall_portids(const struct vport
*vport
,
441 struct vport_portids
*ids
;
443 ids
= rcu_dereference_ovsl(vport
->upcall_portids
);
445 if (vport
->dp
->user_features
& OVS_DP_F_VPORT_PIDS
)
446 return nla_put(skb
, OVS_VPORT_ATTR_UPCALL_PID
,
447 ids
->n_ids
* sizeof(u32
), (void *)ids
->ids
);
449 return nla_put_u32(skb
, OVS_VPORT_ATTR_UPCALL_PID
, ids
->ids
[0]);
453 * ovs_vport_find_upcall_portid - find the upcall portid to send upcall.
455 * @vport: vport from which the missed packet is received.
456 * @skb: skb that the missed packet was received.
458 * Uses the skb_get_hash() to select the upcall portid to send the
461 * Returns the portid of the target socket. Must be called with rcu_read_lock.
463 u32
ovs_vport_find_upcall_portid(const struct vport
*vport
, struct sk_buff
*skb
)
465 struct vport_portids
*ids
;
469 ids
= rcu_dereference(vport
->upcall_portids
);
471 if (ids
->n_ids
== 1 && ids
->ids
[0] == 0)
474 hash
= skb_get_hash(skb
);
475 ids_index
= hash
- ids
->n_ids
* reciprocal_divide(hash
, ids
->rn_ids
);
476 return ids
->ids
[ids_index
];
480 * ovs_vport_receive - pass up received packet to the datapath for processing
482 * @vport: vport that received the packet
483 * @skb: skb that was received
484 * @tun_key: tunnel (if any) that carried packet
486 * Must be called with rcu_read_lock. The packet cannot be shared and
487 * skb->data should point to the Ethernet header.
489 int ovs_vport_receive(struct vport
*vport
, struct sk_buff
*skb
,
490 const struct ip_tunnel_info
*tun_info
)
492 struct sw_flow_key key
;
495 OVS_CB(skb
)->input_vport
= vport
;
496 OVS_CB(skb
)->mru
= 0;
497 if (unlikely(dev_net(skb
->dev
) != ovs_dp_get_net(vport
->dp
))) {
501 skb_scrub_packet(skb
, true);
506 ovs_skb_init_inner_protocol(skb
);
507 skb_clear_ovs_gso_cb(skb
);
508 /* Extract flow from 'skb' into 'key'. */
509 error
= ovs_flow_key_extract(tun_info
, skb
, &key
);
510 if (unlikely(error
)) {
514 ovs_dp_process_packet(skb
, &key
);
517 EXPORT_SYMBOL_GPL(ovs_vport_receive
);
519 static void free_vport_rcu(struct rcu_head
*rcu
)
521 struct vport
*vport
= container_of(rcu
, struct vport
, rcu
);
523 ovs_vport_free(vport
);
526 void ovs_vport_deferred_free(struct vport
*vport
)
531 call_rcu(&vport
->rcu
, free_vport_rcu
);
533 EXPORT_SYMBOL_GPL(ovs_vport_deferred_free
);
535 int ovs_tunnel_get_egress_info(struct dp_upcall_info
*upcall
,
542 struct ip_tunnel_info
*egress_tun_info
= upcall
->egress_tun_info
;
543 struct ip_tunnel_info
*tun_info
= skb_tunnel_info(skb
);
544 const struct ip_tunnel_key
*tun_key
;
545 u32 skb_mark
= skb
->mark
;
549 if (unlikely(!tun_info
))
551 if (ip_tunnel_info_af(tun_info
) != AF_INET
)
554 tun_key
= &tun_info
->key
;
556 /* Route lookup to get srouce IP address.
557 * The process may need to be changed if the corresponding process
558 * in vports ops changed.
560 rt
= ovs_tunnel_route_lookup(net
, tun_key
, skb_mark
, &fl
, ipproto
);
566 /* Generate egress_tun_info based on tun_info,
567 * saddr, tp_src and tp_dst
569 ip_tunnel_key_init(&egress_tun_info
->key
,
570 fl
.saddr
, tun_key
->u
.ipv4
.dst
,
576 egress_tun_info
->options_len
= tun_info
->options_len
;
577 egress_tun_info
->mode
= tun_info
->mode
;
578 upcall
->egress_tun_opts
= ip_tunnel_info_opts(tun_info
);
581 EXPORT_SYMBOL_GPL(ovs_tunnel_get_egress_info
);
583 int ovs_vport_get_egress_tun_info(struct vport
*vport
, struct sk_buff
*skb
,
584 struct dp_upcall_info
*upcall
)
586 /* get_egress_tun_info() is only implemented on tunnel ports. */
587 if (unlikely(!vport
->ops
->get_egress_tun_info
))
590 return vport
->ops
->get_egress_tun_info(vport
, skb
, upcall
);
593 static unsigned int packet_length(const struct sk_buff
*skb
)
595 unsigned int length
= skb
->len
- ETH_HLEN
;
597 if (skb
->protocol
== htons(ETH_P_8021Q
))
603 void ovs_vport_send(struct vport
*vport
, struct sk_buff
*skb
)
605 int mtu
= vport
->dev
->mtu
;
607 if (unlikely(packet_length(skb
) > mtu
&& !skb_is_gso(skb
))) {
608 net_warn_ratelimited("%s: dropped over-mtu packet: %d > %d\n",
610 packet_length(skb
), mtu
);
611 vport
->dev
->stats
.tx_errors
++;
615 skb
->dev
= vport
->dev
;
616 vport
->ops
->send(skb
);