xref: /openbmc/linux/net/bridge/br_fdb.c (revision 56a0eccd)
1 /*
2  *	Forwarding database
3  *	Linux ethernet bridge
4  *
5  *	Authors:
6  *	Lennert Buytenhek		<buytenh@gnu.org>
7  *
8  *	This program is free software; you can redistribute it and/or
9  *	modify it under the terms of the GNU General Public License
10  *	as published by the Free Software Foundation; either version
11  *	2 of the License, or (at your option) any later version.
12  */
13 
14 #include <linux/kernel.h>
15 #include <linux/init.h>
16 #include <linux/rculist.h>
17 #include <linux/spinlock.h>
18 #include <linux/times.h>
19 #include <linux/netdevice.h>
20 #include <linux/etherdevice.h>
21 #include <linux/jhash.h>
22 #include <linux/random.h>
23 #include <linux/slab.h>
24 #include <linux/atomic.h>
25 #include <asm/unaligned.h>
26 #include <linux/if_vlan.h>
27 #include <net/switchdev.h>
28 #include "br_private.h"
29 
30 static struct kmem_cache *br_fdb_cache __read_mostly;
31 static struct net_bridge_fdb_entry *fdb_find(struct hlist_head *head,
32 					     const unsigned char *addr,
33 					     __u16 vid);
34 static int fdb_insert(struct net_bridge *br, struct net_bridge_port *source,
35 		      const unsigned char *addr, u16 vid);
36 static void fdb_notify(struct net_bridge *br,
37 		       const struct net_bridge_fdb_entry *, int);
38 
39 static u32 fdb_salt __read_mostly;
40 
41 int __init br_fdb_init(void)
42 {
43 	br_fdb_cache = kmem_cache_create("bridge_fdb_cache",
44 					 sizeof(struct net_bridge_fdb_entry),
45 					 0,
46 					 SLAB_HWCACHE_ALIGN, NULL);
47 	if (!br_fdb_cache)
48 		return -ENOMEM;
49 
50 	get_random_bytes(&fdb_salt, sizeof(fdb_salt));
51 	return 0;
52 }
53 
54 void br_fdb_fini(void)
55 {
56 	kmem_cache_destroy(br_fdb_cache);
57 }
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 !fdb->is_static &&
72 		time_before_eq(fdb->updated + hold_time(br), jiffies);
73 }
74 
75 static inline int br_mac_hash(const unsigned char *mac, __u16 vid)
76 {
77 	/* use 1 byte of OUI and 3 bytes of NIC */
78 	u32 key = get_unaligned((u32 *)(mac + 2));
79 	return jhash_2words(key, vid, fdb_salt) & (BR_HASH_SIZE - 1);
80 }
81 
82 static void fdb_rcu_free(struct rcu_head *head)
83 {
84 	struct net_bridge_fdb_entry *ent
85 		= container_of(head, struct net_bridge_fdb_entry, rcu);
86 	kmem_cache_free(br_fdb_cache, ent);
87 }
88 
89 /* When a static FDB entry is added, the mac address from the entry is
90  * added to the bridge private HW address list and all required ports
91  * are then updated with the new information.
92  * Called under RTNL.
93  */
94 static void fdb_add_hw_addr(struct net_bridge *br, const unsigned char *addr)
95 {
96 	int err;
97 	struct net_bridge_port *p;
98 
99 	ASSERT_RTNL();
100 
101 	list_for_each_entry(p, &br->port_list, list) {
102 		if (!br_promisc_port(p)) {
103 			err = dev_uc_add(p->dev, addr);
104 			if (err)
105 				goto undo;
106 		}
107 	}
108 
109 	return;
110 undo:
111 	list_for_each_entry_continue_reverse(p, &br->port_list, list) {
112 		if (!br_promisc_port(p))
113 			dev_uc_del(p->dev, addr);
114 	}
115 }
116 
117 /* When a static FDB entry is deleted, the HW address from that entry is
118  * also removed from the bridge private HW address list and updates all
119  * the ports with needed information.
120  * Called under RTNL.
121  */
122 static void fdb_del_hw_addr(struct net_bridge *br, const unsigned char *addr)
123 {
124 	struct net_bridge_port *p;
125 
126 	ASSERT_RTNL();
127 
128 	list_for_each_entry(p, &br->port_list, list) {
129 		if (!br_promisc_port(p))
130 			dev_uc_del(p->dev, addr);
131 	}
132 }
133 
134 static void fdb_del_external_learn(struct net_bridge_fdb_entry *f)
135 {
136 	struct switchdev_obj_port_fdb fdb = {
137 		.obj = {
138 			.orig_dev = f->dst->dev,
139 			.id = SWITCHDEV_OBJ_ID_PORT_FDB,
140 			.flags = SWITCHDEV_F_DEFER,
141 		},
142 		.vid = f->vlan_id,
143 	};
144 
145 	ether_addr_copy(fdb.addr, f->addr.addr);
146 	switchdev_port_obj_del(f->dst->dev, &fdb.obj);
147 }
148 
149 static void fdb_delete(struct net_bridge *br, struct net_bridge_fdb_entry *f)
150 {
151 	if (f->is_static)
152 		fdb_del_hw_addr(br, f->addr.addr);
153 
154 	if (f->added_by_external_learn)
155 		fdb_del_external_learn(f);
156 
157 	hlist_del_rcu(&f->hlist);
158 	fdb_notify(br, f, RTM_DELNEIGH);
159 	call_rcu(&f->rcu, fdb_rcu_free);
160 }
161 
162 /* Delete a local entry if no other port had the same address. */
163 static void fdb_delete_local(struct net_bridge *br,
164 			     const struct net_bridge_port *p,
165 			     struct net_bridge_fdb_entry *f)
166 {
167 	const unsigned char *addr = f->addr.addr;
168 	struct net_bridge_vlan_group *vg;
169 	const struct net_bridge_vlan *v;
170 	struct net_bridge_port *op;
171 	u16 vid = f->vlan_id;
172 
173 	/* Maybe another port has same hw addr? */
174 	list_for_each_entry(op, &br->port_list, list) {
175 		vg = nbp_vlan_group(op);
176 		if (op != p && ether_addr_equal(op->dev->dev_addr, addr) &&
177 		    (!vid || br_vlan_find(vg, vid))) {
178 			f->dst = op;
179 			f->added_by_user = 0;
180 			return;
181 		}
182 	}
183 
184 	vg = br_vlan_group(br);
185 	v = br_vlan_find(vg, vid);
186 	/* Maybe bridge device has same hw addr? */
187 	if (p && ether_addr_equal(br->dev->dev_addr, addr) &&
188 	    (!vid || (v && br_vlan_should_use(v)))) {
189 		f->dst = NULL;
190 		f->added_by_user = 0;
191 		return;
192 	}
193 
194 	fdb_delete(br, f);
195 }
196 
197 void br_fdb_find_delete_local(struct net_bridge *br,
198 			      const struct net_bridge_port *p,
199 			      const unsigned char *addr, u16 vid)
200 {
201 	struct hlist_head *head = &br->hash[br_mac_hash(addr, vid)];
202 	struct net_bridge_fdb_entry *f;
203 
204 	spin_lock_bh(&br->hash_lock);
205 	f = fdb_find(head, addr, vid);
206 	if (f && f->is_local && !f->added_by_user && f->dst == p)
207 		fdb_delete_local(br, p, f);
208 	spin_unlock_bh(&br->hash_lock);
209 }
210 
211 void br_fdb_changeaddr(struct net_bridge_port *p, const unsigned char *newaddr)
212 {
213 	struct net_bridge_vlan_group *vg;
214 	struct net_bridge *br = p->br;
215 	struct net_bridge_vlan *v;
216 	int i;
217 
218 	spin_lock_bh(&br->hash_lock);
219 
220 	vg = nbp_vlan_group(p);
221 	/* Search all chains since old address/hash is unknown */
222 	for (i = 0; i < BR_HASH_SIZE; i++) {
223 		struct hlist_node *h;
224 		hlist_for_each(h, &br->hash[i]) {
225 			struct net_bridge_fdb_entry *f;
226 
227 			f = hlist_entry(h, struct net_bridge_fdb_entry, hlist);
228 			if (f->dst == p && f->is_local && !f->added_by_user) {
229 				/* delete old one */
230 				fdb_delete_local(br, p, f);
231 
232 				/* if this port has no vlan information
233 				 * configured, we can safely be done at
234 				 * this point.
235 				 */
236 				if (!vg || !vg->num_vlans)
237 					goto insert;
238 			}
239 		}
240 	}
241 
242 insert:
243 	/* insert new address,  may fail if invalid address or dup. */
244 	fdb_insert(br, p, newaddr, 0);
245 
246 	if (!vg || !vg->num_vlans)
247 		goto done;
248 
249 	/* Now add entries for every VLAN configured on the port.
250 	 * This function runs under RTNL so the bitmap will not change
251 	 * from under us.
252 	 */
253 	list_for_each_entry(v, &vg->vlan_list, vlist)
254 		fdb_insert(br, p, newaddr, v->vid);
255 
256 done:
257 	spin_unlock_bh(&br->hash_lock);
258 }
259 
260 void br_fdb_change_mac_address(struct net_bridge *br, const u8 *newaddr)
261 {
262 	struct net_bridge_vlan_group *vg;
263 	struct net_bridge_fdb_entry *f;
264 	struct net_bridge_vlan *v;
265 
266 	spin_lock_bh(&br->hash_lock);
267 
268 	/* If old entry was unassociated with any port, then delete it. */
269 	f = __br_fdb_get(br, br->dev->dev_addr, 0);
270 	if (f && f->is_local && !f->dst)
271 		fdb_delete_local(br, NULL, f);
272 
273 	fdb_insert(br, NULL, newaddr, 0);
274 	vg = br_vlan_group(br);
275 	if (!vg || !vg->num_vlans)
276 		goto out;
277 	/* Now remove and add entries for every VLAN configured on the
278 	 * bridge.  This function runs under RTNL so the bitmap will not
279 	 * change from under us.
280 	 */
281 	list_for_each_entry(v, &vg->vlan_list, vlist) {
282 		f = __br_fdb_get(br, br->dev->dev_addr, v->vid);
283 		if (f && f->is_local && !f->dst)
284 			fdb_delete_local(br, NULL, f);
285 		fdb_insert(br, NULL, newaddr, v->vid);
286 	}
287 out:
288 	spin_unlock_bh(&br->hash_lock);
289 }
290 
291 void br_fdb_cleanup(unsigned long _data)
292 {
293 	struct net_bridge *br = (struct net_bridge *)_data;
294 	unsigned long delay = hold_time(br);
295 	unsigned long next_timer = jiffies + br->ageing_time;
296 	int i;
297 
298 	spin_lock(&br->hash_lock);
299 	for (i = 0; i < BR_HASH_SIZE; i++) {
300 		struct net_bridge_fdb_entry *f;
301 		struct hlist_node *n;
302 
303 		hlist_for_each_entry_safe(f, n, &br->hash[i], hlist) {
304 			unsigned long this_timer;
305 			if (f->is_static)
306 				continue;
307 			if (f->added_by_external_learn)
308 				continue;
309 			this_timer = f->updated + delay;
310 			if (time_before_eq(this_timer, jiffies))
311 				fdb_delete(br, f);
312 			else if (time_before(this_timer, next_timer))
313 				next_timer = this_timer;
314 		}
315 	}
316 	spin_unlock(&br->hash_lock);
317 
318 	mod_timer(&br->gc_timer, round_jiffies_up(next_timer));
319 }
320 
321 /* Completely flush all dynamic entries in forwarding database.*/
322 void br_fdb_flush(struct net_bridge *br)
323 {
324 	int i;
325 
326 	spin_lock_bh(&br->hash_lock);
327 	for (i = 0; i < BR_HASH_SIZE; i++) {
328 		struct net_bridge_fdb_entry *f;
329 		struct hlist_node *n;
330 		hlist_for_each_entry_safe(f, n, &br->hash[i], hlist) {
331 			if (!f->is_static)
332 				fdb_delete(br, f);
333 		}
334 	}
335 	spin_unlock_bh(&br->hash_lock);
336 }
337 
338 /* Flush all entries referring to a specific port.
339  * if do_all is set also flush static entries
340  * if vid is set delete all entries that match the vlan_id
341  */
342 void br_fdb_delete_by_port(struct net_bridge *br,
343 			   const struct net_bridge_port *p,
344 			   u16 vid,
345 			   int do_all)
346 {
347 	int i;
348 
349 	spin_lock_bh(&br->hash_lock);
350 	for (i = 0; i < BR_HASH_SIZE; i++) {
351 		struct hlist_node *h, *g;
352 
353 		hlist_for_each_safe(h, g, &br->hash[i]) {
354 			struct net_bridge_fdb_entry *f
355 				= hlist_entry(h, struct net_bridge_fdb_entry, hlist);
356 			if (f->dst != p)
357 				continue;
358 
359 			if (!do_all)
360 				if (f->is_static || (vid && f->vlan_id != vid))
361 					continue;
362 
363 			if (f->is_local)
364 				fdb_delete_local(br, p, f);
365 			else
366 				fdb_delete(br, f);
367 		}
368 	}
369 	spin_unlock_bh(&br->hash_lock);
370 }
371 
372 /* No locking or refcounting, assumes caller has rcu_read_lock */
373 struct net_bridge_fdb_entry *__br_fdb_get(struct net_bridge *br,
374 					  const unsigned char *addr,
375 					  __u16 vid)
376 {
377 	struct net_bridge_fdb_entry *fdb;
378 
379 	hlist_for_each_entry_rcu(fdb,
380 				&br->hash[br_mac_hash(addr, vid)], hlist) {
381 		if (ether_addr_equal(fdb->addr.addr, addr) &&
382 		    fdb->vlan_id == vid) {
383 			if (unlikely(has_expired(br, fdb)))
384 				break;
385 			return fdb;
386 		}
387 	}
388 
389 	return NULL;
390 }
391 
392 #if IS_ENABLED(CONFIG_ATM_LANE)
393 /* Interface used by ATM LANE hook to test
394  * if an addr is on some other bridge port */
395 int br_fdb_test_addr(struct net_device *dev, unsigned char *addr)
396 {
397 	struct net_bridge_fdb_entry *fdb;
398 	struct net_bridge_port *port;
399 	int ret;
400 
401 	rcu_read_lock();
402 	port = br_port_get_rcu(dev);
403 	if (!port)
404 		ret = 0;
405 	else {
406 		fdb = __br_fdb_get(port->br, addr, 0);
407 		ret = fdb && fdb->dst && fdb->dst->dev != dev &&
408 			fdb->dst->state == BR_STATE_FORWARDING;
409 	}
410 	rcu_read_unlock();
411 
412 	return ret;
413 }
414 #endif /* CONFIG_ATM_LANE */
415 
416 /*
417  * Fill buffer with forwarding table records in
418  * the API format.
419  */
420 int br_fdb_fillbuf(struct net_bridge *br, void *buf,
421 		   unsigned long maxnum, unsigned long skip)
422 {
423 	struct __fdb_entry *fe = buf;
424 	int i, num = 0;
425 	struct net_bridge_fdb_entry *f;
426 
427 	memset(buf, 0, maxnum*sizeof(struct __fdb_entry));
428 
429 	rcu_read_lock();
430 	for (i = 0; i < BR_HASH_SIZE; i++) {
431 		hlist_for_each_entry_rcu(f, &br->hash[i], hlist) {
432 			if (num >= maxnum)
433 				goto out;
434 
435 			if (has_expired(br, f))
436 				continue;
437 
438 			/* ignore pseudo entry for local MAC address */
439 			if (!f->dst)
440 				continue;
441 
442 			if (skip) {
443 				--skip;
444 				continue;
445 			}
446 
447 			/* convert from internal format to API */
448 			memcpy(fe->mac_addr, f->addr.addr, ETH_ALEN);
449 
450 			/* due to ABI compat need to split into hi/lo */
451 			fe->port_no = f->dst->port_no;
452 			fe->port_hi = f->dst->port_no >> 8;
453 
454 			fe->is_local = f->is_local;
455 			if (!f->is_static)
456 				fe->ageing_timer_value = jiffies_delta_to_clock_t(jiffies - f->updated);
457 			++fe;
458 			++num;
459 		}
460 	}
461 
462  out:
463 	rcu_read_unlock();
464 
465 	return num;
466 }
467 
468 static struct net_bridge_fdb_entry *fdb_find(struct hlist_head *head,
469 					     const unsigned char *addr,
470 					     __u16 vid)
471 {
472 	struct net_bridge_fdb_entry *fdb;
473 
474 	hlist_for_each_entry(fdb, head, hlist) {
475 		if (ether_addr_equal(fdb->addr.addr, addr) &&
476 		    fdb->vlan_id == vid)
477 			return fdb;
478 	}
479 	return NULL;
480 }
481 
482 static struct net_bridge_fdb_entry *fdb_find_rcu(struct hlist_head *head,
483 						 const unsigned char *addr,
484 						 __u16 vid)
485 {
486 	struct net_bridge_fdb_entry *fdb;
487 
488 	hlist_for_each_entry_rcu(fdb, head, hlist) {
489 		if (ether_addr_equal(fdb->addr.addr, addr) &&
490 		    fdb->vlan_id == vid)
491 			return fdb;
492 	}
493 	return NULL;
494 }
495 
496 static struct net_bridge_fdb_entry *fdb_create(struct hlist_head *head,
497 					       struct net_bridge_port *source,
498 					       const unsigned char *addr,
499 					       __u16 vid,
500 					       unsigned char is_local,
501 					       unsigned char is_static)
502 {
503 	struct net_bridge_fdb_entry *fdb;
504 
505 	fdb = kmem_cache_alloc(br_fdb_cache, GFP_ATOMIC);
506 	if (fdb) {
507 		memcpy(fdb->addr.addr, addr, ETH_ALEN);
508 		fdb->dst = source;
509 		fdb->vlan_id = vid;
510 		fdb->is_local = is_local;
511 		fdb->is_static = is_static;
512 		fdb->added_by_user = 0;
513 		fdb->added_by_external_learn = 0;
514 		fdb->updated = fdb->used = jiffies;
515 		hlist_add_head_rcu(&fdb->hlist, head);
516 	}
517 	return fdb;
518 }
519 
520 static int fdb_insert(struct net_bridge *br, struct net_bridge_port *source,
521 		  const unsigned char *addr, u16 vid)
522 {
523 	struct hlist_head *head = &br->hash[br_mac_hash(addr, vid)];
524 	struct net_bridge_fdb_entry *fdb;
525 
526 	if (!is_valid_ether_addr(addr))
527 		return -EINVAL;
528 
529 	fdb = fdb_find(head, addr, vid);
530 	if (fdb) {
531 		/* it is okay to have multiple ports with same
532 		 * address, just use the first one.
533 		 */
534 		if (fdb->is_local)
535 			return 0;
536 		br_warn(br, "adding interface %s with same address "
537 		       "as a received packet\n",
538 		       source ? source->dev->name : br->dev->name);
539 		fdb_delete(br, fdb);
540 	}
541 
542 	fdb = fdb_create(head, source, addr, vid, 1, 1);
543 	if (!fdb)
544 		return -ENOMEM;
545 
546 	fdb_add_hw_addr(br, addr);
547 	fdb_notify(br, fdb, RTM_NEWNEIGH);
548 	return 0;
549 }
550 
551 /* Add entry for local address of interface */
552 int br_fdb_insert(struct net_bridge *br, struct net_bridge_port *source,
553 		  const unsigned char *addr, u16 vid)
554 {
555 	int ret;
556 
557 	spin_lock_bh(&br->hash_lock);
558 	ret = fdb_insert(br, source, addr, vid);
559 	spin_unlock_bh(&br->hash_lock);
560 	return ret;
561 }
562 
563 void br_fdb_update(struct net_bridge *br, struct net_bridge_port *source,
564 		   const unsigned char *addr, u16 vid, bool added_by_user)
565 {
566 	struct hlist_head *head = &br->hash[br_mac_hash(addr, vid)];
567 	struct net_bridge_fdb_entry *fdb;
568 	bool fdb_modified = false;
569 
570 	/* some users want to always flood. */
571 	if (hold_time(br) == 0)
572 		return;
573 
574 	/* ignore packets unless we are using this port */
575 	if (!(source->state == BR_STATE_LEARNING ||
576 	      source->state == BR_STATE_FORWARDING))
577 		return;
578 
579 	fdb = fdb_find_rcu(head, addr, vid);
580 	if (likely(fdb)) {
581 		/* attempt to update an entry for a local interface */
582 		if (unlikely(fdb->is_local)) {
583 			if (net_ratelimit())
584 				br_warn(br, "received packet on %s with "
585 					"own address as source address\n",
586 					source->dev->name);
587 		} else {
588 			/* fastpath: update of existing entry */
589 			if (unlikely(source != fdb->dst)) {
590 				fdb->dst = source;
591 				fdb_modified = true;
592 			}
593 			fdb->updated = jiffies;
594 			if (unlikely(added_by_user))
595 				fdb->added_by_user = 1;
596 			if (unlikely(fdb_modified))
597 				fdb_notify(br, fdb, RTM_NEWNEIGH);
598 		}
599 	} else {
600 		spin_lock(&br->hash_lock);
601 		if (likely(!fdb_find(head, addr, vid))) {
602 			fdb = fdb_create(head, source, addr, vid, 0, 0);
603 			if (fdb) {
604 				if (unlikely(added_by_user))
605 					fdb->added_by_user = 1;
606 				fdb_notify(br, fdb, RTM_NEWNEIGH);
607 			}
608 		}
609 		/* else  we lose race and someone else inserts
610 		 * it first, don't bother updating
611 		 */
612 		spin_unlock(&br->hash_lock);
613 	}
614 }
615 
616 static int fdb_to_nud(const struct net_bridge *br,
617 		      const struct net_bridge_fdb_entry *fdb)
618 {
619 	if (fdb->is_local)
620 		return NUD_PERMANENT;
621 	else if (fdb->is_static)
622 		return NUD_NOARP;
623 	else if (has_expired(br, fdb))
624 		return NUD_STALE;
625 	else
626 		return NUD_REACHABLE;
627 }
628 
629 static int fdb_fill_info(struct sk_buff *skb, const struct net_bridge *br,
630 			 const struct net_bridge_fdb_entry *fdb,
631 			 u32 portid, u32 seq, int type, unsigned int flags)
632 {
633 	unsigned long now = jiffies;
634 	struct nda_cacheinfo ci;
635 	struct nlmsghdr *nlh;
636 	struct ndmsg *ndm;
637 
638 	nlh = nlmsg_put(skb, portid, seq, type, sizeof(*ndm), flags);
639 	if (nlh == NULL)
640 		return -EMSGSIZE;
641 
642 	ndm = nlmsg_data(nlh);
643 	ndm->ndm_family	 = AF_BRIDGE;
644 	ndm->ndm_pad1    = 0;
645 	ndm->ndm_pad2    = 0;
646 	ndm->ndm_flags	 = fdb->added_by_external_learn ? NTF_EXT_LEARNED : 0;
647 	ndm->ndm_type	 = 0;
648 	ndm->ndm_ifindex = fdb->dst ? fdb->dst->dev->ifindex : br->dev->ifindex;
649 	ndm->ndm_state   = fdb_to_nud(br, fdb);
650 
651 	if (nla_put(skb, NDA_LLADDR, ETH_ALEN, &fdb->addr))
652 		goto nla_put_failure;
653 	if (nla_put_u32(skb, NDA_MASTER, br->dev->ifindex))
654 		goto nla_put_failure;
655 	ci.ndm_used	 = jiffies_to_clock_t(now - fdb->used);
656 	ci.ndm_confirmed = 0;
657 	ci.ndm_updated	 = jiffies_to_clock_t(now - fdb->updated);
658 	ci.ndm_refcnt	 = 0;
659 	if (nla_put(skb, NDA_CACHEINFO, sizeof(ci), &ci))
660 		goto nla_put_failure;
661 
662 	if (fdb->vlan_id && nla_put(skb, NDA_VLAN, sizeof(u16), &fdb->vlan_id))
663 		goto nla_put_failure;
664 
665 	nlmsg_end(skb, nlh);
666 	return 0;
667 
668 nla_put_failure:
669 	nlmsg_cancel(skb, nlh);
670 	return -EMSGSIZE;
671 }
672 
673 static inline size_t fdb_nlmsg_size(void)
674 {
675 	return NLMSG_ALIGN(sizeof(struct ndmsg))
676 		+ nla_total_size(ETH_ALEN) /* NDA_LLADDR */
677 		+ nla_total_size(sizeof(u32)) /* NDA_MASTER */
678 		+ nla_total_size(sizeof(u16)) /* NDA_VLAN */
679 		+ nla_total_size(sizeof(struct nda_cacheinfo));
680 }
681 
682 static void fdb_notify(struct net_bridge *br,
683 		       const struct net_bridge_fdb_entry *fdb, int type)
684 {
685 	struct net *net = dev_net(br->dev);
686 	struct sk_buff *skb;
687 	int err = -ENOBUFS;
688 
689 	skb = nlmsg_new(fdb_nlmsg_size(), GFP_ATOMIC);
690 	if (skb == NULL)
691 		goto errout;
692 
693 	err = fdb_fill_info(skb, br, fdb, 0, 0, type, 0);
694 	if (err < 0) {
695 		/* -EMSGSIZE implies BUG in fdb_nlmsg_size() */
696 		WARN_ON(err == -EMSGSIZE);
697 		kfree_skb(skb);
698 		goto errout;
699 	}
700 	rtnl_notify(skb, net, 0, RTNLGRP_NEIGH, NULL, GFP_ATOMIC);
701 	return;
702 errout:
703 	rtnl_set_sk_err(net, RTNLGRP_NEIGH, err);
704 }
705 
706 /* Dump information about entries, in response to GETNEIGH */
707 int br_fdb_dump(struct sk_buff *skb,
708 		struct netlink_callback *cb,
709 		struct net_device *dev,
710 		struct net_device *filter_dev,
711 		int idx)
712 {
713 	struct net_bridge *br = netdev_priv(dev);
714 	int i;
715 
716 	if (!(dev->priv_flags & IFF_EBRIDGE))
717 		goto out;
718 
719 	if (!filter_dev)
720 		idx = ndo_dflt_fdb_dump(skb, cb, dev, NULL, idx);
721 
722 	for (i = 0; i < BR_HASH_SIZE; i++) {
723 		struct net_bridge_fdb_entry *f;
724 
725 		hlist_for_each_entry_rcu(f, &br->hash[i], hlist) {
726 			int err;
727 
728 			if (idx < cb->args[0])
729 				goto skip;
730 
731 			if (filter_dev &&
732 			    (!f->dst || f->dst->dev != filter_dev)) {
733 				if (filter_dev != dev)
734 					goto skip;
735 				/* !f->dst is a special case for bridge
736 				 * It means the MAC belongs to the bridge
737 				 * Therefore need a little more filtering
738 				 * we only want to dump the !f->dst case
739 				 */
740 				if (f->dst)
741 					goto skip;
742 			}
743 			if (!filter_dev && f->dst)
744 				goto skip;
745 
746 			err = fdb_fill_info(skb, br, f,
747 					    NETLINK_CB(cb->skb).portid,
748 					    cb->nlh->nlmsg_seq,
749 					    RTM_NEWNEIGH,
750 					    NLM_F_MULTI);
751 			if (err < 0) {
752 				cb->args[1] = err;
753 				break;
754 			}
755 skip:
756 			++idx;
757 		}
758 	}
759 
760 out:
761 	return idx;
762 }
763 
764 /* Update (create or replace) forwarding database entry */
765 static int fdb_add_entry(struct net_bridge_port *source, const __u8 *addr,
766 			 __u16 state, __u16 flags, __u16 vid)
767 {
768 	struct net_bridge *br = source->br;
769 	struct hlist_head *head = &br->hash[br_mac_hash(addr, vid)];
770 	struct net_bridge_fdb_entry *fdb;
771 	bool modified = false;
772 
773 	/* If the port cannot learn allow only local and static entries */
774 	if (!(state & NUD_PERMANENT) && !(state & NUD_NOARP) &&
775 	    !(source->state == BR_STATE_LEARNING ||
776 	      source->state == BR_STATE_FORWARDING))
777 		return -EPERM;
778 
779 	fdb = fdb_find(head, addr, vid);
780 	if (fdb == NULL) {
781 		if (!(flags & NLM_F_CREATE))
782 			return -ENOENT;
783 
784 		fdb = fdb_create(head, source, addr, vid, 0, 0);
785 		if (!fdb)
786 			return -ENOMEM;
787 
788 		modified = true;
789 	} else {
790 		if (flags & NLM_F_EXCL)
791 			return -EEXIST;
792 
793 		if (fdb->dst != source) {
794 			fdb->dst = source;
795 			modified = true;
796 		}
797 	}
798 
799 	if (fdb_to_nud(br, fdb) != state) {
800 		if (state & NUD_PERMANENT) {
801 			fdb->is_local = 1;
802 			if (!fdb->is_static) {
803 				fdb->is_static = 1;
804 				fdb_add_hw_addr(br, addr);
805 			}
806 		} else if (state & NUD_NOARP) {
807 			fdb->is_local = 0;
808 			if (!fdb->is_static) {
809 				fdb->is_static = 1;
810 				fdb_add_hw_addr(br, addr);
811 			}
812 		} else {
813 			fdb->is_local = 0;
814 			if (fdb->is_static) {
815 				fdb->is_static = 0;
816 				fdb_del_hw_addr(br, addr);
817 			}
818 		}
819 
820 		modified = true;
821 	}
822 	fdb->added_by_user = 1;
823 
824 	fdb->used = jiffies;
825 	if (modified) {
826 		fdb->updated = jiffies;
827 		fdb_notify(br, fdb, RTM_NEWNEIGH);
828 	}
829 
830 	return 0;
831 }
832 
833 static int __br_fdb_add(struct ndmsg *ndm, struct net_bridge_port *p,
834 	       const unsigned char *addr, u16 nlh_flags, u16 vid)
835 {
836 	int err = 0;
837 
838 	if (ndm->ndm_flags & NTF_USE) {
839 		local_bh_disable();
840 		rcu_read_lock();
841 		br_fdb_update(p->br, p, addr, vid, true);
842 		rcu_read_unlock();
843 		local_bh_enable();
844 	} else {
845 		spin_lock_bh(&p->br->hash_lock);
846 		err = fdb_add_entry(p, addr, ndm->ndm_state,
847 				    nlh_flags, vid);
848 		spin_unlock_bh(&p->br->hash_lock);
849 	}
850 
851 	return err;
852 }
853 
854 /* Add new permanent fdb entry with RTM_NEWNEIGH */
855 int br_fdb_add(struct ndmsg *ndm, struct nlattr *tb[],
856 	       struct net_device *dev,
857 	       const unsigned char *addr, u16 vid, u16 nlh_flags)
858 {
859 	struct net_bridge_vlan_group *vg;
860 	struct net_bridge_port *p = NULL;
861 	struct net_bridge_vlan *v;
862 	struct net_bridge *br = NULL;
863 	int err = 0;
864 
865 	if (!(ndm->ndm_state & (NUD_PERMANENT|NUD_NOARP|NUD_REACHABLE))) {
866 		pr_info("bridge: RTM_NEWNEIGH with invalid state %#x\n", ndm->ndm_state);
867 		return -EINVAL;
868 	}
869 
870 	if (is_zero_ether_addr(addr)) {
871 		pr_info("bridge: RTM_NEWNEIGH with invalid ether address\n");
872 		return -EINVAL;
873 	}
874 
875 	if (dev->priv_flags & IFF_EBRIDGE) {
876 		br = netdev_priv(dev);
877 		vg = br_vlan_group(br);
878 	} else {
879 		p = br_port_get_rtnl(dev);
880 		if (!p) {
881 			pr_info("bridge: RTM_NEWNEIGH %s not a bridge port\n",
882 				dev->name);
883 			return -EINVAL;
884 		}
885 		vg = nbp_vlan_group(p);
886 	}
887 
888 	if (vid) {
889 		v = br_vlan_find(vg, vid);
890 		if (!v || !br_vlan_should_use(v)) {
891 			pr_info("bridge: RTM_NEWNEIGH with unconfigured vlan %d on %s\n", vid, dev->name);
892 			return -EINVAL;
893 		}
894 
895 		/* VID was specified, so use it. */
896 		if (dev->priv_flags & IFF_EBRIDGE)
897 			err = br_fdb_insert(br, NULL, addr, vid);
898 		else
899 			err = __br_fdb_add(ndm, p, addr, nlh_flags, vid);
900 	} else {
901 		if (dev->priv_flags & IFF_EBRIDGE)
902 			err = br_fdb_insert(br, NULL, addr, 0);
903 		else
904 			err = __br_fdb_add(ndm, p, addr, nlh_flags, 0);
905 		if (err || !vg || !vg->num_vlans)
906 			goto out;
907 
908 		/* We have vlans configured on this port and user didn't
909 		 * specify a VLAN.  To be nice, add/update entry for every
910 		 * vlan on this port.
911 		 */
912 		list_for_each_entry(v, &vg->vlan_list, vlist) {
913 			if (!br_vlan_should_use(v))
914 				continue;
915 			if (dev->priv_flags & IFF_EBRIDGE)
916 				err = br_fdb_insert(br, NULL, addr, v->vid);
917 			else
918 				err = __br_fdb_add(ndm, p, addr, nlh_flags,
919 						   v->vid);
920 			if (err)
921 				goto out;
922 		}
923 	}
924 
925 out:
926 	return err;
927 }
928 
929 static int fdb_delete_by_addr(struct net_bridge *br, const u8 *addr,
930 			      u16 vid)
931 {
932 	struct hlist_head *head = &br->hash[br_mac_hash(addr, vid)];
933 	struct net_bridge_fdb_entry *fdb;
934 
935 	fdb = fdb_find(head, addr, vid);
936 	if (!fdb)
937 		return -ENOENT;
938 
939 	fdb_delete(br, fdb);
940 	return 0;
941 }
942 
943 static int __br_fdb_delete_by_addr(struct net_bridge *br,
944 				   const unsigned char *addr, u16 vid)
945 {
946 	int err;
947 
948 	spin_lock_bh(&br->hash_lock);
949 	err = fdb_delete_by_addr(br, addr, vid);
950 	spin_unlock_bh(&br->hash_lock);
951 
952 	return err;
953 }
954 
955 static int fdb_delete_by_addr_and_port(struct net_bridge_port *p,
956 				       const u8 *addr, u16 vlan)
957 {
958 	struct net_bridge *br = p->br;
959 	struct hlist_head *head = &br->hash[br_mac_hash(addr, vlan)];
960 	struct net_bridge_fdb_entry *fdb;
961 
962 	fdb = fdb_find(head, addr, vlan);
963 	if (!fdb || fdb->dst != p)
964 		return -ENOENT;
965 
966 	fdb_delete(br, fdb);
967 	return 0;
968 }
969 
970 static int __br_fdb_delete(struct net_bridge_port *p,
971 			   const unsigned char *addr, u16 vid)
972 {
973 	int err;
974 
975 	spin_lock_bh(&p->br->hash_lock);
976 	err = fdb_delete_by_addr_and_port(p, addr, vid);
977 	spin_unlock_bh(&p->br->hash_lock);
978 
979 	return err;
980 }
981 
982 /* Remove neighbor entry with RTM_DELNEIGH */
983 int br_fdb_delete(struct ndmsg *ndm, struct nlattr *tb[],
984 		  struct net_device *dev,
985 		  const unsigned char *addr, u16 vid)
986 {
987 	struct net_bridge_vlan_group *vg;
988 	struct net_bridge_port *p = NULL;
989 	struct net_bridge_vlan *v;
990 	struct net_bridge *br = NULL;
991 	int err;
992 
993 	if (dev->priv_flags & IFF_EBRIDGE) {
994 		br = netdev_priv(dev);
995 		vg = br_vlan_group(br);
996 	} else {
997 		p = br_port_get_rtnl(dev);
998 		if (!p) {
999 			pr_info("bridge: RTM_DELNEIGH %s not a bridge port\n",
1000 				dev->name);
1001 			return -EINVAL;
1002 		}
1003 		vg = nbp_vlan_group(p);
1004 	}
1005 
1006 	if (vid) {
1007 		v = br_vlan_find(vg, vid);
1008 		if (!v) {
1009 			pr_info("bridge: RTM_DELNEIGH with unconfigured vlan %d on %s\n", vid, dev->name);
1010 			return -EINVAL;
1011 		}
1012 
1013 		if (dev->priv_flags & IFF_EBRIDGE)
1014 			err = __br_fdb_delete_by_addr(br, addr, vid);
1015 		else
1016 			err = __br_fdb_delete(p, addr, vid);
1017 	} else {
1018 		err = -ENOENT;
1019 		if (dev->priv_flags & IFF_EBRIDGE)
1020 			err = __br_fdb_delete_by_addr(br, addr, 0);
1021 		else
1022 			err &= __br_fdb_delete(p, addr, 0);
1023 
1024 		if (!vg || !vg->num_vlans)
1025 			goto out;
1026 
1027 		list_for_each_entry(v, &vg->vlan_list, vlist) {
1028 			if (!br_vlan_should_use(v))
1029 				continue;
1030 			if (dev->priv_flags & IFF_EBRIDGE)
1031 				err = __br_fdb_delete_by_addr(br, addr, v->vid);
1032 			else
1033 				err &= __br_fdb_delete(p, addr, v->vid);
1034 		}
1035 	}
1036 out:
1037 	return err;
1038 }
1039 
1040 int br_fdb_sync_static(struct net_bridge *br, struct net_bridge_port *p)
1041 {
1042 	struct net_bridge_fdb_entry *fdb, *tmp;
1043 	int i;
1044 	int err;
1045 
1046 	ASSERT_RTNL();
1047 
1048 	for (i = 0; i < BR_HASH_SIZE; i++) {
1049 		hlist_for_each_entry(fdb, &br->hash[i], hlist) {
1050 			/* We only care for static entries */
1051 			if (!fdb->is_static)
1052 				continue;
1053 
1054 			err = dev_uc_add(p->dev, fdb->addr.addr);
1055 			if (err)
1056 				goto rollback;
1057 		}
1058 	}
1059 	return 0;
1060 
1061 rollback:
1062 	for (i = 0; i < BR_HASH_SIZE; i++) {
1063 		hlist_for_each_entry(tmp, &br->hash[i], hlist) {
1064 			/* If we reached the fdb that failed, we can stop */
1065 			if (tmp == fdb)
1066 				break;
1067 
1068 			/* We only care for static entries */
1069 			if (!tmp->is_static)
1070 				continue;
1071 
1072 			dev_uc_del(p->dev, tmp->addr.addr);
1073 		}
1074 	}
1075 	return err;
1076 }
1077 
1078 void br_fdb_unsync_static(struct net_bridge *br, struct net_bridge_port *p)
1079 {
1080 	struct net_bridge_fdb_entry *fdb;
1081 	int i;
1082 
1083 	ASSERT_RTNL();
1084 
1085 	for (i = 0; i < BR_HASH_SIZE; i++) {
1086 		hlist_for_each_entry_rcu(fdb, &br->hash[i], hlist) {
1087 			/* We only care for static entries */
1088 			if (!fdb->is_static)
1089 				continue;
1090 
1091 			dev_uc_del(p->dev, fdb->addr.addr);
1092 		}
1093 	}
1094 }
1095 
1096 int br_fdb_external_learn_add(struct net_bridge *br, struct net_bridge_port *p,
1097 			      const unsigned char *addr, u16 vid)
1098 {
1099 	struct hlist_head *head;
1100 	struct net_bridge_fdb_entry *fdb;
1101 	int err = 0;
1102 
1103 	ASSERT_RTNL();
1104 	spin_lock_bh(&br->hash_lock);
1105 
1106 	head = &br->hash[br_mac_hash(addr, vid)];
1107 	fdb = fdb_find(head, addr, vid);
1108 	if (!fdb) {
1109 		fdb = fdb_create(head, p, addr, vid, 0, 0);
1110 		if (!fdb) {
1111 			err = -ENOMEM;
1112 			goto err_unlock;
1113 		}
1114 		fdb->added_by_external_learn = 1;
1115 		fdb_notify(br, fdb, RTM_NEWNEIGH);
1116 	} else if (fdb->added_by_external_learn) {
1117 		/* Refresh entry */
1118 		fdb->updated = fdb->used = jiffies;
1119 	} else if (!fdb->added_by_user) {
1120 		/* Take over SW learned entry */
1121 		fdb->added_by_external_learn = 1;
1122 		fdb->updated = jiffies;
1123 		fdb_notify(br, fdb, RTM_NEWNEIGH);
1124 	}
1125 
1126 err_unlock:
1127 	spin_unlock_bh(&br->hash_lock);
1128 
1129 	return err;
1130 }
1131 
1132 int br_fdb_external_learn_del(struct net_bridge *br, struct net_bridge_port *p,
1133 			      const unsigned char *addr, u16 vid)
1134 {
1135 	struct hlist_head *head;
1136 	struct net_bridge_fdb_entry *fdb;
1137 	int err = 0;
1138 
1139 	ASSERT_RTNL();
1140 	spin_lock_bh(&br->hash_lock);
1141 
1142 	head = &br->hash[br_mac_hash(addr, vid)];
1143 	fdb = fdb_find(head, addr, vid);
1144 	if (fdb && fdb->added_by_external_learn)
1145 		fdb_delete(br, fdb);
1146 	else
1147 		err = -ENOENT;
1148 
1149 	spin_unlock_bh(&br->hash_lock);
1150 
1151 	return err;
1152 }
1153