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 net_device *dev;
43 struct list_head list;
44 struct hlist_node hlist;
45 struct macvlan_port *port;
46 struct net_device *lowerdev;
50 static struct macvlan_dev *macvlan_hash_lookup(const struct macvlan_port *port,
51 const unsigned char *addr)
53 struct macvlan_dev *vlan;
56 hlist_for_each_entry_rcu(vlan, n, &port->vlan_hash[addr[5]], hlist) {
57 if (!compare_ether_addr(vlan->dev->dev_addr, addr))
63 static void macvlan_broadcast(struct sk_buff *skb,
64 const struct macvlan_port *port)
66 const struct ethhdr *eth = eth_hdr(skb);
67 const struct macvlan_dev *vlan;
69 struct net_device *dev;
73 for (i = 0; i < MACVLAN_HASH_SIZE; i++) {
74 hlist_for_each_entry_rcu(vlan, n, &port->vlan_hash[i], hlist) {
77 nskb = skb_clone(skb, GFP_ATOMIC);
79 dev->stats.rx_errors++;
80 dev->stats.rx_dropped++;
84 dev->stats.rx_bytes += skb->len + ETH_HLEN;
85 dev->stats.rx_packets++;
86 dev->stats.multicast++;
89 if (!compare_ether_addr(eth->h_dest, dev->broadcast))
90 nskb->pkt_type = PACKET_BROADCAST;
92 nskb->pkt_type = PACKET_MULTICAST;
99 /* called under rcu_read_lock() from netif_receive_skb */
100 static struct sk_buff *macvlan_handle_frame(struct sk_buff *skb)
102 const struct ethhdr *eth = eth_hdr(skb);
103 const struct macvlan_port *port;
104 const struct macvlan_dev *vlan;
105 struct net_device *dev;
107 port = rcu_dereference(skb->dev->macvlan_port);
111 if (is_multicast_ether_addr(eth->h_dest)) {
112 macvlan_broadcast(skb, port);
116 vlan = macvlan_hash_lookup(port, eth->h_dest);
121 if (unlikely(!(dev->flags & IFF_UP))) {
126 skb = skb_share_check(skb, GFP_ATOMIC);
128 dev->stats.rx_errors++;
129 dev->stats.rx_dropped++;
133 dev->stats.rx_bytes += skb->len + ETH_HLEN;
134 dev->stats.rx_packets++;
137 skb->pkt_type = PACKET_HOST;
143 static int macvlan_hard_start_xmit(struct sk_buff *skb, struct net_device *dev)
145 const struct macvlan_dev *vlan = netdev_priv(dev);
146 unsigned int len = skb->len;
149 skb->dev = vlan->lowerdev;
150 ret = dev_queue_xmit(skb);
152 if (likely(ret == NET_XMIT_SUCCESS)) {
153 dev->stats.tx_packets++;
154 dev->stats.tx_bytes += len;
156 dev->stats.tx_errors++;
157 dev->stats.tx_aborted_errors++;
162 static int macvlan_hard_header(struct sk_buff *skb, struct net_device *dev,
163 unsigned short type, const void *daddr,
164 const void *saddr, unsigned len)
166 const struct macvlan_dev *vlan = netdev_priv(dev);
167 struct net_device *lowerdev = vlan->lowerdev;
169 return dev_hard_header(skb, lowerdev, type, daddr,
170 saddr ? : dev->dev_addr, len);
173 static const struct header_ops macvlan_hard_header_ops = {
174 .create = macvlan_hard_header,
175 .rebuild = eth_rebuild_header,
176 .parse = eth_header_parse,
177 .cache = eth_header_cache,
178 .cache_update = eth_header_cache_update,
181 static int macvlan_open(struct net_device *dev)
183 struct macvlan_dev *vlan = netdev_priv(dev);
184 struct macvlan_port *port = vlan->port;
185 struct net_device *lowerdev = vlan->lowerdev;
188 err = dev_unicast_add(lowerdev, dev->dev_addr, ETH_ALEN);
191 if (dev->flags & IFF_ALLMULTI) {
192 err = dev_set_allmulti(lowerdev, 1);
197 hlist_add_head_rcu(&vlan->hlist, &port->vlan_hash[dev->dev_addr[5]]);
201 dev_unicast_delete(lowerdev, dev->dev_addr, ETH_ALEN);
206 static int macvlan_stop(struct net_device *dev)
208 struct macvlan_dev *vlan = netdev_priv(dev);
209 struct net_device *lowerdev = vlan->lowerdev;
211 dev_mc_unsync(lowerdev, dev);
212 if (dev->flags & IFF_ALLMULTI)
213 dev_set_allmulti(lowerdev, -1);
215 dev_unicast_delete(lowerdev, dev->dev_addr, ETH_ALEN);
217 hlist_del_rcu(&vlan->hlist);
222 static int macvlan_set_mac_address(struct net_device *dev, void *p)
224 struct macvlan_dev *vlan = netdev_priv(dev);
225 struct net_device *lowerdev = vlan->lowerdev;
226 struct sockaddr *addr = p;
229 if (!is_valid_ether_addr(addr->sa_data))
230 return -EADDRNOTAVAIL;
232 if (!(dev->flags & IFF_UP))
235 err = dev_unicast_add(lowerdev, addr->sa_data, ETH_ALEN);
238 dev_unicast_delete(lowerdev, dev->dev_addr, ETH_ALEN);
241 memcpy(dev->dev_addr, addr->sa_data, ETH_ALEN);
245 static void macvlan_change_rx_flags(struct net_device *dev, int change)
247 struct macvlan_dev *vlan = netdev_priv(dev);
248 struct net_device *lowerdev = vlan->lowerdev;
250 if (change & IFF_ALLMULTI)
251 dev_set_allmulti(lowerdev, dev->flags & IFF_ALLMULTI ? 1 : -1);
254 static void macvlan_set_multicast_list(struct net_device *dev)
256 struct macvlan_dev *vlan = netdev_priv(dev);
258 dev_mc_sync(vlan->lowerdev, dev);
261 static int macvlan_change_mtu(struct net_device *dev, int new_mtu)
263 struct macvlan_dev *vlan = netdev_priv(dev);
265 if (new_mtu < 68 || vlan->lowerdev->mtu < new_mtu)
272 * macvlan network devices have devices nesting below it and are a special
273 * "super class" of normal network devices; split their locks off into a
274 * separate class since they always nest.
276 static struct lock_class_key macvlan_netdev_xmit_lock_key;
277 static struct lock_class_key macvlan_netdev_addr_lock_key;
279 #define MACVLAN_FEATURES \
280 (NETIF_F_SG | NETIF_F_ALL_CSUM | NETIF_F_HIGHDMA | NETIF_F_FRAGLIST | \
281 NETIF_F_GSO | NETIF_F_TSO | NETIF_F_UFO | NETIF_F_GSO_ROBUST | \
282 NETIF_F_TSO_ECN | NETIF_F_TSO6)
284 #define MACVLAN_STATE_MASK \
285 ((1<<__LINK_STATE_NOCARRIER) | (1<<__LINK_STATE_DORMANT))
287 static void macvlan_set_lockdep_class_one(struct net_device *dev,
288 struct netdev_queue *txq,
291 lockdep_set_class(&txq->_xmit_lock,
292 &macvlan_netdev_xmit_lock_key);
295 static void macvlan_set_lockdep_class(struct net_device *dev)
297 lockdep_set_class(&dev->addr_list_lock,
298 &macvlan_netdev_addr_lock_key);
299 netdev_for_each_tx_queue(dev, macvlan_set_lockdep_class_one, NULL);
302 static int macvlan_init(struct net_device *dev)
304 struct macvlan_dev *vlan = netdev_priv(dev);
305 const struct net_device *lowerdev = vlan->lowerdev;
307 dev->state = (dev->state & ~MACVLAN_STATE_MASK) |
308 (lowerdev->state & MACVLAN_STATE_MASK);
309 dev->features = lowerdev->features & MACVLAN_FEATURES;
310 dev->iflink = lowerdev->ifindex;
312 macvlan_set_lockdep_class(dev);
317 static void macvlan_ethtool_get_drvinfo(struct net_device *dev,
318 struct ethtool_drvinfo *drvinfo)
320 snprintf(drvinfo->driver, 32, "macvlan");
321 snprintf(drvinfo->version, 32, "0.1");
324 static u32 macvlan_ethtool_get_rx_csum(struct net_device *dev)
326 const struct macvlan_dev *vlan = netdev_priv(dev);
327 struct net_device *lowerdev = vlan->lowerdev;
329 if (lowerdev->ethtool_ops->get_rx_csum == NULL)
331 return lowerdev->ethtool_ops->get_rx_csum(lowerdev);
334 static int macvlan_ethtool_get_settings(struct net_device *dev,
335 struct ethtool_cmd *cmd)
337 const struct macvlan_dev *vlan = netdev_priv(dev);
338 struct net_device *lowerdev = vlan->lowerdev;
340 if (!lowerdev->ethtool_ops->get_settings)
343 return lowerdev->ethtool_ops->get_settings(lowerdev, cmd);
346 static u32 macvlan_ethtool_get_flags(struct net_device *dev)
348 const struct macvlan_dev *vlan = netdev_priv(dev);
349 struct net_device *lowerdev = vlan->lowerdev;
351 if (!lowerdev->ethtool_ops->get_flags)
353 return lowerdev->ethtool_ops->get_flags(lowerdev);
356 static const struct ethtool_ops macvlan_ethtool_ops = {
357 .get_link = ethtool_op_get_link,
358 .get_settings = macvlan_ethtool_get_settings,
359 .get_rx_csum = macvlan_ethtool_get_rx_csum,
360 .get_drvinfo = macvlan_ethtool_get_drvinfo,
361 .get_flags = macvlan_ethtool_get_flags,
364 static const struct net_device_ops macvlan_netdev_ops = {
365 .ndo_init = macvlan_init,
366 .ndo_open = macvlan_open,
367 .ndo_stop = macvlan_stop,
368 .ndo_change_mtu = macvlan_change_mtu,
369 .ndo_change_rx_flags = macvlan_change_rx_flags,
370 .ndo_set_mac_address = macvlan_set_mac_address,
371 .ndo_set_multicast_list = macvlan_set_multicast_list,
372 .ndo_validate_addr = eth_validate_addr,
375 static void macvlan_setup(struct net_device *dev)
379 dev->netdev_ops = &macvlan_netdev_ops;
380 dev->hard_start_xmit = macvlan_hard_start_xmit;
381 dev->destructor = free_netdev;
382 dev->header_ops = &macvlan_hard_header_ops,
383 dev->ethtool_ops = &macvlan_ethtool_ops;
384 dev->tx_queue_len = 0;
387 static int macvlan_port_create(struct net_device *dev)
389 struct macvlan_port *port;
392 if (dev->type != ARPHRD_ETHER || dev->flags & IFF_LOOPBACK)
395 port = kzalloc(sizeof(*port), GFP_KERNEL);
400 INIT_LIST_HEAD(&port->vlans);
401 for (i = 0; i < MACVLAN_HASH_SIZE; i++)
402 INIT_HLIST_HEAD(&port->vlan_hash[i]);
403 rcu_assign_pointer(dev->macvlan_port, port);
407 static void macvlan_port_destroy(struct net_device *dev)
409 struct macvlan_port *port = dev->macvlan_port;
411 rcu_assign_pointer(dev->macvlan_port, NULL);
416 static void macvlan_transfer_operstate(struct net_device *dev)
418 struct macvlan_dev *vlan = netdev_priv(dev);
419 const struct net_device *lowerdev = vlan->lowerdev;
421 if (lowerdev->operstate == IF_OPER_DORMANT)
422 netif_dormant_on(dev);
424 netif_dormant_off(dev);
426 if (netif_carrier_ok(lowerdev)) {
427 if (!netif_carrier_ok(dev))
428 netif_carrier_on(dev);
430 if (netif_carrier_ok(dev))
431 netif_carrier_off(dev);
435 static int macvlan_validate(struct nlattr *tb[], struct nlattr *data[])
437 if (tb[IFLA_ADDRESS]) {
438 if (nla_len(tb[IFLA_ADDRESS]) != ETH_ALEN)
440 if (!is_valid_ether_addr(nla_data(tb[IFLA_ADDRESS])))
441 return -EADDRNOTAVAIL;
446 static int macvlan_newlink(struct net_device *dev,
447 struct nlattr *tb[], struct nlattr *data[])
449 struct macvlan_dev *vlan = netdev_priv(dev);
450 struct macvlan_port *port;
451 struct net_device *lowerdev;
457 lowerdev = __dev_get_by_index(dev_net(dev), nla_get_u32(tb[IFLA_LINK]));
458 if (lowerdev == NULL)
461 /* Don't allow macvlans on top of other macvlans - its not really
462 * wrong, but lockdep can't handle it and its not useful for anything
463 * you couldn't do directly on top of the real device.
465 if (lowerdev->rtnl_link_ops == dev->rtnl_link_ops)
469 dev->mtu = lowerdev->mtu;
470 else if (dev->mtu > lowerdev->mtu)
473 if (!tb[IFLA_ADDRESS])
474 random_ether_addr(dev->dev_addr);
476 if (lowerdev->macvlan_port == NULL) {
477 err = macvlan_port_create(lowerdev);
481 port = lowerdev->macvlan_port;
483 vlan->lowerdev = lowerdev;
487 err = register_netdevice(dev);
491 list_add_tail(&vlan->list, &port->vlans);
492 macvlan_transfer_operstate(dev);
496 static void macvlan_dellink(struct net_device *dev)
498 struct macvlan_dev *vlan = netdev_priv(dev);
499 struct macvlan_port *port = vlan->port;
501 list_del(&vlan->list);
502 unregister_netdevice(dev);
504 if (list_empty(&port->vlans))
505 macvlan_port_destroy(port->dev);
508 static struct rtnl_link_ops macvlan_link_ops __read_mostly = {
510 .priv_size = sizeof(struct macvlan_dev),
511 .setup = macvlan_setup,
512 .validate = macvlan_validate,
513 .newlink = macvlan_newlink,
514 .dellink = macvlan_dellink,
517 static int macvlan_device_event(struct notifier_block *unused,
518 unsigned long event, void *ptr)
520 struct net_device *dev = ptr;
521 struct macvlan_dev *vlan, *next;
522 struct macvlan_port *port;
524 port = dev->macvlan_port;
530 list_for_each_entry(vlan, &port->vlans, list)
531 macvlan_transfer_operstate(vlan->dev);
533 case NETDEV_FEAT_CHANGE:
534 list_for_each_entry(vlan, &port->vlans, list) {
535 vlan->dev->features = dev->features & MACVLAN_FEATURES;
536 netdev_features_change(vlan->dev);
539 case NETDEV_UNREGISTER:
540 list_for_each_entry_safe(vlan, next, &port->vlans, list)
541 macvlan_dellink(vlan->dev);
547 static struct notifier_block macvlan_notifier_block __read_mostly = {
548 .notifier_call = macvlan_device_event,
551 static int __init macvlan_init_module(void)
555 register_netdevice_notifier(&macvlan_notifier_block);
556 macvlan_handle_frame_hook = macvlan_handle_frame;
558 err = rtnl_link_register(&macvlan_link_ops);
563 macvlan_handle_frame_hook = NULL;
564 unregister_netdevice_notifier(&macvlan_notifier_block);
568 static void __exit macvlan_cleanup_module(void)
570 rtnl_link_unregister(&macvlan_link_ops);
571 macvlan_handle_frame_hook = NULL;
572 unregister_netdevice_notifier(&macvlan_notifier_block);
575 module_init(macvlan_init_module);
576 module_exit(macvlan_cleanup_module);
578 MODULE_LICENSE("GPL");
579 MODULE_AUTHOR("Patrick McHardy <kaber@trash.net>");
580 MODULE_DESCRIPTION("Driver for MAC address based VLANs");
581 MODULE_ALIAS_RTNL_LINK("macvlan");