xref: /linux/net/bridge/br_fdb.c (revision 0e59523b440c90ed1899476f32ad4e949282f43e)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  *	Forwarding database
4  *	Linux ethernet bridge
5  *
6  *	Authors:
7  *	Lennert Buytenhek		<buytenh@gnu.org>
8  */
9 
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 <linux/unaligned.h>
22 #include <linux/if_vlan.h>
23 #include <net/switchdev.h>
24 #include <trace/events/bridge.h>
25 #include "br_private.h"
26 
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,
32 };
33 
34 static struct kmem_cache *br_fdb_cache __read_mostly;
35 
36 int __init br_fdb_init(void)
37 {
38 	br_fdb_cache = KMEM_CACHE(net_bridge_fdb_entry, SLAB_HWCACHE_ALIGN);
39 	if (!br_fdb_cache)
40 		return -ENOMEM;
41 
42 	return 0;
43 }
44 
45 void br_fdb_fini(void)
46 {
47 	kmem_cache_destroy(br_fdb_cache);
48 }
49 
50 int br_fdb_hash_init(struct net_bridge *br)
51 {
52 	return rhashtable_init(&br->fdb_hash_tbl, &br_fdb_rht_params);
53 }
54 
55 void br_fdb_hash_fini(struct net_bridge *br)
56 {
57 	rhashtable_destroy(&br->fdb_hash_tbl);
58 }
59 
60 /* if topology_changing then use forward_delay (default 15 sec)
61  * otherwise keep longer (default 5 minutes)
62  */
63 static inline unsigned long hold_time(const struct net_bridge *br)
64 {
65 	return br->topology_change ? br->forward_delay : br->ageing_time;
66 }
67 
68 static inline int has_expired(const struct net_bridge *br,
69 				  const struct net_bridge_fdb_entry *fdb)
70 {
71 	return !test_bit(BR_FDB_STATIC, &fdb->flags) &&
72 	       !test_bit(BR_FDB_ADDED_BY_EXT_LEARN, &fdb->flags) &&
73 	       time_before_eq(READ_ONCE(fdb->updated) + hold_time(br), jiffies);
74 }
75 
76 static int fdb_to_nud(const struct net_bridge *br,
77 		      const struct net_bridge_fdb_entry *fdb)
78 {
79 	if (test_bit(BR_FDB_LOCAL, &fdb->flags))
80 		return NUD_PERMANENT;
81 	else if (test_bit(BR_FDB_STATIC, &fdb->flags))
82 		return NUD_NOARP;
83 	else if (has_expired(br, fdb))
84 		return NUD_STALE;
85 	else
86 		return NUD_REACHABLE;
87 }
88 
89 static int fdb_fill_info(struct sk_buff *skb, const struct net_bridge *br,
90 			 const struct net_bridge_fdb_entry *fdb,
91 			 u32 portid, u32 seq, int type, unsigned int flags)
92 {
93 	const struct net_bridge_port *dst = br_fdb_dst_port(fdb);
94 	unsigned long now = jiffies;
95 	struct nda_cacheinfo ci;
96 	struct nlmsghdr *nlh;
97 	struct ndmsg *ndm;
98 	u32 ext_flags = 0;
99 
100 	nlh = nlmsg_put(skb, portid, seq, type, sizeof(*ndm), flags);
101 	if (nlh == NULL)
102 		return -EMSGSIZE;
103 
104 	ndm = nlmsg_data(nlh);
105 	ndm->ndm_family	 = AF_BRIDGE;
106 	ndm->ndm_pad1    = 0;
107 	ndm->ndm_pad2    = 0;
108 	ndm->ndm_flags	 = 0;
109 	ndm->ndm_type	 = 0;
110 	ndm->ndm_ifindex = dst ? dst->dev->ifindex : br->dev->ifindex;
111 	ndm->ndm_state   = fdb_to_nud(br, fdb);
112 
113 	if (test_bit(BR_FDB_OFFLOADED, &fdb->flags))
114 		ndm->ndm_flags |= NTF_OFFLOADED;
115 	if (test_bit(BR_FDB_ADDED_BY_EXT_LEARN, &fdb->flags))
116 		ndm->ndm_flags |= NTF_EXT_LEARNED;
117 	if (test_bit(BR_FDB_STICKY, &fdb->flags))
118 		ndm->ndm_flags |= NTF_STICKY;
119 	if (test_bit(BR_FDB_LOCKED, &fdb->flags))
120 		ext_flags |= NTF_EXT_LOCKED;
121 
122 	if (nla_put(skb, NDA_LLADDR, ETH_ALEN, &fdb->key.addr))
123 		goto nla_put_failure;
124 	if (nla_put_u32(skb, NDA_MASTER, br->dev->ifindex))
125 		goto nla_put_failure;
126 	if (nla_put_u32(skb, NDA_FLAGS_EXT, ext_flags))
127 		goto nla_put_failure;
128 
129 	ci.ndm_used	 = jiffies_to_clock_t(now - READ_ONCE(fdb->used));
130 	ci.ndm_confirmed = 0;
131 	ci.ndm_updated	 = jiffies_to_clock_t(now - READ_ONCE(fdb->updated));
132 	ci.ndm_refcnt	 = 0;
133 	if (nla_put(skb, NDA_CACHEINFO, sizeof(ci), &ci))
134 		goto nla_put_failure;
135 
136 	if (fdb->key.vlan_id && nla_put(skb, NDA_VLAN, sizeof(u16),
137 					&fdb->key.vlan_id))
138 		goto nla_put_failure;
139 
140 	if (test_bit(BR_FDB_NOTIFY, &fdb->flags)) {
141 		struct nlattr *nest = nla_nest_start(skb, NDA_FDB_EXT_ATTRS);
142 		u8 notify_bits = FDB_NOTIFY_BIT;
143 
144 		if (!nest)
145 			goto nla_put_failure;
146 		if (test_bit(BR_FDB_NOTIFY_INACTIVE, &fdb->flags))
147 			notify_bits |= FDB_NOTIFY_INACTIVE_BIT;
148 
149 		if (nla_put_u8(skb, NFEA_ACTIVITY_NOTIFY, notify_bits)) {
150 			nla_nest_cancel(skb, nest);
151 			goto nla_put_failure;
152 		}
153 
154 		nla_nest_end(skb, nest);
155 	}
156 
157 	nlmsg_end(skb, nlh);
158 	return 0;
159 
160 nla_put_failure:
161 	nlmsg_cancel(skb, nlh);
162 	return -EMSGSIZE;
163 }
164 
165 static inline size_t fdb_nlmsg_size(void)
166 {
167 	return NLMSG_ALIGN(sizeof(struct ndmsg))
168 		+ nla_total_size(ETH_ALEN) /* NDA_LLADDR */
169 		+ nla_total_size(sizeof(u32)) /* NDA_MASTER */
170 		+ nla_total_size(sizeof(u32)) /* NDA_FLAGS_EXT */
171 		+ nla_total_size(sizeof(u16)) /* NDA_VLAN */
172 		+ nla_total_size(sizeof(struct nda_cacheinfo))
173 		+ nla_total_size(0) /* NDA_FDB_EXT_ATTRS */
174 		+ nla_total_size(sizeof(u8)); /* NFEA_ACTIVITY_NOTIFY */
175 }
176 
177 static void fdb_notify(struct net_bridge *br,
178 		       const struct net_bridge_fdb_entry *fdb, int type,
179 		       bool swdev_notify)
180 {
181 	struct net *net = dev_net(br->dev);
182 	struct sk_buff *skb;
183 	int err = -ENOBUFS;
184 
185 	if (swdev_notify)
186 		br_switchdev_fdb_notify(br, fdb, type);
187 
188 	skb = nlmsg_new(fdb_nlmsg_size(), GFP_ATOMIC);
189 	if (skb == NULL)
190 		goto errout;
191 
192 	err = fdb_fill_info(skb, br, fdb, 0, 0, type, 0);
193 	if (err < 0) {
194 		/* -EMSGSIZE implies BUG in fdb_nlmsg_size() */
195 		WARN_ON(err == -EMSGSIZE);
196 		kfree_skb(skb);
197 		goto errout;
198 	}
199 	rtnl_notify(skb, net, 0, RTNLGRP_NEIGH, NULL, GFP_ATOMIC);
200 	return;
201 errout:
202 	rtnl_set_sk_err(net, RTNLGRP_NEIGH, err);
203 }
204 
205 static struct net_bridge_fdb_entry *fdb_find_rcu(struct rhashtable *tbl,
206 						 const unsigned char *addr,
207 						 __u16 vid)
208 {
209 	struct net_bridge_fdb_key key;
210 
211 	WARN_ON_ONCE(!rcu_read_lock_held());
212 
213 	key.vlan_id = vid;
214 	memcpy(key.addr.addr, addr, sizeof(key.addr.addr));
215 
216 	return rhashtable_lookup(tbl, &key, br_fdb_rht_params);
217 }
218 
219 /* requires bridge hash_lock */
220 static struct net_bridge_fdb_entry *br_fdb_find(struct net_bridge *br,
221 						const unsigned char *addr,
222 						__u16 vid)
223 {
224 	struct net_bridge_fdb_entry *fdb;
225 
226 	lockdep_assert_held_once(&br->hash_lock);
227 
228 	rcu_read_lock();
229 	fdb = fdb_find_rcu(&br->fdb_hash_tbl, addr, vid);
230 	rcu_read_unlock();
231 
232 	return fdb;
233 }
234 
235 struct net_device *br_fdb_find_port(const struct net_device *br_dev,
236 				    const unsigned char *addr,
237 				    __u16 vid)
238 {
239 	const struct net_bridge_port *dst;
240 	struct net_bridge_fdb_entry *f;
241 	struct net_device *dev = NULL;
242 	struct net_bridge *br;
243 
244 	ASSERT_RTNL();
245 
246 	if (!netif_is_bridge_master(br_dev))
247 		return NULL;
248 
249 	br = netdev_priv(br_dev);
250 	rcu_read_lock();
251 	f = br_fdb_find_rcu(br, addr, vid);
252 	if (f) {
253 		dst = br_fdb_dst_port(f);
254 		if (dst)
255 			dev = dst->dev;
256 	}
257 	rcu_read_unlock();
258 
259 	return dev;
260 }
261 EXPORT_SYMBOL_GPL(br_fdb_find_port);
262 
263 struct net_bridge_fdb_entry *br_fdb_find_rcu(struct net_bridge *br,
264 					     const unsigned char *addr,
265 					     __u16 vid)
266 {
267 	return fdb_find_rcu(&br->fdb_hash_tbl, addr, vid);
268 }
269 
270 /* When a static FDB entry is added, the mac address from the entry is
271  * added to the bridge private HW address list and all required ports
272  * are then updated with the new information.
273  * Called under RTNL.
274  */
275 static void fdb_add_hw_addr(struct net_bridge *br, const unsigned char *addr)
276 {
277 	int err;
278 	struct net_bridge_port *p;
279 
280 	ASSERT_RTNL();
281 
282 	list_for_each_entry(p, &br->port_list, list) {
283 		if (!br_promisc_port(p)) {
284 			err = dev_uc_add(p->dev, addr);
285 			if (err)
286 				goto undo;
287 		}
288 	}
289 
290 	return;
291 undo:
292 	list_for_each_entry_continue_reverse(p, &br->port_list, list) {
293 		if (!br_promisc_port(p))
294 			dev_uc_del(p->dev, addr);
295 	}
296 }
297 
298 /* When a static FDB entry is deleted, the HW address from that entry is
299  * also removed from the bridge private HW address list and updates all
300  * the ports with needed information.
301  * Called under RTNL.
302  */
303 static void fdb_del_hw_addr(struct net_bridge *br, const unsigned char *addr)
304 {
305 	struct net_bridge_port *p;
306 
307 	ASSERT_RTNL();
308 
309 	list_for_each_entry(p, &br->port_list, list) {
310 		if (!br_promisc_port(p))
311 			dev_uc_del(p->dev, addr);
312 	}
313 }
314 
315 static void fdb_delete(struct net_bridge *br, struct net_bridge_fdb_entry *f,
316 		       bool swdev_notify)
317 {
318 	trace_fdb_delete(br, f, br_fdb_dst_port(f));
319 
320 	if (test_bit(BR_FDB_STATIC, &f->flags))
321 		fdb_del_hw_addr(br, f->key.addr.addr);
322 
323 	hlist_del_init_rcu(&f->fdb_node);
324 	rhashtable_remove_fast(&br->fdb_hash_tbl, &f->rhnode,
325 			       br_fdb_rht_params);
326 	if (test_and_clear_bit(BR_FDB_DYNAMIC_LEARNED, &f->flags))
327 		atomic_dec(&br->fdb_n_learned);
328 	fdb_notify(br, f, RTM_DELNEIGH, swdev_notify);
329 	kfree_rcu(f, rcu);
330 }
331 
332 /* Delete a local entry if no other port had the same address.
333  *
334  * This function should only be called on entries with BR_FDB_LOCAL set,
335  * so even with BR_FDB_ADDED_BY_USER cleared we never need to increase
336  * the accounting for dynamically learned entries again.
337  */
338 static void fdb_delete_local(struct net_bridge *br,
339 			     const struct net_bridge_port *p,
340 			     struct net_bridge_fdb_entry *f)
341 {
342 	const unsigned char *addr = f->key.addr.addr;
343 	struct net_bridge_vlan_group *vg;
344 	const struct net_bridge_vlan *v;
345 	struct net_bridge_port *op;
346 	u16 vid = f->key.vlan_id;
347 
348 	/* Maybe another port has same hw addr? */
349 	list_for_each_entry(op, &br->port_list, list) {
350 		vg = nbp_vlan_group(op);
351 		if (op != p && ether_addr_equal(op->dev->dev_addr, addr) &&
352 		    (!vid || br_vlan_find(vg, vid))) {
353 			br_fdb_dst_write(f, br_port_to_dst(op));
354 			clear_bit(BR_FDB_ADDED_BY_USER, &f->flags);
355 			return;
356 		}
357 	}
358 
359 	vg = br_vlan_group(br);
360 	v = br_vlan_find(vg, vid);
361 	/* Maybe bridge device has same hw addr? */
362 	if (p && ether_addr_equal(br->dev->dev_addr, addr) &&
363 	    (!vid || (v && br_vlan_should_use(v)))) {
364 		br_fdb_dst_write(f, br_port_to_dst(NULL));
365 		clear_bit(BR_FDB_ADDED_BY_USER, &f->flags);
366 		return;
367 	}
368 
369 	fdb_delete(br, f, true);
370 }
371 
372 void br_fdb_find_delete_local(struct net_bridge *br,
373 			      const struct net_bridge_port *p,
374 			      const unsigned char *addr, u16 vid)
375 {
376 	struct net_bridge_fdb_entry *f;
377 
378 	spin_lock_bh(&br->hash_lock);
379 	f = br_fdb_find(br, addr, vid);
380 	if (f && test_bit(BR_FDB_LOCAL, &f->flags) &&
381 	    !test_bit(BR_FDB_ADDED_BY_USER, &f->flags) &&
382 	    br_fdb_dst_port(f) == p)
383 		fdb_delete_local(br, p, f);
384 	spin_unlock_bh(&br->hash_lock);
385 }
386 
387 static struct net_bridge_fdb_entry *fdb_create(struct net_bridge *br,
388 					       struct net_bridge_dst dst,
389 					       const unsigned char *addr,
390 					       __u16 vid,
391 					       unsigned long flags)
392 {
393 	bool learned = !test_bit(BR_FDB_ADDED_BY_USER, &flags) &&
394 		       !test_bit(BR_FDB_LOCAL, &flags);
395 	u32 max_learned = READ_ONCE(br->fdb_max_learned);
396 	struct net_bridge_fdb_entry *fdb;
397 	int err;
398 
399 	if (likely(learned)) {
400 		int n_learned = atomic_read(&br->fdb_n_learned);
401 
402 		if (unlikely(max_learned && n_learned >= max_learned))
403 			return NULL;
404 		__set_bit(BR_FDB_DYNAMIC_LEARNED, &flags);
405 	}
406 
407 	fdb = kmem_cache_alloc(br_fdb_cache, GFP_ATOMIC);
408 	if (!fdb)
409 		return NULL;
410 
411 	memcpy(fdb->key.addr.addr, addr, ETH_ALEN);
412 	br_fdb_dst_write(fdb, dst);
413 	fdb->key.vlan_id = vid;
414 	fdb->flags = flags;
415 	fdb->updated = fdb->used = jiffies;
416 	err = rhashtable_lookup_insert_fast(&br->fdb_hash_tbl, &fdb->rhnode,
417 					    br_fdb_rht_params);
418 	if (err) {
419 		kmem_cache_free(br_fdb_cache, fdb);
420 		return NULL;
421 	}
422 
423 	if (likely(learned))
424 		atomic_inc(&br->fdb_n_learned);
425 
426 	hlist_add_head_rcu(&fdb->fdb_node, &br->fdb_list);
427 
428 	return fdb;
429 }
430 
431 static int fdb_add_local(struct net_bridge *br, struct net_bridge_port *source,
432 			 const unsigned char *addr, u16 vid)
433 {
434 	struct net_bridge_fdb_entry *fdb;
435 
436 	if (!is_valid_ether_addr(addr))
437 		return -EINVAL;
438 
439 	fdb = br_fdb_find(br, addr, vid);
440 	if (fdb) {
441 		/* it is okay to have multiple ports with same
442 		 * address, just use the first one.
443 		 */
444 		if (test_bit(BR_FDB_LOCAL, &fdb->flags))
445 			return 0;
446 		br_warn(br, "adding interface %s with same address as a received packet (addr:%pM, vlan:%u)\n",
447 			source ? source->dev->name : br->dev->name, addr, vid);
448 		fdb_delete(br, fdb, true);
449 	}
450 
451 	fdb = fdb_create(br, br_port_to_dst(source), addr, vid,
452 			 BIT(BR_FDB_LOCAL) | BIT(BR_FDB_STATIC));
453 	if (!fdb)
454 		return -ENOMEM;
455 
456 	fdb_add_hw_addr(br, addr);
457 	fdb_notify(br, fdb, RTM_NEWNEIGH, true);
458 	return 0;
459 }
460 
461 void br_fdb_changeaddr(struct net_bridge_port *p, const unsigned char *newaddr)
462 {
463 	struct net_bridge_vlan_group *vg;
464 	struct net_bridge_fdb_entry *f;
465 	struct net_bridge *br = p->br;
466 	struct net_bridge_vlan *v;
467 	bool local_vlan_0;
468 
469 	local_vlan_0 = br_opt_get(br, BROPT_FDB_LOCAL_VLAN_0);
470 
471 	spin_lock_bh(&br->hash_lock);
472 	vg = nbp_vlan_group(p);
473 	hlist_for_each_entry(f, &br->fdb_list, fdb_node) {
474 		if (br_fdb_dst_port(f) == p &&
475 		    test_bit(BR_FDB_LOCAL, &f->flags) &&
476 		    !test_bit(BR_FDB_ADDED_BY_USER, &f->flags)) {
477 			/* delete old one */
478 			fdb_delete_local(br, p, f);
479 
480 			/* if this port has no vlan information configured, or
481 			 * local entries are only kept on VLAN 0, we can safely
482 			 * be done at this point.
483 			 */
484 			if (!vg || !vg->num_vlans || local_vlan_0)
485 				goto insert;
486 		}
487 	}
488 
489 insert:
490 	/* insert new address,  may fail if invalid address or dup. */
491 	fdb_add_local(br, p, newaddr, 0);
492 
493 	if (!vg || !vg->num_vlans || local_vlan_0)
494 		goto done;
495 
496 	/* Now add entries for every VLAN configured on the port.
497 	 * This function runs under RTNL so the bitmap will not change
498 	 * from under us.
499 	 */
500 	list_for_each_entry(v, &vg->vlan_list, vlist)
501 		fdb_add_local(br, p, newaddr, v->vid);
502 
503 done:
504 	spin_unlock_bh(&br->hash_lock);
505 }
506 
507 void br_fdb_change_mac_address(struct net_bridge *br, const u8 *newaddr)
508 {
509 	struct net_bridge_vlan_group *vg;
510 	struct net_bridge_fdb_entry *f;
511 	struct net_bridge_vlan *v;
512 	bool local_vlan_0;
513 
514 	local_vlan_0 = br_opt_get(br, BROPT_FDB_LOCAL_VLAN_0);
515 
516 	spin_lock_bh(&br->hash_lock);
517 
518 	/* If old entry was unassociated with any port, then delete it. */
519 	f = br_fdb_find(br, br->dev->dev_addr, 0);
520 	if (f && test_bit(BR_FDB_LOCAL, &f->flags) &&
521 	    !br_fdb_dst_port(f) &&
522 	    !test_bit(BR_FDB_ADDED_BY_USER, &f->flags))
523 		fdb_delete_local(br, NULL, f);
524 
525 	fdb_add_local(br, NULL, newaddr, 0);
526 	vg = br_vlan_group(br);
527 	if (!vg || !vg->num_vlans || local_vlan_0)
528 		goto out;
529 	/* Now remove and add entries for every VLAN configured on the
530 	 * bridge.  This function runs under RTNL so the bitmap will not
531 	 * change from under us.
532 	 */
533 	list_for_each_entry(v, &vg->vlan_list, vlist) {
534 		if (!br_vlan_should_use(v))
535 			continue;
536 		f = br_fdb_find(br, br->dev->dev_addr, v->vid);
537 		if (f && test_bit(BR_FDB_LOCAL, &f->flags) &&
538 		    !br_fdb_dst_port(f) &&
539 		    !test_bit(BR_FDB_ADDED_BY_USER, &f->flags))
540 			fdb_delete_local(br, NULL, f);
541 		fdb_add_local(br, NULL, newaddr, v->vid);
542 	}
543 out:
544 	spin_unlock_bh(&br->hash_lock);
545 }
546 
547 void br_fdb_cleanup(struct work_struct *work)
548 {
549 	struct net_bridge *br = container_of(work, struct net_bridge,
550 					     gc_work.work);
551 	struct net_bridge_fdb_entry *f = NULL;
552 	unsigned long delay = hold_time(br);
553 	unsigned long work_delay = delay;
554 	unsigned long now = jiffies;
555 
556 	/* this part is tricky, in order to avoid blocking learning and
557 	 * consequently forwarding, we rely on rcu to delete objects with
558 	 * delayed freeing allowing us to continue traversing
559 	 */
560 	rcu_read_lock();
561 	hlist_for_each_entry_rcu(f, &br->fdb_list, fdb_node) {
562 		unsigned long this_timer = READ_ONCE(f->updated) + delay;
563 
564 		if (test_bit(BR_FDB_STATIC, &f->flags) ||
565 		    test_bit(BR_FDB_ADDED_BY_EXT_LEARN, &f->flags)) {
566 			if (test_bit(BR_FDB_NOTIFY, &f->flags)) {
567 				if (time_after(this_timer, now))
568 					work_delay = min(work_delay,
569 							 this_timer - now);
570 				else if (!test_and_set_bit(BR_FDB_NOTIFY_INACTIVE,
571 							   &f->flags))
572 					fdb_notify(br, f, RTM_NEWNEIGH, false);
573 			}
574 			continue;
575 		}
576 
577 		if (time_after(this_timer, now)) {
578 			work_delay = min(work_delay, this_timer - now);
579 		} else {
580 			spin_lock_bh(&br->hash_lock);
581 			if (!hlist_unhashed(&f->fdb_node))
582 				fdb_delete(br, f, true);
583 			spin_unlock_bh(&br->hash_lock);
584 		}
585 	}
586 	rcu_read_unlock();
587 
588 	/* Cleanup minimum 10 milliseconds apart */
589 	work_delay = max_t(unsigned long, work_delay, msecs_to_jiffies(10));
590 	mod_delayed_work(system_long_wq, &br->gc_work, work_delay);
591 }
592 
593 static void br_fdb_delete_locals_per_vlan_port(struct net_bridge *br,
594 					       struct net_bridge_port *p)
595 {
596 	struct net_bridge_vlan_group *vg;
597 	struct net_bridge_vlan *v;
598 	struct net_device *dev;
599 
600 	if (p) {
601 		vg = nbp_vlan_group(p);
602 		dev = p->dev;
603 	} else {
604 		vg = br_vlan_group(br);
605 		dev = br->dev;
606 	}
607 
608 	if (!vg)
609 		return;
610 
611 	list_for_each_entry(v, &vg->vlan_list, vlist)
612 		br_fdb_find_delete_local(br, p, dev->dev_addr, v->vid);
613 }
614 
615 static void br_fdb_delete_locals_per_vlan(struct net_bridge *br)
616 {
617 	struct net_bridge_port *p;
618 
619 	ASSERT_RTNL();
620 
621 	list_for_each_entry(p, &br->port_list, list)
622 		br_fdb_delete_locals_per_vlan_port(br, p);
623 
624 	br_fdb_delete_locals_per_vlan_port(br, NULL);
625 }
626 
627 static int br_fdb_insert_locals_per_vlan_port(struct net_bridge *br,
628 					      struct net_bridge_port *p,
629 					      struct netlink_ext_ack *extack)
630 {
631 	struct net_bridge_vlan_group *vg;
632 	struct net_bridge_vlan *v;
633 	struct net_device *dev;
634 	int err;
635 
636 	if (p) {
637 		vg = nbp_vlan_group(p);
638 		dev = p->dev;
639 	} else {
640 		vg = br_vlan_group(br);
641 		dev = br->dev;
642 	}
643 
644 	if (!vg)
645 		return 0;
646 
647 	list_for_each_entry(v, &vg->vlan_list, vlist) {
648 		if (!br_vlan_should_use(v))
649 			continue;
650 
651 		err = br_fdb_add_local(br, p, dev->dev_addr, v->vid);
652 		if (err)
653 			return err;
654 	}
655 
656 	return 0;
657 }
658 
659 static int br_fdb_insert_locals_per_vlan(struct net_bridge *br,
660 					 struct netlink_ext_ack *extack)
661 {
662 	struct net_bridge_port *p;
663 	int err;
664 
665 	ASSERT_RTNL();
666 
667 	list_for_each_entry(p, &br->port_list, list) {
668 		err = br_fdb_insert_locals_per_vlan_port(br, p, extack);
669 		if (err)
670 			goto rollback;
671 	}
672 
673 	err = br_fdb_insert_locals_per_vlan_port(br, NULL, extack);
674 	if (err)
675 		goto rollback;
676 
677 	return 0;
678 
679 rollback:
680 	NL_SET_ERR_MSG_MOD(extack, "fdb_local_vlan_0 toggle: FDB entry insertion failed");
681 	br_fdb_delete_locals_per_vlan(br);
682 	return err;
683 }
684 
685 int br_fdb_toggle_local_vlan_0(struct net_bridge *br, bool on,
686 			       struct netlink_ext_ack *extack)
687 {
688 	if (!on)
689 		return br_fdb_insert_locals_per_vlan(br, extack);
690 
691 	br_fdb_delete_locals_per_vlan(br);
692 	return 0;
693 }
694 
695 static bool __fdb_flush_matches(const struct net_bridge *br,
696 				const struct net_bridge_fdb_entry *f,
697 				const struct net_bridge_fdb_flush_desc *desc)
698 {
699 	const struct net_bridge_port *dst = br_fdb_dst_port(f);
700 	int port_ifidx = dst ? dst->dev->ifindex : br->dev->ifindex;
701 
702 	if (desc->vlan_id && desc->vlan_id != f->key.vlan_id)
703 		return false;
704 	if (desc->port_ifindex && desc->port_ifindex != port_ifidx)
705 		return false;
706 	if (desc->flags_mask && (f->flags & desc->flags_mask) != desc->flags)
707 		return false;
708 
709 	return true;
710 }
711 
712 /* Flush forwarding database entries matching the description */
713 void br_fdb_flush(struct net_bridge *br,
714 		  const struct net_bridge_fdb_flush_desc *desc)
715 {
716 	struct net_bridge_fdb_entry *f;
717 
718 	rcu_read_lock();
719 	hlist_for_each_entry_rcu(f, &br->fdb_list, fdb_node) {
720 		if (!__fdb_flush_matches(br, f, desc))
721 			continue;
722 
723 		spin_lock_bh(&br->hash_lock);
724 		if (!hlist_unhashed(&f->fdb_node))
725 			fdb_delete(br, f, true);
726 		spin_unlock_bh(&br->hash_lock);
727 	}
728 	rcu_read_unlock();
729 }
730 
731 static unsigned long __ndm_state_to_fdb_flags(u16 ndm_state)
732 {
733 	unsigned long flags = 0;
734 
735 	if (ndm_state & NUD_PERMANENT)
736 		__set_bit(BR_FDB_LOCAL, &flags);
737 	if (ndm_state & NUD_NOARP)
738 		__set_bit(BR_FDB_STATIC, &flags);
739 
740 	return flags;
741 }
742 
743 static unsigned long __ndm_flags_to_fdb_flags(u8 ndm_flags)
744 {
745 	unsigned long flags = 0;
746 
747 	if (ndm_flags & NTF_USE)
748 		__set_bit(BR_FDB_ADDED_BY_USER, &flags);
749 	if (ndm_flags & NTF_EXT_LEARNED)
750 		__set_bit(BR_FDB_ADDED_BY_EXT_LEARN, &flags);
751 	if (ndm_flags & NTF_OFFLOADED)
752 		__set_bit(BR_FDB_OFFLOADED, &flags);
753 	if (ndm_flags & NTF_STICKY)
754 		__set_bit(BR_FDB_STICKY, &flags);
755 
756 	return flags;
757 }
758 
759 static int __fdb_flush_validate_ifindex(const struct net_bridge *br,
760 					int ifindex,
761 					struct netlink_ext_ack *extack)
762 {
763 	const struct net_device *dev;
764 
765 	dev = __dev_get_by_index(dev_net(br->dev), ifindex);
766 	if (!dev) {
767 		NL_SET_ERR_MSG_MOD(extack, "Unknown flush device ifindex");
768 		return -ENODEV;
769 	}
770 	if (!netif_is_bridge_master(dev) && !netif_is_bridge_port(dev)) {
771 		NL_SET_ERR_MSG_MOD(extack, "Flush device is not a bridge or bridge port");
772 		return -EINVAL;
773 	}
774 	if (netif_is_bridge_master(dev) && dev != br->dev) {
775 		NL_SET_ERR_MSG_MOD(extack,
776 				   "Flush bridge device does not match target bridge device");
777 		return -EINVAL;
778 	}
779 	if (netif_is_bridge_port(dev)) {
780 		struct net_bridge_port *p = br_port_get_rtnl(dev);
781 
782 		if (p->br != br) {
783 			NL_SET_ERR_MSG_MOD(extack, "Port belongs to a different bridge device");
784 			return -EINVAL;
785 		}
786 	}
787 
788 	return 0;
789 }
790 
791 static const struct nla_policy br_fdb_del_bulk_policy[NDA_MAX + 1] = {
792 	[NDA_VLAN]	= NLA_POLICY_RANGE(NLA_U16, 1, VLAN_N_VID - 2),
793 	[NDA_IFINDEX]	= NLA_POLICY_MIN(NLA_S32, 1),
794 	[NDA_NDM_STATE_MASK]	= { .type = NLA_U16 },
795 	[NDA_NDM_FLAGS_MASK]	= { .type = NLA_U8 },
796 };
797 
798 int br_fdb_delete_bulk(struct nlmsghdr *nlh, struct net_device *dev,
799 		       struct netlink_ext_ack *extack)
800 {
801 	struct net_bridge_fdb_flush_desc desc = {};
802 	struct ndmsg *ndm = nlmsg_data(nlh);
803 	struct net_bridge_port *p = NULL;
804 	struct nlattr *tb[NDA_MAX + 1];
805 	struct net_bridge *br;
806 	u8 ndm_flags;
807 	int err;
808 
809 	ndm_flags = ndm->ndm_flags & ~FDB_FLUSH_IGNORED_NDM_FLAGS;
810 
811 	err = nlmsg_parse(nlh, sizeof(*ndm), tb, NDA_MAX,
812 			  br_fdb_del_bulk_policy, extack);
813 	if (err)
814 		return err;
815 
816 	if (netif_is_bridge_master(dev)) {
817 		br = netdev_priv(dev);
818 	} else {
819 		p = br_port_get_rtnl(dev);
820 		if (!p) {
821 			NL_SET_ERR_MSG_MOD(extack, "Device is not a bridge port");
822 			return -EINVAL;
823 		}
824 		br = p->br;
825 	}
826 
827 	if (tb[NDA_VLAN])
828 		desc.vlan_id = nla_get_u16(tb[NDA_VLAN]);
829 
830 	if (ndm_flags & ~FDB_FLUSH_ALLOWED_NDM_FLAGS) {
831 		NL_SET_ERR_MSG(extack, "Unsupported fdb flush ndm flag bits set");
832 		return -EINVAL;
833 	}
834 	if (ndm->ndm_state & ~FDB_FLUSH_ALLOWED_NDM_STATES) {
835 		NL_SET_ERR_MSG(extack, "Unsupported fdb flush ndm state bits set");
836 		return -EINVAL;
837 	}
838 
839 	desc.flags |= __ndm_state_to_fdb_flags(ndm->ndm_state);
840 	desc.flags |= __ndm_flags_to_fdb_flags(ndm_flags);
841 	if (tb[NDA_NDM_STATE_MASK]) {
842 		u16 ndm_state_mask = nla_get_u16(tb[NDA_NDM_STATE_MASK]);
843 
844 		desc.flags_mask |= __ndm_state_to_fdb_flags(ndm_state_mask);
845 	}
846 	if (tb[NDA_NDM_FLAGS_MASK]) {
847 		u8 ndm_flags_mask = nla_get_u8(tb[NDA_NDM_FLAGS_MASK]);
848 
849 		desc.flags_mask |= __ndm_flags_to_fdb_flags(ndm_flags_mask);
850 	}
851 	if (tb[NDA_IFINDEX]) {
852 		int ifidx = nla_get_s32(tb[NDA_IFINDEX]);
853 
854 		err = __fdb_flush_validate_ifindex(br, ifidx, extack);
855 		if (err)
856 			return err;
857 		desc.port_ifindex = ifidx;
858 	} else if (p) {
859 		/* flush was invoked with port device and NTF_MASTER */
860 		desc.port_ifindex = p->dev->ifindex;
861 	}
862 
863 	br_debug(br, "flushing port ifindex: %d vlan id: %u flags: 0x%lx flags mask: 0x%lx\n",
864 		 desc.port_ifindex, desc.vlan_id, desc.flags, desc.flags_mask);
865 
866 	br_fdb_flush(br, &desc);
867 
868 	return 0;
869 }
870 
871 /* Clean up entries referring to cleanup_dst's port.
872  * If do_all is set ignore vid and entry flags. Otherwise vid selects
873  * the VLAN (0 means all), keeping static and non-offloaded ext learned entries.
874  * For a port-VLAN dst, vid must match its VLAN ID. Always clean up its local
875  * entry unless user-added and fall back to the port dst for retained entries.
876  */
877 void br_fdb_cleanup_by_dst(struct net_bridge *br,
878 			   struct net_bridge_dst cleanup_dst, u16 vid,
879 			   int do_all)
880 {
881 	const struct net_bridge_vlan *vlan = br_dst_vlan(cleanup_dst);
882 	const struct net_bridge_port *p = br_dst_port(cleanup_dst);
883 	struct net_bridge_fdb_entry *f;
884 	struct hlist_node *tmp;
885 
886 	spin_lock_bh(&br->hash_lock);
887 	hlist_for_each_entry_safe(f, tmp, &br->fdb_list, fdb_node) {
888 		struct net_bridge_dst dst = br_fdb_dst_read(f);
889 
890 		if (br_dst_port(dst) != p)
891 			continue;
892 
893 		if (vlan && f->key.vlan_id == vlan->vid &&
894 		    test_bit(BR_FDB_LOCAL, &f->flags) &&
895 		    !test_bit(BR_FDB_ADDED_BY_USER, &f->flags) &&
896 		    ether_addr_equal(f->key.addr.addr, p->dev->dev_addr)) {
897 			fdb_delete_local(br, p, f);
898 			continue;
899 		}
900 
901 		if (!do_all) {
902 			if (vid && f->key.vlan_id != vid)
903 				continue;
904 
905 			if (test_bit(BR_FDB_STATIC, &f->flags) ||
906 			    (test_bit(BR_FDB_ADDED_BY_EXT_LEARN, &f->flags) &&
907 			     !test_bit(BR_FDB_OFFLOADED, &f->flags))) {
908 				/* The entry outlives the VLAN, so it must fall
909 				 * back to the raw port destination
910 				 */
911 				if (vlan && br_dst_vlan(dst) == vlan)
912 					br_fdb_dst_replace(f, dst,
913 							   br_port_to_dst(p));
914 				continue;
915 			}
916 		}
917 
918 		if (test_bit(BR_FDB_LOCAL, &f->flags))
919 			fdb_delete_local(br, p, f);
920 		else
921 			fdb_delete(br, f, true);
922 	}
923 	spin_unlock_bh(&br->hash_lock);
924 }
925 
926 /*
927  * Fill buffer with forwarding table records in
928  * the API format.
929  */
930 int br_fdb_fillbuf(struct net_bridge *br, void *buf,
931 		   unsigned long maxnum, unsigned long skip)
932 {
933 	const struct net_bridge_port *dst;
934 	struct net_bridge_fdb_entry *f;
935 	struct __fdb_entry *fe = buf;
936 	unsigned long delta;
937 	int num = 0;
938 
939 	memset(buf, 0, maxnum*sizeof(struct __fdb_entry));
940 
941 	rcu_read_lock();
942 	hlist_for_each_entry_rcu(f, &br->fdb_list, fdb_node) {
943 		if (num >= maxnum)
944 			break;
945 
946 		if (has_expired(br, f))
947 			continue;
948 
949 		/* ignore pseudo entry for local MAC address */
950 		dst = br_fdb_dst_port(f);
951 		if (!dst)
952 			continue;
953 
954 		if (skip) {
955 			--skip;
956 			continue;
957 		}
958 
959 		/* convert from internal format to API */
960 		memcpy(fe->mac_addr, f->key.addr.addr, ETH_ALEN);
961 
962 		/* due to ABI compat need to split into hi/lo */
963 		fe->port_no = dst->port_no;
964 		fe->port_hi = dst->port_no >> 8;
965 
966 		fe->is_local = test_bit(BR_FDB_LOCAL, &f->flags);
967 		if (!test_bit(BR_FDB_STATIC, &f->flags)) {
968 			delta = jiffies - READ_ONCE(f->updated);
969 			fe->ageing_timer_value =
970 				jiffies_delta_to_clock_t(delta);
971 		}
972 		++fe;
973 		++num;
974 	}
975 	rcu_read_unlock();
976 
977 	return num;
978 }
979 
980 /* Add entry for local address of interface */
981 int br_fdb_add_local(struct net_bridge *br, struct net_bridge_port *source,
982 		     const unsigned char *addr, u16 vid)
983 {
984 	int ret;
985 
986 	spin_lock_bh(&br->hash_lock);
987 	ret = fdb_add_local(br, source, addr, vid);
988 	spin_unlock_bh(&br->hash_lock);
989 	return ret;
990 }
991 
992 /* returns true if the fdb was modified */
993 static bool __fdb_mark_active(struct net_bridge_fdb_entry *fdb)
994 {
995 	return !!(test_bit(BR_FDB_NOTIFY_INACTIVE, &fdb->flags) &&
996 		  test_and_clear_bit(BR_FDB_NOTIFY_INACTIVE, &fdb->flags));
997 }
998 
999 static void __fdb_update(struct net_bridge *br,
1000 			 struct net_bridge_fdb_entry *fdb,
1001 			 struct net_bridge_port *source,
1002 			 struct net_bridge_dst dst,
1003 			 unsigned long flags)
1004 {
1005 	struct net_bridge_port *old_port;
1006 	struct net_bridge_dst old_dst;
1007 	bool fdb_modified = false;
1008 	unsigned long now;
1009 
1010 	/* attempt to update an entry for a local interface */
1011 	if (unlikely(test_bit(BR_FDB_LOCAL, &fdb->flags))) {
1012 		if (net_ratelimit())
1013 			br_warn(br, "received packet on %s with own address as source address (addr:%pM, vlan:%u)\n",
1014 				source->dev->name, fdb->key.addr.addr,
1015 				fdb->key.vlan_id);
1016 		return;
1017 	}
1018 
1019 	now = jiffies;
1020 	if (now != READ_ONCE(fdb->updated)) {
1021 		WRITE_ONCE(fdb->updated, now);
1022 		fdb_modified = __fdb_mark_active(fdb);
1023 	}
1024 
1025 	old_dst = br_fdb_dst_read(fdb);
1026 	old_port = br_dst_port(old_dst);
1027 	/* fastpath: update of existing entry */
1028 	if (unlikely(!br_dst_equal(dst, old_dst) &&
1029 		     (source == old_port ||
1030 		      !test_bit(BR_FDB_STICKY, &fdb->flags)))) {
1031 		if (source != old_port) {
1032 			br_switchdev_fdb_notify(br, fdb, RTM_DELNEIGH);
1033 			br_fdb_dst_write(fdb, dst);
1034 			fdb_modified = true;
1035 			/* take over HW learned entry */
1036 			if (unlikely(test_bit(BR_FDB_ADDED_BY_EXT_LEARN,
1037 					      &fdb->flags)))
1038 				clear_bit(BR_FDB_ADDED_BY_EXT_LEARN,
1039 					  &fdb->flags);
1040 			/* clear locked flag when roaming to an unlocked port */
1041 			if (unlikely(test_bit(BR_FDB_LOCKED, &fdb->flags)))
1042 				clear_bit(BR_FDB_LOCKED, &fdb->flags);
1043 		} else {
1044 			/* raw port-to-VLAN promotion shouldn't overwrite a
1045 			 * concurrent roam to another port
1046 			 */
1047 			br_fdb_dst_replace(fdb, old_dst, dst);
1048 		}
1049 	}
1050 
1051 	if (unlikely(test_bit(BR_FDB_ADDED_BY_USER, &flags))) {
1052 		set_bit(BR_FDB_ADDED_BY_USER, &fdb->flags);
1053 		if (test_and_clear_bit(BR_FDB_DYNAMIC_LEARNED, &fdb->flags))
1054 			atomic_dec(&br->fdb_n_learned);
1055 	}
1056 
1057 	if (unlikely(fdb_modified)) {
1058 		trace_br_fdb_update(br, source, fdb->key.addr.addr,
1059 				    fdb->key.vlan_id, flags);
1060 		fdb_notify(br, fdb, RTM_NEWNEIGH, true);
1061 	}
1062 }
1063 
1064 void br_fdb_update(struct net_bridge *br, struct net_bridge_port *source,
1065 		   struct net_bridge_vlan *vlan, const unsigned char *addr,
1066 		   unsigned long flags)
1067 {
1068 	struct net_bridge_dst dst = vlan ? br_vlan_to_dst(vlan) :
1069 					   br_port_to_dst(source);
1070 	struct net_bridge_fdb_entry *fdb;
1071 	u16 vid = vlan ? vlan->vid : 0;
1072 
1073 	/* some users want to always flood. */
1074 	if (hold_time(br) == 0)
1075 		return;
1076 
1077 	fdb = fdb_find_rcu(&br->fdb_hash_tbl, addr, vid);
1078 	if (likely(fdb)) {
1079 		__fdb_update(br, fdb, source, dst, flags);
1080 	} else {
1081 		spin_lock(&br->hash_lock);
1082 		fdb = fdb_create(br, dst, addr, vid, flags);
1083 		if (fdb) {
1084 			trace_br_fdb_update(br, source, addr, vid, flags);
1085 			fdb_notify(br, fdb, RTM_NEWNEIGH, true);
1086 		}
1087 		spin_unlock(&br->hash_lock);
1088 	}
1089 }
1090 
1091 /* Dump information about entries, in response to GETNEIGH */
1092 int br_fdb_dump(struct sk_buff *skb,
1093 		struct netlink_callback *cb,
1094 		struct net_device *dev,
1095 		struct net_device *filter_dev,
1096 		int *idx)
1097 {
1098 	struct ndo_fdb_dump_context *ctx = (void *)cb->ctx;
1099 	struct net_bridge *br = netdev_priv(dev);
1100 	struct net_bridge_fdb_entry *f;
1101 	int err = 0;
1102 
1103 	if (!netif_is_bridge_master(dev))
1104 		return err;
1105 
1106 	if (!filter_dev) {
1107 		err = ndo_dflt_fdb_dump(skb, cb, dev, NULL, idx);
1108 		if (err < 0)
1109 			return err;
1110 	}
1111 
1112 	rcu_read_lock();
1113 	hlist_for_each_entry_rcu(f, &br->fdb_list, fdb_node) {
1114 		const struct net_bridge_port *dst = br_fdb_dst_port(f);
1115 
1116 		if (*idx < ctx->fdb_idx)
1117 			goto skip;
1118 		if (filter_dev && (!dst || dst->dev != filter_dev)) {
1119 			if (filter_dev != dev)
1120 				goto skip;
1121 			/* A NULL destination is a special case for bridge
1122 			 * It means the MAC belongs to the bridge
1123 			 * Therefore need a little more filtering
1124 			 * we only want to dump the NULL destination case
1125 			 */
1126 			if (dst)
1127 				goto skip;
1128 		}
1129 		if (!filter_dev && dst)
1130 			goto skip;
1131 
1132 		err = fdb_fill_info(skb, br, f,
1133 				    NETLINK_CB(cb->skb).portid,
1134 				    cb->nlh->nlmsg_seq,
1135 				    RTM_NEWNEIGH,
1136 				    NLM_F_MULTI);
1137 		if (err < 0)
1138 			break;
1139 skip:
1140 		*idx += 1;
1141 	}
1142 	rcu_read_unlock();
1143 
1144 	return err;
1145 }
1146 
1147 int br_fdb_get(struct sk_buff *skb,
1148 	       struct nlattr *tb[],
1149 	       struct net_device *dev,
1150 	       const unsigned char *addr,
1151 	       u16 vid, u32 portid, u32 seq,
1152 	       struct netlink_ext_ack *extack)
1153 {
1154 	struct net_bridge *br = netdev_priv(dev);
1155 	struct net_bridge_fdb_entry *f;
1156 	int err = 0;
1157 
1158 	rcu_read_lock();
1159 	f = br_fdb_find_rcu(br, addr, vid);
1160 	if (!f) {
1161 		NL_SET_ERR_MSG(extack, "Fdb entry not found");
1162 		err = -ENOENT;
1163 		goto errout;
1164 	}
1165 
1166 	err = fdb_fill_info(skb, br, f, portid, seq,
1167 			    RTM_NEWNEIGH, 0);
1168 errout:
1169 	rcu_read_unlock();
1170 	return err;
1171 }
1172 
1173 /* returns true if the fdb is modified */
1174 static bool fdb_handle_notify(struct net_bridge_fdb_entry *fdb, u8 notify)
1175 {
1176 	bool modified = false;
1177 
1178 	/* allow to mark an entry as inactive, usually done on creation */
1179 	if ((notify & FDB_NOTIFY_INACTIVE_BIT) &&
1180 	    !test_and_set_bit(BR_FDB_NOTIFY_INACTIVE, &fdb->flags))
1181 		modified = true;
1182 
1183 	if ((notify & FDB_NOTIFY_BIT) &&
1184 	    !test_and_set_bit(BR_FDB_NOTIFY, &fdb->flags)) {
1185 		/* enabled activity tracking */
1186 		modified = true;
1187 	} else if (!(notify & FDB_NOTIFY_BIT) &&
1188 		   test_and_clear_bit(BR_FDB_NOTIFY, &fdb->flags)) {
1189 		/* disabled activity tracking, clear notify state */
1190 		clear_bit(BR_FDB_NOTIFY_INACTIVE, &fdb->flags);
1191 		modified = true;
1192 	}
1193 
1194 	return modified;
1195 }
1196 
1197 static bool fdb_update_dst(struct net_bridge_fdb_entry *fdb,
1198 			   struct net_bridge_dst old_dst,
1199 			   struct net_bridge_dst dst)
1200 {
1201 	if (br_dst_equal(old_dst, dst))
1202 		return false;
1203 
1204 	if (br_dst_port(old_dst) == br_dst_port(dst)) {
1205 		br_fdb_dst_replace(fdb, old_dst, dst);
1206 		return false;
1207 	}
1208 
1209 	br_fdb_dst_write(fdb, dst);
1210 	return true;
1211 }
1212 
1213 /* Update (create or replace) forwarding database entry */
1214 static int fdb_add_entry(struct net_bridge *br, struct net_bridge_dst dst,
1215 			 const u8 *addr, struct ndmsg *ndm, u16 flags, u16 vid,
1216 			 struct nlattr *nfea_tb[])
1217 {
1218 	struct net_bridge_port *source = br_dst_port(dst);
1219 	bool is_sticky = !!(ndm->ndm_flags & NTF_STICKY);
1220 	bool refresh = !nfea_tb[NFEA_DONT_REFRESH];
1221 	struct net_bridge_fdb_entry *fdb;
1222 	u16 state = ndm->ndm_state;
1223 	bool modified = false;
1224 	u8 notify = 0;
1225 
1226 	/* If the port cannot learn allow only local and static entries */
1227 	if (source && !(state & NUD_PERMANENT) && !(state & NUD_NOARP) &&
1228 	    !(source->state == BR_STATE_LEARNING ||
1229 	      source->state == BR_STATE_FORWARDING))
1230 		return -EPERM;
1231 
1232 	if (!source && !(state & NUD_PERMANENT)) {
1233 		pr_info("bridge: RTM_NEWNEIGH %s without NUD_PERMANENT\n",
1234 			br->dev->name);
1235 		return -EINVAL;
1236 	}
1237 
1238 	if (is_sticky && (state & NUD_PERMANENT))
1239 		return -EINVAL;
1240 
1241 	if (nfea_tb[NFEA_ACTIVITY_NOTIFY]) {
1242 		notify = nla_get_u8(nfea_tb[NFEA_ACTIVITY_NOTIFY]);
1243 		if ((notify & ~BR_FDB_NOTIFY_SETTABLE_BITS) ||
1244 		    (notify & BR_FDB_NOTIFY_SETTABLE_BITS) == FDB_NOTIFY_INACTIVE_BIT)
1245 			return -EINVAL;
1246 	}
1247 
1248 	fdb = br_fdb_find(br, addr, vid);
1249 	if (fdb == NULL) {
1250 		if (!(flags & NLM_F_CREATE))
1251 			return -ENOENT;
1252 
1253 		fdb = fdb_create(br, dst, addr, vid,
1254 				 BIT(BR_FDB_ADDED_BY_USER));
1255 		if (!fdb)
1256 			return -ENOMEM;
1257 
1258 		modified = true;
1259 	} else {
1260 		struct net_bridge_dst old_dst;
1261 
1262 		if (flags & NLM_F_EXCL)
1263 			return -EEXIST;
1264 
1265 		old_dst = br_fdb_dst_read(fdb);
1266 		modified = fdb_update_dst(fdb, old_dst, dst);
1267 
1268 		set_bit(BR_FDB_ADDED_BY_USER, &fdb->flags);
1269 		if (test_and_clear_bit(BR_FDB_DYNAMIC_LEARNED, &fdb->flags))
1270 			atomic_dec(&br->fdb_n_learned);
1271 	}
1272 
1273 	if (fdb_to_nud(br, fdb) != state) {
1274 		if (state & NUD_PERMANENT) {
1275 			set_bit(BR_FDB_LOCAL, &fdb->flags);
1276 			if (!test_and_set_bit(BR_FDB_STATIC, &fdb->flags))
1277 				fdb_add_hw_addr(br, addr);
1278 		} else if (state & NUD_NOARP) {
1279 			clear_bit(BR_FDB_LOCAL, &fdb->flags);
1280 			if (!test_and_set_bit(BR_FDB_STATIC, &fdb->flags))
1281 				fdb_add_hw_addr(br, addr);
1282 		} else {
1283 			clear_bit(BR_FDB_LOCAL, &fdb->flags);
1284 			if (test_and_clear_bit(BR_FDB_STATIC, &fdb->flags))
1285 				fdb_del_hw_addr(br, addr);
1286 		}
1287 
1288 		modified = true;
1289 	}
1290 
1291 	if (is_sticky != test_bit(BR_FDB_STICKY, &fdb->flags)) {
1292 		change_bit(BR_FDB_STICKY, &fdb->flags);
1293 		modified = true;
1294 	}
1295 
1296 	if (test_and_clear_bit(BR_FDB_LOCKED, &fdb->flags))
1297 		modified = true;
1298 
1299 	if (fdb_handle_notify(fdb, notify))
1300 		modified = true;
1301 
1302 	WRITE_ONCE(fdb->used, jiffies);
1303 	if (modified) {
1304 		if (refresh)
1305 			WRITE_ONCE(fdb->updated, jiffies);
1306 		fdb_notify(br, fdb, RTM_NEWNEIGH, true);
1307 	}
1308 
1309 	return 0;
1310 }
1311 
1312 static int __br_fdb_add(struct ndmsg *ndm, struct net_bridge *br,
1313 			struct net_bridge_port *p, const unsigned char *addr,
1314 			u16 nlh_flags, struct net_bridge_vlan *vlan,
1315 			struct nlattr *nfea_tb[],
1316 			bool *notified, struct netlink_ext_ack *extack)
1317 {
1318 	u16 vid = vlan ? vlan->vid : 0;
1319 	struct net_bridge_dst dst;
1320 	int err = 0;
1321 
1322 	if (ndm->ndm_flags & NTF_USE) {
1323 		if (!p) {
1324 			pr_info("bridge: RTM_NEWNEIGH %s with NTF_USE is not supported\n",
1325 				br->dev->name);
1326 			return -EINVAL;
1327 		}
1328 		if (!nbp_state_should_learn(p))
1329 			return 0;
1330 
1331 		local_bh_disable();
1332 		rcu_read_lock();
1333 		br_fdb_update(br, p, vlan, addr, BIT(BR_FDB_ADDED_BY_USER));
1334 		rcu_read_unlock();
1335 		local_bh_enable();
1336 	} else if (ndm->ndm_flags & NTF_EXT_LEARNED) {
1337 		if (!p && !(ndm->ndm_state & NUD_PERMANENT)) {
1338 			NL_SET_ERR_MSG_MOD(extack,
1339 					   "FDB entry towards bridge must be permanent");
1340 			return -EINVAL;
1341 		}
1342 		err = br_fdb_external_learn_add(br, p, addr, vid, false, true);
1343 	} else {
1344 		dst = p && vlan ? br_vlan_to_dst(vlan) : br_port_to_dst(p);
1345 		spin_lock_bh(&br->hash_lock);
1346 		err = fdb_add_entry(br, dst, addr, ndm, nlh_flags, vid,
1347 				    nfea_tb);
1348 		spin_unlock_bh(&br->hash_lock);
1349 	}
1350 
1351 	if (!err)
1352 		*notified = true;
1353 	return err;
1354 }
1355 
1356 static const struct nla_policy br_nda_fdb_pol[NFEA_MAX + 1] = {
1357 	[NFEA_ACTIVITY_NOTIFY]	= { .type = NLA_U8 },
1358 	[NFEA_DONT_REFRESH]	= { .type = NLA_FLAG },
1359 };
1360 
1361 /* Add new permanent fdb entry with RTM_NEWNEIGH */
1362 int br_fdb_add(struct ndmsg *ndm, struct nlattr *tb[],
1363 	       struct net_device *dev,
1364 	       const unsigned char *addr, u16 vid, u16 nlh_flags,
1365 	       bool *notified, struct netlink_ext_ack *extack)
1366 {
1367 	struct nlattr *nfea_tb[NFEA_MAX + 1], *attr;
1368 	struct net_bridge_vlan_group *vg;
1369 	struct net_bridge_port *p = NULL;
1370 	struct net_bridge_vlan *v;
1371 	struct net_bridge *br = NULL;
1372 	u32 ext_flags = 0;
1373 	int err = 0;
1374 
1375 	trace_br_fdb_add(ndm, dev, addr, vid, nlh_flags);
1376 
1377 	if (!(ndm->ndm_state & (NUD_PERMANENT|NUD_NOARP|NUD_REACHABLE))) {
1378 		pr_info("bridge: RTM_NEWNEIGH with invalid state %#x\n", ndm->ndm_state);
1379 		return -EINVAL;
1380 	}
1381 
1382 	if (is_zero_ether_addr(addr)) {
1383 		pr_info("bridge: RTM_NEWNEIGH with invalid ether address\n");
1384 		return -EINVAL;
1385 	}
1386 
1387 	if (netif_is_bridge_master(dev)) {
1388 		br = netdev_priv(dev);
1389 		vg = br_vlan_group(br);
1390 	} else {
1391 		p = br_port_get_rtnl(dev);
1392 		if (!p) {
1393 			pr_info("bridge: RTM_NEWNEIGH %s not a bridge port\n",
1394 				dev->name);
1395 			return -EINVAL;
1396 		}
1397 		br = p->br;
1398 		vg = nbp_vlan_group(p);
1399 	}
1400 
1401 	if (tb[NDA_FLAGS_EXT])
1402 		ext_flags = nla_get_u32(tb[NDA_FLAGS_EXT]);
1403 
1404 	if (ext_flags & NTF_EXT_LOCKED) {
1405 		NL_SET_ERR_MSG_MOD(extack, "Cannot add FDB entry with \"locked\" flag set");
1406 		return -EINVAL;
1407 	}
1408 
1409 	if (tb[NDA_FDB_EXT_ATTRS]) {
1410 		attr = tb[NDA_FDB_EXT_ATTRS];
1411 		err = nla_parse_nested(nfea_tb, NFEA_MAX, attr,
1412 				       br_nda_fdb_pol, extack);
1413 		if (err)
1414 			return err;
1415 	} else {
1416 		memset(nfea_tb, 0, sizeof(struct nlattr *) * (NFEA_MAX + 1));
1417 	}
1418 
1419 	if (vid) {
1420 		v = br_vlan_find(vg, vid);
1421 		if (!v || !br_vlan_should_use(v)) {
1422 			pr_info("bridge: RTM_NEWNEIGH with unconfigured vlan %d on %s\n", vid, dev->name);
1423 			return -EINVAL;
1424 		}
1425 
1426 		/* VID was specified, so use it. */
1427 		err = __br_fdb_add(ndm, br, p, addr, nlh_flags, v, nfea_tb,
1428 				   notified, extack);
1429 	} else {
1430 		err = __br_fdb_add(ndm, br, p, addr, nlh_flags, NULL, nfea_tb,
1431 				   notified, extack);
1432 		if (err || !vg || !vg->num_vlans)
1433 			goto out;
1434 
1435 		/* We have vlans configured on this port and user didn't
1436 		 * specify a VLAN.  To be nice, add/update entry for every
1437 		 * vlan on this port.
1438 		 */
1439 		list_for_each_entry(v, &vg->vlan_list, vlist) {
1440 			if (!br_vlan_should_use(v))
1441 				continue;
1442 			err = __br_fdb_add(ndm, br, p, addr, nlh_flags, v,
1443 					   nfea_tb, notified, extack);
1444 			if (err)
1445 				goto out;
1446 		}
1447 	}
1448 
1449 out:
1450 	return err;
1451 }
1452 
1453 static int fdb_delete_by_addr_and_port(struct net_bridge *br,
1454 				       const struct net_bridge_port *p,
1455 				       const u8 *addr, u16 vlan, bool *notified)
1456 {
1457 	struct net_bridge_fdb_entry *fdb;
1458 
1459 	fdb = br_fdb_find(br, addr, vlan);
1460 	if (!fdb || br_fdb_dst_port(fdb) != p)
1461 		return -ENOENT;
1462 
1463 	fdb_delete(br, fdb, true);
1464 	*notified = true;
1465 
1466 	return 0;
1467 }
1468 
1469 static int __br_fdb_delete(struct net_bridge *br,
1470 			   const struct net_bridge_port *p,
1471 			   const unsigned char *addr, u16 vid, bool *notified)
1472 {
1473 	int err;
1474 
1475 	spin_lock_bh(&br->hash_lock);
1476 	err = fdb_delete_by_addr_and_port(br, p, addr, vid, notified);
1477 	spin_unlock_bh(&br->hash_lock);
1478 
1479 	return err;
1480 }
1481 
1482 /* Remove neighbor entry with RTM_DELNEIGH */
1483 int br_fdb_delete(struct ndmsg *ndm, struct nlattr *tb[],
1484 		  struct net_device *dev,
1485 		  const unsigned char *addr, u16 vid, bool *notified,
1486 		  struct netlink_ext_ack *extack)
1487 {
1488 	struct net_bridge_vlan_group *vg;
1489 	struct net_bridge_port *p = NULL;
1490 	struct net_bridge *br;
1491 	int err;
1492 
1493 	if (netif_is_bridge_master(dev)) {
1494 		br = netdev_priv(dev);
1495 		vg = br_vlan_group(br);
1496 	} else {
1497 		p = br_port_get_rtnl(dev);
1498 		if (!p) {
1499 			pr_info("bridge: RTM_DELNEIGH %s not a bridge port\n",
1500 				dev->name);
1501 			return -EINVAL;
1502 		}
1503 		vg = nbp_vlan_group(p);
1504 		br = p->br;
1505 	}
1506 
1507 	if (vid) {
1508 		err = __br_fdb_delete(br, p, addr, vid, notified);
1509 	} else {
1510 		struct net_bridge_vlan *v;
1511 
1512 		err = -ENOENT;
1513 		err &= __br_fdb_delete(br, p, addr, 0, notified);
1514 		if (!vg || !vg->num_vlans)
1515 			return err;
1516 
1517 		list_for_each_entry(v, &vg->vlan_list, vlist) {
1518 			if (!br_vlan_should_use(v))
1519 				continue;
1520 			err &= __br_fdb_delete(br, p, addr, v->vid, notified);
1521 		}
1522 	}
1523 
1524 	return err;
1525 }
1526 
1527 int br_fdb_sync_static(struct net_bridge *br, struct net_bridge_port *p)
1528 {
1529 	struct net_bridge_fdb_entry *f, *tmp;
1530 	int err = 0;
1531 
1532 	ASSERT_RTNL();
1533 
1534 	/* the key here is that static entries change only under rtnl */
1535 	rcu_read_lock();
1536 	hlist_for_each_entry_rcu(f, &br->fdb_list, fdb_node) {
1537 		/* We only care for static entries */
1538 		if (!test_bit(BR_FDB_STATIC, &f->flags))
1539 			continue;
1540 		err = dev_uc_add(p->dev, f->key.addr.addr);
1541 		if (err)
1542 			goto rollback;
1543 	}
1544 done:
1545 	rcu_read_unlock();
1546 
1547 	return err;
1548 
1549 rollback:
1550 	hlist_for_each_entry_rcu(tmp, &br->fdb_list, fdb_node) {
1551 		/* We only care for static entries */
1552 		if (!test_bit(BR_FDB_STATIC, &tmp->flags))
1553 			continue;
1554 		if (tmp == f)
1555 			break;
1556 		dev_uc_del(p->dev, tmp->key.addr.addr);
1557 	}
1558 
1559 	goto done;
1560 }
1561 
1562 void br_fdb_unsync_static(struct net_bridge *br, struct net_bridge_port *p)
1563 {
1564 	struct net_bridge_fdb_entry *f;
1565 
1566 	ASSERT_RTNL();
1567 
1568 	rcu_read_lock();
1569 	hlist_for_each_entry_rcu(f, &br->fdb_list, fdb_node) {
1570 		/* We only care for static entries */
1571 		if (!test_bit(BR_FDB_STATIC, &f->flags))
1572 			continue;
1573 
1574 		dev_uc_del(p->dev, f->key.addr.addr);
1575 	}
1576 	rcu_read_unlock();
1577 }
1578 
1579 static struct net_bridge_dst br_fdb_resolve_dst(const struct net_bridge_port *p,
1580 						u16 vid)
1581 {
1582 	struct net_bridge_dst dst = br_port_to_dst(p);
1583 	struct net_bridge_vlan *v;
1584 
1585 	lockdep_assert(rcu_read_lock_held() || lockdep_rtnl_is_held());
1586 
1587 	if (!p || !vid)
1588 		return dst;
1589 
1590 	rcu_read_lock();
1591 	v = br_vlan_find(nbp_vlan_group_rcu(p), vid);
1592 	if (v)
1593 		dst = br_vlan_to_dst(v);
1594 	rcu_read_unlock();
1595 
1596 	return dst;
1597 }
1598 
1599 int br_fdb_external_learn_add(struct net_bridge *br, struct net_bridge_port *p,
1600 			      const unsigned char *addr, u16 vid, bool locked,
1601 			      bool swdev_notify)
1602 {
1603 	struct net_bridge_dst dst = br_fdb_resolve_dst(p, vid);
1604 	struct net_bridge_fdb_entry *fdb;
1605 	bool modified = false;
1606 	int err = 0;
1607 
1608 	trace_br_fdb_external_learn_add(br, p, addr, vid);
1609 
1610 	if (locked && (!p || !test_bit(BR_PORT_MAB_BIT, &p->flags)))
1611 		return -EINVAL;
1612 
1613 	spin_lock_bh(&br->hash_lock);
1614 
1615 	fdb = br_fdb_find(br, addr, vid);
1616 	if (!fdb) {
1617 		unsigned long flags = BIT(BR_FDB_ADDED_BY_EXT_LEARN);
1618 
1619 		if (swdev_notify)
1620 			flags |= BIT(BR_FDB_ADDED_BY_USER);
1621 
1622 		if (!p)
1623 			flags |= BIT(BR_FDB_LOCAL);
1624 
1625 		if (locked)
1626 			flags |= BIT(BR_FDB_LOCKED);
1627 
1628 		fdb = fdb_create(br, dst, addr, vid, flags);
1629 		if (!fdb) {
1630 			err = -ENOMEM;
1631 			goto err_unlock;
1632 		}
1633 		fdb_notify(br, fdb, RTM_NEWNEIGH, swdev_notify);
1634 	} else {
1635 		struct net_bridge_dst old_dst;
1636 
1637 		old_dst = br_fdb_dst_read(fdb);
1638 		if (locked &&
1639 		    (!test_bit(BR_FDB_LOCKED, &fdb->flags) ||
1640 		     br_dst_port(old_dst) != p)) {
1641 			err = -EINVAL;
1642 			goto err_unlock;
1643 		}
1644 
1645 		WRITE_ONCE(fdb->updated, jiffies);
1646 
1647 		modified = fdb_update_dst(fdb, old_dst, dst);
1648 
1649 		if (test_and_set_bit(BR_FDB_ADDED_BY_EXT_LEARN, &fdb->flags)) {
1650 			/* Refresh entry */
1651 			WRITE_ONCE(fdb->used, jiffies);
1652 		} else {
1653 			modified = true;
1654 		}
1655 
1656 		if (locked != test_bit(BR_FDB_LOCKED, &fdb->flags)) {
1657 			change_bit(BR_FDB_LOCKED, &fdb->flags);
1658 			modified = true;
1659 		}
1660 
1661 		if (swdev_notify)
1662 			set_bit(BR_FDB_ADDED_BY_USER, &fdb->flags);
1663 
1664 		if (!p)
1665 			set_bit(BR_FDB_LOCAL, &fdb->flags);
1666 
1667 		if ((swdev_notify || !p) &&
1668 		    test_and_clear_bit(BR_FDB_DYNAMIC_LEARNED, &fdb->flags))
1669 			atomic_dec(&br->fdb_n_learned);
1670 
1671 		if (modified)
1672 			fdb_notify(br, fdb, RTM_NEWNEIGH, swdev_notify);
1673 	}
1674 
1675 err_unlock:
1676 	spin_unlock_bh(&br->hash_lock);
1677 
1678 	return err;
1679 }
1680 
1681 int br_fdb_external_learn_del(struct net_bridge *br, struct net_bridge_port *p,
1682 			      const unsigned char *addr, u16 vid,
1683 			      bool swdev_notify)
1684 {
1685 	struct net_bridge_fdb_entry *fdb;
1686 	int err = 0;
1687 
1688 	spin_lock_bh(&br->hash_lock);
1689 
1690 	fdb = br_fdb_find(br, addr, vid);
1691 	if (fdb && test_bit(BR_FDB_ADDED_BY_EXT_LEARN, &fdb->flags))
1692 		fdb_delete(br, fdb, swdev_notify);
1693 	else
1694 		err = -ENOENT;
1695 
1696 	spin_unlock_bh(&br->hash_lock);
1697 
1698 	return err;
1699 }
1700 
1701 void br_fdb_offloaded_set(struct net_bridge *br, struct net_bridge_port *p,
1702 			  const unsigned char *addr, u16 vid, bool offloaded)
1703 {
1704 	struct net_bridge_fdb_entry *fdb;
1705 
1706 	spin_lock_bh(&br->hash_lock);
1707 
1708 	fdb = br_fdb_find(br, addr, vid);
1709 	if (fdb && offloaded != test_bit(BR_FDB_OFFLOADED, &fdb->flags))
1710 		change_bit(BR_FDB_OFFLOADED, &fdb->flags);
1711 
1712 	spin_unlock_bh(&br->hash_lock);
1713 }
1714 
1715 void br_fdb_clear_offload(const struct net_device *dev, u16 vid)
1716 {
1717 	struct net_bridge_fdb_entry *f;
1718 	struct net_bridge_port *p;
1719 
1720 	ASSERT_RTNL();
1721 
1722 	p = br_port_get_rtnl(dev);
1723 	if (!p)
1724 		return;
1725 
1726 	spin_lock_bh(&p->br->hash_lock);
1727 	hlist_for_each_entry(f, &p->br->fdb_list, fdb_node) {
1728 		if (br_fdb_dst_port(f) == p && f->key.vlan_id == vid)
1729 			clear_bit(BR_FDB_OFFLOADED, &f->flags);
1730 	}
1731 	spin_unlock_bh(&p->br->hash_lock);
1732 }
1733 EXPORT_SYMBOL_GPL(br_fdb_clear_offload);
1734