2 * Copyright (c) 2007 Patrick McHardy <kaber@trash.net>
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
12 * Alex Zeffertt, Cambridge Broadband Ltd, ajz@cambridgebroadband.com
13 * Re-worked by Ben Greear <greearb@candelatech.com>
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 inline void macvlan_count_rx(const struct macvlan_dev *vlan,
120 unsigned int len, bool success,
123 struct macvlan_rx_stats *rx_stats;
125 rx_stats = per_cpu_ptr(vlan->rx_stats, smp_processor_id());
126 if (likely(success)) {
127 rx_stats->rx_packets++;;
128 rx_stats->rx_bytes += len;
130 rx_stats->multicast++;
132 rx_stats->rx_errors++;
136 static int macvlan_broadcast_one(struct sk_buff *skb, struct net_device *dev,
137 const struct ethhdr *eth)
143 if (!compare_ether_addr_64bits(eth->h_dest,
145 skb->pkt_type = PACKET_BROADCAST;
147 skb->pkt_type = PACKET_MULTICAST;
149 return netif_rx(skb);
152 static void macvlan_broadcast(struct sk_buff *skb,
153 const struct macvlan_port *port)
155 const struct ethhdr *eth = eth_hdr(skb);
156 const struct macvlan_dev *vlan;
157 struct hlist_node *n;
158 struct sk_buff *nskb;
162 if (skb->protocol == htons(ETH_P_PAUSE))
165 for (i = 0; i < MACVLAN_HASH_SIZE; i++) {
166 hlist_for_each_entry_rcu(vlan, n, &port->vlan_hash[i], hlist) {
167 nskb = skb_clone(skb, GFP_ATOMIC);
168 err = macvlan_broadcast_one(nskb, vlan->dev, eth);
169 macvlan_count_rx(vlan, skb->len + ETH_HLEN,
170 err == NET_RX_SUCCESS, 1);
175 /* called under rcu_read_lock() from netif_receive_skb */
176 static struct sk_buff *macvlan_handle_frame(struct sk_buff *skb)
178 const struct ethhdr *eth = eth_hdr(skb);
179 const struct macvlan_port *port;
180 const struct macvlan_dev *vlan;
181 struct net_device *dev;
184 port = rcu_dereference(skb->dev->macvlan_port);
188 if (is_multicast_ether_addr(eth->h_dest)) {
189 macvlan_broadcast(skb, port);
193 vlan = macvlan_hash_lookup(port, eth->h_dest);
198 if (unlikely(!(dev->flags & IFF_UP))) {
202 len = skb->len + ETH_HLEN;
203 skb = skb_share_check(skb, GFP_ATOMIC);
204 macvlan_count_rx(vlan, len, skb != NULL, 0);
209 skb->pkt_type = PACKET_HOST;
215 static netdev_tx_t macvlan_start_xmit(struct sk_buff *skb,
216 struct net_device *dev)
218 int i = skb_get_queue_mapping(skb);
219 struct netdev_queue *txq = netdev_get_tx_queue(dev, i);
220 const struct macvlan_dev *vlan = netdev_priv(dev);
221 unsigned int len = skb->len;
224 skb->dev = vlan->lowerdev;
225 ret = dev_queue_xmit(skb);
227 if (likely(ret == NET_XMIT_SUCCESS)) {
229 txq->tx_bytes += len;
236 static int macvlan_hard_header(struct sk_buff *skb, struct net_device *dev,
237 unsigned short type, const void *daddr,
238 const void *saddr, unsigned len)
240 const struct macvlan_dev *vlan = netdev_priv(dev);
241 struct net_device *lowerdev = vlan->lowerdev;
243 return dev_hard_header(skb, lowerdev, type, daddr,
244 saddr ? : dev->dev_addr, len);
247 static const struct header_ops macvlan_hard_header_ops = {
248 .create = macvlan_hard_header,
249 .rebuild = eth_rebuild_header,
250 .parse = eth_header_parse,
251 .cache = eth_header_cache,
252 .cache_update = eth_header_cache_update,
255 static int macvlan_open(struct net_device *dev)
257 struct macvlan_dev *vlan = netdev_priv(dev);
258 struct net_device *lowerdev = vlan->lowerdev;
262 if (macvlan_addr_busy(vlan->port, dev->dev_addr))
265 err = dev_unicast_add(lowerdev, dev->dev_addr);
268 if (dev->flags & IFF_ALLMULTI) {
269 err = dev_set_allmulti(lowerdev, 1);
273 macvlan_hash_add(vlan);
277 dev_unicast_delete(lowerdev, dev->dev_addr);
282 static int macvlan_stop(struct net_device *dev)
284 struct macvlan_dev *vlan = netdev_priv(dev);
285 struct net_device *lowerdev = vlan->lowerdev;
287 dev_mc_unsync(lowerdev, dev);
288 if (dev->flags & IFF_ALLMULTI)
289 dev_set_allmulti(lowerdev, -1);
291 dev_unicast_delete(lowerdev, dev->dev_addr);
293 macvlan_hash_del(vlan);
297 static int macvlan_set_mac_address(struct net_device *dev, void *p)
299 struct macvlan_dev *vlan = netdev_priv(dev);
300 struct net_device *lowerdev = vlan->lowerdev;
301 struct sockaddr *addr = p;
304 if (!is_valid_ether_addr(addr->sa_data))
305 return -EADDRNOTAVAIL;
307 if (!(dev->flags & IFF_UP)) {
308 /* Just copy in the new address */
309 memcpy(dev->dev_addr, addr->sa_data, ETH_ALEN);
311 /* Rehash and update the device filters */
312 if (macvlan_addr_busy(vlan->port, addr->sa_data))
315 err = dev_unicast_add(lowerdev, addr->sa_data);
319 dev_unicast_delete(lowerdev, dev->dev_addr);
321 macvlan_hash_change_addr(vlan, addr->sa_data);
326 static void macvlan_change_rx_flags(struct net_device *dev, int change)
328 struct macvlan_dev *vlan = netdev_priv(dev);
329 struct net_device *lowerdev = vlan->lowerdev;
331 if (change & IFF_ALLMULTI)
332 dev_set_allmulti(lowerdev, dev->flags & IFF_ALLMULTI ? 1 : -1);
335 static void macvlan_set_multicast_list(struct net_device *dev)
337 struct macvlan_dev *vlan = netdev_priv(dev);
339 dev_mc_sync(vlan->lowerdev, dev);
342 static int macvlan_change_mtu(struct net_device *dev, int new_mtu)
344 struct macvlan_dev *vlan = netdev_priv(dev);
346 if (new_mtu < 68 || vlan->lowerdev->mtu < new_mtu)
353 * macvlan network devices have devices nesting below it and are a special
354 * "super class" of normal network devices; split their locks off into a
355 * separate class since they always nest.
357 static struct lock_class_key macvlan_netdev_xmit_lock_key;
358 static struct lock_class_key macvlan_netdev_addr_lock_key;
360 #define MACVLAN_FEATURES \
361 (NETIF_F_SG | NETIF_F_ALL_CSUM | NETIF_F_HIGHDMA | NETIF_F_FRAGLIST | \
362 NETIF_F_GSO | NETIF_F_TSO | NETIF_F_UFO | NETIF_F_GSO_ROBUST | \
363 NETIF_F_TSO_ECN | NETIF_F_TSO6)
365 #define MACVLAN_STATE_MASK \
366 ((1<<__LINK_STATE_NOCARRIER) | (1<<__LINK_STATE_DORMANT))
368 static void macvlan_set_lockdep_class_one(struct net_device *dev,
369 struct netdev_queue *txq,
372 lockdep_set_class(&txq->_xmit_lock,
373 &macvlan_netdev_xmit_lock_key);
376 static void macvlan_set_lockdep_class(struct net_device *dev)
378 lockdep_set_class(&dev->addr_list_lock,
379 &macvlan_netdev_addr_lock_key);
380 netdev_for_each_tx_queue(dev, macvlan_set_lockdep_class_one, NULL);
383 static int macvlan_init(struct net_device *dev)
385 struct macvlan_dev *vlan = netdev_priv(dev);
386 const struct net_device *lowerdev = vlan->lowerdev;
388 dev->state = (dev->state & ~MACVLAN_STATE_MASK) |
389 (lowerdev->state & MACVLAN_STATE_MASK);
390 dev->features = lowerdev->features & MACVLAN_FEATURES;
391 dev->iflink = lowerdev->ifindex;
392 dev->hard_header_len = lowerdev->hard_header_len;
394 macvlan_set_lockdep_class(dev);
396 vlan->rx_stats = alloc_percpu(struct macvlan_rx_stats);
403 static void macvlan_uninit(struct net_device *dev)
405 struct macvlan_dev *vlan = netdev_priv(dev);
407 free_percpu(vlan->rx_stats);
410 static struct net_device_stats *macvlan_dev_get_stats(struct net_device *dev)
412 struct net_device_stats *stats = &dev->stats;
413 struct macvlan_dev *vlan = netdev_priv(dev);
415 dev_txq_stats_fold(dev, stats);
417 if (vlan->rx_stats) {
418 struct macvlan_rx_stats *p, rx = {0};
421 for_each_possible_cpu(i) {
422 p = per_cpu_ptr(vlan->rx_stats, i);
423 rx.rx_packets += p->rx_packets;
424 rx.rx_bytes += p->rx_bytes;
425 rx.rx_errors += p->rx_errors;
426 rx.multicast += p->multicast;
428 stats->rx_packets = rx.rx_packets;
429 stats->rx_bytes = rx.rx_bytes;
430 stats->rx_errors = rx.rx_errors;
431 stats->rx_dropped = rx.rx_errors;
432 stats->multicast = rx.multicast;
437 static void macvlan_ethtool_get_drvinfo(struct net_device *dev,
438 struct ethtool_drvinfo *drvinfo)
440 snprintf(drvinfo->driver, 32, "macvlan");
441 snprintf(drvinfo->version, 32, "0.1");
444 static u32 macvlan_ethtool_get_rx_csum(struct net_device *dev)
446 const struct macvlan_dev *vlan = netdev_priv(dev);
447 return dev_ethtool_get_rx_csum(vlan->lowerdev);
450 static int macvlan_ethtool_get_settings(struct net_device *dev,
451 struct ethtool_cmd *cmd)
453 const struct macvlan_dev *vlan = netdev_priv(dev);
454 return dev_ethtool_get_settings(vlan->lowerdev, cmd);
457 static u32 macvlan_ethtool_get_flags(struct net_device *dev)
459 const struct macvlan_dev *vlan = netdev_priv(dev);
460 return dev_ethtool_get_flags(vlan->lowerdev);
463 static const struct ethtool_ops macvlan_ethtool_ops = {
464 .get_link = ethtool_op_get_link,
465 .get_settings = macvlan_ethtool_get_settings,
466 .get_rx_csum = macvlan_ethtool_get_rx_csum,
467 .get_drvinfo = macvlan_ethtool_get_drvinfo,
468 .get_flags = macvlan_ethtool_get_flags,
471 static const struct net_device_ops macvlan_netdev_ops = {
472 .ndo_init = macvlan_init,
473 .ndo_uninit = macvlan_uninit,
474 .ndo_open = macvlan_open,
475 .ndo_stop = macvlan_stop,
476 .ndo_start_xmit = macvlan_start_xmit,
477 .ndo_change_mtu = macvlan_change_mtu,
478 .ndo_change_rx_flags = macvlan_change_rx_flags,
479 .ndo_set_mac_address = macvlan_set_mac_address,
480 .ndo_set_multicast_list = macvlan_set_multicast_list,
481 .ndo_get_stats = macvlan_dev_get_stats,
482 .ndo_validate_addr = eth_validate_addr,
485 static void macvlan_setup(struct net_device *dev)
489 dev->priv_flags &= ~IFF_XMIT_DST_RELEASE;
490 dev->netdev_ops = &macvlan_netdev_ops;
491 dev->destructor = free_netdev;
492 dev->header_ops = &macvlan_hard_header_ops,
493 dev->ethtool_ops = &macvlan_ethtool_ops;
494 dev->tx_queue_len = 0;
497 static int macvlan_port_create(struct net_device *dev)
499 struct macvlan_port *port;
502 if (dev->type != ARPHRD_ETHER || dev->flags & IFF_LOOPBACK)
505 port = kzalloc(sizeof(*port), GFP_KERNEL);
510 INIT_LIST_HEAD(&port->vlans);
511 for (i = 0; i < MACVLAN_HASH_SIZE; i++)
512 INIT_HLIST_HEAD(&port->vlan_hash[i]);
513 rcu_assign_pointer(dev->macvlan_port, port);
517 static void macvlan_port_destroy(struct net_device *dev)
519 struct macvlan_port *port = dev->macvlan_port;
521 rcu_assign_pointer(dev->macvlan_port, NULL);
526 static void macvlan_transfer_operstate(struct net_device *dev)
528 struct macvlan_dev *vlan = netdev_priv(dev);
529 const struct net_device *lowerdev = vlan->lowerdev;
531 if (lowerdev->operstate == IF_OPER_DORMANT)
532 netif_dormant_on(dev);
534 netif_dormant_off(dev);
536 if (netif_carrier_ok(lowerdev)) {
537 if (!netif_carrier_ok(dev))
538 netif_carrier_on(dev);
540 if (netif_carrier_ok(dev))
541 netif_carrier_off(dev);
545 static int macvlan_validate(struct nlattr *tb[], struct nlattr *data[])
547 if (tb[IFLA_ADDRESS]) {
548 if (nla_len(tb[IFLA_ADDRESS]) != ETH_ALEN)
550 if (!is_valid_ether_addr(nla_data(tb[IFLA_ADDRESS])))
551 return -EADDRNOTAVAIL;
556 static int macvlan_get_tx_queues(struct net *net,
558 unsigned int *num_tx_queues,
559 unsigned int *real_num_tx_queues)
561 struct net_device *real_dev;
566 real_dev = __dev_get_by_index(net, nla_get_u32(tb[IFLA_LINK]));
570 *num_tx_queues = real_dev->num_tx_queues;
571 *real_num_tx_queues = real_dev->real_num_tx_queues;
575 static int macvlan_newlink(struct net *src_net, struct net_device *dev,
576 struct nlattr *tb[], struct nlattr *data[])
578 struct macvlan_dev *vlan = netdev_priv(dev);
579 struct macvlan_port *port;
580 struct net_device *lowerdev;
586 lowerdev = __dev_get_by_index(src_net, nla_get_u32(tb[IFLA_LINK]));
587 if (lowerdev == NULL)
590 /* When creating macvlans on top of other macvlans - use
591 * the real device as the lowerdev.
593 if (lowerdev->rtnl_link_ops == dev->rtnl_link_ops) {
594 struct macvlan_dev *lowervlan = netdev_priv(lowerdev);
595 lowerdev = lowervlan->lowerdev;
599 dev->mtu = lowerdev->mtu;
600 else if (dev->mtu > lowerdev->mtu)
603 if (!tb[IFLA_ADDRESS])
604 random_ether_addr(dev->dev_addr);
606 if (lowerdev->macvlan_port == NULL) {
607 err = macvlan_port_create(lowerdev);
611 port = lowerdev->macvlan_port;
613 vlan->lowerdev = lowerdev;
617 err = register_netdevice(dev);
621 list_add_tail(&vlan->list, &port->vlans);
622 macvlan_transfer_operstate(dev);
626 static void macvlan_dellink(struct net_device *dev, struct list_head *head)
628 struct macvlan_dev *vlan = netdev_priv(dev);
629 struct macvlan_port *port = vlan->port;
631 list_del(&vlan->list);
632 unregister_netdevice_queue(dev, head);
634 if (list_empty(&port->vlans))
635 macvlan_port_destroy(port->dev);
638 static struct rtnl_link_ops macvlan_link_ops __read_mostly = {
640 .priv_size = sizeof(struct macvlan_dev),
641 .get_tx_queues = macvlan_get_tx_queues,
642 .setup = macvlan_setup,
643 .validate = macvlan_validate,
644 .newlink = macvlan_newlink,
645 .dellink = macvlan_dellink,
648 static int macvlan_device_event(struct notifier_block *unused,
649 unsigned long event, void *ptr)
651 struct net_device *dev = ptr;
652 struct macvlan_dev *vlan, *next;
653 struct macvlan_port *port;
655 port = dev->macvlan_port;
661 list_for_each_entry(vlan, &port->vlans, list)
662 macvlan_transfer_operstate(vlan->dev);
664 case NETDEV_FEAT_CHANGE:
665 list_for_each_entry(vlan, &port->vlans, list) {
666 vlan->dev->features = dev->features & MACVLAN_FEATURES;
667 netdev_features_change(vlan->dev);
670 case NETDEV_UNREGISTER:
671 list_for_each_entry_safe(vlan, next, &port->vlans, list)
672 macvlan_dellink(vlan->dev, NULL);
678 static struct notifier_block macvlan_notifier_block __read_mostly = {
679 .notifier_call = macvlan_device_event,
682 static int __init macvlan_init_module(void)
686 register_netdevice_notifier(&macvlan_notifier_block);
687 macvlan_handle_frame_hook = macvlan_handle_frame;
689 err = rtnl_link_register(&macvlan_link_ops);
694 macvlan_handle_frame_hook = NULL;
695 unregister_netdevice_notifier(&macvlan_notifier_block);
699 static void __exit macvlan_cleanup_module(void)
701 rtnl_link_unregister(&macvlan_link_ops);
702 macvlan_handle_frame_hook = NULL;
703 unregister_netdevice_notifier(&macvlan_notifier_block);
706 module_init(macvlan_init_module);
707 module_exit(macvlan_cleanup_module);
709 MODULE_LICENSE("GPL");
710 MODULE_AUTHOR("Patrick McHardy <kaber@trash.net>");
711 MODULE_DESCRIPTION("Driver for MAC address based VLANs");
712 MODULE_ALIAS_RTNL_LINK("macvlan");