Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * net/core/dev_addr_lists.c - Functions for handling net device lists
4 * Copyright (c) 2010 Jiri Pirko <jpirko@redhat.com>
5 *
6 * This file contains functions for working with unicast, multicast and device
7 * addresses lists.
8 */
9
10#include <linux/netdevice.h>
11#include <linux/rtnetlink.h>
12#include <linux/export.h>
13#include <linux/list.h>
14
15/*
16 * General list handling functions
17 */
18
19static int __hw_addr_create_ex(struct netdev_hw_addr_list *list,
20 const unsigned char *addr, int addr_len,
21 unsigned char addr_type, bool global,
22 bool sync)
23{
24 struct netdev_hw_addr *ha;
25 int alloc_size;
26
27 alloc_size = sizeof(*ha);
28 if (alloc_size < L1_CACHE_BYTES)
29 alloc_size = L1_CACHE_BYTES;
30 ha = kmalloc(alloc_size, GFP_ATOMIC);
31 if (!ha)
32 return -ENOMEM;
33 memcpy(ha->addr, addr, addr_len);
34 ha->type = addr_type;
35 ha->refcount = 1;
36 ha->global_use = global;
37 ha->synced = sync ? 1 : 0;
38 ha->sync_cnt = 0;
39 list_add_tail_rcu(&ha->list, &list->list);
40 list->count++;
41
42 return 0;
43}
44
45static int __hw_addr_add_ex(struct netdev_hw_addr_list *list,
46 const unsigned char *addr, int addr_len,
47 unsigned char addr_type, bool global, bool sync,
48 int sync_count)
49{
50 struct netdev_hw_addr *ha;
51
52 if (addr_len > MAX_ADDR_LEN)
53 return -EINVAL;
54
55 list_for_each_entry(ha, &list->list, list) {
56 if (ha->type == addr_type &&
57 !memcmp(ha->addr, addr, addr_len)) {
58 if (global) {
59 /* check if addr is already used as global */
60 if (ha->global_use)
61 return 0;
62 else
63 ha->global_use = true;
64 }
65 if (sync) {
66 if (ha->synced && sync_count)
67 return -EEXIST;
68 else
69 ha->synced++;
70 }
71 ha->refcount++;
72 return 0;
73 }
74 }
75
76 return __hw_addr_create_ex(list, addr, addr_len, addr_type, global,
77 sync);
78}
79
80static int __hw_addr_add(struct netdev_hw_addr_list *list,
81 const unsigned char *addr, int addr_len,
82 unsigned char addr_type)
83{
84 return __hw_addr_add_ex(list, addr, addr_len, addr_type, false, false,
85 0);
86}
87
88static int __hw_addr_del_entry(struct netdev_hw_addr_list *list,
89 struct netdev_hw_addr *ha, bool global,
90 bool sync)
91{
92 if (global && !ha->global_use)
93 return -ENOENT;
94
95 if (sync && !ha->synced)
96 return -ENOENT;
97
98 if (global)
99 ha->global_use = false;
100
101 if (sync)
102 ha->synced--;
103
104 if (--ha->refcount)
105 return 0;
106 list_del_rcu(&ha->list);
107 kfree_rcu(ha, rcu_head);
108 list->count--;
109 return 0;
110}
111
112static int __hw_addr_del_ex(struct netdev_hw_addr_list *list,
113 const unsigned char *addr, int addr_len,
114 unsigned char addr_type, bool global, bool sync)
115{
116 struct netdev_hw_addr *ha;
117
118 list_for_each_entry(ha, &list->list, list) {
119 if (!memcmp(ha->addr, addr, addr_len) &&
120 (ha->type == addr_type || !addr_type))
121 return __hw_addr_del_entry(list, ha, global, sync);
122 }
123 return -ENOENT;
124}
125
126static int __hw_addr_del(struct netdev_hw_addr_list *list,
127 const unsigned char *addr, int addr_len,
128 unsigned char addr_type)
129{
130 return __hw_addr_del_ex(list, addr, addr_len, addr_type, false, false);
131}
132
133static int __hw_addr_sync_one(struct netdev_hw_addr_list *to_list,
134 struct netdev_hw_addr *ha,
135 int addr_len)
136{
137 int err;
138
139 err = __hw_addr_add_ex(to_list, ha->addr, addr_len, ha->type,
140 false, true, ha->sync_cnt);
141 if (err && err != -EEXIST)
142 return err;
143
144 if (!err) {
145 ha->sync_cnt++;
146 ha->refcount++;
147 }
148
149 return 0;
150}
151
152static void __hw_addr_unsync_one(struct netdev_hw_addr_list *to_list,
153 struct netdev_hw_addr_list *from_list,
154 struct netdev_hw_addr *ha,
155 int addr_len)
156{
157 int err;
158
159 err = __hw_addr_del_ex(to_list, ha->addr, addr_len, ha->type,
160 false, true);
161 if (err)
162 return;
163 ha->sync_cnt--;
164 /* address on from list is not marked synced */
165 __hw_addr_del_entry(from_list, ha, false, false);
166}
167
168static int __hw_addr_sync_multiple(struct netdev_hw_addr_list *to_list,
169 struct netdev_hw_addr_list *from_list,
170 int addr_len)
171{
172 int err = 0;
173 struct netdev_hw_addr *ha, *tmp;
174
175 list_for_each_entry_safe(ha, tmp, &from_list->list, list) {
176 if (ha->sync_cnt == ha->refcount) {
177 __hw_addr_unsync_one(to_list, from_list, ha, addr_len);
178 } else {
179 err = __hw_addr_sync_one(to_list, ha, addr_len);
180 if (err)
181 break;
182 }
183 }
184 return err;
185}
186
187/* This function only works where there is a strict 1-1 relationship
188 * between source and destionation of they synch. If you ever need to
189 * sync addresses to more then 1 destination, you need to use
190 * __hw_addr_sync_multiple().
191 */
192int __hw_addr_sync(struct netdev_hw_addr_list *to_list,
193 struct netdev_hw_addr_list *from_list,
194 int addr_len)
195{
196 int err = 0;
197 struct netdev_hw_addr *ha, *tmp;
198
199 list_for_each_entry_safe(ha, tmp, &from_list->list, list) {
200 if (!ha->sync_cnt) {
201 err = __hw_addr_sync_one(to_list, ha, addr_len);
202 if (err)
203 break;
204 } else if (ha->refcount == 1)
205 __hw_addr_unsync_one(to_list, from_list, ha, addr_len);
206 }
207 return err;
208}
209EXPORT_SYMBOL(__hw_addr_sync);
210
211void __hw_addr_unsync(struct netdev_hw_addr_list *to_list,
212 struct netdev_hw_addr_list *from_list,
213 int addr_len)
214{
215 struct netdev_hw_addr *ha, *tmp;
216
217 list_for_each_entry_safe(ha, tmp, &from_list->list, list) {
218 if (ha->sync_cnt)
219 __hw_addr_unsync_one(to_list, from_list, ha, addr_len);
220 }
221}
222EXPORT_SYMBOL(__hw_addr_unsync);
223
224/**
225 * __hw_addr_sync_dev - Synchonize device's multicast list
226 * @list: address list to syncronize
227 * @dev: device to sync
228 * @sync: function to call if address should be added
229 * @unsync: function to call if address should be removed
230 *
231 * This function is intended to be called from the ndo_set_rx_mode
232 * function of devices that require explicit address add/remove
233 * notifications. The unsync function may be NULL in which case
234 * the addresses requiring removal will simply be removed without
235 * any notification to the device.
236 **/
237int __hw_addr_sync_dev(struct netdev_hw_addr_list *list,
238 struct net_device *dev,
239 int (*sync)(struct net_device *, const unsigned char *),
240 int (*unsync)(struct net_device *,
241 const unsigned char *))
242{
243 struct netdev_hw_addr *ha, *tmp;
244 int err;
245
246 /* first go through and flush out any stale entries */
247 list_for_each_entry_safe(ha, tmp, &list->list, list) {
248 if (!ha->sync_cnt || ha->refcount != 1)
249 continue;
250
251 /* if unsync is defined and fails defer unsyncing address */
252 if (unsync && unsync(dev, ha->addr))
253 continue;
254
255 ha->sync_cnt--;
256 __hw_addr_del_entry(list, ha, false, false);
257 }
258
259 /* go through and sync new entries to the list */
260 list_for_each_entry_safe(ha, tmp, &list->list, list) {
261 if (ha->sync_cnt)
262 continue;
263
264 err = sync(dev, ha->addr);
265 if (err)
266 return err;
267
268 ha->sync_cnt++;
269 ha->refcount++;
270 }
271
272 return 0;
273}
274EXPORT_SYMBOL(__hw_addr_sync_dev);
275
276/**
277 * __hw_addr_ref_sync_dev - Synchronize device's multicast address list taking
278 * into account references
279 * @list: address list to synchronize
280 * @dev: device to sync
281 * @sync: function to call if address or reference on it should be added
282 * @unsync: function to call if address or some reference on it should removed
283 *
284 * This function is intended to be called from the ndo_set_rx_mode
285 * function of devices that require explicit address or references on it
286 * add/remove notifications. The unsync function may be NULL in which case
287 * the addresses or references on it requiring removal will simply be
288 * removed without any notification to the device. That is responsibility of
289 * the driver to identify and distribute address or references on it between
290 * internal address tables.
291 **/
292int __hw_addr_ref_sync_dev(struct netdev_hw_addr_list *list,
293 struct net_device *dev,
294 int (*sync)(struct net_device *,
295 const unsigned char *, int),
296 int (*unsync)(struct net_device *,
297 const unsigned char *, int))
298{
299 struct netdev_hw_addr *ha, *tmp;
300 int err, ref_cnt;
301
302 /* first go through and flush out any unsynced/stale entries */
303 list_for_each_entry_safe(ha, tmp, &list->list, list) {
304 /* sync if address is not used */
305 if ((ha->sync_cnt << 1) <= ha->refcount)
306 continue;
307
308 /* if fails defer unsyncing address */
309 ref_cnt = ha->refcount - ha->sync_cnt;
310 if (unsync && unsync(dev, ha->addr, ref_cnt))
311 continue;
312
313 ha->refcount = (ref_cnt << 1) + 1;
314 ha->sync_cnt = ref_cnt;
315 __hw_addr_del_entry(list, ha, false, false);
316 }
317
318 /* go through and sync updated/new entries to the list */
319 list_for_each_entry_safe(ha, tmp, &list->list, list) {
320 /* sync if address added or reused */
321 if ((ha->sync_cnt << 1) >= ha->refcount)
322 continue;
323
324 ref_cnt = ha->refcount - ha->sync_cnt;
325 err = sync(dev, ha->addr, ref_cnt);
326 if (err)
327 return err;
328
329 ha->refcount = ref_cnt << 1;
330 ha->sync_cnt = ref_cnt;
331 }
332
333 return 0;
334}
335EXPORT_SYMBOL(__hw_addr_ref_sync_dev);
336
337/**
338 * __hw_addr_ref_unsync_dev - Remove synchronized addresses and references on
339 * it from device
340 * @list: address list to remove synchronized addresses (references on it) from
341 * @dev: device to sync
342 * @unsync: function to call if address and references on it should be removed
343 *
344 * Remove all addresses that were added to the device by
345 * __hw_addr_ref_sync_dev(). This function is intended to be called from the
346 * ndo_stop or ndo_open functions on devices that require explicit address (or
347 * references on it) add/remove notifications. If the unsync function pointer
348 * is NULL then this function can be used to just reset the sync_cnt for the
349 * addresses in the list.
350 **/
351void __hw_addr_ref_unsync_dev(struct netdev_hw_addr_list *list,
352 struct net_device *dev,
353 int (*unsync)(struct net_device *,
354 const unsigned char *, int))
355{
356 struct netdev_hw_addr *ha, *tmp;
357
358 list_for_each_entry_safe(ha, tmp, &list->list, list) {
359 if (!ha->sync_cnt)
360 continue;
361
362 /* if fails defer unsyncing address */
363 if (unsync && unsync(dev, ha->addr, ha->sync_cnt))
364 continue;
365
366 ha->refcount -= ha->sync_cnt - 1;
367 ha->sync_cnt = 0;
368 __hw_addr_del_entry(list, ha, false, false);
369 }
370}
371EXPORT_SYMBOL(__hw_addr_ref_unsync_dev);
372
373/**
374 * __hw_addr_unsync_dev - Remove synchronized addresses from device
375 * @list: address list to remove synchronized addresses from
376 * @dev: device to sync
377 * @unsync: function to call if address should be removed
378 *
379 * Remove all addresses that were added to the device by __hw_addr_sync_dev().
380 * This function is intended to be called from the ndo_stop or ndo_open
381 * functions on devices that require explicit address add/remove
382 * notifications. If the unsync function pointer is NULL then this function
383 * can be used to just reset the sync_cnt for the addresses in the list.
384 **/
385void __hw_addr_unsync_dev(struct netdev_hw_addr_list *list,
386 struct net_device *dev,
387 int (*unsync)(struct net_device *,
388 const unsigned char *))
389{
390 struct netdev_hw_addr *ha, *tmp;
391
392 list_for_each_entry_safe(ha, tmp, &list->list, list) {
393 if (!ha->sync_cnt)
394 continue;
395
396 /* if unsync is defined and fails defer unsyncing address */
397 if (unsync && unsync(dev, ha->addr))
398 continue;
399
400 ha->sync_cnt--;
401 __hw_addr_del_entry(list, ha, false, false);
402 }
403}
404EXPORT_SYMBOL(__hw_addr_unsync_dev);
405
406static void __hw_addr_flush(struct netdev_hw_addr_list *list)
407{
408 struct netdev_hw_addr *ha, *tmp;
409
410 list_for_each_entry_safe(ha, tmp, &list->list, list) {
411 list_del_rcu(&ha->list);
412 kfree_rcu(ha, rcu_head);
413 }
414 list->count = 0;
415}
416
417void __hw_addr_init(struct netdev_hw_addr_list *list)
418{
419 INIT_LIST_HEAD(&list->list);
420 list->count = 0;
421}
422EXPORT_SYMBOL(__hw_addr_init);
423
424/*
425 * Device addresses handling functions
426 */
427
428/**
429 * dev_addr_flush - Flush device address list
430 * @dev: device
431 *
432 * Flush device address list and reset ->dev_addr.
433 *
434 * The caller must hold the rtnl_mutex.
435 */
436void dev_addr_flush(struct net_device *dev)
437{
438 /* rtnl_mutex must be held here */
439
440 __hw_addr_flush(&dev->dev_addrs);
441 dev->dev_addr = NULL;
442}
443EXPORT_SYMBOL(dev_addr_flush);
444
445/**
446 * dev_addr_init - Init device address list
447 * @dev: device
448 *
449 * Init device address list and create the first element,
450 * used by ->dev_addr.
451 *
452 * The caller must hold the rtnl_mutex.
453 */
454int dev_addr_init(struct net_device *dev)
455{
456 unsigned char addr[MAX_ADDR_LEN];
457 struct netdev_hw_addr *ha;
458 int err;
459
460 /* rtnl_mutex must be held here */
461
462 __hw_addr_init(&dev->dev_addrs);
463 memset(addr, 0, sizeof(addr));
464 err = __hw_addr_add(&dev->dev_addrs, addr, sizeof(addr),
465 NETDEV_HW_ADDR_T_LAN);
466 if (!err) {
467 /*
468 * Get the first (previously created) address from the list
469 * and set dev_addr pointer to this location.
470 */
471 ha = list_first_entry(&dev->dev_addrs.list,
472 struct netdev_hw_addr, list);
473 dev->dev_addr = ha->addr;
474 }
475 return err;
476}
477EXPORT_SYMBOL(dev_addr_init);
478
479/**
480 * dev_addr_add - Add a device address
481 * @dev: device
482 * @addr: address to add
483 * @addr_type: address type
484 *
485 * Add a device address to the device or increase the reference count if
486 * it already exists.
487 *
488 * The caller must hold the rtnl_mutex.
489 */
490int dev_addr_add(struct net_device *dev, const unsigned char *addr,
491 unsigned char addr_type)
492{
493 int err;
494
495 ASSERT_RTNL();
496
497 err = dev_pre_changeaddr_notify(dev, addr, NULL);
498 if (err)
499 return err;
500 err = __hw_addr_add(&dev->dev_addrs, addr, dev->addr_len, addr_type);
501 if (!err)
502 call_netdevice_notifiers(NETDEV_CHANGEADDR, dev);
503 return err;
504}
505EXPORT_SYMBOL(dev_addr_add);
506
507/**
508 * dev_addr_del - Release a device address.
509 * @dev: device
510 * @addr: address to delete
511 * @addr_type: address type
512 *
513 * Release reference to a device address and remove it from the device
514 * if the reference count drops to zero.
515 *
516 * The caller must hold the rtnl_mutex.
517 */
518int dev_addr_del(struct net_device *dev, const unsigned char *addr,
519 unsigned char addr_type)
520{
521 int err;
522 struct netdev_hw_addr *ha;
523
524 ASSERT_RTNL();
525
526 /*
527 * We can not remove the first address from the list because
528 * dev->dev_addr points to that.
529 */
530 ha = list_first_entry(&dev->dev_addrs.list,
531 struct netdev_hw_addr, list);
532 if (!memcmp(ha->addr, addr, dev->addr_len) &&
533 ha->type == addr_type && ha->refcount == 1)
534 return -ENOENT;
535
536 err = __hw_addr_del(&dev->dev_addrs, addr, dev->addr_len,
537 addr_type);
538 if (!err)
539 call_netdevice_notifiers(NETDEV_CHANGEADDR, dev);
540 return err;
541}
542EXPORT_SYMBOL(dev_addr_del);
543
544/*
545 * Unicast list handling functions
546 */
547
548/**
549 * dev_uc_add_excl - Add a global secondary unicast address
550 * @dev: device
551 * @addr: address to add
552 */
553int dev_uc_add_excl(struct net_device *dev, const unsigned char *addr)
554{
555 struct netdev_hw_addr *ha;
556 int err;
557
558 netif_addr_lock_bh(dev);
559 list_for_each_entry(ha, &dev->uc.list, list) {
560 if (!memcmp(ha->addr, addr, dev->addr_len) &&
561 ha->type == NETDEV_HW_ADDR_T_UNICAST) {
562 err = -EEXIST;
563 goto out;
564 }
565 }
566 err = __hw_addr_create_ex(&dev->uc, addr, dev->addr_len,
567 NETDEV_HW_ADDR_T_UNICAST, true, false);
568 if (!err)
569 __dev_set_rx_mode(dev);
570out:
571 netif_addr_unlock_bh(dev);
572 return err;
573}
574EXPORT_SYMBOL(dev_uc_add_excl);
575
576/**
577 * dev_uc_add - Add a secondary unicast address
578 * @dev: device
579 * @addr: address to add
580 *
581 * Add a secondary unicast address to the device or increase
582 * the reference count if it already exists.
583 */
584int dev_uc_add(struct net_device *dev, const unsigned char *addr)
585{
586 int err;
587
588 netif_addr_lock_bh(dev);
589 err = __hw_addr_add(&dev->uc, addr, dev->addr_len,
590 NETDEV_HW_ADDR_T_UNICAST);
591 if (!err)
592 __dev_set_rx_mode(dev);
593 netif_addr_unlock_bh(dev);
594 return err;
595}
596EXPORT_SYMBOL(dev_uc_add);
597
598/**
599 * dev_uc_del - Release secondary unicast address.
600 * @dev: device
601 * @addr: address to delete
602 *
603 * Release reference to a secondary unicast address and remove it
604 * from the device if the reference count drops to zero.
605 */
606int dev_uc_del(struct net_device *dev, const unsigned char *addr)
607{
608 int err;
609
610 netif_addr_lock_bh(dev);
611 err = __hw_addr_del(&dev->uc, addr, dev->addr_len,
612 NETDEV_HW_ADDR_T_UNICAST);
613 if (!err)
614 __dev_set_rx_mode(dev);
615 netif_addr_unlock_bh(dev);
616 return err;
617}
618EXPORT_SYMBOL(dev_uc_del);
619
620/**
621 * dev_uc_sync - Synchronize device's unicast list to another device
622 * @to: destination device
623 * @from: source device
624 *
625 * Add newly added addresses to the destination device and release
626 * addresses that have no users left. The source device must be
627 * locked by netif_addr_lock_bh.
628 *
629 * This function is intended to be called from the dev->set_rx_mode
630 * function of layered software devices. This function assumes that
631 * addresses will only ever be synced to the @to devices and no other.
632 */
633int dev_uc_sync(struct net_device *to, struct net_device *from)
634{
635 int err = 0;
636
637 if (to->addr_len != from->addr_len)
638 return -EINVAL;
639
640 netif_addr_lock(to);
641 err = __hw_addr_sync(&to->uc, &from->uc, to->addr_len);
642 if (!err)
643 __dev_set_rx_mode(to);
644 netif_addr_unlock(to);
645 return err;
646}
647EXPORT_SYMBOL(dev_uc_sync);
648
649/**
650 * dev_uc_sync_multiple - Synchronize device's unicast list to another
651 * device, but allow for multiple calls to sync to multiple devices.
652 * @to: destination device
653 * @from: source device
654 *
655 * Add newly added addresses to the destination device and release
656 * addresses that have been deleted from the source. The source device
657 * must be locked by netif_addr_lock_bh.
658 *
659 * This function is intended to be called from the dev->set_rx_mode
660 * function of layered software devices. It allows for a single source
661 * device to be synced to multiple destination devices.
662 */
663int dev_uc_sync_multiple(struct net_device *to, struct net_device *from)
664{
665 int err = 0;
666
667 if (to->addr_len != from->addr_len)
668 return -EINVAL;
669
670 netif_addr_lock(to);
671 err = __hw_addr_sync_multiple(&to->uc, &from->uc, to->addr_len);
672 if (!err)
673 __dev_set_rx_mode(to);
674 netif_addr_unlock(to);
675 return err;
676}
677EXPORT_SYMBOL(dev_uc_sync_multiple);
678
679/**
680 * dev_uc_unsync - Remove synchronized addresses from the destination device
681 * @to: destination device
682 * @from: source device
683 *
684 * Remove all addresses that were added to the destination device by
685 * dev_uc_sync(). This function is intended to be called from the
686 * dev->stop function of layered software devices.
687 */
688void dev_uc_unsync(struct net_device *to, struct net_device *from)
689{
690 if (to->addr_len != from->addr_len)
691 return;
692
693 /* netif_addr_lock_bh() uses lockdep subclass 0, this is okay for two
694 * reasons:
695 * 1) This is always called without any addr_list_lock, so as the
696 * outermost one here, it must be 0.
697 * 2) This is called by some callers after unlinking the upper device,
698 * so the dev->lower_level becomes 1 again.
699 * Therefore, the subclass for 'from' is 0, for 'to' is either 1 or
700 * larger.
701 */
702 netif_addr_lock_bh(from);
703 netif_addr_lock(to);
704 __hw_addr_unsync(&to->uc, &from->uc, to->addr_len);
705 __dev_set_rx_mode(to);
706 netif_addr_unlock(to);
707 netif_addr_unlock_bh(from);
708}
709EXPORT_SYMBOL(dev_uc_unsync);
710
711/**
712 * dev_uc_flush - Flush unicast addresses
713 * @dev: device
714 *
715 * Flush unicast addresses.
716 */
717void dev_uc_flush(struct net_device *dev)
718{
719 netif_addr_lock_bh(dev);
720 __hw_addr_flush(&dev->uc);
721 netif_addr_unlock_bh(dev);
722}
723EXPORT_SYMBOL(dev_uc_flush);
724
725/**
726 * dev_uc_init - Init unicast address list
727 * @dev: device
728 *
729 * Init unicast address list.
730 */
731void dev_uc_init(struct net_device *dev)
732{
733 __hw_addr_init(&dev->uc);
734}
735EXPORT_SYMBOL(dev_uc_init);
736
737/*
738 * Multicast list handling functions
739 */
740
741/**
742 * dev_mc_add_excl - Add a global secondary multicast address
743 * @dev: device
744 * @addr: address to add
745 */
746int dev_mc_add_excl(struct net_device *dev, const unsigned char *addr)
747{
748 struct netdev_hw_addr *ha;
749 int err;
750
751 netif_addr_lock_bh(dev);
752 list_for_each_entry(ha, &dev->mc.list, list) {
753 if (!memcmp(ha->addr, addr, dev->addr_len) &&
754 ha->type == NETDEV_HW_ADDR_T_MULTICAST) {
755 err = -EEXIST;
756 goto out;
757 }
758 }
759 err = __hw_addr_create_ex(&dev->mc, addr, dev->addr_len,
760 NETDEV_HW_ADDR_T_MULTICAST, true, false);
761 if (!err)
762 __dev_set_rx_mode(dev);
763out:
764 netif_addr_unlock_bh(dev);
765 return err;
766}
767EXPORT_SYMBOL(dev_mc_add_excl);
768
769static int __dev_mc_add(struct net_device *dev, const unsigned char *addr,
770 bool global)
771{
772 int err;
773
774 netif_addr_lock_bh(dev);
775 err = __hw_addr_add_ex(&dev->mc, addr, dev->addr_len,
776 NETDEV_HW_ADDR_T_MULTICAST, global, false, 0);
777 if (!err)
778 __dev_set_rx_mode(dev);
779 netif_addr_unlock_bh(dev);
780 return err;
781}
782/**
783 * dev_mc_add - Add a multicast address
784 * @dev: device
785 * @addr: address to add
786 *
787 * Add a multicast address to the device or increase
788 * the reference count if it already exists.
789 */
790int dev_mc_add(struct net_device *dev, const unsigned char *addr)
791{
792 return __dev_mc_add(dev, addr, false);
793}
794EXPORT_SYMBOL(dev_mc_add);
795
796/**
797 * dev_mc_add_global - Add a global multicast address
798 * @dev: device
799 * @addr: address to add
800 *
801 * Add a global multicast address to the device.
802 */
803int dev_mc_add_global(struct net_device *dev, const unsigned char *addr)
804{
805 return __dev_mc_add(dev, addr, true);
806}
807EXPORT_SYMBOL(dev_mc_add_global);
808
809static int __dev_mc_del(struct net_device *dev, const unsigned char *addr,
810 bool global)
811{
812 int err;
813
814 netif_addr_lock_bh(dev);
815 err = __hw_addr_del_ex(&dev->mc, addr, dev->addr_len,
816 NETDEV_HW_ADDR_T_MULTICAST, global, false);
817 if (!err)
818 __dev_set_rx_mode(dev);
819 netif_addr_unlock_bh(dev);
820 return err;
821}
822
823/**
824 * dev_mc_del - Delete a multicast address.
825 * @dev: device
826 * @addr: address to delete
827 *
828 * Release reference to a multicast address and remove it
829 * from the device if the reference count drops to zero.
830 */
831int dev_mc_del(struct net_device *dev, const unsigned char *addr)
832{
833 return __dev_mc_del(dev, addr, false);
834}
835EXPORT_SYMBOL(dev_mc_del);
836
837/**
838 * dev_mc_del_global - Delete a global multicast address.
839 * @dev: device
840 * @addr: address to delete
841 *
842 * Release reference to a multicast address and remove it
843 * from the device if the reference count drops to zero.
844 */
845int dev_mc_del_global(struct net_device *dev, const unsigned char *addr)
846{
847 return __dev_mc_del(dev, addr, true);
848}
849EXPORT_SYMBOL(dev_mc_del_global);
850
851/**
852 * dev_mc_sync - Synchronize device's multicast list to another device
853 * @to: destination device
854 * @from: source device
855 *
856 * Add newly added addresses to the destination device and release
857 * addresses that have no users left. The source device must be
858 * locked by netif_addr_lock_bh.
859 *
860 * This function is intended to be called from the ndo_set_rx_mode
861 * function of layered software devices.
862 */
863int dev_mc_sync(struct net_device *to, struct net_device *from)
864{
865 int err = 0;
866
867 if (to->addr_len != from->addr_len)
868 return -EINVAL;
869
870 netif_addr_lock(to);
871 err = __hw_addr_sync(&to->mc, &from->mc, to->addr_len);
872 if (!err)
873 __dev_set_rx_mode(to);
874 netif_addr_unlock(to);
875 return err;
876}
877EXPORT_SYMBOL(dev_mc_sync);
878
879/**
880 * dev_mc_sync_multiple - Synchronize device's multicast list to another
881 * device, but allow for multiple calls to sync to multiple devices.
882 * @to: destination device
883 * @from: source device
884 *
885 * Add newly added addresses to the destination device and release
886 * addresses that have no users left. The source device must be
887 * locked by netif_addr_lock_bh.
888 *
889 * This function is intended to be called from the ndo_set_rx_mode
890 * function of layered software devices. It allows for a single
891 * source device to be synced to multiple destination devices.
892 */
893int dev_mc_sync_multiple(struct net_device *to, struct net_device *from)
894{
895 int err = 0;
896
897 if (to->addr_len != from->addr_len)
898 return -EINVAL;
899
900 netif_addr_lock(to);
901 err = __hw_addr_sync_multiple(&to->mc, &from->mc, to->addr_len);
902 if (!err)
903 __dev_set_rx_mode(to);
904 netif_addr_unlock(to);
905 return err;
906}
907EXPORT_SYMBOL(dev_mc_sync_multiple);
908
909/**
910 * dev_mc_unsync - Remove synchronized addresses from the destination device
911 * @to: destination device
912 * @from: source device
913 *
914 * Remove all addresses that were added to the destination device by
915 * dev_mc_sync(). This function is intended to be called from the
916 * dev->stop function of layered software devices.
917 */
918void dev_mc_unsync(struct net_device *to, struct net_device *from)
919{
920 if (to->addr_len != from->addr_len)
921 return;
922
923 /* See the above comments inside dev_uc_unsync(). */
924 netif_addr_lock_bh(from);
925 netif_addr_lock(to);
926 __hw_addr_unsync(&to->mc, &from->mc, to->addr_len);
927 __dev_set_rx_mode(to);
928 netif_addr_unlock(to);
929 netif_addr_unlock_bh(from);
930}
931EXPORT_SYMBOL(dev_mc_unsync);
932
933/**
934 * dev_mc_flush - Flush multicast addresses
935 * @dev: device
936 *
937 * Flush multicast addresses.
938 */
939void dev_mc_flush(struct net_device *dev)
940{
941 netif_addr_lock_bh(dev);
942 __hw_addr_flush(&dev->mc);
943 netif_addr_unlock_bh(dev);
944}
945EXPORT_SYMBOL(dev_mc_flush);
946
947/**
948 * dev_mc_init - Init multicast address list
949 * @dev: device
950 *
951 * Init multicast address list.
952 */
953void dev_mc_init(struct net_device *dev)
954{
955 __hw_addr_init(&dev->mc);
956}
957EXPORT_SYMBOL(dev_mc_init);
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * net/core/dev_addr_lists.c - Functions for handling net device lists
4 * Copyright (c) 2010 Jiri Pirko <jpirko@redhat.com>
5 *
6 * This file contains functions for working with unicast, multicast and device
7 * addresses lists.
8 */
9
10#include <linux/netdevice.h>
11#include <linux/rtnetlink.h>
12#include <linux/export.h>
13#include <linux/list.h>
14
15#include "dev.h"
16
17/*
18 * General list handling functions
19 */
20
21static int __hw_addr_insert(struct netdev_hw_addr_list *list,
22 struct netdev_hw_addr *new, int addr_len)
23{
24 struct rb_node **ins_point = &list->tree.rb_node, *parent = NULL;
25 struct netdev_hw_addr *ha;
26
27 while (*ins_point) {
28 int diff;
29
30 ha = rb_entry(*ins_point, struct netdev_hw_addr, node);
31 diff = memcmp(new->addr, ha->addr, addr_len);
32 if (diff == 0)
33 diff = memcmp(&new->type, &ha->type, sizeof(new->type));
34
35 parent = *ins_point;
36 if (diff < 0)
37 ins_point = &parent->rb_left;
38 else if (diff > 0)
39 ins_point = &parent->rb_right;
40 else
41 return -EEXIST;
42 }
43
44 rb_link_node_rcu(&new->node, parent, ins_point);
45 rb_insert_color(&new->node, &list->tree);
46
47 return 0;
48}
49
50static struct netdev_hw_addr*
51__hw_addr_create(const unsigned char *addr, int addr_len,
52 unsigned char addr_type, bool global, bool sync)
53{
54 struct netdev_hw_addr *ha;
55 int alloc_size;
56
57 alloc_size = sizeof(*ha);
58 if (alloc_size < L1_CACHE_BYTES)
59 alloc_size = L1_CACHE_BYTES;
60 ha = kmalloc(alloc_size, GFP_ATOMIC);
61 if (!ha)
62 return NULL;
63 memcpy(ha->addr, addr, addr_len);
64 ha->type = addr_type;
65 ha->refcount = 1;
66 ha->global_use = global;
67 ha->synced = sync ? 1 : 0;
68 ha->sync_cnt = 0;
69
70 return ha;
71}
72
73static int __hw_addr_add_ex(struct netdev_hw_addr_list *list,
74 const unsigned char *addr, int addr_len,
75 unsigned char addr_type, bool global, bool sync,
76 int sync_count, bool exclusive)
77{
78 struct rb_node **ins_point = &list->tree.rb_node, *parent = NULL;
79 struct netdev_hw_addr *ha;
80
81 if (addr_len > MAX_ADDR_LEN)
82 return -EINVAL;
83
84 while (*ins_point) {
85 int diff;
86
87 ha = rb_entry(*ins_point, struct netdev_hw_addr, node);
88 diff = memcmp(addr, ha->addr, addr_len);
89 if (diff == 0)
90 diff = memcmp(&addr_type, &ha->type, sizeof(addr_type));
91
92 parent = *ins_point;
93 if (diff < 0) {
94 ins_point = &parent->rb_left;
95 } else if (diff > 0) {
96 ins_point = &parent->rb_right;
97 } else {
98 if (exclusive)
99 return -EEXIST;
100 if (global) {
101 /* check if addr is already used as global */
102 if (ha->global_use)
103 return 0;
104 else
105 ha->global_use = true;
106 }
107 if (sync) {
108 if (ha->synced && sync_count)
109 return -EEXIST;
110 else
111 ha->synced++;
112 }
113 ha->refcount++;
114 return 0;
115 }
116 }
117
118 ha = __hw_addr_create(addr, addr_len, addr_type, global, sync);
119 if (!ha)
120 return -ENOMEM;
121
122 rb_link_node(&ha->node, parent, ins_point);
123 rb_insert_color(&ha->node, &list->tree);
124
125 list_add_tail_rcu(&ha->list, &list->list);
126 list->count++;
127
128 return 0;
129}
130
131static int __hw_addr_add(struct netdev_hw_addr_list *list,
132 const unsigned char *addr, int addr_len,
133 unsigned char addr_type)
134{
135 return __hw_addr_add_ex(list, addr, addr_len, addr_type, false, false,
136 0, false);
137}
138
139static int __hw_addr_del_entry(struct netdev_hw_addr_list *list,
140 struct netdev_hw_addr *ha, bool global,
141 bool sync)
142{
143 if (global && !ha->global_use)
144 return -ENOENT;
145
146 if (sync && !ha->synced)
147 return -ENOENT;
148
149 if (global)
150 ha->global_use = false;
151
152 if (sync)
153 ha->synced--;
154
155 if (--ha->refcount)
156 return 0;
157
158 rb_erase(&ha->node, &list->tree);
159
160 list_del_rcu(&ha->list);
161 kfree_rcu(ha, rcu_head);
162 list->count--;
163 return 0;
164}
165
166static struct netdev_hw_addr *__hw_addr_lookup(struct netdev_hw_addr_list *list,
167 const unsigned char *addr, int addr_len,
168 unsigned char addr_type)
169{
170 struct rb_node *node;
171
172 node = list->tree.rb_node;
173
174 while (node) {
175 struct netdev_hw_addr *ha = rb_entry(node, struct netdev_hw_addr, node);
176 int diff = memcmp(addr, ha->addr, addr_len);
177
178 if (diff == 0 && addr_type)
179 diff = memcmp(&addr_type, &ha->type, sizeof(addr_type));
180
181 if (diff < 0)
182 node = node->rb_left;
183 else if (diff > 0)
184 node = node->rb_right;
185 else
186 return ha;
187 }
188
189 return NULL;
190}
191
192static int __hw_addr_del_ex(struct netdev_hw_addr_list *list,
193 const unsigned char *addr, int addr_len,
194 unsigned char addr_type, bool global, bool sync)
195{
196 struct netdev_hw_addr *ha = __hw_addr_lookup(list, addr, addr_len, addr_type);
197
198 if (!ha)
199 return -ENOENT;
200 return __hw_addr_del_entry(list, ha, global, sync);
201}
202
203static int __hw_addr_del(struct netdev_hw_addr_list *list,
204 const unsigned char *addr, int addr_len,
205 unsigned char addr_type)
206{
207 return __hw_addr_del_ex(list, addr, addr_len, addr_type, false, false);
208}
209
210static int __hw_addr_sync_one(struct netdev_hw_addr_list *to_list,
211 struct netdev_hw_addr *ha,
212 int addr_len)
213{
214 int err;
215
216 err = __hw_addr_add_ex(to_list, ha->addr, addr_len, ha->type,
217 false, true, ha->sync_cnt, false);
218 if (err && err != -EEXIST)
219 return err;
220
221 if (!err) {
222 ha->sync_cnt++;
223 ha->refcount++;
224 }
225
226 return 0;
227}
228
229static void __hw_addr_unsync_one(struct netdev_hw_addr_list *to_list,
230 struct netdev_hw_addr_list *from_list,
231 struct netdev_hw_addr *ha,
232 int addr_len)
233{
234 int err;
235
236 err = __hw_addr_del_ex(to_list, ha->addr, addr_len, ha->type,
237 false, true);
238 if (err)
239 return;
240 ha->sync_cnt--;
241 /* address on from list is not marked synced */
242 __hw_addr_del_entry(from_list, ha, false, false);
243}
244
245static int __hw_addr_sync_multiple(struct netdev_hw_addr_list *to_list,
246 struct netdev_hw_addr_list *from_list,
247 int addr_len)
248{
249 int err = 0;
250 struct netdev_hw_addr *ha, *tmp;
251
252 list_for_each_entry_safe(ha, tmp, &from_list->list, list) {
253 if (ha->sync_cnt == ha->refcount) {
254 __hw_addr_unsync_one(to_list, from_list, ha, addr_len);
255 } else {
256 err = __hw_addr_sync_one(to_list, ha, addr_len);
257 if (err)
258 break;
259 }
260 }
261 return err;
262}
263
264/* This function only works where there is a strict 1-1 relationship
265 * between source and destionation of they synch. If you ever need to
266 * sync addresses to more then 1 destination, you need to use
267 * __hw_addr_sync_multiple().
268 */
269int __hw_addr_sync(struct netdev_hw_addr_list *to_list,
270 struct netdev_hw_addr_list *from_list,
271 int addr_len)
272{
273 int err = 0;
274 struct netdev_hw_addr *ha, *tmp;
275
276 list_for_each_entry_safe(ha, tmp, &from_list->list, list) {
277 if (!ha->sync_cnt) {
278 err = __hw_addr_sync_one(to_list, ha, addr_len);
279 if (err)
280 break;
281 } else if (ha->refcount == 1)
282 __hw_addr_unsync_one(to_list, from_list, ha, addr_len);
283 }
284 return err;
285}
286EXPORT_SYMBOL(__hw_addr_sync);
287
288void __hw_addr_unsync(struct netdev_hw_addr_list *to_list,
289 struct netdev_hw_addr_list *from_list,
290 int addr_len)
291{
292 struct netdev_hw_addr *ha, *tmp;
293
294 list_for_each_entry_safe(ha, tmp, &from_list->list, list) {
295 if (ha->sync_cnt)
296 __hw_addr_unsync_one(to_list, from_list, ha, addr_len);
297 }
298}
299EXPORT_SYMBOL(__hw_addr_unsync);
300
301/**
302 * __hw_addr_sync_dev - Synchonize device's multicast list
303 * @list: address list to syncronize
304 * @dev: device to sync
305 * @sync: function to call if address should be added
306 * @unsync: function to call if address should be removed
307 *
308 * This function is intended to be called from the ndo_set_rx_mode
309 * function of devices that require explicit address add/remove
310 * notifications. The unsync function may be NULL in which case
311 * the addresses requiring removal will simply be removed without
312 * any notification to the device.
313 **/
314int __hw_addr_sync_dev(struct netdev_hw_addr_list *list,
315 struct net_device *dev,
316 int (*sync)(struct net_device *, const unsigned char *),
317 int (*unsync)(struct net_device *,
318 const unsigned char *))
319{
320 struct netdev_hw_addr *ha, *tmp;
321 int err;
322
323 /* first go through and flush out any stale entries */
324 list_for_each_entry_safe(ha, tmp, &list->list, list) {
325 if (!ha->sync_cnt || ha->refcount != 1)
326 continue;
327
328 /* if unsync is defined and fails defer unsyncing address */
329 if (unsync && unsync(dev, ha->addr))
330 continue;
331
332 ha->sync_cnt--;
333 __hw_addr_del_entry(list, ha, false, false);
334 }
335
336 /* go through and sync new entries to the list */
337 list_for_each_entry_safe(ha, tmp, &list->list, list) {
338 if (ha->sync_cnt)
339 continue;
340
341 err = sync(dev, ha->addr);
342 if (err)
343 return err;
344
345 ha->sync_cnt++;
346 ha->refcount++;
347 }
348
349 return 0;
350}
351EXPORT_SYMBOL(__hw_addr_sync_dev);
352
353/**
354 * __hw_addr_ref_sync_dev - Synchronize device's multicast address list taking
355 * into account references
356 * @list: address list to synchronize
357 * @dev: device to sync
358 * @sync: function to call if address or reference on it should be added
359 * @unsync: function to call if address or some reference on it should removed
360 *
361 * This function is intended to be called from the ndo_set_rx_mode
362 * function of devices that require explicit address or references on it
363 * add/remove notifications. The unsync function may be NULL in which case
364 * the addresses or references on it requiring removal will simply be
365 * removed without any notification to the device. That is responsibility of
366 * the driver to identify and distribute address or references on it between
367 * internal address tables.
368 **/
369int __hw_addr_ref_sync_dev(struct netdev_hw_addr_list *list,
370 struct net_device *dev,
371 int (*sync)(struct net_device *,
372 const unsigned char *, int),
373 int (*unsync)(struct net_device *,
374 const unsigned char *, int))
375{
376 struct netdev_hw_addr *ha, *tmp;
377 int err, ref_cnt;
378
379 /* first go through and flush out any unsynced/stale entries */
380 list_for_each_entry_safe(ha, tmp, &list->list, list) {
381 /* sync if address is not used */
382 if ((ha->sync_cnt << 1) <= ha->refcount)
383 continue;
384
385 /* if fails defer unsyncing address */
386 ref_cnt = ha->refcount - ha->sync_cnt;
387 if (unsync && unsync(dev, ha->addr, ref_cnt))
388 continue;
389
390 ha->refcount = (ref_cnt << 1) + 1;
391 ha->sync_cnt = ref_cnt;
392 __hw_addr_del_entry(list, ha, false, false);
393 }
394
395 /* go through and sync updated/new entries to the list */
396 list_for_each_entry_safe(ha, tmp, &list->list, list) {
397 /* sync if address added or reused */
398 if ((ha->sync_cnt << 1) >= ha->refcount)
399 continue;
400
401 ref_cnt = ha->refcount - ha->sync_cnt;
402 err = sync(dev, ha->addr, ref_cnt);
403 if (err)
404 return err;
405
406 ha->refcount = ref_cnt << 1;
407 ha->sync_cnt = ref_cnt;
408 }
409
410 return 0;
411}
412EXPORT_SYMBOL(__hw_addr_ref_sync_dev);
413
414/**
415 * __hw_addr_ref_unsync_dev - Remove synchronized addresses and references on
416 * it from device
417 * @list: address list to remove synchronized addresses (references on it) from
418 * @dev: device to sync
419 * @unsync: function to call if address and references on it should be removed
420 *
421 * Remove all addresses that were added to the device by
422 * __hw_addr_ref_sync_dev(). This function is intended to be called from the
423 * ndo_stop or ndo_open functions on devices that require explicit address (or
424 * references on it) add/remove notifications. If the unsync function pointer
425 * is NULL then this function can be used to just reset the sync_cnt for the
426 * addresses in the list.
427 **/
428void __hw_addr_ref_unsync_dev(struct netdev_hw_addr_list *list,
429 struct net_device *dev,
430 int (*unsync)(struct net_device *,
431 const unsigned char *, int))
432{
433 struct netdev_hw_addr *ha, *tmp;
434
435 list_for_each_entry_safe(ha, tmp, &list->list, list) {
436 if (!ha->sync_cnt)
437 continue;
438
439 /* if fails defer unsyncing address */
440 if (unsync && unsync(dev, ha->addr, ha->sync_cnt))
441 continue;
442
443 ha->refcount -= ha->sync_cnt - 1;
444 ha->sync_cnt = 0;
445 __hw_addr_del_entry(list, ha, false, false);
446 }
447}
448EXPORT_SYMBOL(__hw_addr_ref_unsync_dev);
449
450/**
451 * __hw_addr_unsync_dev - Remove synchronized addresses from device
452 * @list: address list to remove synchronized addresses from
453 * @dev: device to sync
454 * @unsync: function to call if address should be removed
455 *
456 * Remove all addresses that were added to the device by __hw_addr_sync_dev().
457 * This function is intended to be called from the ndo_stop or ndo_open
458 * functions on devices that require explicit address add/remove
459 * notifications. If the unsync function pointer is NULL then this function
460 * can be used to just reset the sync_cnt for the addresses in the list.
461 **/
462void __hw_addr_unsync_dev(struct netdev_hw_addr_list *list,
463 struct net_device *dev,
464 int (*unsync)(struct net_device *,
465 const unsigned char *))
466{
467 struct netdev_hw_addr *ha, *tmp;
468
469 list_for_each_entry_safe(ha, tmp, &list->list, list) {
470 if (!ha->sync_cnt)
471 continue;
472
473 /* if unsync is defined and fails defer unsyncing address */
474 if (unsync && unsync(dev, ha->addr))
475 continue;
476
477 ha->sync_cnt--;
478 __hw_addr_del_entry(list, ha, false, false);
479 }
480}
481EXPORT_SYMBOL(__hw_addr_unsync_dev);
482
483static void __hw_addr_flush(struct netdev_hw_addr_list *list)
484{
485 struct netdev_hw_addr *ha, *tmp;
486
487 list->tree = RB_ROOT;
488 list_for_each_entry_safe(ha, tmp, &list->list, list) {
489 list_del_rcu(&ha->list);
490 kfree_rcu(ha, rcu_head);
491 }
492 list->count = 0;
493}
494
495void __hw_addr_init(struct netdev_hw_addr_list *list)
496{
497 INIT_LIST_HEAD(&list->list);
498 list->count = 0;
499 list->tree = RB_ROOT;
500}
501EXPORT_SYMBOL(__hw_addr_init);
502
503/*
504 * Device addresses handling functions
505 */
506
507/* Check that netdev->dev_addr is not written to directly as this would
508 * break the rbtree layout. All changes should go thru dev_addr_set() and co.
509 * Remove this check in mid-2024.
510 */
511void dev_addr_check(struct net_device *dev)
512{
513 if (!memcmp(dev->dev_addr, dev->dev_addr_shadow, MAX_ADDR_LEN))
514 return;
515
516 netdev_warn(dev, "Current addr: %*ph\n", MAX_ADDR_LEN, dev->dev_addr);
517 netdev_warn(dev, "Expected addr: %*ph\n",
518 MAX_ADDR_LEN, dev->dev_addr_shadow);
519 netdev_WARN(dev, "Incorrect netdev->dev_addr\n");
520}
521
522/**
523 * dev_addr_flush - Flush device address list
524 * @dev: device
525 *
526 * Flush device address list and reset ->dev_addr.
527 *
528 * The caller must hold the rtnl_mutex.
529 */
530void dev_addr_flush(struct net_device *dev)
531{
532 /* rtnl_mutex must be held here */
533 dev_addr_check(dev);
534
535 __hw_addr_flush(&dev->dev_addrs);
536 dev->dev_addr = NULL;
537}
538
539/**
540 * dev_addr_init - Init device address list
541 * @dev: device
542 *
543 * Init device address list and create the first element,
544 * used by ->dev_addr.
545 *
546 * The caller must hold the rtnl_mutex.
547 */
548int dev_addr_init(struct net_device *dev)
549{
550 unsigned char addr[MAX_ADDR_LEN];
551 struct netdev_hw_addr *ha;
552 int err;
553
554 /* rtnl_mutex must be held here */
555
556 __hw_addr_init(&dev->dev_addrs);
557 memset(addr, 0, sizeof(addr));
558 err = __hw_addr_add(&dev->dev_addrs, addr, sizeof(addr),
559 NETDEV_HW_ADDR_T_LAN);
560 if (!err) {
561 /*
562 * Get the first (previously created) address from the list
563 * and set dev_addr pointer to this location.
564 */
565 ha = list_first_entry(&dev->dev_addrs.list,
566 struct netdev_hw_addr, list);
567 dev->dev_addr = ha->addr;
568 }
569 return err;
570}
571
572void dev_addr_mod(struct net_device *dev, unsigned int offset,
573 const void *addr, size_t len)
574{
575 struct netdev_hw_addr *ha;
576
577 dev_addr_check(dev);
578
579 ha = container_of(dev->dev_addr, struct netdev_hw_addr, addr[0]);
580 rb_erase(&ha->node, &dev->dev_addrs.tree);
581 memcpy(&ha->addr[offset], addr, len);
582 memcpy(&dev->dev_addr_shadow[offset], addr, len);
583 WARN_ON(__hw_addr_insert(&dev->dev_addrs, ha, dev->addr_len));
584}
585EXPORT_SYMBOL(dev_addr_mod);
586
587/**
588 * dev_addr_add - Add a device address
589 * @dev: device
590 * @addr: address to add
591 * @addr_type: address type
592 *
593 * Add a device address to the device or increase the reference count if
594 * it already exists.
595 *
596 * The caller must hold the rtnl_mutex.
597 */
598int dev_addr_add(struct net_device *dev, const unsigned char *addr,
599 unsigned char addr_type)
600{
601 int err;
602
603 ASSERT_RTNL();
604
605 err = dev_pre_changeaddr_notify(dev, addr, NULL);
606 if (err)
607 return err;
608 err = __hw_addr_add(&dev->dev_addrs, addr, dev->addr_len, addr_type);
609 if (!err)
610 call_netdevice_notifiers(NETDEV_CHANGEADDR, dev);
611 return err;
612}
613EXPORT_SYMBOL(dev_addr_add);
614
615/**
616 * dev_addr_del - Release a device address.
617 * @dev: device
618 * @addr: address to delete
619 * @addr_type: address type
620 *
621 * Release reference to a device address and remove it from the device
622 * if the reference count drops to zero.
623 *
624 * The caller must hold the rtnl_mutex.
625 */
626int dev_addr_del(struct net_device *dev, const unsigned char *addr,
627 unsigned char addr_type)
628{
629 int err;
630 struct netdev_hw_addr *ha;
631
632 ASSERT_RTNL();
633
634 /*
635 * We can not remove the first address from the list because
636 * dev->dev_addr points to that.
637 */
638 ha = list_first_entry(&dev->dev_addrs.list,
639 struct netdev_hw_addr, list);
640 if (!memcmp(ha->addr, addr, dev->addr_len) &&
641 ha->type == addr_type && ha->refcount == 1)
642 return -ENOENT;
643
644 err = __hw_addr_del(&dev->dev_addrs, addr, dev->addr_len,
645 addr_type);
646 if (!err)
647 call_netdevice_notifiers(NETDEV_CHANGEADDR, dev);
648 return err;
649}
650EXPORT_SYMBOL(dev_addr_del);
651
652/*
653 * Unicast list handling functions
654 */
655
656/**
657 * dev_uc_add_excl - Add a global secondary unicast address
658 * @dev: device
659 * @addr: address to add
660 */
661int dev_uc_add_excl(struct net_device *dev, const unsigned char *addr)
662{
663 int err;
664
665 netif_addr_lock_bh(dev);
666 err = __hw_addr_add_ex(&dev->uc, addr, dev->addr_len,
667 NETDEV_HW_ADDR_T_UNICAST, true, false,
668 0, true);
669 if (!err)
670 __dev_set_rx_mode(dev);
671 netif_addr_unlock_bh(dev);
672 return err;
673}
674EXPORT_SYMBOL(dev_uc_add_excl);
675
676/**
677 * dev_uc_add - Add a secondary unicast address
678 * @dev: device
679 * @addr: address to add
680 *
681 * Add a secondary unicast address to the device or increase
682 * the reference count if it already exists.
683 */
684int dev_uc_add(struct net_device *dev, const unsigned char *addr)
685{
686 int err;
687
688 netif_addr_lock_bh(dev);
689 err = __hw_addr_add(&dev->uc, addr, dev->addr_len,
690 NETDEV_HW_ADDR_T_UNICAST);
691 if (!err)
692 __dev_set_rx_mode(dev);
693 netif_addr_unlock_bh(dev);
694 return err;
695}
696EXPORT_SYMBOL(dev_uc_add);
697
698/**
699 * dev_uc_del - Release secondary unicast address.
700 * @dev: device
701 * @addr: address to delete
702 *
703 * Release reference to a secondary unicast address and remove it
704 * from the device if the reference count drops to zero.
705 */
706int dev_uc_del(struct net_device *dev, const unsigned char *addr)
707{
708 int err;
709
710 netif_addr_lock_bh(dev);
711 err = __hw_addr_del(&dev->uc, addr, dev->addr_len,
712 NETDEV_HW_ADDR_T_UNICAST);
713 if (!err)
714 __dev_set_rx_mode(dev);
715 netif_addr_unlock_bh(dev);
716 return err;
717}
718EXPORT_SYMBOL(dev_uc_del);
719
720/**
721 * dev_uc_sync - Synchronize device's unicast list to another device
722 * @to: destination device
723 * @from: source device
724 *
725 * Add newly added addresses to the destination device and release
726 * addresses that have no users left. The source device must be
727 * locked by netif_addr_lock_bh.
728 *
729 * This function is intended to be called from the dev->set_rx_mode
730 * function of layered software devices. This function assumes that
731 * addresses will only ever be synced to the @to devices and no other.
732 */
733int dev_uc_sync(struct net_device *to, struct net_device *from)
734{
735 int err = 0;
736
737 if (to->addr_len != from->addr_len)
738 return -EINVAL;
739
740 netif_addr_lock(to);
741 err = __hw_addr_sync(&to->uc, &from->uc, to->addr_len);
742 if (!err)
743 __dev_set_rx_mode(to);
744 netif_addr_unlock(to);
745 return err;
746}
747EXPORT_SYMBOL(dev_uc_sync);
748
749/**
750 * dev_uc_sync_multiple - Synchronize device's unicast list to another
751 * device, but allow for multiple calls to sync to multiple devices.
752 * @to: destination device
753 * @from: source device
754 *
755 * Add newly added addresses to the destination device and release
756 * addresses that have been deleted from the source. The source device
757 * must be locked by netif_addr_lock_bh.
758 *
759 * This function is intended to be called from the dev->set_rx_mode
760 * function of layered software devices. It allows for a single source
761 * device to be synced to multiple destination devices.
762 */
763int dev_uc_sync_multiple(struct net_device *to, struct net_device *from)
764{
765 int err = 0;
766
767 if (to->addr_len != from->addr_len)
768 return -EINVAL;
769
770 netif_addr_lock(to);
771 err = __hw_addr_sync_multiple(&to->uc, &from->uc, to->addr_len);
772 if (!err)
773 __dev_set_rx_mode(to);
774 netif_addr_unlock(to);
775 return err;
776}
777EXPORT_SYMBOL(dev_uc_sync_multiple);
778
779/**
780 * dev_uc_unsync - Remove synchronized addresses from the destination device
781 * @to: destination device
782 * @from: source device
783 *
784 * Remove all addresses that were added to the destination device by
785 * dev_uc_sync(). This function is intended to be called from the
786 * dev->stop function of layered software devices.
787 */
788void dev_uc_unsync(struct net_device *to, struct net_device *from)
789{
790 if (to->addr_len != from->addr_len)
791 return;
792
793 /* netif_addr_lock_bh() uses lockdep subclass 0, this is okay for two
794 * reasons:
795 * 1) This is always called without any addr_list_lock, so as the
796 * outermost one here, it must be 0.
797 * 2) This is called by some callers after unlinking the upper device,
798 * so the dev->lower_level becomes 1 again.
799 * Therefore, the subclass for 'from' is 0, for 'to' is either 1 or
800 * larger.
801 */
802 netif_addr_lock_bh(from);
803 netif_addr_lock(to);
804 __hw_addr_unsync(&to->uc, &from->uc, to->addr_len);
805 __dev_set_rx_mode(to);
806 netif_addr_unlock(to);
807 netif_addr_unlock_bh(from);
808}
809EXPORT_SYMBOL(dev_uc_unsync);
810
811/**
812 * dev_uc_flush - Flush unicast addresses
813 * @dev: device
814 *
815 * Flush unicast addresses.
816 */
817void dev_uc_flush(struct net_device *dev)
818{
819 netif_addr_lock_bh(dev);
820 __hw_addr_flush(&dev->uc);
821 netif_addr_unlock_bh(dev);
822}
823EXPORT_SYMBOL(dev_uc_flush);
824
825/**
826 * dev_uc_init - Init unicast address list
827 * @dev: device
828 *
829 * Init unicast address list.
830 */
831void dev_uc_init(struct net_device *dev)
832{
833 __hw_addr_init(&dev->uc);
834}
835EXPORT_SYMBOL(dev_uc_init);
836
837/*
838 * Multicast list handling functions
839 */
840
841/**
842 * dev_mc_add_excl - Add a global secondary multicast address
843 * @dev: device
844 * @addr: address to add
845 */
846int dev_mc_add_excl(struct net_device *dev, const unsigned char *addr)
847{
848 int err;
849
850 netif_addr_lock_bh(dev);
851 err = __hw_addr_add_ex(&dev->mc, addr, dev->addr_len,
852 NETDEV_HW_ADDR_T_MULTICAST, true, false,
853 0, true);
854 if (!err)
855 __dev_set_rx_mode(dev);
856 netif_addr_unlock_bh(dev);
857 return err;
858}
859EXPORT_SYMBOL(dev_mc_add_excl);
860
861static int __dev_mc_add(struct net_device *dev, const unsigned char *addr,
862 bool global)
863{
864 int err;
865
866 netif_addr_lock_bh(dev);
867 err = __hw_addr_add_ex(&dev->mc, addr, dev->addr_len,
868 NETDEV_HW_ADDR_T_MULTICAST, global, false,
869 0, false);
870 if (!err)
871 __dev_set_rx_mode(dev);
872 netif_addr_unlock_bh(dev);
873 return err;
874}
875/**
876 * dev_mc_add - Add a multicast address
877 * @dev: device
878 * @addr: address to add
879 *
880 * Add a multicast address to the device or increase
881 * the reference count if it already exists.
882 */
883int dev_mc_add(struct net_device *dev, const unsigned char *addr)
884{
885 return __dev_mc_add(dev, addr, false);
886}
887EXPORT_SYMBOL(dev_mc_add);
888
889/**
890 * dev_mc_add_global - Add a global multicast address
891 * @dev: device
892 * @addr: address to add
893 *
894 * Add a global multicast address to the device.
895 */
896int dev_mc_add_global(struct net_device *dev, const unsigned char *addr)
897{
898 return __dev_mc_add(dev, addr, true);
899}
900EXPORT_SYMBOL(dev_mc_add_global);
901
902static int __dev_mc_del(struct net_device *dev, const unsigned char *addr,
903 bool global)
904{
905 int err;
906
907 netif_addr_lock_bh(dev);
908 err = __hw_addr_del_ex(&dev->mc, addr, dev->addr_len,
909 NETDEV_HW_ADDR_T_MULTICAST, global, false);
910 if (!err)
911 __dev_set_rx_mode(dev);
912 netif_addr_unlock_bh(dev);
913 return err;
914}
915
916/**
917 * dev_mc_del - Delete a multicast address.
918 * @dev: device
919 * @addr: address to delete
920 *
921 * Release reference to a multicast address and remove it
922 * from the device if the reference count drops to zero.
923 */
924int dev_mc_del(struct net_device *dev, const unsigned char *addr)
925{
926 return __dev_mc_del(dev, addr, false);
927}
928EXPORT_SYMBOL(dev_mc_del);
929
930/**
931 * dev_mc_del_global - Delete a global multicast address.
932 * @dev: device
933 * @addr: address to delete
934 *
935 * Release reference to a multicast address and remove it
936 * from the device if the reference count drops to zero.
937 */
938int dev_mc_del_global(struct net_device *dev, const unsigned char *addr)
939{
940 return __dev_mc_del(dev, addr, true);
941}
942EXPORT_SYMBOL(dev_mc_del_global);
943
944/**
945 * dev_mc_sync - Synchronize device's multicast list to another device
946 * @to: destination device
947 * @from: source device
948 *
949 * Add newly added addresses to the destination device and release
950 * addresses that have no users left. The source device must be
951 * locked by netif_addr_lock_bh.
952 *
953 * This function is intended to be called from the ndo_set_rx_mode
954 * function of layered software devices.
955 */
956int dev_mc_sync(struct net_device *to, struct net_device *from)
957{
958 int err = 0;
959
960 if (to->addr_len != from->addr_len)
961 return -EINVAL;
962
963 netif_addr_lock(to);
964 err = __hw_addr_sync(&to->mc, &from->mc, to->addr_len);
965 if (!err)
966 __dev_set_rx_mode(to);
967 netif_addr_unlock(to);
968 return err;
969}
970EXPORT_SYMBOL(dev_mc_sync);
971
972/**
973 * dev_mc_sync_multiple - Synchronize device's multicast list to another
974 * device, but allow for multiple calls to sync to multiple devices.
975 * @to: destination device
976 * @from: source device
977 *
978 * Add newly added addresses to the destination device and release
979 * addresses that have no users left. The source device must be
980 * locked by netif_addr_lock_bh.
981 *
982 * This function is intended to be called from the ndo_set_rx_mode
983 * function of layered software devices. It allows for a single
984 * source device to be synced to multiple destination devices.
985 */
986int dev_mc_sync_multiple(struct net_device *to, struct net_device *from)
987{
988 int err = 0;
989
990 if (to->addr_len != from->addr_len)
991 return -EINVAL;
992
993 netif_addr_lock(to);
994 err = __hw_addr_sync_multiple(&to->mc, &from->mc, to->addr_len);
995 if (!err)
996 __dev_set_rx_mode(to);
997 netif_addr_unlock(to);
998 return err;
999}
1000EXPORT_SYMBOL(dev_mc_sync_multiple);
1001
1002/**
1003 * dev_mc_unsync - Remove synchronized addresses from the destination device
1004 * @to: destination device
1005 * @from: source device
1006 *
1007 * Remove all addresses that were added to the destination device by
1008 * dev_mc_sync(). This function is intended to be called from the
1009 * dev->stop function of layered software devices.
1010 */
1011void dev_mc_unsync(struct net_device *to, struct net_device *from)
1012{
1013 if (to->addr_len != from->addr_len)
1014 return;
1015
1016 /* See the above comments inside dev_uc_unsync(). */
1017 netif_addr_lock_bh(from);
1018 netif_addr_lock(to);
1019 __hw_addr_unsync(&to->mc, &from->mc, to->addr_len);
1020 __dev_set_rx_mode(to);
1021 netif_addr_unlock(to);
1022 netif_addr_unlock_bh(from);
1023}
1024EXPORT_SYMBOL(dev_mc_unsync);
1025
1026/**
1027 * dev_mc_flush - Flush multicast addresses
1028 * @dev: device
1029 *
1030 * Flush multicast addresses.
1031 */
1032void dev_mc_flush(struct net_device *dev)
1033{
1034 netif_addr_lock_bh(dev);
1035 __hw_addr_flush(&dev->mc);
1036 netif_addr_unlock_bh(dev);
1037}
1038EXPORT_SYMBOL(dev_mc_flush);
1039
1040/**
1041 * dev_mc_init - Init multicast address list
1042 * @dev: device
1043 *
1044 * Init multicast address list.
1045 */
1046void dev_mc_init(struct net_device *dev)
1047{
1048 __hw_addr_init(&dev->mc);
1049}
1050EXPORT_SYMBOL(dev_mc_init);