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_64bits(vlan
->dev
->dev_addr
, addr
))
63 static void macvlan_hash_add(struct macvlan_dev
*vlan
)
65 struct macvlan_port
*port
= vlan
->port
;
66 const unsigned char *addr
= vlan
->dev
->dev_addr
;
68 hlist_add_head_rcu(&vlan
->hlist
, &port
->vlan_hash
[addr
[5]]);
71 static void macvlan_hash_del(struct macvlan_dev
*vlan
)
73 hlist_del_rcu(&vlan
->hlist
);
77 static void macvlan_hash_change_addr(struct macvlan_dev
*vlan
,
78 const unsigned char *addr
)
80 macvlan_hash_del(vlan
);
81 /* Now that we are unhashed it is safe to change the device
82 * address without confusing packet delivery.
84 memcpy(vlan
->dev
->dev_addr
, addr
, ETH_ALEN
);
85 macvlan_hash_add(vlan
);
88 static int macvlan_addr_busy(const struct macvlan_port
*port
,
89 const unsigned char *addr
)
91 /* Test to see if the specified multicast address is
92 * currently in use by the underlying device or
95 if (!compare_ether_addr_64bits(port
->dev
->dev_addr
, addr
))
98 if (macvlan_hash_lookup(port
, addr
))
104 static void macvlan_broadcast(struct sk_buff
*skb
,
105 const struct macvlan_port
*port
)
107 const struct ethhdr
*eth
= eth_hdr(skb
);
108 const struct macvlan_dev
*vlan
;
109 struct hlist_node
*n
;
110 struct net_device
*dev
;
111 struct sk_buff
*nskb
;
114 if (skb
->protocol
== htons(ETH_P_PAUSE
))
117 for (i
= 0; i
< MACVLAN_HASH_SIZE
; i
++) {
118 hlist_for_each_entry_rcu(vlan
, n
, &port
->vlan_hash
[i
], hlist
) {
121 nskb
= skb_clone(skb
, GFP_ATOMIC
);
123 dev
->stats
.rx_errors
++;
124 dev
->stats
.rx_dropped
++;
128 dev
->stats
.rx_bytes
+= skb
->len
+ ETH_HLEN
;
129 dev
->stats
.rx_packets
++;
130 dev
->stats
.multicast
++;
133 if (!compare_ether_addr_64bits(eth
->h_dest
, dev
->broadcast
))
134 nskb
->pkt_type
= PACKET_BROADCAST
;
136 nskb
->pkt_type
= PACKET_MULTICAST
;
143 /* called under rcu_read_lock() from netif_receive_skb */
144 static struct sk_buff
*macvlan_handle_frame(struct sk_buff
*skb
)
146 const struct ethhdr
*eth
= eth_hdr(skb
);
147 const struct macvlan_port
*port
;
148 const struct macvlan_dev
*vlan
;
149 struct net_device
*dev
;
151 port
= rcu_dereference(skb
->dev
->macvlan_port
);
155 if (is_multicast_ether_addr(eth
->h_dest
)) {
156 macvlan_broadcast(skb
, port
);
160 vlan
= macvlan_hash_lookup(port
, eth
->h_dest
);
165 if (unlikely(!(dev
->flags
& IFF_UP
))) {
170 skb
= skb_share_check(skb
, GFP_ATOMIC
);
172 dev
->stats
.rx_errors
++;
173 dev
->stats
.rx_dropped
++;
177 dev
->stats
.rx_bytes
+= skb
->len
+ ETH_HLEN
;
178 dev
->stats
.rx_packets
++;
181 skb
->pkt_type
= PACKET_HOST
;
187 static netdev_tx_t
macvlan_start_xmit(struct sk_buff
*skb
,
188 struct net_device
*dev
)
190 const struct macvlan_dev
*vlan
= netdev_priv(dev
);
191 unsigned int len
= skb
->len
;
194 skb
->dev
= vlan
->lowerdev
;
195 ret
= dev_queue_xmit(skb
);
197 if (likely(ret
== NET_XMIT_SUCCESS
)) {
198 dev
->stats
.tx_packets
++;
199 dev
->stats
.tx_bytes
+= len
;
201 dev
->stats
.tx_errors
++;
202 dev
->stats
.tx_aborted_errors
++;
207 static int macvlan_hard_header(struct sk_buff
*skb
, struct net_device
*dev
,
208 unsigned short type
, const void *daddr
,
209 const void *saddr
, unsigned len
)
211 const struct macvlan_dev
*vlan
= netdev_priv(dev
);
212 struct net_device
*lowerdev
= vlan
->lowerdev
;
214 return dev_hard_header(skb
, lowerdev
, type
, daddr
,
215 saddr
? : dev
->dev_addr
, len
);
218 static const struct header_ops macvlan_hard_header_ops
= {
219 .create
= macvlan_hard_header
,
220 .rebuild
= eth_rebuild_header
,
221 .parse
= eth_header_parse
,
222 .cache
= eth_header_cache
,
223 .cache_update
= eth_header_cache_update
,
226 static int macvlan_open(struct net_device
*dev
)
228 struct macvlan_dev
*vlan
= netdev_priv(dev
);
229 struct net_device
*lowerdev
= vlan
->lowerdev
;
233 if (macvlan_addr_busy(vlan
->port
, dev
->dev_addr
))
236 err
= dev_unicast_add(lowerdev
, dev
->dev_addr
);
239 if (dev
->flags
& IFF_ALLMULTI
) {
240 err
= dev_set_allmulti(lowerdev
, 1);
244 macvlan_hash_add(vlan
);
248 dev_unicast_delete(lowerdev
, dev
->dev_addr
);
253 static int macvlan_stop(struct net_device
*dev
)
255 struct macvlan_dev
*vlan
= netdev_priv(dev
);
256 struct net_device
*lowerdev
= vlan
->lowerdev
;
258 dev_mc_unsync(lowerdev
, dev
);
259 if (dev
->flags
& IFF_ALLMULTI
)
260 dev_set_allmulti(lowerdev
, -1);
262 dev_unicast_delete(lowerdev
, dev
->dev_addr
);
264 macvlan_hash_del(vlan
);
268 static int macvlan_set_mac_address(struct net_device
*dev
, void *p
)
270 struct macvlan_dev
*vlan
= netdev_priv(dev
);
271 struct net_device
*lowerdev
= vlan
->lowerdev
;
272 struct sockaddr
*addr
= p
;
275 if (!is_valid_ether_addr(addr
->sa_data
))
276 return -EADDRNOTAVAIL
;
278 if (!(dev
->flags
& IFF_UP
)) {
279 /* Just copy in the new address */
280 memcpy(dev
->dev_addr
, addr
->sa_data
, ETH_ALEN
);
282 /* Rehash and update the device filters */
283 if (macvlan_addr_busy(vlan
->port
, addr
->sa_data
))
286 err
= dev_unicast_add(lowerdev
, addr
->sa_data
);
290 dev_unicast_delete(lowerdev
, dev
->dev_addr
);
292 macvlan_hash_change_addr(vlan
, addr
->sa_data
);
297 static void macvlan_change_rx_flags(struct net_device
*dev
, int change
)
299 struct macvlan_dev
*vlan
= netdev_priv(dev
);
300 struct net_device
*lowerdev
= vlan
->lowerdev
;
302 if (change
& IFF_ALLMULTI
)
303 dev_set_allmulti(lowerdev
, dev
->flags
& IFF_ALLMULTI
? 1 : -1);
306 static void macvlan_set_multicast_list(struct net_device
*dev
)
308 struct macvlan_dev
*vlan
= netdev_priv(dev
);
310 dev_mc_sync(vlan
->lowerdev
, dev
);
313 static int macvlan_change_mtu(struct net_device
*dev
, int new_mtu
)
315 struct macvlan_dev
*vlan
= netdev_priv(dev
);
317 if (new_mtu
< 68 || vlan
->lowerdev
->mtu
< new_mtu
)
324 * macvlan network devices have devices nesting below it and are a special
325 * "super class" of normal network devices; split their locks off into a
326 * separate class since they always nest.
328 static struct lock_class_key macvlan_netdev_xmit_lock_key
;
329 static struct lock_class_key macvlan_netdev_addr_lock_key
;
331 #define MACVLAN_FEATURES \
332 (NETIF_F_SG | NETIF_F_ALL_CSUM | NETIF_F_HIGHDMA | NETIF_F_FRAGLIST | \
333 NETIF_F_GSO | NETIF_F_TSO | NETIF_F_UFO | NETIF_F_GSO_ROBUST | \
334 NETIF_F_TSO_ECN | NETIF_F_TSO6)
336 #define MACVLAN_STATE_MASK \
337 ((1<<__LINK_STATE_NOCARRIER) | (1<<__LINK_STATE_DORMANT))
339 static void macvlan_set_lockdep_class_one(struct net_device
*dev
,
340 struct netdev_queue
*txq
,
343 lockdep_set_class(&txq
->_xmit_lock
,
344 &macvlan_netdev_xmit_lock_key
);
347 static void macvlan_set_lockdep_class(struct net_device
*dev
)
349 lockdep_set_class(&dev
->addr_list_lock
,
350 &macvlan_netdev_addr_lock_key
);
351 netdev_for_each_tx_queue(dev
, macvlan_set_lockdep_class_one
, NULL
);
354 static int macvlan_init(struct net_device
*dev
)
356 struct macvlan_dev
*vlan
= netdev_priv(dev
);
357 const struct net_device
*lowerdev
= vlan
->lowerdev
;
359 dev
->state
= (dev
->state
& ~MACVLAN_STATE_MASK
) |
360 (lowerdev
->state
& MACVLAN_STATE_MASK
);
361 dev
->features
= lowerdev
->features
& MACVLAN_FEATURES
;
362 dev
->iflink
= lowerdev
->ifindex
;
363 dev
->hard_header_len
= lowerdev
->hard_header_len
;
365 macvlan_set_lockdep_class(dev
);
370 static void macvlan_ethtool_get_drvinfo(struct net_device
*dev
,
371 struct ethtool_drvinfo
*drvinfo
)
373 snprintf(drvinfo
->driver
, 32, "macvlan");
374 snprintf(drvinfo
->version
, 32, "0.1");
377 static u32
macvlan_ethtool_get_rx_csum(struct net_device
*dev
)
379 const struct macvlan_dev
*vlan
= netdev_priv(dev
);
380 return dev_ethtool_get_rx_csum(vlan
->lowerdev
);
383 static int macvlan_ethtool_get_settings(struct net_device
*dev
,
384 struct ethtool_cmd
*cmd
)
386 const struct macvlan_dev
*vlan
= netdev_priv(dev
);
387 return dev_ethtool_get_settings(vlan
->lowerdev
, cmd
);
390 static u32
macvlan_ethtool_get_flags(struct net_device
*dev
)
392 const struct macvlan_dev
*vlan
= netdev_priv(dev
);
393 return dev_ethtool_get_flags(vlan
->lowerdev
);
396 static const struct ethtool_ops macvlan_ethtool_ops
= {
397 .get_link
= ethtool_op_get_link
,
398 .get_settings
= macvlan_ethtool_get_settings
,
399 .get_rx_csum
= macvlan_ethtool_get_rx_csum
,
400 .get_drvinfo
= macvlan_ethtool_get_drvinfo
,
401 .get_flags
= macvlan_ethtool_get_flags
,
404 static const struct net_device_ops macvlan_netdev_ops
= {
405 .ndo_init
= macvlan_init
,
406 .ndo_open
= macvlan_open
,
407 .ndo_stop
= macvlan_stop
,
408 .ndo_start_xmit
= macvlan_start_xmit
,
409 .ndo_change_mtu
= macvlan_change_mtu
,
410 .ndo_change_rx_flags
= macvlan_change_rx_flags
,
411 .ndo_set_mac_address
= macvlan_set_mac_address
,
412 .ndo_set_multicast_list
= macvlan_set_multicast_list
,
413 .ndo_validate_addr
= eth_validate_addr
,
416 static void macvlan_setup(struct net_device
*dev
)
420 dev
->priv_flags
&= ~IFF_XMIT_DST_RELEASE
;
421 dev
->netdev_ops
= &macvlan_netdev_ops
;
422 dev
->destructor
= free_netdev
;
423 dev
->header_ops
= &macvlan_hard_header_ops
,
424 dev
->ethtool_ops
= &macvlan_ethtool_ops
;
425 dev
->tx_queue_len
= 0;
428 static int macvlan_port_create(struct net_device
*dev
)
430 struct macvlan_port
*port
;
433 if (dev
->type
!= ARPHRD_ETHER
|| dev
->flags
& IFF_LOOPBACK
)
436 port
= kzalloc(sizeof(*port
), GFP_KERNEL
);
441 INIT_LIST_HEAD(&port
->vlans
);
442 for (i
= 0; i
< MACVLAN_HASH_SIZE
; i
++)
443 INIT_HLIST_HEAD(&port
->vlan_hash
[i
]);
444 rcu_assign_pointer(dev
->macvlan_port
, port
);
448 static void macvlan_port_destroy(struct net_device
*dev
)
450 struct macvlan_port
*port
= dev
->macvlan_port
;
452 rcu_assign_pointer(dev
->macvlan_port
, NULL
);
457 static void macvlan_transfer_operstate(struct net_device
*dev
)
459 struct macvlan_dev
*vlan
= netdev_priv(dev
);
460 const struct net_device
*lowerdev
= vlan
->lowerdev
;
462 if (lowerdev
->operstate
== IF_OPER_DORMANT
)
463 netif_dormant_on(dev
);
465 netif_dormant_off(dev
);
467 if (netif_carrier_ok(lowerdev
)) {
468 if (!netif_carrier_ok(dev
))
469 netif_carrier_on(dev
);
471 if (netif_carrier_ok(dev
))
472 netif_carrier_off(dev
);
476 static int macvlan_validate(struct nlattr
*tb
[], struct nlattr
*data
[])
478 if (tb
[IFLA_ADDRESS
]) {
479 if (nla_len(tb
[IFLA_ADDRESS
]) != ETH_ALEN
)
481 if (!is_valid_ether_addr(nla_data(tb
[IFLA_ADDRESS
])))
482 return -EADDRNOTAVAIL
;
487 static int macvlan_newlink(struct net_device
*dev
,
488 struct nlattr
*tb
[], struct nlattr
*data
[])
490 struct macvlan_dev
*vlan
= netdev_priv(dev
);
491 struct macvlan_port
*port
;
492 struct net_device
*lowerdev
;
498 lowerdev
= __dev_get_by_index(dev_net(dev
), nla_get_u32(tb
[IFLA_LINK
]));
499 if (lowerdev
== NULL
)
502 /* When creating macvlans on top of other macvlans - use
503 * the real device as the lowerdev.
505 if (lowerdev
->rtnl_link_ops
== dev
->rtnl_link_ops
) {
506 struct macvlan_dev
*lowervlan
= netdev_priv(lowerdev
);
507 lowerdev
= lowervlan
->lowerdev
;
511 dev
->mtu
= lowerdev
->mtu
;
512 else if (dev
->mtu
> lowerdev
->mtu
)
515 if (!tb
[IFLA_ADDRESS
])
516 random_ether_addr(dev
->dev_addr
);
518 if (lowerdev
->macvlan_port
== NULL
) {
519 err
= macvlan_port_create(lowerdev
);
523 port
= lowerdev
->macvlan_port
;
525 vlan
->lowerdev
= lowerdev
;
529 err
= register_netdevice(dev
);
533 list_add_tail(&vlan
->list
, &port
->vlans
);
534 macvlan_transfer_operstate(dev
);
538 static void macvlan_dellink(struct net_device
*dev
)
540 struct macvlan_dev
*vlan
= netdev_priv(dev
);
541 struct macvlan_port
*port
= vlan
->port
;
543 list_del(&vlan
->list
);
544 unregister_netdevice(dev
);
546 if (list_empty(&port
->vlans
))
547 macvlan_port_destroy(port
->dev
);
550 static struct rtnl_link_ops macvlan_link_ops __read_mostly
= {
552 .priv_size
= sizeof(struct macvlan_dev
),
553 .setup
= macvlan_setup
,
554 .validate
= macvlan_validate
,
555 .newlink
= macvlan_newlink
,
556 .dellink
= macvlan_dellink
,
559 static int macvlan_device_event(struct notifier_block
*unused
,
560 unsigned long event
, void *ptr
)
562 struct net_device
*dev
= ptr
;
563 struct macvlan_dev
*vlan
, *next
;
564 struct macvlan_port
*port
;
566 port
= dev
->macvlan_port
;
572 list_for_each_entry(vlan
, &port
->vlans
, list
)
573 macvlan_transfer_operstate(vlan
->dev
);
575 case NETDEV_FEAT_CHANGE
:
576 list_for_each_entry(vlan
, &port
->vlans
, list
) {
577 vlan
->dev
->features
= dev
->features
& MACVLAN_FEATURES
;
578 netdev_features_change(vlan
->dev
);
581 case NETDEV_UNREGISTER
:
582 list_for_each_entry_safe(vlan
, next
, &port
->vlans
, list
)
583 macvlan_dellink(vlan
->dev
);
589 static struct notifier_block macvlan_notifier_block __read_mostly
= {
590 .notifier_call
= macvlan_device_event
,
593 static int __init
macvlan_init_module(void)
597 register_netdevice_notifier(&macvlan_notifier_block
);
598 macvlan_handle_frame_hook
= macvlan_handle_frame
;
600 err
= rtnl_link_register(&macvlan_link_ops
);
605 macvlan_handle_frame_hook
= NULL
;
606 unregister_netdevice_notifier(&macvlan_notifier_block
);
610 static void __exit
macvlan_cleanup_module(void)
612 rtnl_link_unregister(&macvlan_link_ops
);
613 macvlan_handle_frame_hook
= NULL
;
614 unregister_netdevice_notifier(&macvlan_notifier_block
);
617 module_init(macvlan_init_module
);
618 module_exit(macvlan_cleanup_module
);
620 MODULE_LICENSE("GPL");
621 MODULE_AUTHOR("Patrick McHardy <kaber@trash.net>");
622 MODULE_DESCRIPTION("Driver for MAC address based VLANs");
623 MODULE_ALIAS_RTNL_LINK("macvlan");