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;
110 nlh = nlmsg_put(skb, portid, seq, type, sizeof(*ndm), flags);
114 ndm = nlmsg_data(nlh);
115 ndm->ndm_family = AF_BRIDGE;
120 ndm->ndm_ifindex = dst ? dst->dev->ifindex : br->dev->ifindex;
121 ndm->ndm_state = fdb_to_nud(br, fdb);
123 if (test_bit(BR_FDB_OFFLOADED, &fdb->flags))
124 ndm->ndm_flags |= NTF_OFFLOADED;
125 if (test_bit(BR_FDB_ADDED_BY_EXT_LEARN, &fdb->flags))
126 ndm->ndm_flags |= NTF_EXT_LEARNED;
127 if (test_bit(BR_FDB_STICKY, &fdb->flags))
128 ndm->ndm_flags |= NTF_STICKY;
129 if (test_bit(BR_FDB_LOCKED, &fdb->flags))
130 ext_flags |= NTF_EXT_LOCKED;
132 if (nla_put(skb, NDA_LLADDR, ETH_ALEN, &fdb->key.addr))
133 goto nla_put_failure;
134 if (nla_put_u32(skb, NDA_MASTER, br->dev->ifindex))
135 goto nla_put_failure;
136 if (nla_put_u32(skb, NDA_FLAGS_EXT, ext_flags))
137 goto nla_put_failure;
139 ci.ndm_used = jiffies_to_clock_t(now - fdb->used);
140 ci.ndm_confirmed = 0;
141 ci.ndm_updated = jiffies_to_clock_t(now - fdb->updated);
143 if (nla_put(skb, NDA_CACHEINFO, sizeof(ci), &ci))
144 goto nla_put_failure;
146 if (fdb->key.vlan_id && nla_put(skb, NDA_VLAN, sizeof(u16),
148 goto nla_put_failure;
150 if (test_bit(BR_FDB_NOTIFY, &fdb->flags)) {
151 struct nlattr *nest = nla_nest_start(skb, NDA_FDB_EXT_ATTRS);
152 u8 notify_bits = FDB_NOTIFY_BIT;
155 goto nla_put_failure;
156 if (test_bit(BR_FDB_NOTIFY_INACTIVE, &fdb->flags))
157 notify_bits |= FDB_NOTIFY_INACTIVE_BIT;
159 if (nla_put_u8(skb, NFEA_ACTIVITY_NOTIFY, notify_bits)) {
160 nla_nest_cancel(skb, nest);
161 goto nla_put_failure;
164 nla_nest_end(skb, nest);
171 nlmsg_cancel(skb, nlh);
175 static inline size_t fdb_nlmsg_size(void)
177 return NLMSG_ALIGN(sizeof(struct ndmsg))
178 + nla_total_size(ETH_ALEN) /* NDA_LLADDR */
179 + nla_total_size(sizeof(u32)) /* NDA_MASTER */
180 + nla_total_size(sizeof(u32)) /* NDA_FLAGS_EXT */
181 + nla_total_size(sizeof(u16)) /* NDA_VLAN */
182 + nla_total_size(sizeof(struct nda_cacheinfo))
183 + nla_total_size(0) /* NDA_FDB_EXT_ATTRS */
184 + nla_total_size(sizeof(u8)); /* NFEA_ACTIVITY_NOTIFY */
187 static void fdb_notify(struct net_bridge *br,
188 const struct net_bridge_fdb_entry *fdb, int type,
191 struct net *net = dev_net(br->dev);
196 br_switchdev_fdb_notify(br, fdb, type);
198 skb = nlmsg_new(fdb_nlmsg_size(), GFP_ATOMIC);
202 err = fdb_fill_info(skb, br, fdb, 0, 0, type, 0);
204 /* -EMSGSIZE implies BUG in fdb_nlmsg_size() */
205 WARN_ON(err == -EMSGSIZE);
209 rtnl_notify(skb, net, 0, RTNLGRP_NEIGH, NULL, GFP_ATOMIC);
212 rtnl_set_sk_err(net, RTNLGRP_NEIGH, err);
215 static struct net_bridge_fdb_entry *fdb_find_rcu(struct rhashtable *tbl,
216 const unsigned char *addr,
219 struct net_bridge_fdb_key key;
221 WARN_ON_ONCE(!rcu_read_lock_held());
224 memcpy(key.addr.addr, addr, sizeof(key.addr.addr));
226 return rhashtable_lookup(tbl, &key, br_fdb_rht_params);
229 /* requires bridge hash_lock */
230 static struct net_bridge_fdb_entry *br_fdb_find(struct net_bridge *br,
231 const unsigned char *addr,
234 struct net_bridge_fdb_entry *fdb;
236 lockdep_assert_held_once(&br->hash_lock);
239 fdb = fdb_find_rcu(&br->fdb_hash_tbl, addr, vid);
245 struct net_device *br_fdb_find_port(const struct net_device *br_dev,
246 const unsigned char *addr,
249 struct net_bridge_fdb_entry *f;
250 struct net_device *dev = NULL;
251 struct net_bridge *br;
255 if (!netif_is_bridge_master(br_dev))
258 br = netdev_priv(br_dev);
260 f = br_fdb_find_rcu(br, addr, vid);
267 EXPORT_SYMBOL_GPL(br_fdb_find_port);
269 struct net_bridge_fdb_entry *br_fdb_find_rcu(struct net_bridge *br,
270 const unsigned char *addr,
273 return fdb_find_rcu(&br->fdb_hash_tbl, addr, vid);
276 /* When a static FDB entry is added, the mac address from the entry is
277 * added to the bridge private HW address list and all required ports
278 * are then updated with the new information.
281 static void fdb_add_hw_addr(struct net_bridge *br, const unsigned char *addr)
284 struct net_bridge_port *p;
288 list_for_each_entry(p, &br->port_list, list) {
289 if (!br_promisc_port(p)) {
290 err = dev_uc_add(p->dev, addr);
298 list_for_each_entry_continue_reverse(p, &br->port_list, list) {
299 if (!br_promisc_port(p))
300 dev_uc_del(p->dev, addr);
304 /* When a static FDB entry is deleted, the HW address from that entry is
305 * also removed from the bridge private HW address list and updates all
306 * the ports with needed information.
309 static void fdb_del_hw_addr(struct net_bridge *br, const unsigned char *addr)
311 struct net_bridge_port *p;
315 list_for_each_entry(p, &br->port_list, list) {
316 if (!br_promisc_port(p))
317 dev_uc_del(p->dev, addr);
321 static void fdb_delete(struct net_bridge *br, struct net_bridge_fdb_entry *f,
324 trace_fdb_delete(br, f);
326 if (test_bit(BR_FDB_STATIC, &f->flags))
327 fdb_del_hw_addr(br, f->key.addr.addr);
329 hlist_del_init_rcu(&f->fdb_node);
330 rhashtable_remove_fast(&br->fdb_hash_tbl, &f->rhnode,
332 if (test_and_clear_bit(BR_FDB_DYNAMIC_LEARNED, &f->flags))
333 atomic_dec(&br->fdb_n_learned);
334 fdb_notify(br, f, RTM_DELNEIGH, swdev_notify);
335 call_rcu(&f->rcu, fdb_rcu_free);
338 /* Delete a local entry if no other port had the same address.
340 * This function should only be called on entries with BR_FDB_LOCAL set,
341 * so even with BR_FDB_ADDED_BY_USER cleared we never need to increase
342 * the accounting for dynamically learned entries again.
344 static void fdb_delete_local(struct net_bridge *br,
345 const struct net_bridge_port *p,
346 struct net_bridge_fdb_entry *f)
348 const unsigned char *addr = f->key.addr.addr;
349 struct net_bridge_vlan_group *vg;
350 const struct net_bridge_vlan *v;
351 struct net_bridge_port *op;
352 u16 vid = f->key.vlan_id;
354 /* Maybe another port has same hw addr? */
355 list_for_each_entry(op, &br->port_list, list) {
356 vg = nbp_vlan_group(op);
357 if (op != p && ether_addr_equal(op->dev->dev_addr, addr) &&
358 (!vid || br_vlan_find(vg, vid))) {
360 clear_bit(BR_FDB_ADDED_BY_USER, &f->flags);
365 vg = br_vlan_group(br);
366 v = br_vlan_find(vg, vid);
367 /* Maybe bridge device has same hw addr? */
368 if (p && ether_addr_equal(br->dev->dev_addr, addr) &&
369 (!vid || (v && br_vlan_should_use(v)))) {
371 clear_bit(BR_FDB_ADDED_BY_USER, &f->flags);
375 fdb_delete(br, f, true);
378 void br_fdb_find_delete_local(struct net_bridge *br,
379 const struct net_bridge_port *p,
380 const unsigned char *addr, u16 vid)
382 struct net_bridge_fdb_entry *f;
384 spin_lock_bh(&br->hash_lock);
385 f = br_fdb_find(br, addr, vid);
386 if (f && test_bit(BR_FDB_LOCAL, &f->flags) &&
387 !test_bit(BR_FDB_ADDED_BY_USER, &f->flags) && f->dst == p)
388 fdb_delete_local(br, p, f);
389 spin_unlock_bh(&br->hash_lock);
392 static struct net_bridge_fdb_entry *fdb_create(struct net_bridge *br,
393 struct net_bridge_port *source,
394 const unsigned char *addr,
398 bool learned = !test_bit(BR_FDB_ADDED_BY_USER, &flags) &&
399 !test_bit(BR_FDB_LOCAL, &flags);
400 u32 max_learned = READ_ONCE(br->fdb_max_learned);
401 struct net_bridge_fdb_entry *fdb;
404 if (likely(learned)) {
405 int n_learned = atomic_read(&br->fdb_n_learned);
407 if (unlikely(max_learned && n_learned >= max_learned))
409 __set_bit(BR_FDB_DYNAMIC_LEARNED, &flags);
412 fdb = kmem_cache_alloc(br_fdb_cache, GFP_ATOMIC);
416 memcpy(fdb->key.addr.addr, addr, ETH_ALEN);
417 WRITE_ONCE(fdb->dst, source);
418 fdb->key.vlan_id = vid;
420 fdb->updated = fdb->used = jiffies;
421 err = rhashtable_lookup_insert_fast(&br->fdb_hash_tbl, &fdb->rhnode,
424 kmem_cache_free(br_fdb_cache, fdb);
429 atomic_inc(&br->fdb_n_learned);
431 hlist_add_head_rcu(&fdb->fdb_node, &br->fdb_list);
436 static int fdb_add_local(struct net_bridge *br, struct net_bridge_port *source,
437 const unsigned char *addr, u16 vid)
439 struct net_bridge_fdb_entry *fdb;
441 if (!is_valid_ether_addr(addr))
444 fdb = br_fdb_find(br, addr, vid);
446 /* it is okay to have multiple ports with same
447 * address, just use the first one.
449 if (test_bit(BR_FDB_LOCAL, &fdb->flags))
451 br_warn(br, "adding interface %s with same address as a received packet (addr:%pM, vlan:%u)\n",
452 source ? source->dev->name : br->dev->name, addr, vid);
453 fdb_delete(br, fdb, true);
456 fdb = fdb_create(br, source, addr, vid,
457 BIT(BR_FDB_LOCAL) | BIT(BR_FDB_STATIC));
461 fdb_add_hw_addr(br, addr);
462 fdb_notify(br, fdb, RTM_NEWNEIGH, true);
466 void br_fdb_changeaddr(struct net_bridge_port *p, const unsigned char *newaddr)
468 struct net_bridge_vlan_group *vg;
469 struct net_bridge_fdb_entry *f;
470 struct net_bridge *br = p->br;
471 struct net_bridge_vlan *v;
473 spin_lock_bh(&br->hash_lock);
474 vg = nbp_vlan_group(p);
475 hlist_for_each_entry(f, &br->fdb_list, fdb_node) {
476 if (f->dst == p && test_bit(BR_FDB_LOCAL, &f->flags) &&
477 !test_bit(BR_FDB_ADDED_BY_USER, &f->flags)) {
479 fdb_delete_local(br, p, f);
481 /* if this port has no vlan information
482 * configured, we can safely be done at
485 if (!vg || !vg->num_vlans)
491 /* insert new address, may fail if invalid address or dup. */
492 fdb_add_local(br, p, newaddr, 0);
494 if (!vg || !vg->num_vlans)
497 /* Now add entries for every VLAN configured on the port.
498 * This function runs under RTNL so the bitmap will not change
501 list_for_each_entry(v, &vg->vlan_list, vlist)
502 fdb_add_local(br, p, newaddr, v->vid);
505 spin_unlock_bh(&br->hash_lock);
508 void br_fdb_change_mac_address(struct net_bridge *br, const u8 *newaddr)
510 struct net_bridge_vlan_group *vg;
511 struct net_bridge_fdb_entry *f;
512 struct net_bridge_vlan *v;
514 spin_lock_bh(&br->hash_lock);
516 /* If old entry was unassociated with any port, then delete it. */
517 f = br_fdb_find(br, br->dev->dev_addr, 0);
518 if (f && test_bit(BR_FDB_LOCAL, &f->flags) &&
519 !f->dst && !test_bit(BR_FDB_ADDED_BY_USER, &f->flags))
520 fdb_delete_local(br, NULL, f);
522 fdb_add_local(br, NULL, newaddr, 0);
523 vg = br_vlan_group(br);
524 if (!vg || !vg->num_vlans)
526 /* Now remove and add entries for every VLAN configured on the
527 * bridge. This function runs under RTNL so the bitmap will not
528 * change from under us.
530 list_for_each_entry(v, &vg->vlan_list, vlist) {
531 if (!br_vlan_should_use(v))
533 f = br_fdb_find(br, br->dev->dev_addr, v->vid);
534 if (f && test_bit(BR_FDB_LOCAL, &f->flags) &&
535 !f->dst && !test_bit(BR_FDB_ADDED_BY_USER, &f->flags))
536 fdb_delete_local(br, NULL, f);
537 fdb_add_local(br, NULL, newaddr, v->vid);
540 spin_unlock_bh(&br->hash_lock);
543 void br_fdb_cleanup(struct work_struct *work)
545 struct net_bridge *br = container_of(work, struct net_bridge,
547 struct net_bridge_fdb_entry *f = NULL;
548 unsigned long delay = hold_time(br);
549 unsigned long work_delay = delay;
550 unsigned long now = jiffies;
552 /* this part is tricky, in order to avoid blocking learning and
553 * consequently forwarding, we rely on rcu to delete objects with
554 * delayed freeing allowing us to continue traversing
557 hlist_for_each_entry_rcu(f, &br->fdb_list, fdb_node) {
558 unsigned long this_timer = f->updated + delay;
560 if (test_bit(BR_FDB_STATIC, &f->flags) ||
561 test_bit(BR_FDB_ADDED_BY_EXT_LEARN, &f->flags)) {
562 if (test_bit(BR_FDB_NOTIFY, &f->flags)) {
563 if (time_after(this_timer, now))
564 work_delay = min(work_delay,
566 else if (!test_and_set_bit(BR_FDB_NOTIFY_INACTIVE,
568 fdb_notify(br, f, RTM_NEWNEIGH, false);
573 if (time_after(this_timer, now)) {
574 work_delay = min(work_delay, this_timer - now);
576 spin_lock_bh(&br->hash_lock);
577 if (!hlist_unhashed(&f->fdb_node))
578 fdb_delete(br, f, true);
579 spin_unlock_bh(&br->hash_lock);
584 /* Cleanup minimum 10 milliseconds apart */
585 work_delay = max_t(unsigned long, work_delay, msecs_to_jiffies(10));
586 mod_delayed_work(system_long_wq, &br->gc_work, work_delay);
589 static bool __fdb_flush_matches(const struct net_bridge *br,
590 const struct net_bridge_fdb_entry *f,
591 const struct net_bridge_fdb_flush_desc *desc)
593 const struct net_bridge_port *dst = READ_ONCE(f->dst);
594 int port_ifidx = dst ? dst->dev->ifindex : br->dev->ifindex;
596 if (desc->vlan_id && desc->vlan_id != f->key.vlan_id)
598 if (desc->port_ifindex && desc->port_ifindex != port_ifidx)
600 if (desc->flags_mask && (f->flags & desc->flags_mask) != desc->flags)
606 /* Flush forwarding database entries matching the description */
607 void br_fdb_flush(struct net_bridge *br,
608 const struct net_bridge_fdb_flush_desc *desc)
610 struct net_bridge_fdb_entry *f;
613 hlist_for_each_entry_rcu(f, &br->fdb_list, fdb_node) {
614 if (!__fdb_flush_matches(br, f, desc))
617 spin_lock_bh(&br->hash_lock);
618 if (!hlist_unhashed(&f->fdb_node))
619 fdb_delete(br, f, true);
620 spin_unlock_bh(&br->hash_lock);
625 static unsigned long __ndm_state_to_fdb_flags(u16 ndm_state)
627 unsigned long flags = 0;
629 if (ndm_state & NUD_PERMANENT)
630 __set_bit(BR_FDB_LOCAL, &flags);
631 if (ndm_state & NUD_NOARP)
632 __set_bit(BR_FDB_STATIC, &flags);
637 static unsigned long __ndm_flags_to_fdb_flags(u8 ndm_flags)
639 unsigned long flags = 0;
641 if (ndm_flags & NTF_USE)
642 __set_bit(BR_FDB_ADDED_BY_USER, &flags);
643 if (ndm_flags & NTF_EXT_LEARNED)
644 __set_bit(BR_FDB_ADDED_BY_EXT_LEARN, &flags);
645 if (ndm_flags & NTF_OFFLOADED)
646 __set_bit(BR_FDB_OFFLOADED, &flags);
647 if (ndm_flags & NTF_STICKY)
648 __set_bit(BR_FDB_STICKY, &flags);
653 static int __fdb_flush_validate_ifindex(const struct net_bridge *br,
655 struct netlink_ext_ack *extack)
657 const struct net_device *dev;
659 dev = __dev_get_by_index(dev_net(br->dev), ifindex);
661 NL_SET_ERR_MSG_MOD(extack, "Unknown flush device ifindex");
664 if (!netif_is_bridge_master(dev) && !netif_is_bridge_port(dev)) {
665 NL_SET_ERR_MSG_MOD(extack, "Flush device is not a bridge or bridge port");
668 if (netif_is_bridge_master(dev) && dev != br->dev) {
669 NL_SET_ERR_MSG_MOD(extack,
670 "Flush bridge device does not match target bridge device");
673 if (netif_is_bridge_port(dev)) {
674 struct net_bridge_port *p = br_port_get_rtnl(dev);
677 NL_SET_ERR_MSG_MOD(extack, "Port belongs to a different bridge device");
685 static const struct nla_policy br_fdb_del_bulk_policy[NDA_MAX + 1] = {
686 [NDA_VLAN] = NLA_POLICY_RANGE(NLA_U16, 1, VLAN_N_VID - 2),
687 [NDA_IFINDEX] = NLA_POLICY_MIN(NLA_S32, 1),
688 [NDA_NDM_STATE_MASK] = { .type = NLA_U16 },
689 [NDA_NDM_FLAGS_MASK] = { .type = NLA_U8 },
692 int br_fdb_delete_bulk(struct nlmsghdr *nlh, struct net_device *dev,
693 struct netlink_ext_ack *extack)
695 struct net_bridge_fdb_flush_desc desc = {};
696 struct ndmsg *ndm = nlmsg_data(nlh);
697 struct net_bridge_port *p = NULL;
698 struct nlattr *tb[NDA_MAX + 1];
699 struct net_bridge *br;
703 ndm_flags = ndm->ndm_flags & ~FDB_FLUSH_IGNORED_NDM_FLAGS;
705 err = nlmsg_parse(nlh, sizeof(*ndm), tb, NDA_MAX,
706 br_fdb_del_bulk_policy, extack);
710 if (netif_is_bridge_master(dev)) {
711 br = netdev_priv(dev);
713 p = br_port_get_rtnl(dev);
715 NL_SET_ERR_MSG_MOD(extack, "Device is not a bridge port");
722 desc.vlan_id = nla_get_u16(tb[NDA_VLAN]);
724 if (ndm_flags & ~FDB_FLUSH_ALLOWED_NDM_FLAGS) {
725 NL_SET_ERR_MSG(extack, "Unsupported fdb flush ndm flag bits set");
728 if (ndm->ndm_state & ~FDB_FLUSH_ALLOWED_NDM_STATES) {
729 NL_SET_ERR_MSG(extack, "Unsupported fdb flush ndm state bits set");
733 desc.flags |= __ndm_state_to_fdb_flags(ndm->ndm_state);
734 desc.flags |= __ndm_flags_to_fdb_flags(ndm_flags);
735 if (tb[NDA_NDM_STATE_MASK]) {
736 u16 ndm_state_mask = nla_get_u16(tb[NDA_NDM_STATE_MASK]);
738 desc.flags_mask |= __ndm_state_to_fdb_flags(ndm_state_mask);
740 if (tb[NDA_NDM_FLAGS_MASK]) {
741 u8 ndm_flags_mask = nla_get_u8(tb[NDA_NDM_FLAGS_MASK]);
743 desc.flags_mask |= __ndm_flags_to_fdb_flags(ndm_flags_mask);
745 if (tb[NDA_IFINDEX]) {
746 int ifidx = nla_get_s32(tb[NDA_IFINDEX]);
748 err = __fdb_flush_validate_ifindex(br, ifidx, extack);
751 desc.port_ifindex = ifidx;
753 /* flush was invoked with port device and NTF_MASTER */
754 desc.port_ifindex = p->dev->ifindex;
757 br_debug(br, "flushing port ifindex: %d vlan id: %u flags: 0x%lx flags mask: 0x%lx\n",
758 desc.port_ifindex, desc.vlan_id, desc.flags, desc.flags_mask);
760 br_fdb_flush(br, &desc);
765 /* Flush all entries referring to a specific port.
766 * if do_all is set also flush static entries
767 * if vid is set delete all entries that match the vlan_id
769 void br_fdb_delete_by_port(struct net_bridge *br,
770 const struct net_bridge_port *p,
774 struct net_bridge_fdb_entry *f;
775 struct hlist_node *tmp;
777 spin_lock_bh(&br->hash_lock);
778 hlist_for_each_entry_safe(f, tmp, &br->fdb_list, fdb_node) {
783 if (test_bit(BR_FDB_STATIC, &f->flags) ||
784 (test_bit(BR_FDB_ADDED_BY_EXT_LEARN, &f->flags) &&
785 !test_bit(BR_FDB_OFFLOADED, &f->flags)) ||
786 (vid && f->key.vlan_id != vid))
789 if (test_bit(BR_FDB_LOCAL, &f->flags))
790 fdb_delete_local(br, p, f);
792 fdb_delete(br, f, true);
794 spin_unlock_bh(&br->hash_lock);
797 #if IS_ENABLED(CONFIG_ATM_LANE)
798 /* Interface used by ATM LANE hook to test
799 * if an addr is on some other bridge port */
800 int br_fdb_test_addr(struct net_device *dev, unsigned char *addr)
802 struct net_bridge_fdb_entry *fdb;
803 struct net_bridge_port *port;
807 port = br_port_get_rcu(dev);
811 const struct net_bridge_port *dst = NULL;
813 fdb = br_fdb_find_rcu(port->br, addr, 0);
815 dst = READ_ONCE(fdb->dst);
817 ret = dst && dst->dev != dev &&
818 dst->state == BR_STATE_FORWARDING;
824 #endif /* CONFIG_ATM_LANE */
827 * Fill buffer with forwarding table records in
830 int br_fdb_fillbuf(struct net_bridge *br, void *buf,
831 unsigned long maxnum, unsigned long skip)
833 struct net_bridge_fdb_entry *f;
834 struct __fdb_entry *fe = buf;
837 memset(buf, 0, maxnum*sizeof(struct __fdb_entry));
840 hlist_for_each_entry_rcu(f, &br->fdb_list, fdb_node) {
844 if (has_expired(br, f))
847 /* ignore pseudo entry for local MAC address */
856 /* convert from internal format to API */
857 memcpy(fe->mac_addr, f->key.addr.addr, ETH_ALEN);
859 /* due to ABI compat need to split into hi/lo */
860 fe->port_no = f->dst->port_no;
861 fe->port_hi = f->dst->port_no >> 8;
863 fe->is_local = test_bit(BR_FDB_LOCAL, &f->flags);
864 if (!test_bit(BR_FDB_STATIC, &f->flags))
865 fe->ageing_timer_value = jiffies_delta_to_clock_t(jiffies - f->updated);
874 /* Add entry for local address of interface */
875 int br_fdb_add_local(struct net_bridge *br, struct net_bridge_port *source,
876 const unsigned char *addr, u16 vid)
880 spin_lock_bh(&br->hash_lock);
881 ret = fdb_add_local(br, source, addr, vid);
882 spin_unlock_bh(&br->hash_lock);
886 /* returns true if the fdb was modified */
887 static bool __fdb_mark_active(struct net_bridge_fdb_entry *fdb)
889 return !!(test_bit(BR_FDB_NOTIFY_INACTIVE, &fdb->flags) &&
890 test_and_clear_bit(BR_FDB_NOTIFY_INACTIVE, &fdb->flags));
893 void br_fdb_update(struct net_bridge *br, struct net_bridge_port *source,
894 const unsigned char *addr, u16 vid, unsigned long flags)
896 struct net_bridge_fdb_entry *fdb;
898 /* some users want to always flood. */
899 if (hold_time(br) == 0)
902 fdb = fdb_find_rcu(&br->fdb_hash_tbl, addr, vid);
904 /* attempt to update an entry for a local interface */
905 if (unlikely(test_bit(BR_FDB_LOCAL, &fdb->flags))) {
907 br_warn(br, "received packet on %s with own address as source address (addr:%pM, vlan:%u)\n",
908 source->dev->name, addr, vid);
910 unsigned long now = jiffies;
911 bool fdb_modified = false;
913 if (now != fdb->updated) {
915 fdb_modified = __fdb_mark_active(fdb);
918 /* fastpath: update of existing entry */
919 if (unlikely(source != READ_ONCE(fdb->dst) &&
920 !test_bit(BR_FDB_STICKY, &fdb->flags))) {
921 br_switchdev_fdb_notify(br, fdb, RTM_DELNEIGH);
922 WRITE_ONCE(fdb->dst, source);
924 /* Take over HW learned entry */
925 if (unlikely(test_bit(BR_FDB_ADDED_BY_EXT_LEARN,
927 clear_bit(BR_FDB_ADDED_BY_EXT_LEARN,
929 /* Clear locked flag when roaming to an
932 if (unlikely(test_bit(BR_FDB_LOCKED, &fdb->flags)))
933 clear_bit(BR_FDB_LOCKED, &fdb->flags);
936 if (unlikely(test_bit(BR_FDB_ADDED_BY_USER, &flags))) {
937 set_bit(BR_FDB_ADDED_BY_USER, &fdb->flags);
938 if (test_and_clear_bit(BR_FDB_DYNAMIC_LEARNED,
940 atomic_dec(&br->fdb_n_learned);
942 if (unlikely(fdb_modified)) {
943 trace_br_fdb_update(br, source, addr, vid, flags);
944 fdb_notify(br, fdb, RTM_NEWNEIGH, true);
948 spin_lock(&br->hash_lock);
949 fdb = fdb_create(br, source, addr, vid, flags);
951 trace_br_fdb_update(br, source, addr, vid, flags);
952 fdb_notify(br, fdb, RTM_NEWNEIGH, true);
954 /* else we lose race and someone else inserts
955 * it first, don't bother updating
957 spin_unlock(&br->hash_lock);
961 /* Dump information about entries, in response to GETNEIGH */
962 int br_fdb_dump(struct sk_buff *skb,
963 struct netlink_callback *cb,
964 struct net_device *dev,
965 struct net_device *filter_dev,
968 struct net_bridge *br = netdev_priv(dev);
969 struct net_bridge_fdb_entry *f;
972 if (!netif_is_bridge_master(dev))
976 err = ndo_dflt_fdb_dump(skb, cb, dev, NULL, idx);
982 hlist_for_each_entry_rcu(f, &br->fdb_list, fdb_node) {
983 if (*idx < cb->args[2])
985 if (filter_dev && (!f->dst || f->dst->dev != filter_dev)) {
986 if (filter_dev != dev)
988 /* !f->dst is a special case for bridge
989 * It means the MAC belongs to the bridge
990 * Therefore need a little more filtering
991 * we only want to dump the !f->dst case
996 if (!filter_dev && f->dst)
999 err = fdb_fill_info(skb, br, f,
1000 NETLINK_CB(cb->skb).portid,
1014 int br_fdb_get(struct sk_buff *skb,
1015 struct nlattr *tb[],
1016 struct net_device *dev,
1017 const unsigned char *addr,
1018 u16 vid, u32 portid, u32 seq,
1019 struct netlink_ext_ack *extack)
1021 struct net_bridge *br = netdev_priv(dev);
1022 struct net_bridge_fdb_entry *f;
1026 f = br_fdb_find_rcu(br, addr, vid);
1028 NL_SET_ERR_MSG(extack, "Fdb entry not found");
1033 err = fdb_fill_info(skb, br, f, portid, seq,
1040 /* returns true if the fdb is modified */
1041 static bool fdb_handle_notify(struct net_bridge_fdb_entry *fdb, u8 notify)
1043 bool modified = false;
1045 /* allow to mark an entry as inactive, usually done on creation */
1046 if ((notify & FDB_NOTIFY_INACTIVE_BIT) &&
1047 !test_and_set_bit(BR_FDB_NOTIFY_INACTIVE, &fdb->flags))
1050 if ((notify & FDB_NOTIFY_BIT) &&
1051 !test_and_set_bit(BR_FDB_NOTIFY, &fdb->flags)) {
1052 /* enabled activity tracking */
1054 } else if (!(notify & FDB_NOTIFY_BIT) &&
1055 test_and_clear_bit(BR_FDB_NOTIFY, &fdb->flags)) {
1056 /* disabled activity tracking, clear notify state */
1057 clear_bit(BR_FDB_NOTIFY_INACTIVE, &fdb->flags);
1064 /* Update (create or replace) forwarding database entry */
1065 static int fdb_add_entry(struct net_bridge *br, struct net_bridge_port *source,
1066 const u8 *addr, struct ndmsg *ndm, u16 flags, u16 vid,
1067 struct nlattr *nfea_tb[])
1069 bool is_sticky = !!(ndm->ndm_flags & NTF_STICKY);
1070 bool refresh = !nfea_tb[NFEA_DONT_REFRESH];
1071 struct net_bridge_fdb_entry *fdb;
1072 u16 state = ndm->ndm_state;
1073 bool modified = false;
1076 /* If the port cannot learn allow only local and static entries */
1077 if (source && !(state & NUD_PERMANENT) && !(state & NUD_NOARP) &&
1078 !(source->state == BR_STATE_LEARNING ||
1079 source->state == BR_STATE_FORWARDING))
1082 if (!source && !(state & NUD_PERMANENT)) {
1083 pr_info("bridge: RTM_NEWNEIGH %s without NUD_PERMANENT\n",
1088 if (is_sticky && (state & NUD_PERMANENT))
1091 if (nfea_tb[NFEA_ACTIVITY_NOTIFY]) {
1092 notify = nla_get_u8(nfea_tb[NFEA_ACTIVITY_NOTIFY]);
1093 if ((notify & ~BR_FDB_NOTIFY_SETTABLE_BITS) ||
1094 (notify & BR_FDB_NOTIFY_SETTABLE_BITS) == FDB_NOTIFY_INACTIVE_BIT)
1098 fdb = br_fdb_find(br, addr, vid);
1100 if (!(flags & NLM_F_CREATE))
1103 fdb = fdb_create(br, source, addr, vid,
1104 BIT(BR_FDB_ADDED_BY_USER));
1110 if (flags & NLM_F_EXCL)
1113 if (READ_ONCE(fdb->dst) != source) {
1114 WRITE_ONCE(fdb->dst, source);
1118 set_bit(BR_FDB_ADDED_BY_USER, &fdb->flags);
1119 if (test_and_clear_bit(BR_FDB_DYNAMIC_LEARNED, &fdb->flags))
1120 atomic_dec(&br->fdb_n_learned);
1123 if (fdb_to_nud(br, fdb) != state) {
1124 if (state & NUD_PERMANENT) {
1125 set_bit(BR_FDB_LOCAL, &fdb->flags);
1126 if (!test_and_set_bit(BR_FDB_STATIC, &fdb->flags))
1127 fdb_add_hw_addr(br, addr);
1128 } else if (state & NUD_NOARP) {
1129 clear_bit(BR_FDB_LOCAL, &fdb->flags);
1130 if (!test_and_set_bit(BR_FDB_STATIC, &fdb->flags))
1131 fdb_add_hw_addr(br, addr);
1133 clear_bit(BR_FDB_LOCAL, &fdb->flags);
1134 if (test_and_clear_bit(BR_FDB_STATIC, &fdb->flags))
1135 fdb_del_hw_addr(br, addr);
1141 if (is_sticky != test_bit(BR_FDB_STICKY, &fdb->flags)) {
1142 change_bit(BR_FDB_STICKY, &fdb->flags);
1146 if (test_and_clear_bit(BR_FDB_LOCKED, &fdb->flags))
1149 if (fdb_handle_notify(fdb, notify))
1152 fdb->used = jiffies;
1155 fdb->updated = jiffies;
1156 fdb_notify(br, fdb, RTM_NEWNEIGH, true);
1162 static int __br_fdb_add(struct ndmsg *ndm, struct net_bridge *br,
1163 struct net_bridge_port *p, const unsigned char *addr,
1164 u16 nlh_flags, u16 vid, struct nlattr *nfea_tb[],
1165 struct netlink_ext_ack *extack)
1169 if (ndm->ndm_flags & NTF_USE) {
1171 pr_info("bridge: RTM_NEWNEIGH %s with NTF_USE is not supported\n",
1175 if (!nbp_state_should_learn(p))
1180 br_fdb_update(br, p, addr, vid, BIT(BR_FDB_ADDED_BY_USER));
1183 } else if (ndm->ndm_flags & NTF_EXT_LEARNED) {
1184 if (!p && !(ndm->ndm_state & NUD_PERMANENT)) {
1185 NL_SET_ERR_MSG_MOD(extack,
1186 "FDB entry towards bridge must be permanent");
1189 err = br_fdb_external_learn_add(br, p, addr, vid, false, true);
1191 spin_lock_bh(&br->hash_lock);
1192 err = fdb_add_entry(br, p, addr, ndm, nlh_flags, vid, nfea_tb);
1193 spin_unlock_bh(&br->hash_lock);
1199 static const struct nla_policy br_nda_fdb_pol[NFEA_MAX + 1] = {
1200 [NFEA_ACTIVITY_NOTIFY] = { .type = NLA_U8 },
1201 [NFEA_DONT_REFRESH] = { .type = NLA_FLAG },
1204 /* Add new permanent fdb entry with RTM_NEWNEIGH */
1205 int br_fdb_add(struct ndmsg *ndm, struct nlattr *tb[],
1206 struct net_device *dev,
1207 const unsigned char *addr, u16 vid, u16 nlh_flags,
1208 struct netlink_ext_ack *extack)
1210 struct nlattr *nfea_tb[NFEA_MAX + 1], *attr;
1211 struct net_bridge_vlan_group *vg;
1212 struct net_bridge_port *p = NULL;
1213 struct net_bridge_vlan *v;
1214 struct net_bridge *br = NULL;
1218 trace_br_fdb_add(ndm, dev, addr, vid, nlh_flags);
1220 if (!(ndm->ndm_state & (NUD_PERMANENT|NUD_NOARP|NUD_REACHABLE))) {
1221 pr_info("bridge: RTM_NEWNEIGH with invalid state %#x\n", ndm->ndm_state);
1225 if (is_zero_ether_addr(addr)) {
1226 pr_info("bridge: RTM_NEWNEIGH with invalid ether address\n");
1230 if (netif_is_bridge_master(dev)) {
1231 br = netdev_priv(dev);
1232 vg = br_vlan_group(br);
1234 p = br_port_get_rtnl(dev);
1236 pr_info("bridge: RTM_NEWNEIGH %s not a bridge port\n",
1241 vg = nbp_vlan_group(p);
1244 if (tb[NDA_FLAGS_EXT])
1245 ext_flags = nla_get_u32(tb[NDA_FLAGS_EXT]);
1247 if (ext_flags & NTF_EXT_LOCKED) {
1248 NL_SET_ERR_MSG_MOD(extack, "Cannot add FDB entry with \"locked\" flag set");
1252 if (tb[NDA_FDB_EXT_ATTRS]) {
1253 attr = tb[NDA_FDB_EXT_ATTRS];
1254 err = nla_parse_nested(nfea_tb, NFEA_MAX, attr,
1255 br_nda_fdb_pol, extack);
1259 memset(nfea_tb, 0, sizeof(struct nlattr *) * (NFEA_MAX + 1));
1263 v = br_vlan_find(vg, vid);
1264 if (!v || !br_vlan_should_use(v)) {
1265 pr_info("bridge: RTM_NEWNEIGH with unconfigured vlan %d on %s\n", vid, dev->name);
1269 /* VID was specified, so use it. */
1270 err = __br_fdb_add(ndm, br, p, addr, nlh_flags, vid, nfea_tb,
1273 err = __br_fdb_add(ndm, br, p, addr, nlh_flags, 0, nfea_tb,
1275 if (err || !vg || !vg->num_vlans)
1278 /* We have vlans configured on this port and user didn't
1279 * specify a VLAN. To be nice, add/update entry for every
1280 * vlan on this port.
1282 list_for_each_entry(v, &vg->vlan_list, vlist) {
1283 if (!br_vlan_should_use(v))
1285 err = __br_fdb_add(ndm, br, p, addr, nlh_flags, v->vid,
1296 static int fdb_delete_by_addr_and_port(struct net_bridge *br,
1297 const struct net_bridge_port *p,
1298 const u8 *addr, u16 vlan)
1300 struct net_bridge_fdb_entry *fdb;
1302 fdb = br_fdb_find(br, addr, vlan);
1303 if (!fdb || READ_ONCE(fdb->dst) != p)
1306 fdb_delete(br, fdb, true);
1311 static int __br_fdb_delete(struct net_bridge *br,
1312 const struct net_bridge_port *p,
1313 const unsigned char *addr, u16 vid)
1317 spin_lock_bh(&br->hash_lock);
1318 err = fdb_delete_by_addr_and_port(br, p, addr, vid);
1319 spin_unlock_bh(&br->hash_lock);
1324 /* Remove neighbor entry with RTM_DELNEIGH */
1325 int br_fdb_delete(struct ndmsg *ndm, struct nlattr *tb[],
1326 struct net_device *dev,
1327 const unsigned char *addr, u16 vid,
1328 struct netlink_ext_ack *extack)
1330 struct net_bridge_vlan_group *vg;
1331 struct net_bridge_port *p = NULL;
1332 struct net_bridge_vlan *v;
1333 struct net_bridge *br;
1336 if (netif_is_bridge_master(dev)) {
1337 br = netdev_priv(dev);
1338 vg = br_vlan_group(br);
1340 p = br_port_get_rtnl(dev);
1342 pr_info("bridge: RTM_DELNEIGH %s not a bridge port\n",
1346 vg = nbp_vlan_group(p);
1351 v = br_vlan_find(vg, vid);
1353 pr_info("bridge: RTM_DELNEIGH with unconfigured vlan %d on %s\n", vid, dev->name);
1357 err = __br_fdb_delete(br, p, addr, vid);
1360 err &= __br_fdb_delete(br, p, addr, 0);
1361 if (!vg || !vg->num_vlans)
1364 list_for_each_entry(v, &vg->vlan_list, vlist) {
1365 if (!br_vlan_should_use(v))
1367 err &= __br_fdb_delete(br, p, addr, v->vid);
1374 int br_fdb_sync_static(struct net_bridge *br, struct net_bridge_port *p)
1376 struct net_bridge_fdb_entry *f, *tmp;
1381 /* the key here is that static entries change only under rtnl */
1383 hlist_for_each_entry_rcu(f, &br->fdb_list, fdb_node) {
1384 /* We only care for static entries */
1385 if (!test_bit(BR_FDB_STATIC, &f->flags))
1387 err = dev_uc_add(p->dev, f->key.addr.addr);
1397 hlist_for_each_entry_rcu(tmp, &br->fdb_list, fdb_node) {
1398 /* We only care for static entries */
1399 if (!test_bit(BR_FDB_STATIC, &tmp->flags))
1403 dev_uc_del(p->dev, tmp->key.addr.addr);
1409 void br_fdb_unsync_static(struct net_bridge *br, struct net_bridge_port *p)
1411 struct net_bridge_fdb_entry *f;
1416 hlist_for_each_entry_rcu(f, &br->fdb_list, fdb_node) {
1417 /* We only care for static entries */
1418 if (!test_bit(BR_FDB_STATIC, &f->flags))
1421 dev_uc_del(p->dev, f->key.addr.addr);
1426 int br_fdb_external_learn_add(struct net_bridge *br, struct net_bridge_port *p,
1427 const unsigned char *addr, u16 vid, bool locked,
1430 struct net_bridge_fdb_entry *fdb;
1431 bool modified = false;
1434 trace_br_fdb_external_learn_add(br, p, addr, vid);
1436 if (locked && (!p || !(p->flags & BR_PORT_MAB)))
1439 spin_lock_bh(&br->hash_lock);
1441 fdb = br_fdb_find(br, addr, vid);
1443 unsigned long flags = BIT(BR_FDB_ADDED_BY_EXT_LEARN);
1446 flags |= BIT(BR_FDB_ADDED_BY_USER);
1449 flags |= BIT(BR_FDB_LOCAL);
1452 flags |= BIT(BR_FDB_LOCKED);
1454 fdb = fdb_create(br, p, addr, vid, flags);
1459 fdb_notify(br, fdb, RTM_NEWNEIGH, swdev_notify);
1462 (!test_bit(BR_FDB_LOCKED, &fdb->flags) ||
1463 READ_ONCE(fdb->dst) != p)) {
1468 fdb->updated = jiffies;
1470 if (READ_ONCE(fdb->dst) != p) {
1471 WRITE_ONCE(fdb->dst, p);
1475 if (test_bit(BR_FDB_ADDED_BY_EXT_LEARN, &fdb->flags)) {
1477 fdb->used = jiffies;
1478 } else if (!test_bit(BR_FDB_ADDED_BY_USER, &fdb->flags)) {
1479 /* Take over SW learned entry */
1480 set_bit(BR_FDB_ADDED_BY_EXT_LEARN, &fdb->flags);
1484 if (locked != test_bit(BR_FDB_LOCKED, &fdb->flags)) {
1485 change_bit(BR_FDB_LOCKED, &fdb->flags);
1490 set_bit(BR_FDB_ADDED_BY_USER, &fdb->flags);
1493 set_bit(BR_FDB_LOCAL, &fdb->flags);
1495 if ((swdev_notify || !p) &&
1496 test_and_clear_bit(BR_FDB_DYNAMIC_LEARNED, &fdb->flags))
1497 atomic_dec(&br->fdb_n_learned);
1500 fdb_notify(br, fdb, RTM_NEWNEIGH, swdev_notify);
1504 spin_unlock_bh(&br->hash_lock);
1509 int br_fdb_external_learn_del(struct net_bridge *br, struct net_bridge_port *p,
1510 const unsigned char *addr, u16 vid,
1513 struct net_bridge_fdb_entry *fdb;
1516 spin_lock_bh(&br->hash_lock);
1518 fdb = br_fdb_find(br, addr, vid);
1519 if (fdb && test_bit(BR_FDB_ADDED_BY_EXT_LEARN, &fdb->flags))
1520 fdb_delete(br, fdb, swdev_notify);
1524 spin_unlock_bh(&br->hash_lock);
1529 void br_fdb_offloaded_set(struct net_bridge *br, struct net_bridge_port *p,
1530 const unsigned char *addr, u16 vid, bool offloaded)
1532 struct net_bridge_fdb_entry *fdb;
1534 spin_lock_bh(&br->hash_lock);
1536 fdb = br_fdb_find(br, addr, vid);
1537 if (fdb && offloaded != test_bit(BR_FDB_OFFLOADED, &fdb->flags))
1538 change_bit(BR_FDB_OFFLOADED, &fdb->flags);
1540 spin_unlock_bh(&br->hash_lock);
1543 void br_fdb_clear_offload(const struct net_device *dev, u16 vid)
1545 struct net_bridge_fdb_entry *f;
1546 struct net_bridge_port *p;
1550 p = br_port_get_rtnl(dev);
1554 spin_lock_bh(&p->br->hash_lock);
1555 hlist_for_each_entry(f, &p->br->fdb_list, fdb_node) {
1556 if (f->dst == p && f->key.vlan_id == vid)
1557 clear_bit(BR_FDB_OFFLOADED, &f->flags);
1559 spin_unlock_bh(&p->br->hash_lock);
1561 EXPORT_SYMBOL_GPL(br_fdb_clear_offload);