1 // SPDX-License-Identifier: GPL-2.0-or-later
4 * Linux ethernet bridge
7 * Lennert Buytenhek <buytenh@gnu.org>
10 #include <linux/kernel.h>
11 #include <linux/init.h>
12 #include <linux/rculist.h>
13 #include <linux/spinlock.h>
14 #include <linux/times.h>
15 #include <linux/netdevice.h>
16 #include <linux/etherdevice.h>
17 #include <linux/jhash.h>
18 #include <linux/random.h>
19 #include <linux/slab.h>
20 #include <linux/atomic.h>
21 #include <asm/unaligned.h>
22 #include <linux/if_vlan.h>
23 #include <net/switchdev.h>
24 #include <trace/events/bridge.h>
25 #include "br_private.h"
27 static const struct rhashtable_params br_fdb_rht_params = {
28 .head_offset = offsetof(struct net_bridge_fdb_entry, rhnode),
29 .key_offset = offsetof(struct net_bridge_fdb_entry, key),
30 .key_len = sizeof(struct net_bridge_fdb_key),
31 .automatic_shrinking = true,
34 static struct kmem_cache *br_fdb_cache __read_mostly;
36 int __init br_fdb_init(void)
38 br_fdb_cache = kmem_cache_create("bridge_fdb_cache",
39 sizeof(struct net_bridge_fdb_entry),
41 SLAB_HWCACHE_ALIGN, NULL);
48 void br_fdb_fini(void)
50 kmem_cache_destroy(br_fdb_cache);
53 int br_fdb_hash_init(struct net_bridge *br)
55 return rhashtable_init(&br->fdb_hash_tbl, &br_fdb_rht_params);
58 void br_fdb_hash_fini(struct net_bridge *br)
60 rhashtable_destroy(&br->fdb_hash_tbl);
63 /* if topology_changing then use forward_delay (default 15 sec)
64 * otherwise keep longer (default 5 minutes)
66 static inline unsigned long hold_time(const struct net_bridge *br)
68 return br->topology_change ? br->forward_delay : br->ageing_time;
71 static inline int has_expired(const struct net_bridge *br,
72 const struct net_bridge_fdb_entry *fdb)
74 return !test_bit(BR_FDB_STATIC, &fdb->flags) &&
75 !test_bit(BR_FDB_ADDED_BY_EXT_LEARN, &fdb->flags) &&
76 time_before_eq(fdb->updated + hold_time(br), jiffies);
79 static void fdb_rcu_free(struct rcu_head *head)
81 struct net_bridge_fdb_entry *ent
82 = container_of(head, struct net_bridge_fdb_entry, rcu);
83 kmem_cache_free(br_fdb_cache, ent);
86 static int fdb_to_nud(const struct net_bridge *br,
87 const struct net_bridge_fdb_entry *fdb)
89 if (test_bit(BR_FDB_LOCAL, &fdb->flags))
91 else if (test_bit(BR_FDB_STATIC, &fdb->flags))
93 else if (has_expired(br, fdb))
99 static int fdb_fill_info(struct sk_buff *skb, const struct net_bridge *br,
100 const struct net_bridge_fdb_entry *fdb,
101 u32 portid, u32 seq, int type, unsigned int flags)
103 const struct net_bridge_port *dst = READ_ONCE(fdb->dst);
104 unsigned long now = jiffies;
105 struct nda_cacheinfo ci;
106 struct nlmsghdr *nlh;
109 nlh = nlmsg_put(skb, portid, seq, type, sizeof(*ndm), flags);
113 ndm = nlmsg_data(nlh);
114 ndm->ndm_family = AF_BRIDGE;
119 ndm->ndm_ifindex = dst ? dst->dev->ifindex : br->dev->ifindex;
120 ndm->ndm_state = fdb_to_nud(br, fdb);
122 if (test_bit(BR_FDB_OFFLOADED, &fdb->flags))
123 ndm->ndm_flags |= NTF_OFFLOADED;
124 if (test_bit(BR_FDB_ADDED_BY_EXT_LEARN, &fdb->flags))
125 ndm->ndm_flags |= NTF_EXT_LEARNED;
126 if (test_bit(BR_FDB_STICKY, &fdb->flags))
127 ndm->ndm_flags |= NTF_STICKY;
129 if (nla_put(skb, NDA_LLADDR, ETH_ALEN, &fdb->key.addr))
130 goto nla_put_failure;
131 if (nla_put_u32(skb, NDA_MASTER, br->dev->ifindex))
132 goto nla_put_failure;
133 ci.ndm_used = jiffies_to_clock_t(now - fdb->used);
134 ci.ndm_confirmed = 0;
135 ci.ndm_updated = jiffies_to_clock_t(now - fdb->updated);
137 if (nla_put(skb, NDA_CACHEINFO, sizeof(ci), &ci))
138 goto nla_put_failure;
140 if (fdb->key.vlan_id && nla_put(skb, NDA_VLAN, sizeof(u16),
142 goto nla_put_failure;
144 if (test_bit(BR_FDB_NOTIFY, &fdb->flags)) {
145 struct nlattr *nest = nla_nest_start(skb, NDA_FDB_EXT_ATTRS);
146 u8 notify_bits = FDB_NOTIFY_BIT;
149 goto nla_put_failure;
150 if (test_bit(BR_FDB_NOTIFY_INACTIVE, &fdb->flags))
151 notify_bits |= FDB_NOTIFY_INACTIVE_BIT;
153 if (nla_put_u8(skb, NFEA_ACTIVITY_NOTIFY, notify_bits)) {
154 nla_nest_cancel(skb, nest);
155 goto nla_put_failure;
158 nla_nest_end(skb, nest);
165 nlmsg_cancel(skb, nlh);
169 static inline size_t fdb_nlmsg_size(void)
171 return NLMSG_ALIGN(sizeof(struct ndmsg))
172 + nla_total_size(ETH_ALEN) /* NDA_LLADDR */
173 + nla_total_size(sizeof(u32)) /* NDA_MASTER */
174 + nla_total_size(sizeof(u16)) /* NDA_VLAN */
175 + nla_total_size(sizeof(struct nda_cacheinfo))
176 + nla_total_size(0) /* NDA_FDB_EXT_ATTRS */
177 + nla_total_size(sizeof(u8)); /* NFEA_ACTIVITY_NOTIFY */
180 static void fdb_notify(struct net_bridge *br,
181 const struct net_bridge_fdb_entry *fdb, int type,
184 struct net *net = dev_net(br->dev);
189 br_switchdev_fdb_notify(br, fdb, type);
191 skb = nlmsg_new(fdb_nlmsg_size(), GFP_ATOMIC);
195 err = fdb_fill_info(skb, br, fdb, 0, 0, type, 0);
197 /* -EMSGSIZE implies BUG in fdb_nlmsg_size() */
198 WARN_ON(err == -EMSGSIZE);
202 rtnl_notify(skb, net, 0, RTNLGRP_NEIGH, NULL, GFP_ATOMIC);
205 rtnl_set_sk_err(net, RTNLGRP_NEIGH, err);
208 static struct net_bridge_fdb_entry *fdb_find_rcu(struct rhashtable *tbl,
209 const unsigned char *addr,
212 struct net_bridge_fdb_key key;
214 WARN_ON_ONCE(!rcu_read_lock_held());
217 memcpy(key.addr.addr, addr, sizeof(key.addr.addr));
219 return rhashtable_lookup(tbl, &key, br_fdb_rht_params);
222 /* requires bridge hash_lock */
223 static struct net_bridge_fdb_entry *br_fdb_find(struct net_bridge *br,
224 const unsigned char *addr,
227 struct net_bridge_fdb_entry *fdb;
229 lockdep_assert_held_once(&br->hash_lock);
232 fdb = fdb_find_rcu(&br->fdb_hash_tbl, addr, vid);
238 struct net_device *br_fdb_find_port(const struct net_device *br_dev,
239 const unsigned char *addr,
242 struct net_bridge_fdb_entry *f;
243 struct net_device *dev = NULL;
244 struct net_bridge *br;
248 if (!netif_is_bridge_master(br_dev))
251 br = netdev_priv(br_dev);
253 f = br_fdb_find_rcu(br, addr, vid);
260 EXPORT_SYMBOL_GPL(br_fdb_find_port);
262 struct net_bridge_fdb_entry *br_fdb_find_rcu(struct net_bridge *br,
263 const unsigned char *addr,
266 return fdb_find_rcu(&br->fdb_hash_tbl, addr, vid);
269 /* When a static FDB entry is added, the mac address from the entry is
270 * added to the bridge private HW address list and all required ports
271 * are then updated with the new information.
274 static void fdb_add_hw_addr(struct net_bridge *br, const unsigned char *addr)
277 struct net_bridge_port *p;
281 list_for_each_entry(p, &br->port_list, list) {
282 if (!br_promisc_port(p)) {
283 err = dev_uc_add(p->dev, addr);
291 list_for_each_entry_continue_reverse(p, &br->port_list, list) {
292 if (!br_promisc_port(p))
293 dev_uc_del(p->dev, addr);
297 /* When a static FDB entry is deleted, the HW address from that entry is
298 * also removed from the bridge private HW address list and updates all
299 * the ports with needed information.
302 static void fdb_del_hw_addr(struct net_bridge *br, const unsigned char *addr)
304 struct net_bridge_port *p;
308 list_for_each_entry(p, &br->port_list, list) {
309 if (!br_promisc_port(p))
310 dev_uc_del(p->dev, addr);
314 static void fdb_delete(struct net_bridge *br, struct net_bridge_fdb_entry *f,
317 trace_fdb_delete(br, f);
319 if (test_bit(BR_FDB_STATIC, &f->flags))
320 fdb_del_hw_addr(br, f->key.addr.addr);
322 hlist_del_init_rcu(&f->fdb_node);
323 rhashtable_remove_fast(&br->fdb_hash_tbl, &f->rhnode,
325 fdb_notify(br, f, RTM_DELNEIGH, swdev_notify);
326 call_rcu(&f->rcu, fdb_rcu_free);
329 /* Delete a local entry if no other port had the same address. */
330 static void fdb_delete_local(struct net_bridge *br,
331 const struct net_bridge_port *p,
332 struct net_bridge_fdb_entry *f)
334 const unsigned char *addr = f->key.addr.addr;
335 struct net_bridge_vlan_group *vg;
336 const struct net_bridge_vlan *v;
337 struct net_bridge_port *op;
338 u16 vid = f->key.vlan_id;
340 /* Maybe another port has same hw addr? */
341 list_for_each_entry(op, &br->port_list, list) {
342 vg = nbp_vlan_group(op);
343 if (op != p && ether_addr_equal(op->dev->dev_addr, addr) &&
344 (!vid || br_vlan_find(vg, vid))) {
346 clear_bit(BR_FDB_ADDED_BY_USER, &f->flags);
351 vg = br_vlan_group(br);
352 v = br_vlan_find(vg, vid);
353 /* Maybe bridge device has same hw addr? */
354 if (p && ether_addr_equal(br->dev->dev_addr, addr) &&
355 (!vid || (v && br_vlan_should_use(v)))) {
357 clear_bit(BR_FDB_ADDED_BY_USER, &f->flags);
361 fdb_delete(br, f, true);
364 void br_fdb_find_delete_local(struct net_bridge *br,
365 const struct net_bridge_port *p,
366 const unsigned char *addr, u16 vid)
368 struct net_bridge_fdb_entry *f;
370 spin_lock_bh(&br->hash_lock);
371 f = br_fdb_find(br, addr, vid);
372 if (f && test_bit(BR_FDB_LOCAL, &f->flags) &&
373 !test_bit(BR_FDB_ADDED_BY_USER, &f->flags) && f->dst == p)
374 fdb_delete_local(br, p, f);
375 spin_unlock_bh(&br->hash_lock);
378 static struct net_bridge_fdb_entry *fdb_create(struct net_bridge *br,
379 struct net_bridge_port *source,
380 const unsigned char *addr,
384 struct net_bridge_fdb_entry *fdb;
387 fdb = kmem_cache_alloc(br_fdb_cache, GFP_ATOMIC);
391 memcpy(fdb->key.addr.addr, addr, ETH_ALEN);
392 WRITE_ONCE(fdb->dst, source);
393 fdb->key.vlan_id = vid;
395 fdb->updated = fdb->used = jiffies;
396 err = rhashtable_lookup_insert_fast(&br->fdb_hash_tbl, &fdb->rhnode,
399 kmem_cache_free(br_fdb_cache, fdb);
403 hlist_add_head_rcu(&fdb->fdb_node, &br->fdb_list);
408 static int fdb_add_local(struct net_bridge *br, struct net_bridge_port *source,
409 const unsigned char *addr, u16 vid)
411 struct net_bridge_fdb_entry *fdb;
413 if (!is_valid_ether_addr(addr))
416 fdb = br_fdb_find(br, addr, vid);
418 /* it is okay to have multiple ports with same
419 * address, just use the first one.
421 if (test_bit(BR_FDB_LOCAL, &fdb->flags))
423 br_warn(br, "adding interface %s with same address as a received packet (addr:%pM, vlan:%u)\n",
424 source ? source->dev->name : br->dev->name, addr, vid);
425 fdb_delete(br, fdb, true);
428 fdb = fdb_create(br, source, addr, vid,
429 BIT(BR_FDB_LOCAL) | BIT(BR_FDB_STATIC));
433 fdb_add_hw_addr(br, addr);
434 fdb_notify(br, fdb, RTM_NEWNEIGH, true);
438 void br_fdb_changeaddr(struct net_bridge_port *p, const unsigned char *newaddr)
440 struct net_bridge_vlan_group *vg;
441 struct net_bridge_fdb_entry *f;
442 struct net_bridge *br = p->br;
443 struct net_bridge_vlan *v;
445 spin_lock_bh(&br->hash_lock);
446 vg = nbp_vlan_group(p);
447 hlist_for_each_entry(f, &br->fdb_list, fdb_node) {
448 if (f->dst == p && test_bit(BR_FDB_LOCAL, &f->flags) &&
449 !test_bit(BR_FDB_ADDED_BY_USER, &f->flags)) {
451 fdb_delete_local(br, p, f);
453 /* if this port has no vlan information
454 * configured, we can safely be done at
457 if (!vg || !vg->num_vlans)
463 /* insert new address, may fail if invalid address or dup. */
464 fdb_add_local(br, p, newaddr, 0);
466 if (!vg || !vg->num_vlans)
469 /* Now add entries for every VLAN configured on the port.
470 * This function runs under RTNL so the bitmap will not change
473 list_for_each_entry(v, &vg->vlan_list, vlist)
474 fdb_add_local(br, p, newaddr, v->vid);
477 spin_unlock_bh(&br->hash_lock);
480 void br_fdb_change_mac_address(struct net_bridge *br, const u8 *newaddr)
482 struct net_bridge_vlan_group *vg;
483 struct net_bridge_fdb_entry *f;
484 struct net_bridge_vlan *v;
486 spin_lock_bh(&br->hash_lock);
488 /* If old entry was unassociated with any port, then delete it. */
489 f = br_fdb_find(br, br->dev->dev_addr, 0);
490 if (f && test_bit(BR_FDB_LOCAL, &f->flags) &&
491 !f->dst && !test_bit(BR_FDB_ADDED_BY_USER, &f->flags))
492 fdb_delete_local(br, NULL, f);
494 fdb_add_local(br, NULL, newaddr, 0);
495 vg = br_vlan_group(br);
496 if (!vg || !vg->num_vlans)
498 /* Now remove and add entries for every VLAN configured on the
499 * bridge. This function runs under RTNL so the bitmap will not
500 * change from under us.
502 list_for_each_entry(v, &vg->vlan_list, vlist) {
503 if (!br_vlan_should_use(v))
505 f = br_fdb_find(br, br->dev->dev_addr, v->vid);
506 if (f && test_bit(BR_FDB_LOCAL, &f->flags) &&
507 !f->dst && !test_bit(BR_FDB_ADDED_BY_USER, &f->flags))
508 fdb_delete_local(br, NULL, f);
509 fdb_add_local(br, NULL, newaddr, v->vid);
512 spin_unlock_bh(&br->hash_lock);
515 void br_fdb_cleanup(struct work_struct *work)
517 struct net_bridge *br = container_of(work, struct net_bridge,
519 struct net_bridge_fdb_entry *f = NULL;
520 unsigned long delay = hold_time(br);
521 unsigned long work_delay = delay;
522 unsigned long now = jiffies;
524 /* this part is tricky, in order to avoid blocking learning and
525 * consequently forwarding, we rely on rcu to delete objects with
526 * delayed freeing allowing us to continue traversing
529 hlist_for_each_entry_rcu(f, &br->fdb_list, fdb_node) {
530 unsigned long this_timer = f->updated + delay;
532 if (test_bit(BR_FDB_STATIC, &f->flags) ||
533 test_bit(BR_FDB_ADDED_BY_EXT_LEARN, &f->flags)) {
534 if (test_bit(BR_FDB_NOTIFY, &f->flags)) {
535 if (time_after(this_timer, now))
536 work_delay = min(work_delay,
538 else if (!test_and_set_bit(BR_FDB_NOTIFY_INACTIVE,
540 fdb_notify(br, f, RTM_NEWNEIGH, false);
545 if (time_after(this_timer, now)) {
546 work_delay = min(work_delay, this_timer - now);
548 spin_lock_bh(&br->hash_lock);
549 if (!hlist_unhashed(&f->fdb_node))
550 fdb_delete(br, f, true);
551 spin_unlock_bh(&br->hash_lock);
556 /* Cleanup minimum 10 milliseconds apart */
557 work_delay = max_t(unsigned long, work_delay, msecs_to_jiffies(10));
558 mod_delayed_work(system_long_wq, &br->gc_work, work_delay);
561 /* Completely flush all dynamic entries in forwarding database.*/
562 void br_fdb_flush(struct net_bridge *br)
564 struct net_bridge_fdb_entry *f;
565 struct hlist_node *tmp;
567 spin_lock_bh(&br->hash_lock);
568 hlist_for_each_entry_safe(f, tmp, &br->fdb_list, fdb_node) {
569 if (!test_bit(BR_FDB_STATIC, &f->flags))
570 fdb_delete(br, f, true);
572 spin_unlock_bh(&br->hash_lock);
575 /* Flush all entries referring to a specific port.
576 * if do_all is set also flush static entries
577 * if vid is set delete all entries that match the vlan_id
579 void br_fdb_delete_by_port(struct net_bridge *br,
580 const struct net_bridge_port *p,
584 struct net_bridge_fdb_entry *f;
585 struct hlist_node *tmp;
587 spin_lock_bh(&br->hash_lock);
588 hlist_for_each_entry_safe(f, tmp, &br->fdb_list, fdb_node) {
593 if (test_bit(BR_FDB_STATIC, &f->flags) ||
594 (test_bit(BR_FDB_ADDED_BY_EXT_LEARN, &f->flags) &&
595 !test_bit(BR_FDB_OFFLOADED, &f->flags)) ||
596 (vid && f->key.vlan_id != vid))
599 if (test_bit(BR_FDB_LOCAL, &f->flags))
600 fdb_delete_local(br, p, f);
602 fdb_delete(br, f, true);
604 spin_unlock_bh(&br->hash_lock);
607 #if IS_ENABLED(CONFIG_ATM_LANE)
608 /* Interface used by ATM LANE hook to test
609 * if an addr is on some other bridge port */
610 int br_fdb_test_addr(struct net_device *dev, unsigned char *addr)
612 struct net_bridge_fdb_entry *fdb;
613 struct net_bridge_port *port;
617 port = br_port_get_rcu(dev);
621 const struct net_bridge_port *dst = NULL;
623 fdb = br_fdb_find_rcu(port->br, addr, 0);
625 dst = READ_ONCE(fdb->dst);
627 ret = dst && dst->dev != dev &&
628 dst->state == BR_STATE_FORWARDING;
634 #endif /* CONFIG_ATM_LANE */
637 * Fill buffer with forwarding table records in
640 int br_fdb_fillbuf(struct net_bridge *br, void *buf,
641 unsigned long maxnum, unsigned long skip)
643 struct net_bridge_fdb_entry *f;
644 struct __fdb_entry *fe = buf;
647 memset(buf, 0, maxnum*sizeof(struct __fdb_entry));
650 hlist_for_each_entry_rcu(f, &br->fdb_list, fdb_node) {
654 if (has_expired(br, f))
657 /* ignore pseudo entry for local MAC address */
666 /* convert from internal format to API */
667 memcpy(fe->mac_addr, f->key.addr.addr, ETH_ALEN);
669 /* due to ABI compat need to split into hi/lo */
670 fe->port_no = f->dst->port_no;
671 fe->port_hi = f->dst->port_no >> 8;
673 fe->is_local = test_bit(BR_FDB_LOCAL, &f->flags);
674 if (!test_bit(BR_FDB_STATIC, &f->flags))
675 fe->ageing_timer_value = jiffies_delta_to_clock_t(jiffies - f->updated);
684 /* Add entry for local address of interface */
685 int br_fdb_add_local(struct net_bridge *br, struct net_bridge_port *source,
686 const unsigned char *addr, u16 vid)
690 spin_lock_bh(&br->hash_lock);
691 ret = fdb_add_local(br, source, addr, vid);
692 spin_unlock_bh(&br->hash_lock);
696 /* returns true if the fdb was modified */
697 static bool __fdb_mark_active(struct net_bridge_fdb_entry *fdb)
699 return !!(test_bit(BR_FDB_NOTIFY_INACTIVE, &fdb->flags) &&
700 test_and_clear_bit(BR_FDB_NOTIFY_INACTIVE, &fdb->flags));
703 void br_fdb_update(struct net_bridge *br, struct net_bridge_port *source,
704 const unsigned char *addr, u16 vid, unsigned long flags)
706 struct net_bridge_fdb_entry *fdb;
708 /* some users want to always flood. */
709 if (hold_time(br) == 0)
712 fdb = fdb_find_rcu(&br->fdb_hash_tbl, addr, vid);
714 /* attempt to update an entry for a local interface */
715 if (unlikely(test_bit(BR_FDB_LOCAL, &fdb->flags))) {
717 br_warn(br, "received packet on %s with own address as source address (addr:%pM, vlan:%u)\n",
718 source->dev->name, addr, vid);
720 unsigned long now = jiffies;
721 bool fdb_modified = false;
723 if (now != fdb->updated) {
725 fdb_modified = __fdb_mark_active(fdb);
728 /* fastpath: update of existing entry */
729 if (unlikely(source != READ_ONCE(fdb->dst) &&
730 !test_bit(BR_FDB_STICKY, &fdb->flags))) {
731 br_switchdev_fdb_notify(br, fdb, RTM_DELNEIGH);
732 WRITE_ONCE(fdb->dst, source);
734 /* Take over HW learned entry */
735 if (unlikely(test_bit(BR_FDB_ADDED_BY_EXT_LEARN,
737 clear_bit(BR_FDB_ADDED_BY_EXT_LEARN,
741 if (unlikely(test_bit(BR_FDB_ADDED_BY_USER, &flags)))
742 set_bit(BR_FDB_ADDED_BY_USER, &fdb->flags);
743 if (unlikely(fdb_modified)) {
744 trace_br_fdb_update(br, source, addr, vid, flags);
745 fdb_notify(br, fdb, RTM_NEWNEIGH, true);
749 spin_lock(&br->hash_lock);
750 fdb = fdb_create(br, source, addr, vid, flags);
752 trace_br_fdb_update(br, source, addr, vid, flags);
753 fdb_notify(br, fdb, RTM_NEWNEIGH, true);
755 /* else we lose race and someone else inserts
756 * it first, don't bother updating
758 spin_unlock(&br->hash_lock);
762 /* Dump information about entries, in response to GETNEIGH */
763 int br_fdb_dump(struct sk_buff *skb,
764 struct netlink_callback *cb,
765 struct net_device *dev,
766 struct net_device *filter_dev,
769 struct net_bridge *br = netdev_priv(dev);
770 struct net_bridge_fdb_entry *f;
773 if (!netif_is_bridge_master(dev))
777 err = ndo_dflt_fdb_dump(skb, cb, dev, NULL, idx);
783 hlist_for_each_entry_rcu(f, &br->fdb_list, fdb_node) {
784 if (*idx < cb->args[2])
786 if (filter_dev && (!f->dst || f->dst->dev != filter_dev)) {
787 if (filter_dev != dev)
789 /* !f->dst is a special case for bridge
790 * It means the MAC belongs to the bridge
791 * Therefore need a little more filtering
792 * we only want to dump the !f->dst case
797 if (!filter_dev && f->dst)
800 err = fdb_fill_info(skb, br, f,
801 NETLINK_CB(cb->skb).portid,
815 int br_fdb_get(struct sk_buff *skb,
817 struct net_device *dev,
818 const unsigned char *addr,
819 u16 vid, u32 portid, u32 seq,
820 struct netlink_ext_ack *extack)
822 struct net_bridge *br = netdev_priv(dev);
823 struct net_bridge_fdb_entry *f;
827 f = br_fdb_find_rcu(br, addr, vid);
829 NL_SET_ERR_MSG(extack, "Fdb entry not found");
834 err = fdb_fill_info(skb, br, f, portid, seq,
841 /* returns true if the fdb is modified */
842 static bool fdb_handle_notify(struct net_bridge_fdb_entry *fdb, u8 notify)
844 bool modified = false;
846 /* allow to mark an entry as inactive, usually done on creation */
847 if ((notify & FDB_NOTIFY_INACTIVE_BIT) &&
848 !test_and_set_bit(BR_FDB_NOTIFY_INACTIVE, &fdb->flags))
851 if ((notify & FDB_NOTIFY_BIT) &&
852 !test_and_set_bit(BR_FDB_NOTIFY, &fdb->flags)) {
853 /* enabled activity tracking */
855 } else if (!(notify & FDB_NOTIFY_BIT) &&
856 test_and_clear_bit(BR_FDB_NOTIFY, &fdb->flags)) {
857 /* disabled activity tracking, clear notify state */
858 clear_bit(BR_FDB_NOTIFY_INACTIVE, &fdb->flags);
865 /* Update (create or replace) forwarding database entry */
866 static int fdb_add_entry(struct net_bridge *br, struct net_bridge_port *source,
867 const u8 *addr, struct ndmsg *ndm, u16 flags, u16 vid,
868 struct nlattr *nfea_tb[])
870 bool is_sticky = !!(ndm->ndm_flags & NTF_STICKY);
871 bool refresh = !nfea_tb[NFEA_DONT_REFRESH];
872 struct net_bridge_fdb_entry *fdb;
873 u16 state = ndm->ndm_state;
874 bool modified = false;
877 /* If the port cannot learn allow only local and static entries */
878 if (source && !(state & NUD_PERMANENT) && !(state & NUD_NOARP) &&
879 !(source->state == BR_STATE_LEARNING ||
880 source->state == BR_STATE_FORWARDING))
883 if (!source && !(state & NUD_PERMANENT)) {
884 pr_info("bridge: RTM_NEWNEIGH %s without NUD_PERMANENT\n",
889 if (is_sticky && (state & NUD_PERMANENT))
892 if (nfea_tb[NFEA_ACTIVITY_NOTIFY]) {
893 notify = nla_get_u8(nfea_tb[NFEA_ACTIVITY_NOTIFY]);
894 if ((notify & ~BR_FDB_NOTIFY_SETTABLE_BITS) ||
895 (notify & BR_FDB_NOTIFY_SETTABLE_BITS) == FDB_NOTIFY_INACTIVE_BIT)
899 fdb = br_fdb_find(br, addr, vid);
901 if (!(flags & NLM_F_CREATE))
904 fdb = fdb_create(br, source, addr, vid, 0);
910 if (flags & NLM_F_EXCL)
913 if (READ_ONCE(fdb->dst) != source) {
914 WRITE_ONCE(fdb->dst, source);
919 if (fdb_to_nud(br, fdb) != state) {
920 if (state & NUD_PERMANENT) {
921 set_bit(BR_FDB_LOCAL, &fdb->flags);
922 if (!test_and_set_bit(BR_FDB_STATIC, &fdb->flags))
923 fdb_add_hw_addr(br, addr);
924 } else if (state & NUD_NOARP) {
925 clear_bit(BR_FDB_LOCAL, &fdb->flags);
926 if (!test_and_set_bit(BR_FDB_STATIC, &fdb->flags))
927 fdb_add_hw_addr(br, addr);
929 clear_bit(BR_FDB_LOCAL, &fdb->flags);
930 if (test_and_clear_bit(BR_FDB_STATIC, &fdb->flags))
931 fdb_del_hw_addr(br, addr);
937 if (is_sticky != test_bit(BR_FDB_STICKY, &fdb->flags)) {
938 change_bit(BR_FDB_STICKY, &fdb->flags);
942 if (fdb_handle_notify(fdb, notify))
945 set_bit(BR_FDB_ADDED_BY_USER, &fdb->flags);
950 fdb->updated = jiffies;
951 fdb_notify(br, fdb, RTM_NEWNEIGH, true);
957 static int __br_fdb_add(struct ndmsg *ndm, struct net_bridge *br,
958 struct net_bridge_port *p, const unsigned char *addr,
959 u16 nlh_flags, u16 vid, struct nlattr *nfea_tb[],
960 struct netlink_ext_ack *extack)
964 if (ndm->ndm_flags & NTF_USE) {
966 pr_info("bridge: RTM_NEWNEIGH %s with NTF_USE is not supported\n",
970 if (!nbp_state_should_learn(p))
975 br_fdb_update(br, p, addr, vid, BIT(BR_FDB_ADDED_BY_USER));
978 } else if (ndm->ndm_flags & NTF_EXT_LEARNED) {
979 if (!p && !(ndm->ndm_state & NUD_PERMANENT)) {
980 NL_SET_ERR_MSG_MOD(extack,
981 "FDB entry towards bridge must be permanent");
984 err = br_fdb_external_learn_add(br, p, addr, vid, true);
986 spin_lock_bh(&br->hash_lock);
987 err = fdb_add_entry(br, p, addr, ndm, nlh_flags, vid, nfea_tb);
988 spin_unlock_bh(&br->hash_lock);
994 static const struct nla_policy br_nda_fdb_pol[NFEA_MAX + 1] = {
995 [NFEA_ACTIVITY_NOTIFY] = { .type = NLA_U8 },
996 [NFEA_DONT_REFRESH] = { .type = NLA_FLAG },
999 /* Add new permanent fdb entry with RTM_NEWNEIGH */
1000 int br_fdb_add(struct ndmsg *ndm, struct nlattr *tb[],
1001 struct net_device *dev,
1002 const unsigned char *addr, u16 vid, u16 nlh_flags,
1003 struct netlink_ext_ack *extack)
1005 struct nlattr *nfea_tb[NFEA_MAX + 1], *attr;
1006 struct net_bridge_vlan_group *vg;
1007 struct net_bridge_port *p = NULL;
1008 struct net_bridge_vlan *v;
1009 struct net_bridge *br = NULL;
1012 trace_br_fdb_add(ndm, dev, addr, vid, nlh_flags);
1014 if (!(ndm->ndm_state & (NUD_PERMANENT|NUD_NOARP|NUD_REACHABLE))) {
1015 pr_info("bridge: RTM_NEWNEIGH with invalid state %#x\n", ndm->ndm_state);
1019 if (is_zero_ether_addr(addr)) {
1020 pr_info("bridge: RTM_NEWNEIGH with invalid ether address\n");
1024 if (netif_is_bridge_master(dev)) {
1025 br = netdev_priv(dev);
1026 vg = br_vlan_group(br);
1028 p = br_port_get_rtnl(dev);
1030 pr_info("bridge: RTM_NEWNEIGH %s not a bridge port\n",
1035 vg = nbp_vlan_group(p);
1038 if (tb[NDA_FDB_EXT_ATTRS]) {
1039 attr = tb[NDA_FDB_EXT_ATTRS];
1040 err = nla_parse_nested(nfea_tb, NFEA_MAX, attr,
1041 br_nda_fdb_pol, extack);
1045 memset(nfea_tb, 0, sizeof(struct nlattr *) * (NFEA_MAX + 1));
1049 v = br_vlan_find(vg, vid);
1050 if (!v || !br_vlan_should_use(v)) {
1051 pr_info("bridge: RTM_NEWNEIGH with unconfigured vlan %d on %s\n", vid, dev->name);
1055 /* VID was specified, so use it. */
1056 err = __br_fdb_add(ndm, br, p, addr, nlh_flags, vid, nfea_tb,
1059 err = __br_fdb_add(ndm, br, p, addr, nlh_flags, 0, nfea_tb,
1061 if (err || !vg || !vg->num_vlans)
1064 /* We have vlans configured on this port and user didn't
1065 * specify a VLAN. To be nice, add/update entry for every
1066 * vlan on this port.
1068 list_for_each_entry(v, &vg->vlan_list, vlist) {
1069 if (!br_vlan_should_use(v))
1071 err = __br_fdb_add(ndm, br, p, addr, nlh_flags, v->vid,
1082 static int fdb_delete_by_addr_and_port(struct net_bridge *br,
1083 const struct net_bridge_port *p,
1084 const u8 *addr, u16 vlan)
1086 struct net_bridge_fdb_entry *fdb;
1088 fdb = br_fdb_find(br, addr, vlan);
1089 if (!fdb || READ_ONCE(fdb->dst) != p)
1092 fdb_delete(br, fdb, true);
1097 static int __br_fdb_delete(struct net_bridge *br,
1098 const struct net_bridge_port *p,
1099 const unsigned char *addr, u16 vid)
1103 spin_lock_bh(&br->hash_lock);
1104 err = fdb_delete_by_addr_and_port(br, p, addr, vid);
1105 spin_unlock_bh(&br->hash_lock);
1110 /* Remove neighbor entry with RTM_DELNEIGH */
1111 int br_fdb_delete(struct ndmsg *ndm, struct nlattr *tb[],
1112 struct net_device *dev,
1113 const unsigned char *addr, u16 vid)
1115 struct net_bridge_vlan_group *vg;
1116 struct net_bridge_port *p = NULL;
1117 struct net_bridge_vlan *v;
1118 struct net_bridge *br;
1121 if (netif_is_bridge_master(dev)) {
1122 br = netdev_priv(dev);
1123 vg = br_vlan_group(br);
1125 p = br_port_get_rtnl(dev);
1127 pr_info("bridge: RTM_DELNEIGH %s not a bridge port\n",
1131 vg = nbp_vlan_group(p);
1136 v = br_vlan_find(vg, vid);
1138 pr_info("bridge: RTM_DELNEIGH with unconfigured vlan %d on %s\n", vid, dev->name);
1142 err = __br_fdb_delete(br, p, addr, vid);
1145 err &= __br_fdb_delete(br, p, addr, 0);
1146 if (!vg || !vg->num_vlans)
1149 list_for_each_entry(v, &vg->vlan_list, vlist) {
1150 if (!br_vlan_should_use(v))
1152 err &= __br_fdb_delete(br, p, addr, v->vid);
1159 int br_fdb_sync_static(struct net_bridge *br, struct net_bridge_port *p)
1161 struct net_bridge_fdb_entry *f, *tmp;
1166 /* the key here is that static entries change only under rtnl */
1168 hlist_for_each_entry_rcu(f, &br->fdb_list, fdb_node) {
1169 /* We only care for static entries */
1170 if (!test_bit(BR_FDB_STATIC, &f->flags))
1172 err = dev_uc_add(p->dev, f->key.addr.addr);
1182 hlist_for_each_entry_rcu(tmp, &br->fdb_list, fdb_node) {
1183 /* We only care for static entries */
1184 if (!test_bit(BR_FDB_STATIC, &tmp->flags))
1188 dev_uc_del(p->dev, tmp->key.addr.addr);
1194 void br_fdb_unsync_static(struct net_bridge *br, struct net_bridge_port *p)
1196 struct net_bridge_fdb_entry *f;
1201 hlist_for_each_entry_rcu(f, &br->fdb_list, fdb_node) {
1202 /* We only care for static entries */
1203 if (!test_bit(BR_FDB_STATIC, &f->flags))
1206 dev_uc_del(p->dev, f->key.addr.addr);
1211 int br_fdb_external_learn_add(struct net_bridge *br, struct net_bridge_port *p,
1212 const unsigned char *addr, u16 vid,
1215 struct net_bridge_fdb_entry *fdb;
1216 bool modified = false;
1219 trace_br_fdb_external_learn_add(br, p, addr, vid);
1221 spin_lock_bh(&br->hash_lock);
1223 fdb = br_fdb_find(br, addr, vid);
1225 unsigned long flags = BIT(BR_FDB_ADDED_BY_EXT_LEARN);
1228 flags |= BIT(BR_FDB_ADDED_BY_USER);
1231 flags |= BIT(BR_FDB_LOCAL);
1233 fdb = fdb_create(br, p, addr, vid, flags);
1238 fdb_notify(br, fdb, RTM_NEWNEIGH, swdev_notify);
1240 fdb->updated = jiffies;
1242 if (READ_ONCE(fdb->dst) != p) {
1243 WRITE_ONCE(fdb->dst, p);
1247 if (test_bit(BR_FDB_ADDED_BY_EXT_LEARN, &fdb->flags)) {
1249 fdb->used = jiffies;
1250 } else if (!test_bit(BR_FDB_ADDED_BY_USER, &fdb->flags)) {
1251 /* Take over SW learned entry */
1252 set_bit(BR_FDB_ADDED_BY_EXT_LEARN, &fdb->flags);
1257 set_bit(BR_FDB_ADDED_BY_USER, &fdb->flags);
1260 set_bit(BR_FDB_LOCAL, &fdb->flags);
1263 fdb_notify(br, fdb, RTM_NEWNEIGH, swdev_notify);
1267 spin_unlock_bh(&br->hash_lock);
1272 int br_fdb_external_learn_del(struct net_bridge *br, struct net_bridge_port *p,
1273 const unsigned char *addr, u16 vid,
1276 struct net_bridge_fdb_entry *fdb;
1279 spin_lock_bh(&br->hash_lock);
1281 fdb = br_fdb_find(br, addr, vid);
1282 if (fdb && test_bit(BR_FDB_ADDED_BY_EXT_LEARN, &fdb->flags))
1283 fdb_delete(br, fdb, swdev_notify);
1287 spin_unlock_bh(&br->hash_lock);
1292 void br_fdb_offloaded_set(struct net_bridge *br, struct net_bridge_port *p,
1293 const unsigned char *addr, u16 vid, bool offloaded)
1295 struct net_bridge_fdb_entry *fdb;
1297 spin_lock_bh(&br->hash_lock);
1299 fdb = br_fdb_find(br, addr, vid);
1300 if (fdb && offloaded != test_bit(BR_FDB_OFFLOADED, &fdb->flags))
1301 change_bit(BR_FDB_OFFLOADED, &fdb->flags);
1303 spin_unlock_bh(&br->hash_lock);
1306 void br_fdb_clear_offload(const struct net_device *dev, u16 vid)
1308 struct net_bridge_fdb_entry *f;
1309 struct net_bridge_port *p;
1313 p = br_port_get_rtnl(dev);
1317 spin_lock_bh(&p->br->hash_lock);
1318 hlist_for_each_entry(f, &p->br->fdb_list, fdb_node) {
1319 if (f->dst == p && f->key.vlan_id == vid)
1320 clear_bit(BR_FDB_OFFLOADED, &f->flags);
1322 spin_unlock_bh(&p->br->hash_lock);
1324 EXPORT_SYMBOL_GPL(br_fdb_clear_offload);