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;
35 static int fdb_insert(struct net_bridge *br, struct net_bridge_port *source,
36 const unsigned char *addr, u16 vid);
37 static void fdb_notify(struct net_bridge *br,
38 const struct net_bridge_fdb_entry *, int, bool);
40 int __init br_fdb_init(void)
42 br_fdb_cache = kmem_cache_create("bridge_fdb_cache",
43 sizeof(struct net_bridge_fdb_entry),
45 SLAB_HWCACHE_ALIGN, NULL);
52 void br_fdb_fini(void)
54 kmem_cache_destroy(br_fdb_cache);
57 int br_fdb_hash_init(struct net_bridge *br)
59 return rhashtable_init(&br->fdb_hash_tbl, &br_fdb_rht_params);
62 void br_fdb_hash_fini(struct net_bridge *br)
64 rhashtable_destroy(&br->fdb_hash_tbl);
67 /* if topology_changing then use forward_delay (default 15 sec)
68 * otherwise keep longer (default 5 minutes)
70 static inline unsigned long hold_time(const struct net_bridge *br)
72 return br->topology_change ? br->forward_delay : br->ageing_time;
75 static inline int has_expired(const struct net_bridge *br,
76 const struct net_bridge_fdb_entry *fdb)
78 return !test_bit(BR_FDB_STATIC, &fdb->flags) &&
79 !test_bit(BR_FDB_ADDED_BY_EXT_LEARN, &fdb->flags) &&
80 time_before_eq(fdb->updated + hold_time(br), jiffies);
83 static void fdb_rcu_free(struct rcu_head *head)
85 struct net_bridge_fdb_entry *ent
86 = container_of(head, struct net_bridge_fdb_entry, rcu);
87 kmem_cache_free(br_fdb_cache, ent);
90 static struct net_bridge_fdb_entry *fdb_find_rcu(struct rhashtable *tbl,
91 const unsigned char *addr,
94 struct net_bridge_fdb_key key;
96 WARN_ON_ONCE(!rcu_read_lock_held());
99 memcpy(key.addr.addr, addr, sizeof(key.addr.addr));
101 return rhashtable_lookup(tbl, &key, br_fdb_rht_params);
104 /* requires bridge hash_lock */
105 static struct net_bridge_fdb_entry *br_fdb_find(struct net_bridge *br,
106 const unsigned char *addr,
109 struct net_bridge_fdb_entry *fdb;
111 lockdep_assert_held_once(&br->hash_lock);
114 fdb = fdb_find_rcu(&br->fdb_hash_tbl, addr, vid);
120 struct net_device *br_fdb_find_port(const struct net_device *br_dev,
121 const unsigned char *addr,
124 struct net_bridge_fdb_entry *f;
125 struct net_device *dev = NULL;
126 struct net_bridge *br;
130 if (!netif_is_bridge_master(br_dev))
133 br = netdev_priv(br_dev);
135 f = br_fdb_find_rcu(br, addr, vid);
142 EXPORT_SYMBOL_GPL(br_fdb_find_port);
144 struct net_bridge_fdb_entry *br_fdb_find_rcu(struct net_bridge *br,
145 const unsigned char *addr,
148 return fdb_find_rcu(&br->fdb_hash_tbl, addr, vid);
151 /* When a static FDB entry is added, the mac address from the entry is
152 * added to the bridge private HW address list and all required ports
153 * are then updated with the new information.
156 static void fdb_add_hw_addr(struct net_bridge *br, const unsigned char *addr)
159 struct net_bridge_port *p;
163 list_for_each_entry(p, &br->port_list, list) {
164 if (!br_promisc_port(p)) {
165 err = dev_uc_add(p->dev, addr);
173 list_for_each_entry_continue_reverse(p, &br->port_list, list) {
174 if (!br_promisc_port(p))
175 dev_uc_del(p->dev, addr);
179 /* When a static FDB entry is deleted, the HW address from that entry is
180 * also removed from the bridge private HW address list and updates all
181 * the ports with needed information.
184 static void fdb_del_hw_addr(struct net_bridge *br, const unsigned char *addr)
186 struct net_bridge_port *p;
190 list_for_each_entry(p, &br->port_list, list) {
191 if (!br_promisc_port(p))
192 dev_uc_del(p->dev, addr);
196 static void fdb_delete(struct net_bridge *br, struct net_bridge_fdb_entry *f,
199 trace_fdb_delete(br, f);
201 if (test_bit(BR_FDB_STATIC, &f->flags))
202 fdb_del_hw_addr(br, f->key.addr.addr);
204 hlist_del_init_rcu(&f->fdb_node);
205 rhashtable_remove_fast(&br->fdb_hash_tbl, &f->rhnode,
207 fdb_notify(br, f, RTM_DELNEIGH, swdev_notify);
208 call_rcu(&f->rcu, fdb_rcu_free);
211 /* Delete a local entry if no other port had the same address. */
212 static void fdb_delete_local(struct net_bridge *br,
213 const struct net_bridge_port *p,
214 struct net_bridge_fdb_entry *f)
216 const unsigned char *addr = f->key.addr.addr;
217 struct net_bridge_vlan_group *vg;
218 const struct net_bridge_vlan *v;
219 struct net_bridge_port *op;
220 u16 vid = f->key.vlan_id;
222 /* Maybe another port has same hw addr? */
223 list_for_each_entry(op, &br->port_list, list) {
224 vg = nbp_vlan_group(op);
225 if (op != p && ether_addr_equal(op->dev->dev_addr, addr) &&
226 (!vid || br_vlan_find(vg, vid))) {
228 clear_bit(BR_FDB_ADDED_BY_USER, &f->flags);
233 vg = br_vlan_group(br);
234 v = br_vlan_find(vg, vid);
235 /* Maybe bridge device has same hw addr? */
236 if (p && ether_addr_equal(br->dev->dev_addr, addr) &&
237 (!vid || (v && br_vlan_should_use(v)))) {
239 clear_bit(BR_FDB_ADDED_BY_USER, &f->flags);
243 fdb_delete(br, f, true);
246 void br_fdb_find_delete_local(struct net_bridge *br,
247 const struct net_bridge_port *p,
248 const unsigned char *addr, u16 vid)
250 struct net_bridge_fdb_entry *f;
252 spin_lock_bh(&br->hash_lock);
253 f = br_fdb_find(br, addr, vid);
254 if (f && test_bit(BR_FDB_LOCAL, &f->flags) &&
255 !test_bit(BR_FDB_ADDED_BY_USER, &f->flags) && f->dst == p)
256 fdb_delete_local(br, p, f);
257 spin_unlock_bh(&br->hash_lock);
260 void br_fdb_changeaddr(struct net_bridge_port *p, const unsigned char *newaddr)
262 struct net_bridge_vlan_group *vg;
263 struct net_bridge_fdb_entry *f;
264 struct net_bridge *br = p->br;
265 struct net_bridge_vlan *v;
267 spin_lock_bh(&br->hash_lock);
268 vg = nbp_vlan_group(p);
269 hlist_for_each_entry(f, &br->fdb_list, fdb_node) {
270 if (f->dst == p && test_bit(BR_FDB_LOCAL, &f->flags) &&
271 !test_bit(BR_FDB_ADDED_BY_USER, &f->flags)) {
273 fdb_delete_local(br, p, f);
275 /* if this port has no vlan information
276 * configured, we can safely be done at
279 if (!vg || !vg->num_vlans)
285 /* insert new address, may fail if invalid address or dup. */
286 fdb_insert(br, p, newaddr, 0);
288 if (!vg || !vg->num_vlans)
291 /* Now add entries for every VLAN configured on the port.
292 * This function runs under RTNL so the bitmap will not change
295 list_for_each_entry(v, &vg->vlan_list, vlist)
296 fdb_insert(br, p, newaddr, v->vid);
299 spin_unlock_bh(&br->hash_lock);
302 void br_fdb_change_mac_address(struct net_bridge *br, const u8 *newaddr)
304 struct net_bridge_vlan_group *vg;
305 struct net_bridge_fdb_entry *f;
306 struct net_bridge_vlan *v;
308 spin_lock_bh(&br->hash_lock);
310 /* If old entry was unassociated with any port, then delete it. */
311 f = br_fdb_find(br, br->dev->dev_addr, 0);
312 if (f && test_bit(BR_FDB_LOCAL, &f->flags) &&
313 !f->dst && !test_bit(BR_FDB_ADDED_BY_USER, &f->flags))
314 fdb_delete_local(br, NULL, f);
316 fdb_insert(br, NULL, newaddr, 0);
317 vg = br_vlan_group(br);
318 if (!vg || !vg->num_vlans)
320 /* Now remove and add entries for every VLAN configured on the
321 * bridge. This function runs under RTNL so the bitmap will not
322 * change from under us.
324 list_for_each_entry(v, &vg->vlan_list, vlist) {
325 if (!br_vlan_should_use(v))
327 f = br_fdb_find(br, br->dev->dev_addr, v->vid);
328 if (f && test_bit(BR_FDB_LOCAL, &f->flags) &&
329 !f->dst && !test_bit(BR_FDB_ADDED_BY_USER, &f->flags))
330 fdb_delete_local(br, NULL, f);
331 fdb_insert(br, NULL, newaddr, v->vid);
334 spin_unlock_bh(&br->hash_lock);
337 void br_fdb_cleanup(struct work_struct *work)
339 struct net_bridge *br = container_of(work, struct net_bridge,
341 struct net_bridge_fdb_entry *f = NULL;
342 unsigned long delay = hold_time(br);
343 unsigned long work_delay = delay;
344 unsigned long now = jiffies;
346 /* this part is tricky, in order to avoid blocking learning and
347 * consequently forwarding, we rely on rcu to delete objects with
348 * delayed freeing allowing us to continue traversing
351 hlist_for_each_entry_rcu(f, &br->fdb_list, fdb_node) {
352 unsigned long this_timer = f->updated + delay;
354 if (test_bit(BR_FDB_STATIC, &f->flags) ||
355 test_bit(BR_FDB_ADDED_BY_EXT_LEARN, &f->flags)) {
356 if (test_bit(BR_FDB_NOTIFY, &f->flags)) {
357 if (time_after(this_timer, now))
358 work_delay = min(work_delay,
360 else if (!test_and_set_bit(BR_FDB_NOTIFY_INACTIVE,
362 fdb_notify(br, f, RTM_NEWNEIGH, false);
367 if (time_after(this_timer, now)) {
368 work_delay = min(work_delay, this_timer - now);
370 spin_lock_bh(&br->hash_lock);
371 if (!hlist_unhashed(&f->fdb_node))
372 fdb_delete(br, f, true);
373 spin_unlock_bh(&br->hash_lock);
378 /* Cleanup minimum 10 milliseconds apart */
379 work_delay = max_t(unsigned long, work_delay, msecs_to_jiffies(10));
380 mod_delayed_work(system_long_wq, &br->gc_work, work_delay);
383 /* Completely flush all dynamic entries in forwarding database.*/
384 void br_fdb_flush(struct net_bridge *br)
386 struct net_bridge_fdb_entry *f;
387 struct hlist_node *tmp;
389 spin_lock_bh(&br->hash_lock);
390 hlist_for_each_entry_safe(f, tmp, &br->fdb_list, fdb_node) {
391 if (!test_bit(BR_FDB_STATIC, &f->flags))
392 fdb_delete(br, f, true);
394 spin_unlock_bh(&br->hash_lock);
397 /* Flush all entries referring to a specific port.
398 * if do_all is set also flush static entries
399 * if vid is set delete all entries that match the vlan_id
401 void br_fdb_delete_by_port(struct net_bridge *br,
402 const struct net_bridge_port *p,
406 struct net_bridge_fdb_entry *f;
407 struct hlist_node *tmp;
409 spin_lock_bh(&br->hash_lock);
410 hlist_for_each_entry_safe(f, tmp, &br->fdb_list, fdb_node) {
415 if (test_bit(BR_FDB_STATIC, &f->flags) ||
416 (test_bit(BR_FDB_ADDED_BY_EXT_LEARN, &f->flags) &&
417 !test_bit(BR_FDB_OFFLOADED, &f->flags)) ||
418 (vid && f->key.vlan_id != vid))
421 if (test_bit(BR_FDB_LOCAL, &f->flags))
422 fdb_delete_local(br, p, f);
424 fdb_delete(br, f, true);
426 spin_unlock_bh(&br->hash_lock);
429 #if IS_ENABLED(CONFIG_ATM_LANE)
430 /* Interface used by ATM LANE hook to test
431 * if an addr is on some other bridge port */
432 int br_fdb_test_addr(struct net_device *dev, unsigned char *addr)
434 struct net_bridge_fdb_entry *fdb;
435 struct net_bridge_port *port;
439 port = br_port_get_rcu(dev);
443 fdb = br_fdb_find_rcu(port->br, addr, 0);
444 ret = fdb && fdb->dst && fdb->dst->dev != dev &&
445 fdb->dst->state == BR_STATE_FORWARDING;
451 #endif /* CONFIG_ATM_LANE */
454 * Fill buffer with forwarding table records in
457 int br_fdb_fillbuf(struct net_bridge *br, void *buf,
458 unsigned long maxnum, unsigned long skip)
460 struct net_bridge_fdb_entry *f;
461 struct __fdb_entry *fe = buf;
464 memset(buf, 0, maxnum*sizeof(struct __fdb_entry));
467 hlist_for_each_entry_rcu(f, &br->fdb_list, fdb_node) {
471 if (has_expired(br, f))
474 /* ignore pseudo entry for local MAC address */
483 /* convert from internal format to API */
484 memcpy(fe->mac_addr, f->key.addr.addr, ETH_ALEN);
486 /* due to ABI compat need to split into hi/lo */
487 fe->port_no = f->dst->port_no;
488 fe->port_hi = f->dst->port_no >> 8;
490 fe->is_local = test_bit(BR_FDB_LOCAL, &f->flags);
491 if (!test_bit(BR_FDB_STATIC, &f->flags))
492 fe->ageing_timer_value = jiffies_delta_to_clock_t(jiffies - f->updated);
501 static struct net_bridge_fdb_entry *fdb_create(struct net_bridge *br,
502 struct net_bridge_port *source,
503 const unsigned char *addr,
507 struct net_bridge_fdb_entry *fdb;
509 fdb = kmem_cache_alloc(br_fdb_cache, GFP_ATOMIC);
511 memcpy(fdb->key.addr.addr, addr, ETH_ALEN);
513 fdb->key.vlan_id = vid;
515 fdb->updated = fdb->used = jiffies;
516 if (rhashtable_lookup_insert_fast(&br->fdb_hash_tbl,
518 br_fdb_rht_params)) {
519 kmem_cache_free(br_fdb_cache, fdb);
522 hlist_add_head_rcu(&fdb->fdb_node, &br->fdb_list);
528 static int fdb_insert(struct net_bridge *br, struct net_bridge_port *source,
529 const unsigned char *addr, u16 vid)
531 struct net_bridge_fdb_entry *fdb;
533 if (!is_valid_ether_addr(addr))
536 fdb = br_fdb_find(br, addr, vid);
538 /* it is okay to have multiple ports with same
539 * address, just use the first one.
541 if (test_bit(BR_FDB_LOCAL, &fdb->flags))
543 br_warn(br, "adding interface %s with same address as a received packet (addr:%pM, vlan:%u)\n",
544 source ? source->dev->name : br->dev->name, addr, vid);
545 fdb_delete(br, fdb, true);
548 fdb = fdb_create(br, source, addr, vid,
549 BIT(BR_FDB_LOCAL) | BIT(BR_FDB_STATIC));
553 fdb_add_hw_addr(br, addr);
554 fdb_notify(br, fdb, RTM_NEWNEIGH, true);
558 /* Add entry for local address of interface */
559 int br_fdb_insert(struct net_bridge *br, struct net_bridge_port *source,
560 const unsigned char *addr, u16 vid)
564 spin_lock_bh(&br->hash_lock);
565 ret = fdb_insert(br, source, addr, vid);
566 spin_unlock_bh(&br->hash_lock);
570 /* returns true if the fdb was modified */
571 static bool __fdb_mark_active(struct net_bridge_fdb_entry *fdb)
573 return !!(test_bit(BR_FDB_NOTIFY_INACTIVE, &fdb->flags) &&
574 test_and_clear_bit(BR_FDB_NOTIFY_INACTIVE, &fdb->flags));
577 void br_fdb_update(struct net_bridge *br, struct net_bridge_port *source,
578 const unsigned char *addr, u16 vid, unsigned long flags)
580 struct net_bridge_fdb_entry *fdb;
582 /* some users want to always flood. */
583 if (hold_time(br) == 0)
586 fdb = fdb_find_rcu(&br->fdb_hash_tbl, addr, vid);
588 /* attempt to update an entry for a local interface */
589 if (unlikely(test_bit(BR_FDB_LOCAL, &fdb->flags))) {
591 br_warn(br, "received packet on %s with own address as source address (addr:%pM, vlan:%u)\n",
592 source->dev->name, addr, vid);
594 unsigned long now = jiffies;
595 bool fdb_modified = false;
597 if (now != fdb->updated) {
599 fdb_modified = __fdb_mark_active(fdb);
602 /* fastpath: update of existing entry */
603 if (unlikely(source != fdb->dst &&
604 !test_bit(BR_FDB_STICKY, &fdb->flags))) {
605 br_switchdev_fdb_notify(fdb, RTM_DELNEIGH);
608 /* Take over HW learned entry */
609 if (unlikely(test_bit(BR_FDB_ADDED_BY_EXT_LEARN,
611 clear_bit(BR_FDB_ADDED_BY_EXT_LEARN,
615 if (unlikely(test_bit(BR_FDB_ADDED_BY_USER, &flags)))
616 set_bit(BR_FDB_ADDED_BY_USER, &fdb->flags);
617 if (unlikely(fdb_modified)) {
618 trace_br_fdb_update(br, source, addr, vid, flags);
619 fdb_notify(br, fdb, RTM_NEWNEIGH, true);
623 spin_lock(&br->hash_lock);
624 fdb = fdb_create(br, source, addr, vid, flags);
626 trace_br_fdb_update(br, source, addr, vid, flags);
627 fdb_notify(br, fdb, RTM_NEWNEIGH, true);
629 /* else we lose race and someone else inserts
630 * it first, don't bother updating
632 spin_unlock(&br->hash_lock);
636 static int fdb_to_nud(const struct net_bridge *br,
637 const struct net_bridge_fdb_entry *fdb)
639 if (test_bit(BR_FDB_LOCAL, &fdb->flags))
640 return NUD_PERMANENT;
641 else if (test_bit(BR_FDB_STATIC, &fdb->flags))
643 else if (has_expired(br, fdb))
646 return NUD_REACHABLE;
649 static int fdb_fill_info(struct sk_buff *skb, const struct net_bridge *br,
650 const struct net_bridge_fdb_entry *fdb,
651 u32 portid, u32 seq, int type, unsigned int flags)
653 unsigned long now = jiffies;
654 struct nda_cacheinfo ci;
655 struct nlmsghdr *nlh;
658 nlh = nlmsg_put(skb, portid, seq, type, sizeof(*ndm), flags);
662 ndm = nlmsg_data(nlh);
663 ndm->ndm_family = AF_BRIDGE;
668 ndm->ndm_ifindex = fdb->dst ? fdb->dst->dev->ifindex : br->dev->ifindex;
669 ndm->ndm_state = fdb_to_nud(br, fdb);
671 if (test_bit(BR_FDB_OFFLOADED, &fdb->flags))
672 ndm->ndm_flags |= NTF_OFFLOADED;
673 if (test_bit(BR_FDB_ADDED_BY_EXT_LEARN, &fdb->flags))
674 ndm->ndm_flags |= NTF_EXT_LEARNED;
675 if (test_bit(BR_FDB_STICKY, &fdb->flags))
676 ndm->ndm_flags |= NTF_STICKY;
678 if (nla_put(skb, NDA_LLADDR, ETH_ALEN, &fdb->key.addr))
679 goto nla_put_failure;
680 if (nla_put_u32(skb, NDA_MASTER, br->dev->ifindex))
681 goto nla_put_failure;
682 ci.ndm_used = jiffies_to_clock_t(now - fdb->used);
683 ci.ndm_confirmed = 0;
684 ci.ndm_updated = jiffies_to_clock_t(now - fdb->updated);
686 if (nla_put(skb, NDA_CACHEINFO, sizeof(ci), &ci))
687 goto nla_put_failure;
689 if (fdb->key.vlan_id && nla_put(skb, NDA_VLAN, sizeof(u16),
691 goto nla_put_failure;
693 if (test_bit(BR_FDB_NOTIFY, &fdb->flags)) {
694 struct nlattr *nest = nla_nest_start(skb, NDA_FDB_EXT_ATTRS);
695 u8 notify_bits = FDB_NOTIFY_BIT;
698 goto nla_put_failure;
699 if (test_bit(BR_FDB_NOTIFY_INACTIVE, &fdb->flags))
700 notify_bits |= FDB_NOTIFY_INACTIVE_BIT;
702 if (nla_put_u8(skb, NFEA_ACTIVITY_NOTIFY, notify_bits)) {
703 nla_nest_cancel(skb, nest);
704 goto nla_put_failure;
707 nla_nest_end(skb, nest);
714 nlmsg_cancel(skb, nlh);
718 static inline size_t fdb_nlmsg_size(void)
720 return NLMSG_ALIGN(sizeof(struct ndmsg))
721 + nla_total_size(ETH_ALEN) /* NDA_LLADDR */
722 + nla_total_size(sizeof(u32)) /* NDA_MASTER */
723 + nla_total_size(sizeof(u16)) /* NDA_VLAN */
724 + nla_total_size(sizeof(struct nda_cacheinfo))
725 + nla_total_size(0) /* NDA_FDB_EXT_ATTRS */
726 + nla_total_size(sizeof(u8)); /* NFEA_ACTIVITY_NOTIFY */
729 static void fdb_notify(struct net_bridge *br,
730 const struct net_bridge_fdb_entry *fdb, int type,
733 struct net *net = dev_net(br->dev);
738 br_switchdev_fdb_notify(fdb, type);
740 skb = nlmsg_new(fdb_nlmsg_size(), GFP_ATOMIC);
744 err = fdb_fill_info(skb, br, fdb, 0, 0, type, 0);
746 /* -EMSGSIZE implies BUG in fdb_nlmsg_size() */
747 WARN_ON(err == -EMSGSIZE);
751 rtnl_notify(skb, net, 0, RTNLGRP_NEIGH, NULL, GFP_ATOMIC);
754 rtnl_set_sk_err(net, RTNLGRP_NEIGH, err);
757 /* Dump information about entries, in response to GETNEIGH */
758 int br_fdb_dump(struct sk_buff *skb,
759 struct netlink_callback *cb,
760 struct net_device *dev,
761 struct net_device *filter_dev,
764 struct net_bridge *br = netdev_priv(dev);
765 struct net_bridge_fdb_entry *f;
768 if (!(dev->priv_flags & IFF_EBRIDGE))
772 err = ndo_dflt_fdb_dump(skb, cb, dev, NULL, idx);
778 hlist_for_each_entry_rcu(f, &br->fdb_list, fdb_node) {
779 if (*idx < cb->args[2])
781 if (filter_dev && (!f->dst || f->dst->dev != filter_dev)) {
782 if (filter_dev != dev)
784 /* !f->dst is a special case for bridge
785 * It means the MAC belongs to the bridge
786 * Therefore need a little more filtering
787 * we only want to dump the !f->dst case
792 if (!filter_dev && f->dst)
795 err = fdb_fill_info(skb, br, f,
796 NETLINK_CB(cb->skb).portid,
810 int br_fdb_get(struct sk_buff *skb,
812 struct net_device *dev,
813 const unsigned char *addr,
814 u16 vid, u32 portid, u32 seq,
815 struct netlink_ext_ack *extack)
817 struct net_bridge *br = netdev_priv(dev);
818 struct net_bridge_fdb_entry *f;
822 f = br_fdb_find_rcu(br, addr, vid);
824 NL_SET_ERR_MSG(extack, "Fdb entry not found");
829 err = fdb_fill_info(skb, br, f, portid, seq,
836 /* returns true if the fdb is modified */
837 static bool fdb_handle_notify(struct net_bridge_fdb_entry *fdb, u8 notify)
839 bool modified = false;
841 /* allow to mark an entry as inactive, usually done on creation */
842 if ((notify & FDB_NOTIFY_INACTIVE_BIT) &&
843 !test_and_set_bit(BR_FDB_NOTIFY_INACTIVE, &fdb->flags))
846 if ((notify & FDB_NOTIFY_BIT) &&
847 !test_and_set_bit(BR_FDB_NOTIFY, &fdb->flags)) {
848 /* enabled activity tracking */
850 } else if (!(notify & FDB_NOTIFY_BIT) &&
851 test_and_clear_bit(BR_FDB_NOTIFY, &fdb->flags)) {
852 /* disabled activity tracking, clear notify state */
853 clear_bit(BR_FDB_NOTIFY_INACTIVE, &fdb->flags);
860 /* Update (create or replace) forwarding database entry */
861 static int fdb_add_entry(struct net_bridge *br, struct net_bridge_port *source,
862 const u8 *addr, struct ndmsg *ndm, u16 flags, u16 vid,
863 struct nlattr *nfea_tb[])
865 bool is_sticky = !!(ndm->ndm_flags & NTF_STICKY);
866 bool refresh = !nfea_tb[NFEA_DONT_REFRESH];
867 struct net_bridge_fdb_entry *fdb;
868 u16 state = ndm->ndm_state;
869 bool modified = false;
872 /* If the port cannot learn allow only local and static entries */
873 if (source && !(state & NUD_PERMANENT) && !(state & NUD_NOARP) &&
874 !(source->state == BR_STATE_LEARNING ||
875 source->state == BR_STATE_FORWARDING))
878 if (!source && !(state & NUD_PERMANENT)) {
879 pr_info("bridge: RTM_NEWNEIGH %s without NUD_PERMANENT\n",
884 if (is_sticky && (state & NUD_PERMANENT))
887 if (nfea_tb[NFEA_ACTIVITY_NOTIFY]) {
888 notify = nla_get_u8(nfea_tb[NFEA_ACTIVITY_NOTIFY]);
889 if ((notify & ~BR_FDB_NOTIFY_SETTABLE_BITS) ||
890 (notify & BR_FDB_NOTIFY_SETTABLE_BITS) == FDB_NOTIFY_INACTIVE_BIT)
894 fdb = br_fdb_find(br, addr, vid);
896 if (!(flags & NLM_F_CREATE))
899 fdb = fdb_create(br, source, addr, vid, 0);
905 if (flags & NLM_F_EXCL)
908 if (fdb->dst != source) {
914 if (fdb_to_nud(br, fdb) != state) {
915 if (state & NUD_PERMANENT) {
916 set_bit(BR_FDB_LOCAL, &fdb->flags);
917 if (!test_and_set_bit(BR_FDB_STATIC, &fdb->flags))
918 fdb_add_hw_addr(br, addr);
919 } else if (state & NUD_NOARP) {
920 clear_bit(BR_FDB_LOCAL, &fdb->flags);
921 if (!test_and_set_bit(BR_FDB_STATIC, &fdb->flags))
922 fdb_add_hw_addr(br, addr);
924 clear_bit(BR_FDB_LOCAL, &fdb->flags);
925 if (test_and_clear_bit(BR_FDB_STATIC, &fdb->flags))
926 fdb_del_hw_addr(br, addr);
932 if (is_sticky != test_bit(BR_FDB_STICKY, &fdb->flags)) {
933 change_bit(BR_FDB_STICKY, &fdb->flags);
937 if (fdb_handle_notify(fdb, notify))
940 set_bit(BR_FDB_ADDED_BY_USER, &fdb->flags);
945 fdb->updated = jiffies;
946 fdb_notify(br, fdb, RTM_NEWNEIGH, true);
952 static int __br_fdb_add(struct ndmsg *ndm, struct net_bridge *br,
953 struct net_bridge_port *p, const unsigned char *addr,
954 u16 nlh_flags, u16 vid, struct nlattr *nfea_tb[])
958 if (ndm->ndm_flags & NTF_USE) {
960 pr_info("bridge: RTM_NEWNEIGH %s with NTF_USE is not supported\n",
964 if (!nbp_state_should_learn(p))
969 br_fdb_update(br, p, addr, vid, BIT(BR_FDB_ADDED_BY_USER));
972 } else if (ndm->ndm_flags & NTF_EXT_LEARNED) {
973 err = br_fdb_external_learn_add(br, p, addr, vid, true);
975 spin_lock_bh(&br->hash_lock);
976 err = fdb_add_entry(br, p, addr, ndm, nlh_flags, vid, nfea_tb);
977 spin_unlock_bh(&br->hash_lock);
983 static const struct nla_policy br_nda_fdb_pol[NFEA_MAX + 1] = {
984 [NFEA_ACTIVITY_NOTIFY] = { .type = NLA_U8 },
985 [NFEA_DONT_REFRESH] = { .type = NLA_FLAG },
988 /* Add new permanent fdb entry with RTM_NEWNEIGH */
989 int br_fdb_add(struct ndmsg *ndm, struct nlattr *tb[],
990 struct net_device *dev,
991 const unsigned char *addr, u16 vid, u16 nlh_flags,
992 struct netlink_ext_ack *extack)
994 struct nlattr *nfea_tb[NFEA_MAX + 1], *attr;
995 struct net_bridge_vlan_group *vg;
996 struct net_bridge_port *p = NULL;
997 struct net_bridge_vlan *v;
998 struct net_bridge *br = NULL;
1001 trace_br_fdb_add(ndm, dev, addr, vid, nlh_flags);
1003 if (!(ndm->ndm_state & (NUD_PERMANENT|NUD_NOARP|NUD_REACHABLE))) {
1004 pr_info("bridge: RTM_NEWNEIGH with invalid state %#x\n", ndm->ndm_state);
1008 if (is_zero_ether_addr(addr)) {
1009 pr_info("bridge: RTM_NEWNEIGH with invalid ether address\n");
1013 if (dev->priv_flags & IFF_EBRIDGE) {
1014 br = netdev_priv(dev);
1015 vg = br_vlan_group(br);
1017 p = br_port_get_rtnl(dev);
1019 pr_info("bridge: RTM_NEWNEIGH %s not a bridge port\n",
1024 vg = nbp_vlan_group(p);
1027 if (tb[NDA_FDB_EXT_ATTRS]) {
1028 attr = tb[NDA_FDB_EXT_ATTRS];
1029 err = nla_parse_nested(nfea_tb, NFEA_MAX, attr,
1030 br_nda_fdb_pol, extack);
1034 memset(nfea_tb, 0, sizeof(struct nlattr *) * (NFEA_MAX + 1));
1038 v = br_vlan_find(vg, vid);
1039 if (!v || !br_vlan_should_use(v)) {
1040 pr_info("bridge: RTM_NEWNEIGH with unconfigured vlan %d on %s\n", vid, dev->name);
1044 /* VID was specified, so use it. */
1045 err = __br_fdb_add(ndm, br, p, addr, nlh_flags, vid, nfea_tb);
1047 err = __br_fdb_add(ndm, br, p, addr, nlh_flags, 0, nfea_tb);
1048 if (err || !vg || !vg->num_vlans)
1051 /* We have vlans configured on this port and user didn't
1052 * specify a VLAN. To be nice, add/update entry for every
1053 * vlan on this port.
1055 list_for_each_entry(v, &vg->vlan_list, vlist) {
1056 if (!br_vlan_should_use(v))
1058 err = __br_fdb_add(ndm, br, p, addr, nlh_flags, v->vid,
1069 static int fdb_delete_by_addr_and_port(struct net_bridge *br,
1070 const struct net_bridge_port *p,
1071 const u8 *addr, u16 vlan)
1073 struct net_bridge_fdb_entry *fdb;
1075 fdb = br_fdb_find(br, addr, vlan);
1076 if (!fdb || fdb->dst != p)
1079 fdb_delete(br, fdb, true);
1084 static int __br_fdb_delete(struct net_bridge *br,
1085 const struct net_bridge_port *p,
1086 const unsigned char *addr, u16 vid)
1090 spin_lock_bh(&br->hash_lock);
1091 err = fdb_delete_by_addr_and_port(br, p, addr, vid);
1092 spin_unlock_bh(&br->hash_lock);
1097 /* Remove neighbor entry with RTM_DELNEIGH */
1098 int br_fdb_delete(struct ndmsg *ndm, struct nlattr *tb[],
1099 struct net_device *dev,
1100 const unsigned char *addr, u16 vid)
1102 struct net_bridge_vlan_group *vg;
1103 struct net_bridge_port *p = NULL;
1104 struct net_bridge_vlan *v;
1105 struct net_bridge *br;
1108 if (dev->priv_flags & IFF_EBRIDGE) {
1109 br = netdev_priv(dev);
1110 vg = br_vlan_group(br);
1112 p = br_port_get_rtnl(dev);
1114 pr_info("bridge: RTM_DELNEIGH %s not a bridge port\n",
1118 vg = nbp_vlan_group(p);
1123 v = br_vlan_find(vg, vid);
1125 pr_info("bridge: RTM_DELNEIGH with unconfigured vlan %d on %s\n", vid, dev->name);
1129 err = __br_fdb_delete(br, p, addr, vid);
1132 err &= __br_fdb_delete(br, p, addr, 0);
1133 if (!vg || !vg->num_vlans)
1136 list_for_each_entry(v, &vg->vlan_list, vlist) {
1137 if (!br_vlan_should_use(v))
1139 err &= __br_fdb_delete(br, p, addr, v->vid);
1146 int br_fdb_sync_static(struct net_bridge *br, struct net_bridge_port *p)
1148 struct net_bridge_fdb_entry *f, *tmp;
1153 /* the key here is that static entries change only under rtnl */
1155 hlist_for_each_entry_rcu(f, &br->fdb_list, fdb_node) {
1156 /* We only care for static entries */
1157 if (!test_bit(BR_FDB_STATIC, &f->flags))
1159 err = dev_uc_add(p->dev, f->key.addr.addr);
1169 hlist_for_each_entry_rcu(tmp, &br->fdb_list, fdb_node) {
1170 /* We only care for static entries */
1171 if (!test_bit(BR_FDB_STATIC, &tmp->flags))
1175 dev_uc_del(p->dev, tmp->key.addr.addr);
1181 void br_fdb_unsync_static(struct net_bridge *br, struct net_bridge_port *p)
1183 struct net_bridge_fdb_entry *f;
1188 hlist_for_each_entry_rcu(f, &br->fdb_list, fdb_node) {
1189 /* We only care for static entries */
1190 if (!test_bit(BR_FDB_STATIC, &f->flags))
1193 dev_uc_del(p->dev, f->key.addr.addr);
1198 int br_fdb_external_learn_add(struct net_bridge *br, struct net_bridge_port *p,
1199 const unsigned char *addr, u16 vid,
1202 struct net_bridge_fdb_entry *fdb;
1203 bool modified = false;
1206 trace_br_fdb_external_learn_add(br, p, addr, vid);
1208 spin_lock_bh(&br->hash_lock);
1210 fdb = br_fdb_find(br, addr, vid);
1212 unsigned long flags = BIT(BR_FDB_ADDED_BY_EXT_LEARN);
1215 flags |= BIT(BR_FDB_ADDED_BY_USER);
1216 fdb = fdb_create(br, p, addr, vid, flags);
1221 fdb_notify(br, fdb, RTM_NEWNEIGH, swdev_notify);
1223 fdb->updated = jiffies;
1225 if (fdb->dst != p) {
1230 if (test_bit(BR_FDB_ADDED_BY_EXT_LEARN, &fdb->flags)) {
1232 fdb->used = jiffies;
1233 } else if (!test_bit(BR_FDB_ADDED_BY_USER, &fdb->flags)) {
1234 /* Take over SW learned entry */
1235 set_bit(BR_FDB_ADDED_BY_EXT_LEARN, &fdb->flags);
1240 set_bit(BR_FDB_ADDED_BY_USER, &fdb->flags);
1243 fdb_notify(br, fdb, RTM_NEWNEIGH, swdev_notify);
1247 spin_unlock_bh(&br->hash_lock);
1252 int br_fdb_external_learn_del(struct net_bridge *br, struct net_bridge_port *p,
1253 const unsigned char *addr, u16 vid,
1256 struct net_bridge_fdb_entry *fdb;
1259 spin_lock_bh(&br->hash_lock);
1261 fdb = br_fdb_find(br, addr, vid);
1262 if (fdb && test_bit(BR_FDB_ADDED_BY_EXT_LEARN, &fdb->flags))
1263 fdb_delete(br, fdb, swdev_notify);
1267 spin_unlock_bh(&br->hash_lock);
1272 void br_fdb_offloaded_set(struct net_bridge *br, struct net_bridge_port *p,
1273 const unsigned char *addr, u16 vid, bool offloaded)
1275 struct net_bridge_fdb_entry *fdb;
1277 spin_lock_bh(&br->hash_lock);
1279 fdb = br_fdb_find(br, addr, vid);
1280 if (fdb && offloaded != test_bit(BR_FDB_OFFLOADED, &fdb->flags))
1281 change_bit(BR_FDB_OFFLOADED, &fdb->flags);
1283 spin_unlock_bh(&br->hash_lock);
1286 void br_fdb_clear_offload(const struct net_device *dev, u16 vid)
1288 struct net_bridge_fdb_entry *f;
1289 struct net_bridge_port *p;
1293 p = br_port_get_rtnl(dev);
1297 spin_lock_bh(&p->br->hash_lock);
1298 hlist_for_each_entry(f, &p->br->fdb_list, fdb_node) {
1299 if (f->dst == p && f->key.vlan_id == vid)
1300 clear_bit(BR_FDB_OFFLOADED, &f->flags);
1302 spin_unlock_bh(&p->br->hash_lock);
1304 EXPORT_SYMBOL_GPL(br_fdb_clear_offload);