xref: /openbmc/linux/drivers/net/veth.c (revision 82ced6fd)
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 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 int 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, cpu;
157 
158 	skb_orphan(skb);
159 
160 	priv = netdev_priv(dev);
161 	rcv = priv->peer;
162 	rcv_priv = netdev_priv(rcv);
163 
164 	cpu = smp_processor_id();
165 	stats = per_cpu_ptr(priv->stats, cpu);
166 	rcv_stats = per_cpu_ptr(rcv_priv->stats, cpu);
167 
168 	if (!(rcv->flags & IFF_UP))
169 		goto tx_drop;
170 
171 	if (skb->len > (rcv->mtu + MTU_PAD))
172 		goto rx_drop;
173 
174 	skb->pkt_type = PACKET_HOST;
175 	skb->protocol = eth_type_trans(skb, rcv);
176 	if (dev->features & NETIF_F_NO_CSUM)
177 		skb->ip_summed = rcv_priv->ip_summed;
178 
179 	dst_release(skb->dst);
180 	skb->dst = NULL;
181 	skb->mark = 0;
182 	secpath_reset(skb);
183 	nf_reset(skb);
184 
185 	length = skb->len;
186 
187 	stats->tx_bytes += length;
188 	stats->tx_packets++;
189 
190 	rcv_stats->rx_bytes += length;
191 	rcv_stats->rx_packets++;
192 
193 	netif_rx(skb);
194 	return 0;
195 
196 tx_drop:
197 	kfree_skb(skb);
198 	stats->tx_dropped++;
199 	return 0;
200 
201 rx_drop:
202 	kfree_skb(skb);
203 	rcv_stats->rx_dropped++;
204 	return 0;
205 }
206 
207 /*
208  * general routines
209  */
210 
211 static struct net_device_stats *veth_get_stats(struct net_device *dev)
212 {
213 	struct veth_priv *priv = netdev_priv(dev);
214 	struct net_device_stats *dev_stats = &dev->stats;
215 	unsigned int cpu;
216 	struct veth_net_stats *stats;
217 
218 	dev_stats->rx_packets = 0;
219 	dev_stats->tx_packets = 0;
220 	dev_stats->rx_bytes = 0;
221 	dev_stats->tx_bytes = 0;
222 	dev_stats->tx_dropped = 0;
223 	dev_stats->rx_dropped = 0;
224 
225 	if (priv->stats)
226 		for_each_online_cpu(cpu) {
227 			stats = per_cpu_ptr(priv->stats, cpu);
228 
229 			dev_stats->rx_packets += stats->rx_packets;
230 			dev_stats->tx_packets += stats->tx_packets;
231 			dev_stats->rx_bytes += stats->rx_bytes;
232 			dev_stats->tx_bytes += stats->tx_bytes;
233 			dev_stats->tx_dropped += stats->tx_dropped;
234 			dev_stats->rx_dropped += stats->rx_dropped;
235 		}
236 
237 	return dev_stats;
238 }
239 
240 static int veth_open(struct net_device *dev)
241 {
242 	struct veth_priv *priv;
243 
244 	priv = netdev_priv(dev);
245 	if (priv->peer == NULL)
246 		return -ENOTCONN;
247 
248 	if (priv->peer->flags & IFF_UP) {
249 		netif_carrier_on(dev);
250 		netif_carrier_on(priv->peer);
251 	}
252 	return 0;
253 }
254 
255 static int veth_close(struct net_device *dev)
256 {
257 	struct veth_priv *priv = netdev_priv(dev);
258 
259 	netif_carrier_off(dev);
260 	netif_carrier_off(priv->peer);
261 
262 	free_percpu(priv->stats);
263 	priv->stats = NULL;
264 	return 0;
265 }
266 
267 static int is_valid_veth_mtu(int new_mtu)
268 {
269 	return (new_mtu >= MIN_MTU && new_mtu <= MAX_MTU);
270 }
271 
272 static int veth_change_mtu(struct net_device *dev, int new_mtu)
273 {
274 	if (!is_valid_veth_mtu(new_mtu))
275 		return -EINVAL;
276 	dev->mtu = new_mtu;
277 	return 0;
278 }
279 
280 static int veth_dev_init(struct net_device *dev)
281 {
282 	struct veth_net_stats *stats;
283 	struct veth_priv *priv;
284 
285 	stats = alloc_percpu(struct veth_net_stats);
286 	if (stats == NULL)
287 		return -ENOMEM;
288 
289 	priv = netdev_priv(dev);
290 	priv->stats = stats;
291 	return 0;
292 }
293 
294 static const struct net_device_ops veth_netdev_ops = {
295 	.ndo_init            = veth_dev_init,
296 	.ndo_open            = veth_open,
297 	.ndo_stop            = veth_close,
298 	.ndo_start_xmit      = veth_xmit,
299 	.ndo_change_mtu      = veth_change_mtu,
300 	.ndo_get_stats       = veth_get_stats,
301 	.ndo_set_mac_address = eth_mac_addr,
302 };
303 
304 static void veth_setup(struct net_device *dev)
305 {
306 	ether_setup(dev);
307 
308 	dev->netdev_ops = &veth_netdev_ops;
309 	dev->ethtool_ops = &veth_ethtool_ops;
310 	dev->features |= NETIF_F_LLTX;
311 	dev->destructor = free_netdev;
312 }
313 
314 /*
315  * netlink interface
316  */
317 
318 static int veth_validate(struct nlattr *tb[], struct nlattr *data[])
319 {
320 	if (tb[IFLA_ADDRESS]) {
321 		if (nla_len(tb[IFLA_ADDRESS]) != ETH_ALEN)
322 			return -EINVAL;
323 		if (!is_valid_ether_addr(nla_data(tb[IFLA_ADDRESS])))
324 			return -EADDRNOTAVAIL;
325 	}
326 	if (tb[IFLA_MTU]) {
327 		if (!is_valid_veth_mtu(nla_get_u32(tb[IFLA_MTU])))
328 			return -EINVAL;
329 	}
330 	return 0;
331 }
332 
333 static struct rtnl_link_ops veth_link_ops;
334 
335 static int veth_newlink(struct net_device *dev,
336 			 struct nlattr *tb[], struct nlattr *data[])
337 {
338 	int err;
339 	struct net_device *peer;
340 	struct veth_priv *priv;
341 	char ifname[IFNAMSIZ];
342 	struct nlattr *peer_tb[IFLA_MAX + 1], **tbp;
343 
344 	/*
345 	 * create and register peer first
346 	 *
347 	 * struct ifinfomsg is at the head of VETH_INFO_PEER, but we
348 	 * skip it since no info from it is useful yet
349 	 */
350 
351 	if (data != NULL && data[VETH_INFO_PEER] != NULL) {
352 		struct nlattr *nla_peer;
353 
354 		nla_peer = data[VETH_INFO_PEER];
355 		err = nla_parse(peer_tb, IFLA_MAX,
356 				nla_data(nla_peer) + sizeof(struct ifinfomsg),
357 				nla_len(nla_peer) - sizeof(struct ifinfomsg),
358 				ifla_policy);
359 		if (err < 0)
360 			return err;
361 
362 		err = veth_validate(peer_tb, NULL);
363 		if (err < 0)
364 			return err;
365 
366 		tbp = peer_tb;
367 	} else
368 		tbp = tb;
369 
370 	if (tbp[IFLA_IFNAME])
371 		nla_strlcpy(ifname, tbp[IFLA_IFNAME], IFNAMSIZ);
372 	else
373 		snprintf(ifname, IFNAMSIZ, DRV_NAME "%%d");
374 
375 	peer = rtnl_create_link(dev_net(dev), ifname, &veth_link_ops, tbp);
376 	if (IS_ERR(peer))
377 		return PTR_ERR(peer);
378 
379 	if (tbp[IFLA_ADDRESS] == NULL)
380 		random_ether_addr(peer->dev_addr);
381 
382 	err = register_netdevice(peer);
383 	if (err < 0)
384 		goto err_register_peer;
385 
386 	netif_carrier_off(peer);
387 
388 	/*
389 	 * register dev last
390 	 *
391 	 * note, that since we've registered new device the dev's name
392 	 * should be re-allocated
393 	 */
394 
395 	if (tb[IFLA_ADDRESS] == NULL)
396 		random_ether_addr(dev->dev_addr);
397 
398 	if (tb[IFLA_IFNAME])
399 		nla_strlcpy(dev->name, tb[IFLA_IFNAME], IFNAMSIZ);
400 	else
401 		snprintf(dev->name, IFNAMSIZ, DRV_NAME "%%d");
402 
403 	if (strchr(dev->name, '%')) {
404 		err = dev_alloc_name(dev, dev->name);
405 		if (err < 0)
406 			goto err_alloc_name;
407 	}
408 
409 	err = register_netdevice(dev);
410 	if (err < 0)
411 		goto err_register_dev;
412 
413 	netif_carrier_off(dev);
414 
415 	/*
416 	 * tie the deviced together
417 	 */
418 
419 	priv = netdev_priv(dev);
420 	priv->peer = peer;
421 
422 	priv = netdev_priv(peer);
423 	priv->peer = dev;
424 	return 0;
425 
426 err_register_dev:
427 	/* nothing to do */
428 err_alloc_name:
429 	unregister_netdevice(peer);
430 	return err;
431 
432 err_register_peer:
433 	free_netdev(peer);
434 	return err;
435 }
436 
437 static void veth_dellink(struct net_device *dev)
438 {
439 	struct veth_priv *priv;
440 	struct net_device *peer;
441 
442 	priv = netdev_priv(dev);
443 	peer = priv->peer;
444 
445 	unregister_netdevice(dev);
446 	unregister_netdevice(peer);
447 }
448 
449 static const struct nla_policy veth_policy[VETH_INFO_MAX + 1];
450 
451 static struct rtnl_link_ops veth_link_ops = {
452 	.kind		= DRV_NAME,
453 	.priv_size	= sizeof(struct veth_priv),
454 	.setup		= veth_setup,
455 	.validate	= veth_validate,
456 	.newlink	= veth_newlink,
457 	.dellink	= veth_dellink,
458 	.policy		= veth_policy,
459 	.maxtype	= VETH_INFO_MAX,
460 };
461 
462 /*
463  * init/fini
464  */
465 
466 static __init int veth_init(void)
467 {
468 	return rtnl_link_register(&veth_link_ops);
469 }
470 
471 static __exit void veth_exit(void)
472 {
473 	rtnl_link_unregister(&veth_link_ops);
474 }
475 
476 module_init(veth_init);
477 module_exit(veth_exit);
478 
479 MODULE_DESCRIPTION("Virtual Ethernet Tunnel");
480 MODULE_LICENSE("GPL v2");
481 MODULE_ALIAS_RTNL_LINK(DRV_NAME);
482