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/list.h>
17 #include <linux/proc_fs.h>
20 * General list handling functions
23 static int __hw_addr_add_ex(struct netdev_hw_addr_list *list,
24 unsigned char *addr, int addr_len,
25 unsigned char addr_type, bool global)
27 struct netdev_hw_addr *ha;
30 if (addr_len > MAX_ADDR_LEN)
33 list_for_each_entry(ha, &list->list, list) {
34 if (!memcmp(ha->addr, addr, addr_len) &&
35 ha->type == addr_type) {
37 /* check if addr is already used as global */
41 ha->global_use = true;
49 alloc_size = sizeof(*ha);
50 if (alloc_size < L1_CACHE_BYTES)
51 alloc_size = L1_CACHE_BYTES;
52 ha = kmalloc(alloc_size, GFP_ATOMIC);
55 memcpy(ha->addr, addr, addr_len);
58 ha->global_use = global;
60 list_add_tail_rcu(&ha->list, &list->list);
65 static int __hw_addr_add(struct netdev_hw_addr_list *list, unsigned char *addr,
66 int addr_len, unsigned char addr_type)
68 return __hw_addr_add_ex(list, addr, addr_len, addr_type, false);
71 static int __hw_addr_del_ex(struct netdev_hw_addr_list *list,
72 unsigned char *addr, int addr_len,
73 unsigned char addr_type, bool global)
75 struct netdev_hw_addr *ha;
77 list_for_each_entry(ha, &list->list, list) {
78 if (!memcmp(ha->addr, addr, addr_len) &&
79 (ha->type == addr_type || !addr_type)) {
84 ha->global_use = false;
88 list_del_rcu(&ha->list);
89 kfree_rcu(ha, rcu_head);
97 static int __hw_addr_del(struct netdev_hw_addr_list *list, unsigned char *addr,
98 int addr_len, unsigned char addr_type)
100 return __hw_addr_del_ex(list, addr, addr_len, addr_type, false);
103 int __hw_addr_add_multiple(struct netdev_hw_addr_list *to_list,
104 struct netdev_hw_addr_list *from_list,
105 int addr_len, unsigned char addr_type)
108 struct netdev_hw_addr *ha, *ha2;
111 list_for_each_entry(ha, &from_list->list, list) {
112 type = addr_type ? addr_type : ha->type;
113 err = __hw_addr_add(to_list, ha->addr, addr_len, type);
120 list_for_each_entry(ha2, &from_list->list, list) {
123 type = addr_type ? addr_type : ha2->type;
124 __hw_addr_del(to_list, ha2->addr, addr_len, type);
128 EXPORT_SYMBOL(__hw_addr_add_multiple);
130 void __hw_addr_del_multiple(struct netdev_hw_addr_list *to_list,
131 struct netdev_hw_addr_list *from_list,
132 int addr_len, unsigned char addr_type)
134 struct netdev_hw_addr *ha;
137 list_for_each_entry(ha, &from_list->list, list) {
138 type = addr_type ? addr_type : ha->type;
139 __hw_addr_del(to_list, ha->addr, addr_len, type);
142 EXPORT_SYMBOL(__hw_addr_del_multiple);
144 int __hw_addr_sync(struct netdev_hw_addr_list *to_list,
145 struct netdev_hw_addr_list *from_list,
149 struct netdev_hw_addr *ha, *tmp;
151 list_for_each_entry_safe(ha, tmp, &from_list->list, list) {
153 err = __hw_addr_add(to_list, ha->addr,
159 } else if (ha->refcount == 1) {
160 __hw_addr_del(to_list, ha->addr, addr_len, ha->type);
161 __hw_addr_del(from_list, ha->addr, addr_len, ha->type);
166 EXPORT_SYMBOL(__hw_addr_sync);
168 void __hw_addr_unsync(struct netdev_hw_addr_list *to_list,
169 struct netdev_hw_addr_list *from_list,
172 struct netdev_hw_addr *ha, *tmp;
174 list_for_each_entry_safe(ha, tmp, &from_list->list, list) {
176 __hw_addr_del(to_list, ha->addr,
179 __hw_addr_del(from_list, ha->addr,
184 EXPORT_SYMBOL(__hw_addr_unsync);
186 void __hw_addr_flush(struct netdev_hw_addr_list *list)
188 struct netdev_hw_addr *ha, *tmp;
190 list_for_each_entry_safe(ha, tmp, &list->list, list) {
191 list_del_rcu(&ha->list);
192 kfree_rcu(ha, rcu_head);
196 EXPORT_SYMBOL(__hw_addr_flush);
198 void __hw_addr_init(struct netdev_hw_addr_list *list)
200 INIT_LIST_HEAD(&list->list);
203 EXPORT_SYMBOL(__hw_addr_init);
206 * Device addresses handling functions
210 * dev_addr_flush - Flush device address list
213 * Flush device address list and reset ->dev_addr.
215 * The caller must hold the rtnl_mutex.
217 void dev_addr_flush(struct net_device *dev)
219 /* rtnl_mutex must be held here */
221 __hw_addr_flush(&dev->dev_addrs);
222 dev->dev_addr = NULL;
224 EXPORT_SYMBOL(dev_addr_flush);
227 * dev_addr_init - Init device address list
230 * Init device address list and create the first element,
231 * used by ->dev_addr.
233 * The caller must hold the rtnl_mutex.
235 int dev_addr_init(struct net_device *dev)
237 unsigned char addr[MAX_ADDR_LEN];
238 struct netdev_hw_addr *ha;
241 /* rtnl_mutex must be held here */
243 __hw_addr_init(&dev->dev_addrs);
244 memset(addr, 0, sizeof(addr));
245 err = __hw_addr_add(&dev->dev_addrs, addr, sizeof(addr),
246 NETDEV_HW_ADDR_T_LAN);
249 * Get the first (previously created) address from the list
250 * and set dev_addr pointer to this location.
252 ha = list_first_entry(&dev->dev_addrs.list,
253 struct netdev_hw_addr, list);
254 dev->dev_addr = ha->addr;
258 EXPORT_SYMBOL(dev_addr_init);
261 * dev_addr_add - Add a device address
263 * @addr: address to add
264 * @addr_type: address type
266 * Add a device address to the device or increase the reference count if
269 * The caller must hold the rtnl_mutex.
271 int dev_addr_add(struct net_device *dev, unsigned char *addr,
272 unsigned char addr_type)
278 err = __hw_addr_add(&dev->dev_addrs, addr, dev->addr_len, addr_type);
280 call_netdevice_notifiers(NETDEV_CHANGEADDR, dev);
283 EXPORT_SYMBOL(dev_addr_add);
286 * dev_addr_del - Release a device address.
288 * @addr: address to delete
289 * @addr_type: address type
291 * Release reference to a device address and remove it from the device
292 * if the reference count drops to zero.
294 * The caller must hold the rtnl_mutex.
296 int dev_addr_del(struct net_device *dev, unsigned char *addr,
297 unsigned char addr_type)
300 struct netdev_hw_addr *ha;
305 * We can not remove the first address from the list because
306 * dev->dev_addr points to that.
308 ha = list_first_entry(&dev->dev_addrs.list,
309 struct netdev_hw_addr, list);
310 if (!memcmp(ha->addr, addr, dev->addr_len) &&
311 ha->type == addr_type && ha->refcount == 1)
314 err = __hw_addr_del(&dev->dev_addrs, addr, dev->addr_len,
317 call_netdevice_notifiers(NETDEV_CHANGEADDR, dev);
320 EXPORT_SYMBOL(dev_addr_del);
323 * dev_addr_add_multiple - Add device addresses from another device
324 * @to_dev: device to which addresses will be added
325 * @from_dev: device from which addresses will be added
326 * @addr_type: address type - 0 means type will be used from from_dev
328 * Add device addresses of the one device to another.
330 * The caller must hold the rtnl_mutex.
332 int dev_addr_add_multiple(struct net_device *to_dev,
333 struct net_device *from_dev,
334 unsigned char addr_type)
340 if (from_dev->addr_len != to_dev->addr_len)
342 err = __hw_addr_add_multiple(&to_dev->dev_addrs, &from_dev->dev_addrs,
343 to_dev->addr_len, addr_type);
345 call_netdevice_notifiers(NETDEV_CHANGEADDR, to_dev);
348 EXPORT_SYMBOL(dev_addr_add_multiple);
351 * dev_addr_del_multiple - Delete device addresses by another device
352 * @to_dev: device where the addresses will be deleted
353 * @from_dev: device supplying the addresses to be deleted
354 * @addr_type: address type - 0 means type will be used from from_dev
356 * Deletes addresses in to device by the list of addresses in from device.
358 * The caller must hold the rtnl_mutex.
360 int dev_addr_del_multiple(struct net_device *to_dev,
361 struct net_device *from_dev,
362 unsigned char addr_type)
366 if (from_dev->addr_len != to_dev->addr_len)
368 __hw_addr_del_multiple(&to_dev->dev_addrs, &from_dev->dev_addrs,
369 to_dev->addr_len, addr_type);
370 call_netdevice_notifiers(NETDEV_CHANGEADDR, to_dev);
373 EXPORT_SYMBOL(dev_addr_del_multiple);
376 * Unicast list handling functions
380 * dev_uc_add - Add a secondary unicast address
382 * @addr: address to add
384 * Add a secondary unicast address to the device or increase
385 * the reference count if it already exists.
387 int dev_uc_add(struct net_device *dev, unsigned char *addr)
391 netif_addr_lock_bh(dev);
392 err = __hw_addr_add(&dev->uc, addr, dev->addr_len,
393 NETDEV_HW_ADDR_T_UNICAST);
395 __dev_set_rx_mode(dev);
396 netif_addr_unlock_bh(dev);
399 EXPORT_SYMBOL(dev_uc_add);
402 * dev_uc_del - Release secondary unicast address.
404 * @addr: address to delete
406 * Release reference to a secondary unicast address and remove it
407 * from the device if the reference count drops to zero.
409 int dev_uc_del(struct net_device *dev, unsigned char *addr)
413 netif_addr_lock_bh(dev);
414 err = __hw_addr_del(&dev->uc, addr, dev->addr_len,
415 NETDEV_HW_ADDR_T_UNICAST);
417 __dev_set_rx_mode(dev);
418 netif_addr_unlock_bh(dev);
421 EXPORT_SYMBOL(dev_uc_del);
424 * dev_uc_sync - Synchronize device's unicast list to another device
425 * @to: destination device
426 * @from: source device
428 * Add newly added addresses to the destination device and release
429 * addresses that have no users left. The source device must be
430 * locked by netif_tx_lock_bh.
432 * This function is intended to be called from the dev->set_rx_mode
433 * function of layered software devices.
435 int dev_uc_sync(struct net_device *to, struct net_device *from)
439 if (to->addr_len != from->addr_len)
442 netif_addr_lock_bh(to);
443 err = __hw_addr_sync(&to->uc, &from->uc, to->addr_len);
445 __dev_set_rx_mode(to);
446 netif_addr_unlock_bh(to);
449 EXPORT_SYMBOL(dev_uc_sync);
452 * dev_uc_unsync - Remove synchronized addresses from the destination device
453 * @to: destination device
454 * @from: source device
456 * Remove all addresses that were added to the destination device by
457 * dev_uc_sync(). This function is intended to be called from the
458 * dev->stop function of layered software devices.
460 void dev_uc_unsync(struct net_device *to, struct net_device *from)
462 if (to->addr_len != from->addr_len)
465 netif_addr_lock_bh(from);
467 __hw_addr_unsync(&to->uc, &from->uc, to->addr_len);
468 __dev_set_rx_mode(to);
469 netif_addr_unlock(to);
470 netif_addr_unlock_bh(from);
472 EXPORT_SYMBOL(dev_uc_unsync);
475 * dev_uc_flush - Flush unicast addresses
478 * Flush unicast addresses.
480 void dev_uc_flush(struct net_device *dev)
482 netif_addr_lock_bh(dev);
483 __hw_addr_flush(&dev->uc);
484 netif_addr_unlock_bh(dev);
486 EXPORT_SYMBOL(dev_uc_flush);
489 * dev_uc_flush - Init unicast address list
492 * Init unicast address list.
494 void dev_uc_init(struct net_device *dev)
496 __hw_addr_init(&dev->uc);
498 EXPORT_SYMBOL(dev_uc_init);
501 * Multicast list handling functions
504 static int __dev_mc_add(struct net_device *dev, unsigned char *addr,
509 netif_addr_lock_bh(dev);
510 err = __hw_addr_add_ex(&dev->mc, addr, dev->addr_len,
511 NETDEV_HW_ADDR_T_MULTICAST, global);
513 __dev_set_rx_mode(dev);
514 netif_addr_unlock_bh(dev);
518 * dev_mc_add - Add a multicast address
520 * @addr: address to add
522 * Add a multicast address to the device or increase
523 * the reference count if it already exists.
525 int dev_mc_add(struct net_device *dev, unsigned char *addr)
527 return __dev_mc_add(dev, addr, false);
529 EXPORT_SYMBOL(dev_mc_add);
532 * dev_mc_add_global - Add a global multicast address
534 * @addr: address to add
536 * Add a global multicast address to the device.
538 int dev_mc_add_global(struct net_device *dev, unsigned char *addr)
540 return __dev_mc_add(dev, addr, true);
542 EXPORT_SYMBOL(dev_mc_add_global);
544 static int __dev_mc_del(struct net_device *dev, unsigned char *addr,
549 netif_addr_lock_bh(dev);
550 err = __hw_addr_del_ex(&dev->mc, addr, dev->addr_len,
551 NETDEV_HW_ADDR_T_MULTICAST, global);
553 __dev_set_rx_mode(dev);
554 netif_addr_unlock_bh(dev);
559 * dev_mc_del - Delete a multicast address.
561 * @addr: address to delete
563 * Release reference to a multicast address and remove it
564 * from the device if the reference count drops to zero.
566 int dev_mc_del(struct net_device *dev, unsigned char *addr)
568 return __dev_mc_del(dev, addr, false);
570 EXPORT_SYMBOL(dev_mc_del);
573 * dev_mc_del_global - Delete a global multicast address.
575 * @addr: address to delete
577 * Release reference to a multicast address and remove it
578 * from the device if the reference count drops to zero.
580 int dev_mc_del_global(struct net_device *dev, unsigned char *addr)
582 return __dev_mc_del(dev, addr, true);
584 EXPORT_SYMBOL(dev_mc_del_global);
587 * dev_mc_sync - Synchronize device's unicast list to another device
588 * @to: destination device
589 * @from: source device
591 * Add newly added addresses to the destination device and release
592 * addresses that have no users left. The source device must be
593 * locked by netif_tx_lock_bh.
595 * This function is intended to be called from the dev->set_multicast_list
596 * or dev->set_rx_mode function of layered software devices.
598 int dev_mc_sync(struct net_device *to, struct net_device *from)
602 if (to->addr_len != from->addr_len)
605 netif_addr_lock_bh(to);
606 err = __hw_addr_sync(&to->mc, &from->mc, to->addr_len);
608 __dev_set_rx_mode(to);
609 netif_addr_unlock_bh(to);
612 EXPORT_SYMBOL(dev_mc_sync);
615 * dev_mc_unsync - Remove synchronized addresses from the destination device
616 * @to: destination device
617 * @from: source device
619 * Remove all addresses that were added to the destination device by
620 * dev_mc_sync(). This function is intended to be called from the
621 * dev->stop function of layered software devices.
623 void dev_mc_unsync(struct net_device *to, struct net_device *from)
625 if (to->addr_len != from->addr_len)
628 netif_addr_lock_bh(from);
630 __hw_addr_unsync(&to->mc, &from->mc, to->addr_len);
631 __dev_set_rx_mode(to);
632 netif_addr_unlock(to);
633 netif_addr_unlock_bh(from);
635 EXPORT_SYMBOL(dev_mc_unsync);
638 * dev_mc_flush - Flush multicast addresses
641 * Flush multicast addresses.
643 void dev_mc_flush(struct net_device *dev)
645 netif_addr_lock_bh(dev);
646 __hw_addr_flush(&dev->mc);
647 netif_addr_unlock_bh(dev);
649 EXPORT_SYMBOL(dev_mc_flush);
652 * dev_mc_flush - Init multicast address list
655 * Init multicast address list.
657 void dev_mc_init(struct net_device *dev)
659 __hw_addr_init(&dev->mc);
661 EXPORT_SYMBOL(dev_mc_init);
663 #ifdef CONFIG_PROC_FS
664 #include <linux/seq_file.h>
666 static int dev_mc_seq_show(struct seq_file *seq, void *v)
668 struct netdev_hw_addr *ha;
669 struct net_device *dev = v;
671 if (v == SEQ_START_TOKEN)
674 netif_addr_lock_bh(dev);
675 netdev_for_each_mc_addr(ha, dev) {
678 seq_printf(seq, "%-4d %-15s %-5d %-5d ", dev->ifindex,
679 dev->name, ha->refcount, ha->global_use);
681 for (i = 0; i < dev->addr_len; i++)
682 seq_printf(seq, "%02x", ha->addr[i]);
686 netif_addr_unlock_bh(dev);
690 static const struct seq_operations dev_mc_seq_ops = {
691 .start = dev_seq_start,
692 .next = dev_seq_next,
693 .stop = dev_seq_stop,
694 .show = dev_mc_seq_show,
697 static int dev_mc_seq_open(struct inode *inode, struct file *file)
699 return seq_open_net(inode, file, &dev_mc_seq_ops,
700 sizeof(struct seq_net_private));
703 static const struct file_operations dev_mc_seq_fops = {
704 .owner = THIS_MODULE,
705 .open = dev_mc_seq_open,
708 .release = seq_release_net,
713 static int __net_init dev_mc_net_init(struct net *net)
715 if (!proc_net_fops_create(net, "dev_mcast", 0, &dev_mc_seq_fops))
720 static void __net_exit dev_mc_net_exit(struct net *net)
722 proc_net_remove(net, "dev_mcast");
725 static struct pernet_operations __net_initdata dev_mc_net_ops = {
726 .init = dev_mc_net_init,
727 .exit = dev_mc_net_exit,
730 void __init dev_mcast_init(void)
732 register_pernet_subsys(&dev_mc_net_ops);