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.
9 * The code this is based on carried the following copyright notice:
11 * (C) Copyright 2001-2006
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>
33 #define MACVLAN_HASH_SIZE (1 << BITS_PER_BYTE)
36 struct net_device *dev;
37 struct hlist_head vlan_hash[MACVLAN_HASH_SIZE];
38 struct list_head vlans;
42 * struct macvlan_rx_stats - MACVLAN percpu rx stats
43 * @rx_packets: number of received packets
44 * @rx_bytes: number of received bytes
45 * @multicast: number of received multicast packets
46 * @rx_errors: number of errors
48 struct macvlan_rx_stats {
49 unsigned long rx_packets;
50 unsigned long rx_bytes;
51 unsigned long multicast;
52 unsigned long rx_errors;
56 struct net_device *dev;
57 struct list_head list;
58 struct hlist_node hlist;
59 struct macvlan_port *port;
60 struct net_device *lowerdev;
61 struct macvlan_rx_stats *rx_stats;
65 static struct macvlan_dev *macvlan_hash_lookup(const struct macvlan_port *port,
66 const unsigned char *addr)
68 struct macvlan_dev *vlan;
71 hlist_for_each_entry_rcu(vlan, n, &port->vlan_hash[addr[5]], hlist) {
72 if (!compare_ether_addr_64bits(vlan->dev->dev_addr, addr))
78 static void macvlan_hash_add(struct macvlan_dev *vlan)
80 struct macvlan_port *port = vlan->port;
81 const unsigned char *addr = vlan->dev->dev_addr;
83 hlist_add_head_rcu(&vlan->hlist, &port->vlan_hash[addr[5]]);
86 static void macvlan_hash_del(struct macvlan_dev *vlan)
88 hlist_del_rcu(&vlan->hlist);
92 static void macvlan_hash_change_addr(struct macvlan_dev *vlan,
93 const unsigned char *addr)
95 macvlan_hash_del(vlan);
96 /* Now that we are unhashed it is safe to change the device
97 * address without confusing packet delivery.
99 memcpy(vlan->dev->dev_addr, addr, ETH_ALEN);
100 macvlan_hash_add(vlan);
103 static int macvlan_addr_busy(const struct macvlan_port *port,
104 const unsigned char *addr)
106 /* Test to see if the specified multicast address is
107 * currently in use by the underlying device or
110 if (!compare_ether_addr_64bits(port->dev->dev_addr, addr))
113 if (macvlan_hash_lookup(port, addr))
119 static void macvlan_broadcast(struct sk_buff *skb,
120 const struct macvlan_port *port)
122 const struct ethhdr *eth = eth_hdr(skb);
123 const struct macvlan_dev *vlan;
124 struct hlist_node *n;
125 struct net_device *dev;
126 struct sk_buff *nskb;
128 struct macvlan_rx_stats *rx_stats;
130 if (skb->protocol == htons(ETH_P_PAUSE))
133 for (i = 0; i < MACVLAN_HASH_SIZE; i++) {
134 hlist_for_each_entry_rcu(vlan, n, &port->vlan_hash[i], hlist) {
136 rx_stats = per_cpu_ptr(vlan->rx_stats, smp_processor_id());
138 nskb = skb_clone(skb, GFP_ATOMIC);
140 rx_stats->rx_errors++;
144 rx_stats->rx_bytes += skb->len + ETH_HLEN;
145 rx_stats->rx_packets++;
146 rx_stats->multicast++;
149 if (!compare_ether_addr_64bits(eth->h_dest, dev->broadcast))
150 nskb->pkt_type = PACKET_BROADCAST;
152 nskb->pkt_type = PACKET_MULTICAST;
159 /* called under rcu_read_lock() from netif_receive_skb */
160 static struct sk_buff *macvlan_handle_frame(struct sk_buff *skb)
162 const struct ethhdr *eth = eth_hdr(skb);
163 const struct macvlan_port *port;
164 const struct macvlan_dev *vlan;
165 struct net_device *dev;
166 struct macvlan_rx_stats *rx_stats;
168 port = rcu_dereference(skb->dev->macvlan_port);
172 if (is_multicast_ether_addr(eth->h_dest)) {
173 macvlan_broadcast(skb, port);
177 vlan = macvlan_hash_lookup(port, eth->h_dest);
182 if (unlikely(!(dev->flags & IFF_UP))) {
186 rx_stats = per_cpu_ptr(vlan->rx_stats, smp_processor_id());
187 skb = skb_share_check(skb, GFP_ATOMIC);
189 rx_stats->rx_errors++;
193 rx_stats->rx_bytes += skb->len + ETH_HLEN;
194 rx_stats->rx_packets++;
197 skb->pkt_type = PACKET_HOST;
203 static netdev_tx_t macvlan_start_xmit(struct sk_buff *skb,
204 struct net_device *dev)
206 int i = skb_get_queue_mapping(skb);
207 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
208 const struct macvlan_dev *vlan = netdev_priv(dev);
209 unsigned int len = skb->len;
212 skb->dev = vlan->lowerdev;
213 ret = dev_queue_xmit(skb);
215 if (likely(ret == NET_XMIT_SUCCESS)) {
217 txq->tx_bytes += len;
224 static int macvlan_hard_header(struct sk_buff *skb, struct net_device *dev,
225 unsigned short type, const void *daddr,
226 const void *saddr, unsigned len)
228 const struct macvlan_dev *vlan = netdev_priv(dev);
229 struct net_device *lowerdev = vlan->lowerdev;
231 return dev_hard_header(skb, lowerdev, type, daddr,
232 saddr ? : dev->dev_addr, len);
235 static const struct header_ops macvlan_hard_header_ops = {
236 .create = macvlan_hard_header,
237 .rebuild = eth_rebuild_header,
238 .parse = eth_header_parse,
239 .cache = eth_header_cache,
240 .cache_update = eth_header_cache_update,
243 static int macvlan_open(struct net_device *dev)
245 struct macvlan_dev *vlan = netdev_priv(dev);
246 struct net_device *lowerdev = vlan->lowerdev;
250 if (macvlan_addr_busy(vlan->port, dev->dev_addr))
253 err = dev_unicast_add(lowerdev, dev->dev_addr);
256 if (dev->flags & IFF_ALLMULTI) {
257 err = dev_set_allmulti(lowerdev, 1);
261 macvlan_hash_add(vlan);
265 dev_unicast_delete(lowerdev, dev->dev_addr);
270 static int macvlan_stop(struct net_device *dev)
272 struct macvlan_dev *vlan = netdev_priv(dev);
273 struct net_device *lowerdev = vlan->lowerdev;
275 dev_mc_unsync(lowerdev, dev);
276 if (dev->flags & IFF_ALLMULTI)
277 dev_set_allmulti(lowerdev, -1);
279 dev_unicast_delete(lowerdev, dev->dev_addr);
281 macvlan_hash_del(vlan);
285 static int macvlan_set_mac_address(struct net_device *dev, void *p)
287 struct macvlan_dev *vlan = netdev_priv(dev);
288 struct net_device *lowerdev = vlan->lowerdev;
289 struct sockaddr *addr = p;
292 if (!is_valid_ether_addr(addr->sa_data))
293 return -EADDRNOTAVAIL;
295 if (!(dev->flags & IFF_UP)) {
296 /* Just copy in the new address */
297 memcpy(dev->dev_addr, addr->sa_data, ETH_ALEN);
299 /* Rehash and update the device filters */
300 if (macvlan_addr_busy(vlan->port, addr->sa_data))
303 err = dev_unicast_add(lowerdev, addr->sa_data);
307 dev_unicast_delete(lowerdev, dev->dev_addr);
309 macvlan_hash_change_addr(vlan, addr->sa_data);
314 static void macvlan_change_rx_flags(struct net_device *dev, int change)
316 struct macvlan_dev *vlan = netdev_priv(dev);
317 struct net_device *lowerdev = vlan->lowerdev;
319 if (change & IFF_ALLMULTI)
320 dev_set_allmulti(lowerdev, dev->flags & IFF_ALLMULTI ? 1 : -1);
323 static void macvlan_set_multicast_list(struct net_device *dev)
325 struct macvlan_dev *vlan = netdev_priv(dev);
327 dev_mc_sync(vlan->lowerdev, dev);
330 static int macvlan_change_mtu(struct net_device *dev, int new_mtu)
332 struct macvlan_dev *vlan = netdev_priv(dev);
334 if (new_mtu < 68 || vlan->lowerdev->mtu < new_mtu)
341 * macvlan network devices have devices nesting below it and are a special
342 * "super class" of normal network devices; split their locks off into a
343 * separate class since they always nest.
345 static struct lock_class_key macvlan_netdev_xmit_lock_key;
346 static struct lock_class_key macvlan_netdev_addr_lock_key;
348 #define MACVLAN_FEATURES \
349 (NETIF_F_SG | NETIF_F_ALL_CSUM | NETIF_F_HIGHDMA | NETIF_F_FRAGLIST | \
350 NETIF_F_GSO | NETIF_F_TSO | NETIF_F_UFO | NETIF_F_GSO_ROBUST | \
351 NETIF_F_TSO_ECN | NETIF_F_TSO6)
353 #define MACVLAN_STATE_MASK \
354 ((1<<__LINK_STATE_NOCARRIER) | (1<<__LINK_STATE_DORMANT))
356 static void macvlan_set_lockdep_class_one(struct net_device *dev,
357 struct netdev_queue *txq,
360 lockdep_set_class(&txq->_xmit_lock,
361 &macvlan_netdev_xmit_lock_key);
364 static void macvlan_set_lockdep_class(struct net_device *dev)
366 lockdep_set_class(&dev->addr_list_lock,
367 &macvlan_netdev_addr_lock_key);
368 netdev_for_each_tx_queue(dev, macvlan_set_lockdep_class_one, NULL);
371 static int macvlan_init(struct net_device *dev)
373 struct macvlan_dev *vlan = netdev_priv(dev);
374 const struct net_device *lowerdev = vlan->lowerdev;
376 dev->state = (dev->state & ~MACVLAN_STATE_MASK) |
377 (lowerdev->state & MACVLAN_STATE_MASK);
378 dev->features = lowerdev->features & MACVLAN_FEATURES;
379 dev->iflink = lowerdev->ifindex;
380 dev->hard_header_len = lowerdev->hard_header_len;
382 macvlan_set_lockdep_class(dev);
384 vlan->rx_stats = alloc_percpu(struct macvlan_rx_stats);
391 static void macvlan_uninit(struct net_device *dev)
393 struct macvlan_dev *vlan = netdev_priv(dev);
395 free_percpu(vlan->rx_stats);
398 static struct net_device_stats *macvlan_dev_get_stats(struct net_device *dev)
400 struct net_device_stats *stats = &dev->stats;
401 struct macvlan_dev *vlan = netdev_priv(dev);
403 dev_txq_stats_fold(dev, stats);
405 if (vlan->rx_stats) {
406 struct macvlan_rx_stats *p, rx = {0};
409 for_each_possible_cpu(i) {
410 p = per_cpu_ptr(vlan->rx_stats, i);
411 rx.rx_packets += p->rx_packets;
412 rx.rx_bytes += p->rx_bytes;
413 rx.rx_errors += p->rx_errors;
414 rx.multicast += p->multicast;
416 stats->rx_packets = rx.rx_packets;
417 stats->rx_bytes = rx.rx_bytes;
418 stats->rx_errors = rx.rx_errors;
419 stats->rx_dropped = rx.rx_errors;
420 stats->multicast = rx.multicast;
425 static void macvlan_ethtool_get_drvinfo(struct net_device *dev,
426 struct ethtool_drvinfo *drvinfo)
428 snprintf(drvinfo->driver, 32, "macvlan");
429 snprintf(drvinfo->version, 32, "0.1");
432 static u32 macvlan_ethtool_get_rx_csum(struct net_device *dev)
434 const struct macvlan_dev *vlan = netdev_priv(dev);
435 return dev_ethtool_get_rx_csum(vlan->lowerdev);
438 static int macvlan_ethtool_get_settings(struct net_device *dev,
439 struct ethtool_cmd *cmd)
441 const struct macvlan_dev *vlan = netdev_priv(dev);
442 return dev_ethtool_get_settings(vlan->lowerdev, cmd);
445 static u32 macvlan_ethtool_get_flags(struct net_device *dev)
447 const struct macvlan_dev *vlan = netdev_priv(dev);
448 return dev_ethtool_get_flags(vlan->lowerdev);
451 static const struct ethtool_ops macvlan_ethtool_ops = {
452 .get_link = ethtool_op_get_link,
453 .get_settings = macvlan_ethtool_get_settings,
454 .get_rx_csum = macvlan_ethtool_get_rx_csum,
455 .get_drvinfo = macvlan_ethtool_get_drvinfo,
456 .get_flags = macvlan_ethtool_get_flags,
459 static const struct net_device_ops macvlan_netdev_ops = {
460 .ndo_init = macvlan_init,
461 .ndo_uninit = macvlan_uninit,
462 .ndo_open = macvlan_open,
463 .ndo_stop = macvlan_stop,
464 .ndo_start_xmit = macvlan_start_xmit,
465 .ndo_change_mtu = macvlan_change_mtu,
466 .ndo_change_rx_flags = macvlan_change_rx_flags,
467 .ndo_set_mac_address = macvlan_set_mac_address,
468 .ndo_set_multicast_list = macvlan_set_multicast_list,
469 .ndo_get_stats = macvlan_dev_get_stats,
470 .ndo_validate_addr = eth_validate_addr,
473 static void macvlan_setup(struct net_device *dev)
477 dev->priv_flags &= ~IFF_XMIT_DST_RELEASE;
478 dev->netdev_ops = &macvlan_netdev_ops;
479 dev->destructor = free_netdev;
480 dev->header_ops = &macvlan_hard_header_ops,
481 dev->ethtool_ops = &macvlan_ethtool_ops;
482 dev->tx_queue_len = 0;
485 static int macvlan_port_create(struct net_device *dev)
487 struct macvlan_port *port;
490 if (dev->type != ARPHRD_ETHER || dev->flags & IFF_LOOPBACK)
493 port = kzalloc(sizeof(*port), GFP_KERNEL);
498 INIT_LIST_HEAD(&port->vlans);
499 for (i = 0; i < MACVLAN_HASH_SIZE; i++)
500 INIT_HLIST_HEAD(&port->vlan_hash[i]);
501 rcu_assign_pointer(dev->macvlan_port, port);
505 static void macvlan_port_destroy(struct net_device *dev)
507 struct macvlan_port *port = dev->macvlan_port;
509 rcu_assign_pointer(dev->macvlan_port, NULL);
514 static void macvlan_transfer_operstate(struct net_device *dev)
516 struct macvlan_dev *vlan = netdev_priv(dev);
517 const struct net_device *lowerdev = vlan->lowerdev;
519 if (lowerdev->operstate == IF_OPER_DORMANT)
520 netif_dormant_on(dev);
522 netif_dormant_off(dev);
524 if (netif_carrier_ok(lowerdev)) {
525 if (!netif_carrier_ok(dev))
526 netif_carrier_on(dev);
528 if (netif_carrier_ok(dev))
529 netif_carrier_off(dev);
533 static int macvlan_validate(struct nlattr *tb[], struct nlattr *data[])
535 if (tb[IFLA_ADDRESS]) {
536 if (nla_len(tb[IFLA_ADDRESS]) != ETH_ALEN)
538 if (!is_valid_ether_addr(nla_data(tb[IFLA_ADDRESS])))
539 return -EADDRNOTAVAIL;
544 static int macvlan_get_tx_queues(struct net *net,
546 unsigned int *num_tx_queues,
547 unsigned int *real_num_tx_queues)
549 struct net_device *real_dev;
554 real_dev = __dev_get_by_index(net, nla_get_u32(tb[IFLA_LINK]));
558 *num_tx_queues = real_dev->num_tx_queues;
559 *real_num_tx_queues = real_dev->real_num_tx_queues;
563 static int macvlan_newlink(struct net *src_net, struct net_device *dev,
564 struct nlattr *tb[], struct nlattr *data[])
566 struct macvlan_dev *vlan = netdev_priv(dev);
567 struct macvlan_port *port;
568 struct net_device *lowerdev;
574 lowerdev = __dev_get_by_index(src_net, nla_get_u32(tb[IFLA_LINK]));
575 if (lowerdev == NULL)
578 /* When creating macvlans on top of other macvlans - use
579 * the real device as the lowerdev.
581 if (lowerdev->rtnl_link_ops == dev->rtnl_link_ops) {
582 struct macvlan_dev *lowervlan = netdev_priv(lowerdev);
583 lowerdev = lowervlan->lowerdev;
587 dev->mtu = lowerdev->mtu;
588 else if (dev->mtu > lowerdev->mtu)
591 if (!tb[IFLA_ADDRESS])
592 random_ether_addr(dev->dev_addr);
594 if (lowerdev->macvlan_port == NULL) {
595 err = macvlan_port_create(lowerdev);
599 port = lowerdev->macvlan_port;
601 vlan->lowerdev = lowerdev;
605 err = register_netdevice(dev);
609 list_add_tail(&vlan->list, &port->vlans);
610 macvlan_transfer_operstate(dev);
614 static void macvlan_dellink(struct net_device *dev, struct list_head *head)
616 struct macvlan_dev *vlan = netdev_priv(dev);
617 struct macvlan_port *port = vlan->port;
619 list_del(&vlan->list);
620 unregister_netdevice_queue(dev, head);
622 if (list_empty(&port->vlans))
623 macvlan_port_destroy(port->dev);
626 static struct rtnl_link_ops macvlan_link_ops __read_mostly = {
628 .priv_size = sizeof(struct macvlan_dev),
629 .get_tx_queues = macvlan_get_tx_queues,
630 .setup = macvlan_setup,
631 .validate = macvlan_validate,
632 .newlink = macvlan_newlink,
633 .dellink = macvlan_dellink,
636 static int macvlan_device_event(struct notifier_block *unused,
637 unsigned long event, void *ptr)
639 struct net_device *dev = ptr;
640 struct macvlan_dev *vlan, *next;
641 struct macvlan_port *port;
643 port = dev->macvlan_port;
649 list_for_each_entry(vlan, &port->vlans, list)
650 macvlan_transfer_operstate(vlan->dev);
652 case NETDEV_FEAT_CHANGE:
653 list_for_each_entry(vlan, &port->vlans, list) {
654 vlan->dev->features = dev->features & MACVLAN_FEATURES;
655 netdev_features_change(vlan->dev);
658 case NETDEV_UNREGISTER:
659 list_for_each_entry_safe(vlan, next, &port->vlans, list)
660 macvlan_dellink(vlan->dev, NULL);
666 static struct notifier_block macvlan_notifier_block __read_mostly = {
667 .notifier_call = macvlan_device_event,
670 static int __init macvlan_init_module(void)
674 register_netdevice_notifier(&macvlan_notifier_block);
675 macvlan_handle_frame_hook = macvlan_handle_frame;
677 err = rtnl_link_register(&macvlan_link_ops);
682 macvlan_handle_frame_hook = NULL;
683 unregister_netdevice_notifier(&macvlan_notifier_block);
687 static void __exit macvlan_cleanup_module(void)
689 rtnl_link_unregister(&macvlan_link_ops);
690 macvlan_handle_frame_hook = NULL;
691 unregister_netdevice_notifier(&macvlan_notifier_block);
694 module_init(macvlan_init_module);
695 module_exit(macvlan_cleanup_module);
697 MODULE_LICENSE("GPL");
699 MODULE_DESCRIPTION("Driver for MAC address based VLANs");
700 MODULE_ALIAS_RTNL_LINK("macvlan");