xref: /openbmc/linux/drivers/net/macvlan.c (revision 367b8112)
1 /*
2  * Copyright (c) 2007 Patrick McHardy <kaber@trash.net>
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License as
6  * published by the Free Software Foundation; either version 2 of
7  * the License, or (at your option) any later version.
8  *
9  * The code this is based on carried the following copyright notice:
10  * ---
11  * (C) Copyright 2001-2006
12  * Alex Zeffertt, Cambridge Broadband Ltd, ajz@cambridgebroadband.com
13  * Re-worked by Ben Greear <greearb@candelatech.com>
14  * ---
15  */
16 #include <linux/kernel.h>
17 #include <linux/types.h>
18 #include <linux/module.h>
19 #include <linux/init.h>
20 #include <linux/errno.h>
21 #include <linux/slab.h>
22 #include <linux/string.h>
23 #include <linux/rculist.h>
24 #include <linux/notifier.h>
25 #include <linux/netdevice.h>
26 #include <linux/etherdevice.h>
27 #include <linux/ethtool.h>
28 #include <linux/if_arp.h>
29 #include <linux/if_link.h>
30 #include <linux/if_macvlan.h>
31 #include <net/rtnetlink.h>
32 
33 #define MACVLAN_HASH_SIZE	(1 << BITS_PER_BYTE)
34 
35 struct macvlan_port {
36 	struct net_device	*dev;
37 	struct hlist_head	vlan_hash[MACVLAN_HASH_SIZE];
38 	struct list_head	vlans;
39 };
40 
41 struct macvlan_dev {
42 	struct net_device	*dev;
43 	struct list_head	list;
44 	struct hlist_node	hlist;
45 	struct macvlan_port	*port;
46 	struct net_device	*lowerdev;
47 };
48 
49 
50 static struct macvlan_dev *macvlan_hash_lookup(const struct macvlan_port *port,
51 					       const unsigned char *addr)
52 {
53 	struct macvlan_dev *vlan;
54 	struct hlist_node *n;
55 
56 	hlist_for_each_entry_rcu(vlan, n, &port->vlan_hash[addr[5]], hlist) {
57 		if (!compare_ether_addr(vlan->dev->dev_addr, addr))
58 			return vlan;
59 	}
60 	return NULL;
61 }
62 
63 static void macvlan_broadcast(struct sk_buff *skb,
64 			      const struct macvlan_port *port)
65 {
66 	const struct ethhdr *eth = eth_hdr(skb);
67 	const struct macvlan_dev *vlan;
68 	struct hlist_node *n;
69 	struct net_device *dev;
70 	struct sk_buff *nskb;
71 	unsigned int i;
72 
73 	for (i = 0; i < MACVLAN_HASH_SIZE; i++) {
74 		hlist_for_each_entry_rcu(vlan, n, &port->vlan_hash[i], hlist) {
75 			dev = vlan->dev;
76 
77 			nskb = skb_clone(skb, GFP_ATOMIC);
78 			if (nskb == NULL) {
79 				dev->stats.rx_errors++;
80 				dev->stats.rx_dropped++;
81 				continue;
82 			}
83 
84 			dev->stats.rx_bytes += skb->len + ETH_HLEN;
85 			dev->stats.rx_packets++;
86 			dev->stats.multicast++;
87 			dev->last_rx = jiffies;
88 
89 			nskb->dev = dev;
90 			if (!compare_ether_addr(eth->h_dest, dev->broadcast))
91 				nskb->pkt_type = PACKET_BROADCAST;
92 			else
93 				nskb->pkt_type = PACKET_MULTICAST;
94 
95 			netif_rx(nskb);
96 		}
97 	}
98 }
99 
100 /* called under rcu_read_lock() from netif_receive_skb */
101 static struct sk_buff *macvlan_handle_frame(struct sk_buff *skb)
102 {
103 	const struct ethhdr *eth = eth_hdr(skb);
104 	const struct macvlan_port *port;
105 	const struct macvlan_dev *vlan;
106 	struct net_device *dev;
107 
108 	port = rcu_dereference(skb->dev->macvlan_port);
109 	if (port == NULL)
110 		return skb;
111 
112 	if (is_multicast_ether_addr(eth->h_dest)) {
113 		macvlan_broadcast(skb, port);
114 		return skb;
115 	}
116 
117 	vlan = macvlan_hash_lookup(port, eth->h_dest);
118 	if (vlan == NULL)
119 		return skb;
120 
121 	dev = vlan->dev;
122 	if (unlikely(!(dev->flags & IFF_UP))) {
123 		kfree_skb(skb);
124 		return NULL;
125 	}
126 
127 	skb = skb_share_check(skb, GFP_ATOMIC);
128 	if (skb == NULL) {
129 		dev->stats.rx_errors++;
130 		dev->stats.rx_dropped++;
131 		return NULL;
132 	}
133 
134 	dev->stats.rx_bytes += skb->len + ETH_HLEN;
135 	dev->stats.rx_packets++;
136 	dev->last_rx = jiffies;
137 
138 	skb->dev = dev;
139 	skb->pkt_type = PACKET_HOST;
140 
141 	netif_rx(skb);
142 	return NULL;
143 }
144 
145 static int macvlan_hard_start_xmit(struct sk_buff *skb, struct net_device *dev)
146 {
147 	const struct macvlan_dev *vlan = netdev_priv(dev);
148 	unsigned int len = skb->len;
149 	int ret;
150 
151 	skb->dev = vlan->lowerdev;
152 	ret = dev_queue_xmit(skb);
153 
154 	if (likely(ret == NET_XMIT_SUCCESS)) {
155 		dev->stats.tx_packets++;
156 		dev->stats.tx_bytes += len;
157 	} else {
158 		dev->stats.tx_errors++;
159 		dev->stats.tx_aborted_errors++;
160 	}
161 	return NETDEV_TX_OK;
162 }
163 
164 static int macvlan_hard_header(struct sk_buff *skb, struct net_device *dev,
165 			       unsigned short type, const void *daddr,
166 			       const void *saddr, unsigned len)
167 {
168 	const struct macvlan_dev *vlan = netdev_priv(dev);
169 	struct net_device *lowerdev = vlan->lowerdev;
170 
171 	return dev_hard_header(skb, lowerdev, type, daddr,
172 			       saddr ? : dev->dev_addr, len);
173 }
174 
175 static const struct header_ops macvlan_hard_header_ops = {
176 	.create  	= macvlan_hard_header,
177 	.rebuild	= eth_rebuild_header,
178 	.parse		= eth_header_parse,
179 	.cache		= eth_header_cache,
180 	.cache_update	= eth_header_cache_update,
181 };
182 
183 static int macvlan_open(struct net_device *dev)
184 {
185 	struct macvlan_dev *vlan = netdev_priv(dev);
186 	struct macvlan_port *port = vlan->port;
187 	struct net_device *lowerdev = vlan->lowerdev;
188 	int err;
189 
190 	err = dev_unicast_add(lowerdev, dev->dev_addr, ETH_ALEN);
191 	if (err < 0)
192 		goto out;
193 	if (dev->flags & IFF_ALLMULTI) {
194 		err = dev_set_allmulti(lowerdev, 1);
195 		if (err < 0)
196 			goto del_unicast;
197 	}
198 
199 	hlist_add_head_rcu(&vlan->hlist, &port->vlan_hash[dev->dev_addr[5]]);
200 	return 0;
201 
202 del_unicast:
203 	dev_unicast_delete(lowerdev, dev->dev_addr, ETH_ALEN);
204 out:
205 	return err;
206 }
207 
208 static int macvlan_stop(struct net_device *dev)
209 {
210 	struct macvlan_dev *vlan = netdev_priv(dev);
211 	struct net_device *lowerdev = vlan->lowerdev;
212 
213 	dev_mc_unsync(lowerdev, dev);
214 	if (dev->flags & IFF_ALLMULTI)
215 		dev_set_allmulti(lowerdev, -1);
216 
217 	dev_unicast_delete(lowerdev, dev->dev_addr, ETH_ALEN);
218 
219 	hlist_del_rcu(&vlan->hlist);
220 	synchronize_rcu();
221 	return 0;
222 }
223 
224 static int macvlan_set_mac_address(struct net_device *dev, void *p)
225 {
226 	struct macvlan_dev *vlan = netdev_priv(dev);
227 	struct net_device *lowerdev = vlan->lowerdev;
228 	struct sockaddr *addr = p;
229 	int err;
230 
231 	if (!is_valid_ether_addr(addr->sa_data))
232 		return -EADDRNOTAVAIL;
233 
234 	if (!(dev->flags & IFF_UP))
235 		goto out;
236 
237 	err = dev_unicast_add(lowerdev, addr->sa_data, ETH_ALEN);
238 	if (err < 0)
239 		return err;
240 	dev_unicast_delete(lowerdev, dev->dev_addr, ETH_ALEN);
241 
242 out:
243 	memcpy(dev->dev_addr, addr->sa_data, ETH_ALEN);
244 	return 0;
245 }
246 
247 static void macvlan_change_rx_flags(struct net_device *dev, int change)
248 {
249 	struct macvlan_dev *vlan = netdev_priv(dev);
250 	struct net_device *lowerdev = vlan->lowerdev;
251 
252 	if (change & IFF_ALLMULTI)
253 		dev_set_allmulti(lowerdev, dev->flags & IFF_ALLMULTI ? 1 : -1);
254 }
255 
256 static void macvlan_set_multicast_list(struct net_device *dev)
257 {
258 	struct macvlan_dev *vlan = netdev_priv(dev);
259 
260 	dev_mc_sync(vlan->lowerdev, dev);
261 }
262 
263 static int macvlan_change_mtu(struct net_device *dev, int new_mtu)
264 {
265 	struct macvlan_dev *vlan = netdev_priv(dev);
266 
267 	if (new_mtu < 68 || vlan->lowerdev->mtu < new_mtu)
268 		return -EINVAL;
269 	dev->mtu = new_mtu;
270 	return 0;
271 }
272 
273 /*
274  * macvlan network devices have devices nesting below it and are a special
275  * "super class" of normal network devices; split their locks off into a
276  * separate class since they always nest.
277  */
278 static struct lock_class_key macvlan_netdev_xmit_lock_key;
279 static struct lock_class_key macvlan_netdev_addr_lock_key;
280 
281 #define MACVLAN_FEATURES \
282 	(NETIF_F_SG | NETIF_F_ALL_CSUM | NETIF_F_HIGHDMA | NETIF_F_FRAGLIST | \
283 	 NETIF_F_GSO | NETIF_F_TSO | NETIF_F_UFO | NETIF_F_GSO_ROBUST | \
284 	 NETIF_F_TSO_ECN | NETIF_F_TSO6)
285 
286 #define MACVLAN_STATE_MASK \
287 	((1<<__LINK_STATE_NOCARRIER) | (1<<__LINK_STATE_DORMANT))
288 
289 static void macvlan_set_lockdep_class_one(struct net_device *dev,
290 					  struct netdev_queue *txq,
291 					  void *_unused)
292 {
293 	lockdep_set_class(&txq->_xmit_lock,
294 			  &macvlan_netdev_xmit_lock_key);
295 }
296 
297 static void macvlan_set_lockdep_class(struct net_device *dev)
298 {
299 	lockdep_set_class(&dev->addr_list_lock,
300 			  &macvlan_netdev_addr_lock_key);
301 	netdev_for_each_tx_queue(dev, macvlan_set_lockdep_class_one, NULL);
302 }
303 
304 static int macvlan_init(struct net_device *dev)
305 {
306 	struct macvlan_dev *vlan = netdev_priv(dev);
307 	const struct net_device *lowerdev = vlan->lowerdev;
308 
309 	dev->state		= (dev->state & ~MACVLAN_STATE_MASK) |
310 				  (lowerdev->state & MACVLAN_STATE_MASK);
311 	dev->features 		= lowerdev->features & MACVLAN_FEATURES;
312 	dev->iflink		= lowerdev->ifindex;
313 
314 	macvlan_set_lockdep_class(dev);
315 
316 	return 0;
317 }
318 
319 static void macvlan_ethtool_get_drvinfo(struct net_device *dev,
320 					struct ethtool_drvinfo *drvinfo)
321 {
322 	snprintf(drvinfo->driver, 32, "macvlan");
323 	snprintf(drvinfo->version, 32, "0.1");
324 }
325 
326 static u32 macvlan_ethtool_get_rx_csum(struct net_device *dev)
327 {
328 	const struct macvlan_dev *vlan = netdev_priv(dev);
329 	struct net_device *lowerdev = vlan->lowerdev;
330 
331 	if (lowerdev->ethtool_ops->get_rx_csum == NULL)
332 		return 0;
333 	return lowerdev->ethtool_ops->get_rx_csum(lowerdev);
334 }
335 
336 static const struct ethtool_ops macvlan_ethtool_ops = {
337 	.get_link		= ethtool_op_get_link,
338 	.get_rx_csum		= macvlan_ethtool_get_rx_csum,
339 	.get_drvinfo		= macvlan_ethtool_get_drvinfo,
340 };
341 
342 static void macvlan_setup(struct net_device *dev)
343 {
344 	ether_setup(dev);
345 
346 	dev->init		= macvlan_init;
347 	dev->open		= macvlan_open;
348 	dev->stop		= macvlan_stop;
349 	dev->change_mtu		= macvlan_change_mtu;
350 	dev->change_rx_flags	= macvlan_change_rx_flags;
351 	dev->set_mac_address	= macvlan_set_mac_address;
352 	dev->set_multicast_list	= macvlan_set_multicast_list;
353 	dev->hard_start_xmit	= macvlan_hard_start_xmit;
354 	dev->destructor		= free_netdev;
355 	dev->header_ops		= &macvlan_hard_header_ops,
356 	dev->ethtool_ops	= &macvlan_ethtool_ops;
357 	dev->tx_queue_len	= 0;
358 }
359 
360 static int macvlan_port_create(struct net_device *dev)
361 {
362 	struct macvlan_port *port;
363 	unsigned int i;
364 
365 	if (dev->type != ARPHRD_ETHER || dev->flags & IFF_LOOPBACK)
366 		return -EINVAL;
367 
368 	port = kzalloc(sizeof(*port), GFP_KERNEL);
369 	if (port == NULL)
370 		return -ENOMEM;
371 
372 	port->dev = dev;
373 	INIT_LIST_HEAD(&port->vlans);
374 	for (i = 0; i < MACVLAN_HASH_SIZE; i++)
375 		INIT_HLIST_HEAD(&port->vlan_hash[i]);
376 	rcu_assign_pointer(dev->macvlan_port, port);
377 	return 0;
378 }
379 
380 static void macvlan_port_destroy(struct net_device *dev)
381 {
382 	struct macvlan_port *port = dev->macvlan_port;
383 
384 	rcu_assign_pointer(dev->macvlan_port, NULL);
385 	synchronize_rcu();
386 	kfree(port);
387 }
388 
389 static void macvlan_transfer_operstate(struct net_device *dev)
390 {
391 	struct macvlan_dev *vlan = netdev_priv(dev);
392 	const struct net_device *lowerdev = vlan->lowerdev;
393 
394 	if (lowerdev->operstate == IF_OPER_DORMANT)
395 		netif_dormant_on(dev);
396 	else
397 		netif_dormant_off(dev);
398 
399 	if (netif_carrier_ok(lowerdev)) {
400 		if (!netif_carrier_ok(dev))
401 			netif_carrier_on(dev);
402 	} else {
403 		if (netif_carrier_ok(dev))
404 			netif_carrier_off(dev);
405 	}
406 }
407 
408 static int macvlan_validate(struct nlattr *tb[], struct nlattr *data[])
409 {
410 	if (tb[IFLA_ADDRESS]) {
411 		if (nla_len(tb[IFLA_ADDRESS]) != ETH_ALEN)
412 			return -EINVAL;
413 		if (!is_valid_ether_addr(nla_data(tb[IFLA_ADDRESS])))
414 			return -EADDRNOTAVAIL;
415 	}
416 	return 0;
417 }
418 
419 static int macvlan_newlink(struct net_device *dev,
420 			   struct nlattr *tb[], struct nlattr *data[])
421 {
422 	struct macvlan_dev *vlan = netdev_priv(dev);
423 	struct macvlan_port *port;
424 	struct net_device *lowerdev;
425 	int err;
426 
427 	if (!tb[IFLA_LINK])
428 		return -EINVAL;
429 
430 	lowerdev = __dev_get_by_index(dev_net(dev), nla_get_u32(tb[IFLA_LINK]));
431 	if (lowerdev == NULL)
432 		return -ENODEV;
433 
434 	/* Don't allow macvlans on top of other macvlans - its not really
435 	 * wrong, but lockdep can't handle it and its not useful for anything
436 	 * you couldn't do directly on top of the real device.
437 	 */
438 	if (lowerdev->rtnl_link_ops == dev->rtnl_link_ops)
439 		return -ENODEV;
440 
441 	if (!tb[IFLA_MTU])
442 		dev->mtu = lowerdev->mtu;
443 	else if (dev->mtu > lowerdev->mtu)
444 		return -EINVAL;
445 
446 	if (!tb[IFLA_ADDRESS])
447 		random_ether_addr(dev->dev_addr);
448 
449 	if (lowerdev->macvlan_port == NULL) {
450 		err = macvlan_port_create(lowerdev);
451 		if (err < 0)
452 			return err;
453 	}
454 	port = lowerdev->macvlan_port;
455 
456 	vlan->lowerdev = lowerdev;
457 	vlan->dev      = dev;
458 	vlan->port     = port;
459 
460 	err = register_netdevice(dev);
461 	if (err < 0)
462 		return err;
463 
464 	list_add_tail(&vlan->list, &port->vlans);
465 	macvlan_transfer_operstate(dev);
466 	return 0;
467 }
468 
469 static void macvlan_dellink(struct net_device *dev)
470 {
471 	struct macvlan_dev *vlan = netdev_priv(dev);
472 	struct macvlan_port *port = vlan->port;
473 
474 	list_del(&vlan->list);
475 	unregister_netdevice(dev);
476 
477 	if (list_empty(&port->vlans))
478 		macvlan_port_destroy(port->dev);
479 }
480 
481 static struct rtnl_link_ops macvlan_link_ops __read_mostly = {
482 	.kind		= "macvlan",
483 	.priv_size	= sizeof(struct macvlan_dev),
484 	.setup		= macvlan_setup,
485 	.validate	= macvlan_validate,
486 	.newlink	= macvlan_newlink,
487 	.dellink	= macvlan_dellink,
488 };
489 
490 static int macvlan_device_event(struct notifier_block *unused,
491 				unsigned long event, void *ptr)
492 {
493 	struct net_device *dev = ptr;
494 	struct macvlan_dev *vlan, *next;
495 	struct macvlan_port *port;
496 
497 	port = dev->macvlan_port;
498 	if (port == NULL)
499 		return NOTIFY_DONE;
500 
501 	switch (event) {
502 	case NETDEV_CHANGE:
503 		list_for_each_entry(vlan, &port->vlans, list)
504 			macvlan_transfer_operstate(vlan->dev);
505 		break;
506 	case NETDEV_FEAT_CHANGE:
507 		list_for_each_entry(vlan, &port->vlans, list) {
508 			vlan->dev->features = dev->features & MACVLAN_FEATURES;
509 			netdev_features_change(vlan->dev);
510 		}
511 		break;
512 	case NETDEV_UNREGISTER:
513 		list_for_each_entry_safe(vlan, next, &port->vlans, list)
514 			macvlan_dellink(vlan->dev);
515 		break;
516 	}
517 	return NOTIFY_DONE;
518 }
519 
520 static struct notifier_block macvlan_notifier_block __read_mostly = {
521 	.notifier_call	= macvlan_device_event,
522 };
523 
524 static int __init macvlan_init_module(void)
525 {
526 	int err;
527 
528 	register_netdevice_notifier(&macvlan_notifier_block);
529 	macvlan_handle_frame_hook = macvlan_handle_frame;
530 
531 	err = rtnl_link_register(&macvlan_link_ops);
532 	if (err < 0)
533 		goto err1;
534 	return 0;
535 err1:
536 	macvlan_handle_frame_hook = NULL;
537 	unregister_netdevice_notifier(&macvlan_notifier_block);
538 	return err;
539 }
540 
541 static void __exit macvlan_cleanup_module(void)
542 {
543 	rtnl_link_unregister(&macvlan_link_ops);
544 	macvlan_handle_frame_hook = NULL;
545 	unregister_netdevice_notifier(&macvlan_notifier_block);
546 }
547 
548 module_init(macvlan_init_module);
549 module_exit(macvlan_cleanup_module);
550 
551 MODULE_LICENSE("GPL");
552 MODULE_AUTHOR("Patrick McHardy <kaber@trash.net>");
553 MODULE_DESCRIPTION("Driver for MAC address based VLANs");
554 MODULE_ALIAS_RTNL_LINK("macvlan");
555