2 * net/core/dev_addr_lists.c - Functions for handling net device lists
3 * Copyright (c) 2010 Jiri Pirko <jpirko@redhat.com>
5 * This file contains functions for working with unicast, multicast and device
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
14 #include <linux/netdevice.h>
15 #include <linux/rtnetlink.h>
16 #include <linux/export.h>
17 #include <linux/list.h>
20 * General list handling functions
23 static int __hw_addr_create_ex(struct netdev_hw_addr_list
*list
,
24 const unsigned char *addr
, int addr_len
,
25 unsigned char addr_type
, bool global
,
28 struct netdev_hw_addr
*ha
;
31 alloc_size
= sizeof(*ha
);
32 if (alloc_size
< L1_CACHE_BYTES
)
33 alloc_size
= L1_CACHE_BYTES
;
34 ha
= kmalloc(alloc_size
, GFP_ATOMIC
);
37 memcpy(ha
->addr
, addr
, addr_len
);
40 ha
->global_use
= global
;
41 ha
->synced
= sync
? 1 : 0;
43 list_add_tail_rcu(&ha
->list
, &list
->list
);
49 static int __hw_addr_add_ex(struct netdev_hw_addr_list
*list
,
50 const unsigned char *addr
, int addr_len
,
51 unsigned char addr_type
, bool global
, bool sync
,
54 struct netdev_hw_addr
*ha
;
56 if (addr_len
> MAX_ADDR_LEN
)
59 list_for_each_entry(ha
, &list
->list
, list
) {
60 if (!memcmp(ha
->addr
, addr
, addr_len
) &&
61 ha
->type
== addr_type
) {
63 /* check if addr is already used as global */
67 ha
->global_use
= true;
70 if (ha
->synced
&& sync_count
)
80 return __hw_addr_create_ex(list
, addr
, addr_len
, addr_type
, global
,
84 static int __hw_addr_add(struct netdev_hw_addr_list
*list
,
85 const unsigned char *addr
, int addr_len
,
86 unsigned char addr_type
)
88 return __hw_addr_add_ex(list
, addr
, addr_len
, addr_type
, false, false,
92 static int __hw_addr_del_entry(struct netdev_hw_addr_list
*list
,
93 struct netdev_hw_addr
*ha
, bool global
,
96 if (global
&& !ha
->global_use
)
99 if (sync
&& !ha
->synced
)
103 ha
->global_use
= false;
110 list_del_rcu(&ha
->list
);
111 kfree_rcu(ha
, rcu_head
);
116 static int __hw_addr_del_ex(struct netdev_hw_addr_list
*list
,
117 const unsigned char *addr
, int addr_len
,
118 unsigned char addr_type
, bool global
, bool sync
)
120 struct netdev_hw_addr
*ha
;
122 list_for_each_entry(ha
, &list
->list
, list
) {
123 if (!memcmp(ha
->addr
, addr
, addr_len
) &&
124 (ha
->type
== addr_type
|| !addr_type
))
125 return __hw_addr_del_entry(list
, ha
, global
, sync
);
130 static int __hw_addr_del(struct netdev_hw_addr_list
*list
,
131 const unsigned char *addr
, int addr_len
,
132 unsigned char addr_type
)
134 return __hw_addr_del_ex(list
, addr
, addr_len
, addr_type
, false, false);
137 static int __hw_addr_sync_one(struct netdev_hw_addr_list
*to_list
,
138 struct netdev_hw_addr
*ha
,
143 err
= __hw_addr_add_ex(to_list
, ha
->addr
, addr_len
, ha
->type
,
144 false, true, ha
->sync_cnt
);
145 if (err
&& err
!= -EEXIST
)
156 static void __hw_addr_unsync_one(struct netdev_hw_addr_list
*to_list
,
157 struct netdev_hw_addr_list
*from_list
,
158 struct netdev_hw_addr
*ha
,
163 err
= __hw_addr_del_ex(to_list
, ha
->addr
, addr_len
, ha
->type
,
168 /* address on from list is not marked synced */
169 __hw_addr_del_entry(from_list
, ha
, false, false);
172 static int __hw_addr_sync_multiple(struct netdev_hw_addr_list
*to_list
,
173 struct netdev_hw_addr_list
*from_list
,
177 struct netdev_hw_addr
*ha
, *tmp
;
179 list_for_each_entry_safe(ha
, tmp
, &from_list
->list
, list
) {
180 if (ha
->sync_cnt
== ha
->refcount
) {
181 __hw_addr_unsync_one(to_list
, from_list
, ha
, addr_len
);
183 err
= __hw_addr_sync_one(to_list
, ha
, addr_len
);
191 /* This function only works where there is a strict 1-1 relationship
192 * between source and destionation of they synch. If you ever need to
193 * sync addresses to more then 1 destination, you need to use
194 * __hw_addr_sync_multiple().
196 int __hw_addr_sync(struct netdev_hw_addr_list
*to_list
,
197 struct netdev_hw_addr_list
*from_list
,
201 struct netdev_hw_addr
*ha
, *tmp
;
203 list_for_each_entry_safe(ha
, tmp
, &from_list
->list
, list
) {
205 err
= __hw_addr_sync_one(to_list
, ha
, addr_len
);
208 } else if (ha
->refcount
== 1)
209 __hw_addr_unsync_one(to_list
, from_list
, ha
, addr_len
);
213 EXPORT_SYMBOL(__hw_addr_sync
);
215 void __hw_addr_unsync(struct netdev_hw_addr_list
*to_list
,
216 struct netdev_hw_addr_list
*from_list
,
219 struct netdev_hw_addr
*ha
, *tmp
;
221 list_for_each_entry_safe(ha
, tmp
, &from_list
->list
, list
) {
223 __hw_addr_unsync_one(to_list
, from_list
, ha
, addr_len
);
226 EXPORT_SYMBOL(__hw_addr_unsync
);
229 * __hw_addr_sync_dev - Synchonize device's multicast list
230 * @list: address list to syncronize
231 * @dev: device to sync
232 * @sync: function to call if address should be added
233 * @unsync: function to call if address should be removed
235 * This funciton is intended to be called from the ndo_set_rx_mode
236 * function of devices that require explicit address add/remove
237 * notifications. The unsync function may be NULL in which case
238 * the addresses requiring removal will simply be removed without
239 * any notification to the device.
241 int __hw_addr_sync_dev(struct netdev_hw_addr_list
*list
,
242 struct net_device
*dev
,
243 int (*sync
)(struct net_device
*, const unsigned char *),
244 int (*unsync
)(struct net_device
*,
245 const unsigned char *))
247 struct netdev_hw_addr
*ha
, *tmp
;
250 /* first go through and flush out any stale entries */
251 list_for_each_entry_safe(ha
, tmp
, &list
->list
, list
) {
252 if (!ha
->sync_cnt
|| ha
->refcount
!= 1)
255 /* if unsync is defined and fails defer unsyncing address */
256 if (unsync
&& unsync(dev
, ha
->addr
))
260 __hw_addr_del_entry(list
, ha
, false, false);
263 /* go through and sync new entries to the list */
264 list_for_each_entry_safe(ha
, tmp
, &list
->list
, list
) {
268 err
= sync(dev
, ha
->addr
);
278 EXPORT_SYMBOL(__hw_addr_sync_dev
);
281 * __hw_addr_unsync_dev - Remove synchonized addresses from device
282 * @list: address list to remove syncronized addresses from
283 * @dev: device to sync
284 * @unsync: function to call if address should be removed
286 * Remove all addresses that were added to the device by __hw_addr_sync_dev().
287 * This function is intended to be called from the ndo_stop or ndo_open
288 * functions on devices that require explicit address add/remove
289 * notifications. If the unsync function pointer is NULL then this function
290 * can be used to just reset the sync_cnt for the addresses in the list.
292 void __hw_addr_unsync_dev(struct netdev_hw_addr_list
*list
,
293 struct net_device
*dev
,
294 int (*unsync
)(struct net_device
*,
295 const unsigned char *))
297 struct netdev_hw_addr
*ha
, *tmp
;
299 list_for_each_entry_safe(ha
, tmp
, &list
->list
, list
) {
303 /* if unsync is defined and fails defer unsyncing address */
304 if (unsync
&& unsync(dev
, ha
->addr
))
308 __hw_addr_del_entry(list
, ha
, false, false);
311 EXPORT_SYMBOL(__hw_addr_unsync_dev
);
313 static void __hw_addr_flush(struct netdev_hw_addr_list
*list
)
315 struct netdev_hw_addr
*ha
, *tmp
;
317 list_for_each_entry_safe(ha
, tmp
, &list
->list
, list
) {
318 list_del_rcu(&ha
->list
);
319 kfree_rcu(ha
, rcu_head
);
324 void __hw_addr_init(struct netdev_hw_addr_list
*list
)
326 INIT_LIST_HEAD(&list
->list
);
329 EXPORT_SYMBOL(__hw_addr_init
);
332 * Device addresses handling functions
336 * dev_addr_flush - Flush device address list
339 * Flush device address list and reset ->dev_addr.
341 * The caller must hold the rtnl_mutex.
343 void dev_addr_flush(struct net_device
*dev
)
345 /* rtnl_mutex must be held here */
347 __hw_addr_flush(&dev
->dev_addrs
);
348 dev
->dev_addr
= NULL
;
350 EXPORT_SYMBOL(dev_addr_flush
);
353 * dev_addr_init - Init device address list
356 * Init device address list and create the first element,
357 * used by ->dev_addr.
359 * The caller must hold the rtnl_mutex.
361 int dev_addr_init(struct net_device
*dev
)
363 unsigned char addr
[MAX_ADDR_LEN
];
364 struct netdev_hw_addr
*ha
;
367 /* rtnl_mutex must be held here */
369 __hw_addr_init(&dev
->dev_addrs
);
370 memset(addr
, 0, sizeof(addr
));
371 err
= __hw_addr_add(&dev
->dev_addrs
, addr
, sizeof(addr
),
372 NETDEV_HW_ADDR_T_LAN
);
375 * Get the first (previously created) address from the list
376 * and set dev_addr pointer to this location.
378 ha
= list_first_entry(&dev
->dev_addrs
.list
,
379 struct netdev_hw_addr
, list
);
380 dev
->dev_addr
= ha
->addr
;
384 EXPORT_SYMBOL(dev_addr_init
);
387 * dev_addr_add - Add a device address
389 * @addr: address to add
390 * @addr_type: address type
392 * Add a device address to the device or increase the reference count if
395 * The caller must hold the rtnl_mutex.
397 int dev_addr_add(struct net_device
*dev
, const unsigned char *addr
,
398 unsigned char addr_type
)
404 err
= __hw_addr_add(&dev
->dev_addrs
, addr
, dev
->addr_len
, addr_type
);
406 call_netdevice_notifiers(NETDEV_CHANGEADDR
, dev
);
409 EXPORT_SYMBOL(dev_addr_add
);
412 * dev_addr_del - Release a device address.
414 * @addr: address to delete
415 * @addr_type: address type
417 * Release reference to a device address and remove it from the device
418 * if the reference count drops to zero.
420 * The caller must hold the rtnl_mutex.
422 int dev_addr_del(struct net_device
*dev
, const unsigned char *addr
,
423 unsigned char addr_type
)
426 struct netdev_hw_addr
*ha
;
431 * We can not remove the first address from the list because
432 * dev->dev_addr points to that.
434 ha
= list_first_entry(&dev
->dev_addrs
.list
,
435 struct netdev_hw_addr
, list
);
436 if (!memcmp(ha
->addr
, addr
, dev
->addr_len
) &&
437 ha
->type
== addr_type
&& ha
->refcount
== 1)
440 err
= __hw_addr_del(&dev
->dev_addrs
, addr
, dev
->addr_len
,
443 call_netdevice_notifiers(NETDEV_CHANGEADDR
, dev
);
446 EXPORT_SYMBOL(dev_addr_del
);
449 * Unicast list handling functions
453 * dev_uc_add_excl - Add a global secondary unicast address
455 * @addr: address to add
457 int dev_uc_add_excl(struct net_device
*dev
, const unsigned char *addr
)
459 struct netdev_hw_addr
*ha
;
462 netif_addr_lock_bh(dev
);
463 list_for_each_entry(ha
, &dev
->uc
.list
, list
) {
464 if (!memcmp(ha
->addr
, addr
, dev
->addr_len
) &&
465 ha
->type
== NETDEV_HW_ADDR_T_UNICAST
) {
470 err
= __hw_addr_create_ex(&dev
->uc
, addr
, dev
->addr_len
,
471 NETDEV_HW_ADDR_T_UNICAST
, true, false);
473 __dev_set_rx_mode(dev
);
475 netif_addr_unlock_bh(dev
);
478 EXPORT_SYMBOL(dev_uc_add_excl
);
481 * dev_uc_add - Add a secondary unicast address
483 * @addr: address to add
485 * Add a secondary unicast address to the device or increase
486 * the reference count if it already exists.
488 int dev_uc_add(struct net_device
*dev
, const unsigned char *addr
)
492 netif_addr_lock_bh(dev
);
493 err
= __hw_addr_add(&dev
->uc
, addr
, dev
->addr_len
,
494 NETDEV_HW_ADDR_T_UNICAST
);
496 __dev_set_rx_mode(dev
);
497 netif_addr_unlock_bh(dev
);
500 EXPORT_SYMBOL(dev_uc_add
);
503 * dev_uc_del - Release secondary unicast address.
505 * @addr: address to delete
507 * Release reference to a secondary unicast address and remove it
508 * from the device if the reference count drops to zero.
510 int dev_uc_del(struct net_device
*dev
, const unsigned char *addr
)
514 netif_addr_lock_bh(dev
);
515 err
= __hw_addr_del(&dev
->uc
, addr
, dev
->addr_len
,
516 NETDEV_HW_ADDR_T_UNICAST
);
518 __dev_set_rx_mode(dev
);
519 netif_addr_unlock_bh(dev
);
522 EXPORT_SYMBOL(dev_uc_del
);
525 * dev_uc_sync - Synchronize device's unicast list to another device
526 * @to: destination device
527 * @from: source device
529 * Add newly added addresses to the destination device and release
530 * addresses that have no users left. The source device must be
531 * locked by netif_addr_lock_bh.
533 * This function is intended to be called from the dev->set_rx_mode
534 * function of layered software devices. This function assumes that
535 * addresses will only ever be synced to the @to devices and no other.
537 int dev_uc_sync(struct net_device
*to
, struct net_device
*from
)
541 if (to
->addr_len
!= from
->addr_len
)
544 netif_addr_lock_nested(to
);
545 err
= __hw_addr_sync(&to
->uc
, &from
->uc
, to
->addr_len
);
547 __dev_set_rx_mode(to
);
548 netif_addr_unlock(to
);
551 EXPORT_SYMBOL(dev_uc_sync
);
554 * dev_uc_sync_multiple - Synchronize device's unicast list to another
555 * device, but allow for multiple calls to sync to multiple devices.
556 * @to: destination device
557 * @from: source device
559 * Add newly added addresses to the destination device and release
560 * addresses that have been deleted from the source. The source device
561 * must be locked by netif_addr_lock_bh.
563 * This function is intended to be called from the dev->set_rx_mode
564 * function of layered software devices. It allows for a single source
565 * device to be synced to multiple destination devices.
567 int dev_uc_sync_multiple(struct net_device
*to
, struct net_device
*from
)
571 if (to
->addr_len
!= from
->addr_len
)
574 netif_addr_lock_nested(to
);
575 err
= __hw_addr_sync_multiple(&to
->uc
, &from
->uc
, to
->addr_len
);
577 __dev_set_rx_mode(to
);
578 netif_addr_unlock(to
);
581 EXPORT_SYMBOL(dev_uc_sync_multiple
);
584 * dev_uc_unsync - Remove synchronized addresses from the destination device
585 * @to: destination device
586 * @from: source device
588 * Remove all addresses that were added to the destination device by
589 * dev_uc_sync(). This function is intended to be called from the
590 * dev->stop function of layered software devices.
592 void dev_uc_unsync(struct net_device
*to
, struct net_device
*from
)
594 if (to
->addr_len
!= from
->addr_len
)
597 netif_addr_lock_bh(from
);
598 netif_addr_lock_nested(to
);
599 __hw_addr_unsync(&to
->uc
, &from
->uc
, to
->addr_len
);
600 __dev_set_rx_mode(to
);
601 netif_addr_unlock(to
);
602 netif_addr_unlock_bh(from
);
604 EXPORT_SYMBOL(dev_uc_unsync
);
607 * dev_uc_flush - Flush unicast addresses
610 * Flush unicast addresses.
612 void dev_uc_flush(struct net_device
*dev
)
614 netif_addr_lock_bh(dev
);
615 __hw_addr_flush(&dev
->uc
);
616 netif_addr_unlock_bh(dev
);
618 EXPORT_SYMBOL(dev_uc_flush
);
621 * dev_uc_flush - Init unicast address list
624 * Init unicast address list.
626 void dev_uc_init(struct net_device
*dev
)
628 __hw_addr_init(&dev
->uc
);
630 EXPORT_SYMBOL(dev_uc_init
);
633 * Multicast list handling functions
637 * dev_mc_add_excl - Add a global secondary multicast address
639 * @addr: address to add
641 int dev_mc_add_excl(struct net_device
*dev
, const unsigned char *addr
)
643 struct netdev_hw_addr
*ha
;
646 netif_addr_lock_bh(dev
);
647 list_for_each_entry(ha
, &dev
->mc
.list
, list
) {
648 if (!memcmp(ha
->addr
, addr
, dev
->addr_len
) &&
649 ha
->type
== NETDEV_HW_ADDR_T_MULTICAST
) {
654 err
= __hw_addr_create_ex(&dev
->mc
, addr
, dev
->addr_len
,
655 NETDEV_HW_ADDR_T_MULTICAST
, true, false);
657 __dev_set_rx_mode(dev
);
659 netif_addr_unlock_bh(dev
);
662 EXPORT_SYMBOL(dev_mc_add_excl
);
664 static int __dev_mc_add(struct net_device
*dev
, const unsigned char *addr
,
669 netif_addr_lock_bh(dev
);
670 err
= __hw_addr_add_ex(&dev
->mc
, addr
, dev
->addr_len
,
671 NETDEV_HW_ADDR_T_MULTICAST
, global
, false, 0);
673 __dev_set_rx_mode(dev
);
674 netif_addr_unlock_bh(dev
);
678 * dev_mc_add - Add a multicast address
680 * @addr: address to add
682 * Add a multicast address to the device or increase
683 * the reference count if it already exists.
685 int dev_mc_add(struct net_device
*dev
, const unsigned char *addr
)
687 return __dev_mc_add(dev
, addr
, false);
689 EXPORT_SYMBOL(dev_mc_add
);
692 * dev_mc_add_global - Add a global multicast address
694 * @addr: address to add
696 * Add a global multicast address to the device.
698 int dev_mc_add_global(struct net_device
*dev
, const unsigned char *addr
)
700 return __dev_mc_add(dev
, addr
, true);
702 EXPORT_SYMBOL(dev_mc_add_global
);
704 static int __dev_mc_del(struct net_device
*dev
, const unsigned char *addr
,
709 netif_addr_lock_bh(dev
);
710 err
= __hw_addr_del_ex(&dev
->mc
, addr
, dev
->addr_len
,
711 NETDEV_HW_ADDR_T_MULTICAST
, global
, false);
713 __dev_set_rx_mode(dev
);
714 netif_addr_unlock_bh(dev
);
719 * dev_mc_del - Delete a multicast address.
721 * @addr: address to delete
723 * Release reference to a multicast address and remove it
724 * from the device if the reference count drops to zero.
726 int dev_mc_del(struct net_device
*dev
, const unsigned char *addr
)
728 return __dev_mc_del(dev
, addr
, false);
730 EXPORT_SYMBOL(dev_mc_del
);
733 * dev_mc_del_global - Delete a global multicast address.
735 * @addr: address to delete
737 * Release reference to a multicast address and remove it
738 * from the device if the reference count drops to zero.
740 int dev_mc_del_global(struct net_device
*dev
, const unsigned char *addr
)
742 return __dev_mc_del(dev
, addr
, true);
744 EXPORT_SYMBOL(dev_mc_del_global
);
747 * dev_mc_sync - Synchronize device's multicast list to another device
748 * @to: destination device
749 * @from: source device
751 * Add newly added addresses to the destination device and release
752 * addresses that have no users left. The source device must be
753 * locked by netif_addr_lock_bh.
755 * This function is intended to be called from the ndo_set_rx_mode
756 * function of layered software devices.
758 int dev_mc_sync(struct net_device
*to
, struct net_device
*from
)
762 if (to
->addr_len
!= from
->addr_len
)
765 netif_addr_lock_nested(to
);
766 err
= __hw_addr_sync(&to
->mc
, &from
->mc
, to
->addr_len
);
768 __dev_set_rx_mode(to
);
769 netif_addr_unlock(to
);
772 EXPORT_SYMBOL(dev_mc_sync
);
775 * dev_mc_sync_multiple - Synchronize device's multicast list to another
776 * device, but allow for multiple calls to sync to multiple devices.
777 * @to: destination device
778 * @from: source device
780 * Add newly added addresses to the destination device and release
781 * addresses that have no users left. The source device must be
782 * locked by netif_addr_lock_bh.
784 * This function is intended to be called from the ndo_set_rx_mode
785 * function of layered software devices. It allows for a single
786 * source device to be synced to multiple destination devices.
788 int dev_mc_sync_multiple(struct net_device
*to
, struct net_device
*from
)
792 if (to
->addr_len
!= from
->addr_len
)
795 netif_addr_lock_nested(to
);
796 err
= __hw_addr_sync_multiple(&to
->mc
, &from
->mc
, to
->addr_len
);
798 __dev_set_rx_mode(to
);
799 netif_addr_unlock(to
);
802 EXPORT_SYMBOL(dev_mc_sync_multiple
);
805 * dev_mc_unsync - Remove synchronized addresses from the destination device
806 * @to: destination device
807 * @from: source device
809 * Remove all addresses that were added to the destination device by
810 * dev_mc_sync(). This function is intended to be called from the
811 * dev->stop function of layered software devices.
813 void dev_mc_unsync(struct net_device
*to
, struct net_device
*from
)
815 if (to
->addr_len
!= from
->addr_len
)
818 netif_addr_lock_bh(from
);
819 netif_addr_lock_nested(to
);
820 __hw_addr_unsync(&to
->mc
, &from
->mc
, to
->addr_len
);
821 __dev_set_rx_mode(to
);
822 netif_addr_unlock(to
);
823 netif_addr_unlock_bh(from
);
825 EXPORT_SYMBOL(dev_mc_unsync
);
828 * dev_mc_flush - Flush multicast addresses
831 * Flush multicast addresses.
833 void dev_mc_flush(struct net_device
*dev
)
835 netif_addr_lock_bh(dev
);
836 __hw_addr_flush(&dev
->mc
);
837 netif_addr_unlock_bh(dev
);
839 EXPORT_SYMBOL(dev_mc_flush
);
842 * dev_mc_flush - Init multicast address list
845 * Init multicast address list.
847 void dev_mc_init(struct net_device
*dev
)
849 __hw_addr_init(&dev
->mc
);
851 EXPORT_SYMBOL(dev_mc_init
);