1 // SPDX-License-Identifier: GPL-2.0-only
3 * Copyright (c) 2007-2014 Nicira, Inc.
6 #include <linux/etherdevice.h>
8 #include <linux/if_vlan.h>
9 #include <linux/jhash.h>
10 #include <linux/kernel.h>
11 #include <linux/list.h>
12 #include <linux/mutex.h>
13 #include <linux/percpu.h>
14 #include <linux/rcupdate.h>
15 #include <linux/rtnetlink.h>
16 #include <linux/compat.h>
17 #include <net/net_namespace.h>
18 #include <linux/module.h>
22 #include "vport-internal_dev.h"
24 static LIST_HEAD(vport_ops_list
);
26 /* Protected by RCU read lock for reading, ovs_mutex for writing. */
27 static struct hlist_head
*dev_table
;
28 #define VPORT_HASH_BUCKETS 1024
31 * ovs_vport_init - initialize vport subsystem
33 * Called at module load time to initialize the vport subsystem.
35 int ovs_vport_init(void)
37 dev_table
= kcalloc(VPORT_HASH_BUCKETS
, sizeof(struct hlist_head
),
46 * ovs_vport_exit - shutdown vport subsystem
48 * Called at module exit time to shutdown the vport subsystem.
50 void ovs_vport_exit(void)
55 static struct hlist_head
*hash_bucket(const struct net
*net
, const char *name
)
57 unsigned int hash
= jhash(name
, strlen(name
), (unsigned long) net
);
58 return &dev_table
[hash
& (VPORT_HASH_BUCKETS
- 1)];
61 int __ovs_vport_ops_register(struct vport_ops
*ops
)
67 list_for_each_entry(o
, &vport_ops_list
, list
)
68 if (ops
->type
== o
->type
)
71 list_add_tail(&ops
->list
, &vport_ops_list
);
77 EXPORT_SYMBOL_GPL(__ovs_vport_ops_register
);
79 void ovs_vport_ops_unregister(struct vport_ops
*ops
)
85 EXPORT_SYMBOL_GPL(ovs_vport_ops_unregister
);
88 * ovs_vport_locate - find a port that has already been created
90 * @name: name of port to find
92 * Must be called with ovs or RCU read lock.
94 struct vport
*ovs_vport_locate(const struct net
*net
, const char *name
)
96 struct hlist_head
*bucket
= hash_bucket(net
, name
);
99 hlist_for_each_entry_rcu(vport
, bucket
, hash_node
,
100 lockdep_ovsl_is_held())
101 if (!strcmp(name
, ovs_vport_name(vport
)) &&
102 net_eq(ovs_dp_get_net(vport
->dp
), net
))
109 * ovs_vport_alloc - allocate and initialize new vport
111 * @priv_size: Size of private data area to allocate.
112 * @ops: vport device ops
114 * Allocate and initialize a new vport defined by @ops. The vport will contain
115 * a private data area of size @priv_size that can be accessed using
116 * vport_priv(). vports that are no longer needed should be released with
119 struct vport
*ovs_vport_alloc(int priv_size
, const struct vport_ops
*ops
,
120 const struct vport_parms
*parms
)
125 alloc_size
= sizeof(struct vport
);
127 alloc_size
= ALIGN(alloc_size
, VPORT_ALIGN
);
128 alloc_size
+= priv_size
;
131 vport
= kzalloc(alloc_size
, GFP_KERNEL
);
133 return ERR_PTR(-ENOMEM
);
135 vport
->dp
= parms
->dp
;
136 vport
->port_no
= parms
->port_no
;
138 INIT_HLIST_NODE(&vport
->dp_hash_node
);
140 if (ovs_vport_set_upcall_portids(vport
, parms
->upcall_portids
)) {
142 return ERR_PTR(-EINVAL
);
147 EXPORT_SYMBOL_GPL(ovs_vport_alloc
);
150 * ovs_vport_free - uninitialize and free vport
152 * @vport: vport to free
154 * Frees a vport allocated with vport_alloc() when it is no longer needed.
156 * The caller must ensure that an RCU grace period has passed since the last
157 * time @vport was in a datapath.
159 void ovs_vport_free(struct vport
*vport
)
161 /* vport is freed from RCU callback or error path, Therefore
162 * it is safe to use raw dereference.
164 kfree(rcu_dereference_raw(vport
->upcall_portids
));
167 EXPORT_SYMBOL_GPL(ovs_vport_free
);
169 static struct vport_ops
*ovs_vport_lookup(const struct vport_parms
*parms
)
171 struct vport_ops
*ops
;
173 list_for_each_entry(ops
, &vport_ops_list
, list
)
174 if (ops
->type
== parms
->type
)
181 * ovs_vport_add - add vport device (for kernel callers)
183 * @parms: Information about new vport.
185 * Creates a new vport with the specified configuration (which is dependent on
186 * device type). ovs_mutex must be held.
188 struct vport
*ovs_vport_add(const struct vport_parms
*parms
)
190 struct vport_ops
*ops
;
193 ops
= ovs_vport_lookup(parms
);
195 struct hlist_head
*bucket
;
197 if (!try_module_get(ops
->owner
))
198 return ERR_PTR(-EAFNOSUPPORT
);
200 vport
= ops
->create(parms
);
202 module_put(ops
->owner
);
206 bucket
= hash_bucket(ovs_dp_get_net(vport
->dp
),
207 ovs_vport_name(vport
));
208 hlist_add_head_rcu(&vport
->hash_node
, bucket
);
212 /* Unlock to attempt module load and return -EAGAIN if load
213 * was successful as we need to restart the port addition
217 request_module("vport-type-%d", parms
->type
);
220 if (!ovs_vport_lookup(parms
))
221 return ERR_PTR(-EAFNOSUPPORT
);
223 return ERR_PTR(-EAGAIN
);
227 * ovs_vport_set_options - modify existing vport device (for kernel callers)
229 * @vport: vport to modify.
230 * @options: New configuration.
232 * Modifies an existing device with the specified configuration (which is
233 * dependent on device type). ovs_mutex must be held.
235 int ovs_vport_set_options(struct vport
*vport
, struct nlattr
*options
)
237 if (!vport
->ops
->set_options
)
239 return vport
->ops
->set_options(vport
, options
);
243 * ovs_vport_del - delete existing vport device
245 * @vport: vport to delete.
247 * Detaches @vport from its datapath and destroys it. ovs_mutex must
250 void ovs_vport_del(struct vport
*vport
)
252 hlist_del_rcu(&vport
->hash_node
);
253 module_put(vport
->ops
->owner
);
254 vport
->ops
->destroy(vport
);
258 * ovs_vport_get_stats - retrieve device stats
260 * @vport: vport from which to retrieve the stats
261 * @stats: location to store stats
263 * Retrieves transmit, receive, and error stats for the given device.
265 * Must be called with ovs_mutex or rcu_read_lock.
267 void ovs_vport_get_stats(struct vport
*vport
, struct ovs_vport_stats
*stats
)
269 const struct rtnl_link_stats64
*dev_stats
;
270 struct rtnl_link_stats64 temp
;
272 dev_stats
= dev_get_stats(vport
->dev
, &temp
);
273 stats
->rx_errors
= dev_stats
->rx_errors
;
274 stats
->tx_errors
= dev_stats
->tx_errors
;
275 stats
->tx_dropped
= dev_stats
->tx_dropped
;
276 stats
->rx_dropped
= dev_stats
->rx_dropped
;
278 stats
->rx_bytes
= dev_stats
->rx_bytes
;
279 stats
->rx_packets
= dev_stats
->rx_packets
;
280 stats
->tx_bytes
= dev_stats
->tx_bytes
;
281 stats
->tx_packets
= dev_stats
->tx_packets
;
285 * ovs_vport_get_options - retrieve device options
287 * @vport: vport from which to retrieve the options.
288 * @skb: sk_buff where options should be appended.
290 * Retrieves the configuration of the given device, appending an
291 * %OVS_VPORT_ATTR_OPTIONS attribute that in turn contains nested
292 * vport-specific attributes to @skb.
294 * Returns 0 if successful, -EMSGSIZE if @skb has insufficient room, or another
295 * negative error code if a real error occurred. If an error occurs, @skb is
298 * Must be called with ovs_mutex or rcu_read_lock.
300 int ovs_vport_get_options(const struct vport
*vport
, struct sk_buff
*skb
)
305 if (!vport
->ops
->get_options
)
308 nla
= nla_nest_start_noflag(skb
, OVS_VPORT_ATTR_OPTIONS
);
312 err
= vport
->ops
->get_options(vport
, skb
);
314 nla_nest_cancel(skb
, nla
);
318 nla_nest_end(skb
, nla
);
323 * ovs_vport_set_upcall_portids - set upcall portids of @vport.
325 * @vport: vport to modify.
326 * @ids: new configuration, an array of port ids.
328 * Sets the vport's upcall_portids to @ids.
330 * Returns 0 if successful, -EINVAL if @ids is zero length or cannot be parsed
331 * as an array of U32.
333 * Must be called with ovs_mutex.
335 int ovs_vport_set_upcall_portids(struct vport
*vport
, const struct nlattr
*ids
)
337 struct vport_portids
*old
, *vport_portids
;
339 if (!nla_len(ids
) || nla_len(ids
) % sizeof(u32
))
342 old
= ovsl_dereference(vport
->upcall_portids
);
344 vport_portids
= kmalloc(sizeof(*vport_portids
) + nla_len(ids
),
349 vport_portids
->n_ids
= nla_len(ids
) / sizeof(u32
);
350 vport_portids
->rn_ids
= reciprocal_value(vport_portids
->n_ids
);
351 nla_memcpy(vport_portids
->ids
, ids
, nla_len(ids
));
353 rcu_assign_pointer(vport
->upcall_portids
, vport_portids
);
361 * ovs_vport_get_upcall_portids - get the upcall_portids of @vport.
363 * @vport: vport from which to retrieve the portids.
364 * @skb: sk_buff where portids should be appended.
366 * Retrieves the configuration of the given vport, appending the
367 * %OVS_VPORT_ATTR_UPCALL_PID attribute which is the array of upcall
370 * Returns 0 if successful, -EMSGSIZE if @skb has insufficient room.
371 * If an error occurs, @skb is left unmodified. Must be called with
372 * ovs_mutex or rcu_read_lock.
374 int ovs_vport_get_upcall_portids(const struct vport
*vport
,
377 struct vport_portids
*ids
;
379 ids
= rcu_dereference_ovsl(vport
->upcall_portids
);
381 if (vport
->dp
->user_features
& OVS_DP_F_VPORT_PIDS
)
382 return nla_put(skb
, OVS_VPORT_ATTR_UPCALL_PID
,
383 ids
->n_ids
* sizeof(u32
), (void *)ids
->ids
);
385 return nla_put_u32(skb
, OVS_VPORT_ATTR_UPCALL_PID
, ids
->ids
[0]);
389 * ovs_vport_find_upcall_portid - find the upcall portid to send upcall.
391 * @vport: vport from which the missed packet is received.
392 * @skb: skb that the missed packet was received.
394 * Uses the skb_get_hash() to select the upcall portid to send the
397 * Returns the portid of the target socket. Must be called with rcu_read_lock.
399 u32
ovs_vport_find_upcall_portid(const struct vport
*vport
, struct sk_buff
*skb
)
401 struct vport_portids
*ids
;
405 ids
= rcu_dereference(vport
->upcall_portids
);
407 /* If there is only one portid, select it in the fast-path. */
411 hash
= skb_get_hash(skb
);
412 ids_index
= hash
- ids
->n_ids
* reciprocal_divide(hash
, ids
->rn_ids
);
413 return ids
->ids
[ids_index
];
417 * ovs_vport_receive - pass up received packet to the datapath for processing
419 * @vport: vport that received the packet
420 * @skb: skb that was received
421 * @tun_key: tunnel (if any) that carried packet
423 * Must be called with rcu_read_lock. The packet cannot be shared and
424 * skb->data should point to the Ethernet header.
426 int ovs_vport_receive(struct vport
*vport
, struct sk_buff
*skb
,
427 const struct ip_tunnel_info
*tun_info
)
429 struct sw_flow_key key
;
432 OVS_CB(skb
)->input_vport
= vport
;
433 OVS_CB(skb
)->mru
= 0;
434 OVS_CB(skb
)->cutlen
= 0;
435 if (unlikely(dev_net(skb
->dev
) != ovs_dp_get_net(vport
->dp
))) {
439 skb_scrub_packet(skb
, true);
444 /* Extract flow from 'skb' into 'key'. */
445 error
= ovs_flow_key_extract(tun_info
, skb
, &key
);
446 if (unlikely(error
)) {
450 ovs_dp_process_packet(skb
, &key
);
454 static int packet_length(const struct sk_buff
*skb
,
455 struct net_device
*dev
)
457 int length
= skb
->len
- dev
->hard_header_len
;
459 if (!skb_vlan_tag_present(skb
) &&
460 eth_type_vlan(skb
->protocol
))
463 /* Don't subtract for multiple VLAN tags. Most (all?) drivers allow
464 * (ETH_LEN + VLAN_HLEN) in addition to the mtu value, but almost none
465 * account for 802.1ad. e.g. is_skb_forwardable().
468 return length
> 0 ? length
: 0;
471 void ovs_vport_send(struct vport
*vport
, struct sk_buff
*skb
, u8 mac_proto
)
473 int mtu
= vport
->dev
->mtu
;
475 switch (vport
->dev
->type
) {
477 if (mac_proto
== MAC_PROTO_ETHERNET
) {
478 skb_reset_network_header(skb
);
479 skb_reset_mac_len(skb
);
480 skb
->protocol
= htons(ETH_P_TEB
);
481 } else if (mac_proto
!= MAC_PROTO_NONE
) {
487 if (mac_proto
!= MAC_PROTO_ETHERNET
)
494 if (unlikely(packet_length(skb
, vport
->dev
) > mtu
&&
496 net_warn_ratelimited("%s: dropped over-mtu packet: %d > %d\n",
498 packet_length(skb
, vport
->dev
), mtu
);
499 vport
->dev
->stats
.tx_errors
++;
503 skb
->dev
= vport
->dev
;
504 vport
->ops
->send(skb
);