xref: /openbmc/linux/drivers/net/veth.c (revision a09d2831) 
1 /*
2  *  drivers/net/veth.c
3  *
4  *  Copyright (C) 2007 OpenVZ http://openvz.org, SWsoft Inc
5  *
6  * Author: Pavel Emelianov <xemul@openvz.org>
7  * Ethtool interface from: Eric W. Biederman <ebiederm@xmission.com>
8  *
9  */
10 
11 #include <linux/netdevice.h>
12 #include <linux/ethtool.h>
13 #include <linux/etherdevice.h>
14 
15 #include <net/dst.h>
16 #include <net/xfrm.h>
17 #include <linux/veth.h>
18 
19 #define DRV_NAME	"veth"
20 #define DRV_VERSION	"1.0"
21 
22 #define MIN_MTU 68		/* Min L3 MTU */
23 #define MAX_MTU 65535		/* Max L3 MTU (arbitrary) */
24 #define MTU_PAD (ETH_HLEN + 4)  /* Max difference between L2 and L3 size MTU */
25 
26 struct veth_net_stats {
27 	unsigned long	rx_packets;
28 	unsigned long	tx_packets;
29 	unsigned long	rx_bytes;
30 	unsigned long	tx_bytes;
31 	unsigned long	tx_dropped;
32 	unsigned long	rx_dropped;
33 };
34 
35 struct veth_priv {
36 	struct net_device *peer;
37 	struct veth_net_stats *stats;
38 	unsigned ip_summed;
39 };
40 
41 /*
42  * ethtool interface
43  */
44 
45 static struct {
46 	const char string[ETH_GSTRING_LEN];
47 } ethtool_stats_keys[] = {
48 	{ "peer_ifindex" },
49 };
50 
51 static int veth_get_settings(struct net_device *dev, struct ethtool_cmd *cmd)
52 {
53 	cmd->supported		= 0;
54 	cmd->advertising	= 0;
55 	cmd->speed		= SPEED_10000;
56 	cmd->duplex		= DUPLEX_FULL;
57 	cmd->port		= PORT_TP;
58 	cmd->phy_address	= 0;
59 	cmd->transceiver	= XCVR_INTERNAL;
60 	cmd->autoneg		= AUTONEG_DISABLE;
61 	cmd->maxtxpkt		= 0;
62 	cmd->maxrxpkt		= 0;
63 	return 0;
64 }
65 
66 static void veth_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info)
67 {
68 	strcpy(info->driver, DRV_NAME);
69 	strcpy(info->version, DRV_VERSION);
70 	strcpy(info->fw_version, "N/A");
71 }
72 
73 static void veth_get_strings(struct net_device *dev, u32 stringset, u8 *buf)
74 {
75 	switch(stringset) {
76 	case ETH_SS_STATS:
77 		memcpy(buf, &ethtool_stats_keys, sizeof(ethtool_stats_keys));
78 		break;
79 	}
80 }
81 
82 static int veth_get_sset_count(struct net_device *dev, int sset)
83 {
84 	switch (sset) {
85 	case ETH_SS_STATS:
86 		return ARRAY_SIZE(ethtool_stats_keys);
87 	default:
88 		return -EOPNOTSUPP;
89 	}
90 }
91 
92 static void veth_get_ethtool_stats(struct net_device *dev,
93 		struct ethtool_stats *stats, u64 *data)
94 {
95 	struct veth_priv *priv;
96 
97 	priv = netdev_priv(dev);
98 	data[0] = priv->peer->ifindex;
99 }
100 
101 static u32 veth_get_rx_csum(struct net_device *dev)
102 {
103 	struct veth_priv *priv;
104 
105 	priv = netdev_priv(dev);
106 	return priv->ip_summed == CHECKSUM_UNNECESSARY;
107 }
108 
109 static int veth_set_rx_csum(struct net_device *dev, u32 data)
110 {
111 	struct veth_priv *priv;
112 
113 	priv = netdev_priv(dev);
114 	priv->ip_summed = data ? CHECKSUM_UNNECESSARY : CHECKSUM_NONE;
115 	return 0;
116 }
117 
118 static u32 veth_get_tx_csum(struct net_device *dev)
119 {
120 	return (dev->features & NETIF_F_NO_CSUM) != 0;
121 }
122 
123 static int veth_set_tx_csum(struct net_device *dev, u32 data)
124 {
125 	if (data)
126 		dev->features |= NETIF_F_NO_CSUM;
127 	else
128 		dev->features &= ~NETIF_F_NO_CSUM;
129 	return 0;
130 }
131 
132 static const struct ethtool_ops veth_ethtool_ops = {
133 	.get_settings		= veth_get_settings,
134 	.get_drvinfo		= veth_get_drvinfo,
135 	.get_link		= ethtool_op_get_link,
136 	.get_rx_csum		= veth_get_rx_csum,
137 	.set_rx_csum		= veth_set_rx_csum,
138 	.get_tx_csum		= veth_get_tx_csum,
139 	.set_tx_csum		= veth_set_tx_csum,
140 	.get_sg			= ethtool_op_get_sg,
141 	.set_sg			= ethtool_op_set_sg,
142 	.get_strings		= veth_get_strings,
143 	.get_sset_count		= veth_get_sset_count,
144 	.get_ethtool_stats	= veth_get_ethtool_stats,
145 };
146 
147 /*
148  * xmit
149  */
150 
151 static netdev_tx_t veth_xmit(struct sk_buff *skb, struct net_device *dev)
152 {
153 	struct net_device *rcv = NULL;
154 	struct veth_priv *priv, *rcv_priv;
155 	struct veth_net_stats *stats, *rcv_stats;
156 	int length;
157 
158 	priv = netdev_priv(dev);
159 	rcv = priv->peer;
160 	rcv_priv = netdev_priv(rcv);
161 
162 	stats = this_cpu_ptr(priv->stats);
163 	rcv_stats = this_cpu_ptr(rcv_priv->stats);
164 
165 	if (!(rcv->flags & IFF_UP))
166 		goto tx_drop;
167 
168 	if (dev->features & NETIF_F_NO_CSUM)
169 		skb->ip_summed = rcv_priv->ip_summed;
170 
171 	length = skb->len + ETH_HLEN;
172 	if (dev_forward_skb(rcv, skb) != NET_RX_SUCCESS)
173 		goto rx_drop;
174 
175 	stats->tx_bytes += length;
176 	stats->tx_packets++;
177 
178 	rcv_stats->rx_bytes += length;
179 	rcv_stats->rx_packets++;
180 
181 	return NETDEV_TX_OK;
182 
183 tx_drop:
184 	kfree_skb(skb);
185 	stats->tx_dropped++;
186 	return NETDEV_TX_OK;
187 
188 rx_drop:
189 	kfree_skb(skb);
190 	rcv_stats->rx_dropped++;
191 	return NETDEV_TX_OK;
192 }
193 
194 /*
195  * general routines
196  */
197 
198 static struct net_device_stats *veth_get_stats(struct net_device *dev)
199 {
200 	struct veth_priv *priv;
201 	int cpu;
202 	struct veth_net_stats *stats, total = {0};
203 
204 	priv = netdev_priv(dev);
205 
206 	for_each_possible_cpu(cpu) {
207 		stats = per_cpu_ptr(priv->stats, cpu);
208 
209 		total.rx_packets += stats->rx_packets;
210 		total.tx_packets += stats->tx_packets;
211 		total.rx_bytes   += stats->rx_bytes;
212 		total.tx_bytes   += stats->tx_bytes;
213 		total.tx_dropped += stats->tx_dropped;
214 		total.rx_dropped += stats->rx_dropped;
215 	}
216 	dev->stats.rx_packets = total.rx_packets;
217 	dev->stats.tx_packets = total.tx_packets;
218 	dev->stats.rx_bytes   = total.rx_bytes;
219 	dev->stats.tx_bytes   = total.tx_bytes;
220 	dev->stats.tx_dropped = total.tx_dropped;
221 	dev->stats.rx_dropped = total.rx_dropped;
222 
223 	return &dev->stats;
224 }
225 
226 static int veth_open(struct net_device *dev)
227 {
228 	struct veth_priv *priv;
229 
230 	priv = netdev_priv(dev);
231 	if (priv->peer == NULL)
232 		return -ENOTCONN;
233 
234 	if (priv->peer->flags & IFF_UP) {
235 		netif_carrier_on(dev);
236 		netif_carrier_on(priv->peer);
237 	}
238 	return 0;
239 }
240 
241 static int veth_close(struct net_device *dev)
242 {
243 	struct veth_priv *priv = netdev_priv(dev);
244 
245 	netif_carrier_off(dev);
246 	netif_carrier_off(priv->peer);
247 
248 	return 0;
249 }
250 
251 static int is_valid_veth_mtu(int new_mtu)
252 {
253 	return (new_mtu >= MIN_MTU && new_mtu <= MAX_MTU);
254 }
255 
256 static int veth_change_mtu(struct net_device *dev, int new_mtu)
257 {
258 	if (!is_valid_veth_mtu(new_mtu))
259 		return -EINVAL;
260 	dev->mtu = new_mtu;
261 	return 0;
262 }
263 
264 static int veth_dev_init(struct net_device *dev)
265 {
266 	struct veth_net_stats *stats;
267 	struct veth_priv *priv;
268 
269 	stats = alloc_percpu(struct veth_net_stats);
270 	if (stats == NULL)
271 		return -ENOMEM;
272 
273 	priv = netdev_priv(dev);
274 	priv->stats = stats;
275 	return 0;
276 }
277 
278 static void veth_dev_free(struct net_device *dev)
279 {
280 	struct veth_priv *priv;
281 
282 	priv = netdev_priv(dev);
283 	free_percpu(priv->stats);
284 	free_netdev(dev);
285 }
286 
287 static const struct net_device_ops veth_netdev_ops = {
288 	.ndo_init            = veth_dev_init,
289 	.ndo_open            = veth_open,
290 	.ndo_stop            = veth_close,
291 	.ndo_start_xmit      = veth_xmit,
292 	.ndo_change_mtu      = veth_change_mtu,
293 	.ndo_get_stats       = veth_get_stats,
294 	.ndo_set_mac_address = eth_mac_addr,
295 };
296 
297 static void veth_setup(struct net_device *dev)
298 {
299 	ether_setup(dev);
300 
301 	dev->netdev_ops = &veth_netdev_ops;
302 	dev->ethtool_ops = &veth_ethtool_ops;
303 	dev->features |= NETIF_F_LLTX;
304 	dev->destructor = veth_dev_free;
305 }
306 
307 /*
308  * netlink interface
309  */
310 
311 static int veth_validate(struct nlattr *tb[], struct nlattr *data[])
312 {
313 	if (tb[IFLA_ADDRESS]) {
314 		if (nla_len(tb[IFLA_ADDRESS]) != ETH_ALEN)
315 			return -EINVAL;
316 		if (!is_valid_ether_addr(nla_data(tb[IFLA_ADDRESS])))
317 			return -EADDRNOTAVAIL;
318 	}
319 	if (tb[IFLA_MTU]) {
320 		if (!is_valid_veth_mtu(nla_get_u32(tb[IFLA_MTU])))
321 			return -EINVAL;
322 	}
323 	return 0;
324 }
325 
326 static struct rtnl_link_ops veth_link_ops;
327 
328 static int veth_newlink(struct net *src_net, struct net_device *dev,
329 			 struct nlattr *tb[], struct nlattr *data[])
330 {
331 	int err;
332 	struct net_device *peer;
333 	struct veth_priv *priv;
334 	char ifname[IFNAMSIZ];
335 	struct nlattr *peer_tb[IFLA_MAX + 1], **tbp;
336 	struct net *net;
337 
338 	/*
339 	 * create and register peer first
340 	 *
341 	 * struct ifinfomsg is at the head of VETH_INFO_PEER, but we
342 	 * skip it since no info from it is useful yet
343 	 */
344 
345 	if (data != NULL && data[VETH_INFO_PEER] != NULL) {
346 		struct nlattr *nla_peer;
347 
348 		nla_peer = data[VETH_INFO_PEER];
349 		err = nla_parse(peer_tb, IFLA_MAX,
350 				nla_data(nla_peer) + sizeof(struct ifinfomsg),
351 				nla_len(nla_peer) - sizeof(struct ifinfomsg),
352 				ifla_policy);
353 		if (err < 0)
354 			return err;
355 
356 		err = veth_validate(peer_tb, NULL);
357 		if (err < 0)
358 			return err;
359 
360 		tbp = peer_tb;
361 	} else
362 		tbp = tb;
363 
364 	if (tbp[IFLA_IFNAME])
365 		nla_strlcpy(ifname, tbp[IFLA_IFNAME], IFNAMSIZ);
366 	else
367 		snprintf(ifname, IFNAMSIZ, DRV_NAME "%%d");
368 
369 	net = rtnl_link_get_net(src_net, tbp);
370 	if (IS_ERR(net))
371 		return PTR_ERR(net);
372 
373 	peer = rtnl_create_link(src_net, net, ifname, &veth_link_ops, tbp);
374 	if (IS_ERR(peer)) {
375 		put_net(net);
376 		return PTR_ERR(peer);
377 	}
378 
379 	if (tbp[IFLA_ADDRESS] == NULL)
380 		random_ether_addr(peer->dev_addr);
381 
382 	err = register_netdevice(peer);
383 	put_net(net);
384 	net = NULL;
385 	if (err < 0)
386 		goto err_register_peer;
387 
388 	netif_carrier_off(peer);
389 
390 	/*
391 	 * register dev last
392 	 *
393 	 * note, that since we've registered new device the dev's name
394 	 * should be re-allocated
395 	 */
396 
397 	if (tb[IFLA_ADDRESS] == NULL)
398 		random_ether_addr(dev->dev_addr);
399 
400 	if (tb[IFLA_IFNAME])
401 		nla_strlcpy(dev->name, tb[IFLA_IFNAME], IFNAMSIZ);
402 	else
403 		snprintf(dev->name, IFNAMSIZ, DRV_NAME "%%d");
404 
405 	if (strchr(dev->name, '%')) {
406 		err = dev_alloc_name(dev, dev->name);
407 		if (err < 0)
408 			goto err_alloc_name;
409 	}
410 
411 	err = register_netdevice(dev);
412 	if (err < 0)
413 		goto err_register_dev;
414 
415 	netif_carrier_off(dev);
416 
417 	/*
418 	 * tie the deviced together
419 	 */
420 
421 	priv = netdev_priv(dev);
422 	priv->peer = peer;
423 
424 	priv = netdev_priv(peer);
425 	priv->peer = dev;
426 	return 0;
427 
428 err_register_dev:
429 	/* nothing to do */
430 err_alloc_name:
431 	unregister_netdevice(peer);
432 	return err;
433 
434 err_register_peer:
435 	free_netdev(peer);
436 	return err;
437 }
438 
439 static void veth_dellink(struct net_device *dev, struct list_head *head)
440 {
441 	struct veth_priv *priv;
442 	struct net_device *peer;
443 
444 	priv = netdev_priv(dev);
445 	peer = priv->peer;
446 
447 	unregister_netdevice_queue(dev, head);
448 	unregister_netdevice_queue(peer, head);
449 }
450 
451 static const struct nla_policy veth_policy[VETH_INFO_MAX + 1];
452 
453 static struct rtnl_link_ops veth_link_ops = {
454 	.kind		= DRV_NAME,
455 	.priv_size	= sizeof(struct veth_priv),
456 	.setup		= veth_setup,
457 	.validate	= veth_validate,
458 	.newlink	= veth_newlink,
459 	.dellink	= veth_dellink,
460 	.policy		= veth_policy,
461 	.maxtype	= VETH_INFO_MAX,
462 };
463 
464 /*
465  * init/fini
466  */
467 
468 static __init int veth_init(void)
469 {
470 	return rtnl_link_register(&veth_link_ops);
471 }
472 
473 static __exit void veth_exit(void)
474 {
475 	rtnl_link_unregister(&veth_link_ops);
476 }
477 
478 module_init(veth_init);
479 module_exit(veth_exit);
480 
481 MODULE_DESCRIPTION("Virtual Ethernet Tunnel");
482 MODULE_LICENSE("GPL v2");
483 MODULE_ALIAS_RTNL_LINK(DRV_NAME);
484