xref: /openbmc/linux/net/bridge/br_private.h (revision 7d850abd)
1 /*
2  *	Linux ethernet bridge
3  *
4  *	Authors:
5  *	Lennert Buytenhek		<buytenh@gnu.org>
6  *
7  *	This program is free software; you can redistribute it and/or
8  *	modify it under the terms of the GNU General Public License
9  *	as published by the Free Software Foundation; either version
10  *	2 of the License, or (at your option) any later version.
11  */
12 
13 #ifndef _BR_PRIVATE_H
14 #define _BR_PRIVATE_H
15 
16 #include <linux/netdevice.h>
17 #include <linux/if_bridge.h>
18 #include <linux/netpoll.h>
19 #include <linux/u64_stats_sync.h>
20 #include <net/route.h>
21 #include <net/ip6_fib.h>
22 #include <linux/if_vlan.h>
23 #include <linux/rhashtable.h>
24 #include <linux/refcount.h>
25 
26 #define BR_HASH_BITS 8
27 #define BR_HASH_SIZE (1 << BR_HASH_BITS)
28 
29 #define BR_HOLD_TIME (1*HZ)
30 
31 #define BR_PORT_BITS	10
32 #define BR_MAX_PORTS	(1<<BR_PORT_BITS)
33 
34 #define BR_VERSION	"2.3"
35 
36 /* Control of forwarding link local multicast */
37 #define BR_GROUPFWD_DEFAULT	0
38 /* Don't allow forwarding of control protocols like STP, MAC PAUSE and LACP */
39 enum {
40 	BR_GROUPFWD_STP		= BIT(0),
41 	BR_GROUPFWD_MACPAUSE	= BIT(1),
42 	BR_GROUPFWD_LACP	= BIT(2),
43 };
44 
45 #define BR_GROUPFWD_RESTRICTED (BR_GROUPFWD_STP | BR_GROUPFWD_MACPAUSE | \
46 				BR_GROUPFWD_LACP)
47 /* The Nearest Customer Bridge Group Address, 01-80-C2-00-00-[00,0B,0C,0D,0F] */
48 #define BR_GROUPFWD_8021AD	0xB801u
49 
50 /* Path to usermode spanning tree program */
51 #define BR_STP_PROG	"/sbin/bridge-stp"
52 
53 typedef struct bridge_id bridge_id;
54 typedef struct mac_addr mac_addr;
55 typedef __u16 port_id;
56 
57 struct bridge_id
58 {
59 	unsigned char	prio[2];
60 	unsigned char	addr[ETH_ALEN];
61 };
62 
63 struct mac_addr
64 {
65 	unsigned char	addr[ETH_ALEN];
66 };
67 
68 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
69 /* our own querier */
70 struct bridge_mcast_own_query {
71 	struct timer_list	timer;
72 	u32			startup_sent;
73 };
74 
75 /* other querier */
76 struct bridge_mcast_other_query {
77 	struct timer_list		timer;
78 	unsigned long			delay_time;
79 };
80 
81 /* selected querier */
82 struct bridge_mcast_querier {
83 	struct br_ip addr;
84 	struct net_bridge_port __rcu	*port;
85 };
86 
87 /* IGMP/MLD statistics */
88 struct bridge_mcast_stats {
89 	struct br_mcast_stats mstats;
90 	struct u64_stats_sync syncp;
91 };
92 #endif
93 
94 struct br_vlan_stats {
95 	u64 rx_bytes;
96 	u64 rx_packets;
97 	u64 tx_bytes;
98 	u64 tx_packets;
99 	struct u64_stats_sync syncp;
100 };
101 
102 struct br_tunnel_info {
103 	__be64			tunnel_id;
104 	struct metadata_dst	*tunnel_dst;
105 };
106 
107 /**
108  * struct net_bridge_vlan - per-vlan entry
109  *
110  * @vnode: rhashtable member
111  * @vid: VLAN id
112  * @flags: bridge vlan flags
113  * @stats: per-cpu VLAN statistics
114  * @br: if MASTER flag set, this points to a bridge struct
115  * @port: if MASTER flag unset, this points to a port struct
116  * @refcnt: if MASTER flag set, this is bumped for each port referencing it
117  * @brvlan: if MASTER flag unset, this points to the global per-VLAN context
118  *          for this VLAN entry
119  * @vlist: sorted list of VLAN entries
120  * @rcu: used for entry destruction
121  *
122  * This structure is shared between the global per-VLAN entries contained in
123  * the bridge rhashtable and the local per-port per-VLAN entries contained in
124  * the port's rhashtable. The union entries should be interpreted depending on
125  * the entry flags that are set.
126  */
127 struct net_bridge_vlan {
128 	struct rhash_head		vnode;
129 	struct rhash_head		tnode;
130 	u16				vid;
131 	u16				flags;
132 	struct br_vlan_stats __percpu	*stats;
133 	union {
134 		struct net_bridge	*br;
135 		struct net_bridge_port	*port;
136 	};
137 	union {
138 		refcount_t		refcnt;
139 		struct net_bridge_vlan	*brvlan;
140 	};
141 
142 	struct br_tunnel_info		tinfo;
143 
144 	struct list_head		vlist;
145 
146 	struct rcu_head			rcu;
147 };
148 
149 /**
150  * struct net_bridge_vlan_group
151  *
152  * @vlan_hash: VLAN entry rhashtable
153  * @vlan_list: sorted VLAN entry list
154  * @num_vlans: number of total VLAN entries
155  * @pvid: PVID VLAN id
156  *
157  * IMPORTANT: Be careful when checking if there're VLAN entries using list
158  *            primitives because the bridge can have entries in its list which
159  *            are just for global context but not for filtering, i.e. they have
160  *            the master flag set but not the brentry flag. If you have to check
161  *            if there're "real" entries in the bridge please test @num_vlans
162  */
163 struct net_bridge_vlan_group {
164 	struct rhashtable		vlan_hash;
165 	struct rhashtable		tunnel_hash;
166 	struct list_head		vlan_list;
167 	u16				num_vlans;
168 	u16				pvid;
169 };
170 
171 struct net_bridge_fdb_key {
172 	mac_addr addr;
173 	u16 vlan_id;
174 };
175 
176 struct net_bridge_fdb_entry {
177 	struct rhash_head		rhnode;
178 	struct net_bridge_port		*dst;
179 
180 	struct net_bridge_fdb_key	key;
181 	struct hlist_node		fdb_node;
182 	unsigned char			is_local:1,
183 					is_static:1,
184 					added_by_user:1,
185 					added_by_external_learn:1,
186 					offloaded:1;
187 
188 	/* write-heavy members should not affect lookups */
189 	unsigned long			updated ____cacheline_aligned_in_smp;
190 	unsigned long			used;
191 
192 	struct rcu_head			rcu;
193 };
194 
195 #define MDB_PG_FLAGS_PERMANENT	BIT(0)
196 #define MDB_PG_FLAGS_OFFLOAD	BIT(1)
197 
198 struct net_bridge_port_group {
199 	struct net_bridge_port		*port;
200 	struct net_bridge_port_group __rcu *next;
201 	struct hlist_node		mglist;
202 	struct rcu_head			rcu;
203 	struct timer_list		timer;
204 	struct br_ip			addr;
205 	unsigned char			flags;
206 	unsigned char			eth_addr[ETH_ALEN];
207 };
208 
209 struct net_bridge_mdb_entry
210 {
211 	struct hlist_node		hlist[2];
212 	struct net_bridge		*br;
213 	struct net_bridge_port_group __rcu *ports;
214 	struct rcu_head			rcu;
215 	struct timer_list		timer;
216 	struct br_ip			addr;
217 	bool				host_joined;
218 };
219 
220 struct net_bridge_mdb_htable
221 {
222 	struct hlist_head		*mhash;
223 	struct rcu_head			rcu;
224 	struct net_bridge_mdb_htable	*old;
225 	u32				size;
226 	u32				max;
227 	u32				secret;
228 	u32				ver;
229 };
230 
231 struct net_bridge_port {
232 	struct net_bridge		*br;
233 	struct net_device		*dev;
234 	struct list_head		list;
235 
236 	unsigned long			flags;
237 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
238 	struct net_bridge_vlan_group	__rcu *vlgrp;
239 #endif
240 
241 	/* STP */
242 	u8				priority;
243 	u8				state;
244 	u16				port_no;
245 	unsigned char			topology_change_ack;
246 	unsigned char			config_pending;
247 	port_id				port_id;
248 	port_id				designated_port;
249 	bridge_id			designated_root;
250 	bridge_id			designated_bridge;
251 	u32				path_cost;
252 	u32				designated_cost;
253 	unsigned long			designated_age;
254 
255 	struct timer_list		forward_delay_timer;
256 	struct timer_list		hold_timer;
257 	struct timer_list		message_age_timer;
258 	struct kobject			kobj;
259 	struct rcu_head			rcu;
260 
261 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
262 	struct bridge_mcast_own_query	ip4_own_query;
263 #if IS_ENABLED(CONFIG_IPV6)
264 	struct bridge_mcast_own_query	ip6_own_query;
265 #endif /* IS_ENABLED(CONFIG_IPV6) */
266 	unsigned char			multicast_router;
267 	struct bridge_mcast_stats	__percpu *mcast_stats;
268 	struct timer_list		multicast_router_timer;
269 	struct hlist_head		mglist;
270 	struct hlist_node		rlist;
271 #endif
272 
273 #ifdef CONFIG_SYSFS
274 	char				sysfs_name[IFNAMSIZ];
275 #endif
276 
277 #ifdef CONFIG_NET_POLL_CONTROLLER
278 	struct netpoll			*np;
279 #endif
280 #ifdef CONFIG_NET_SWITCHDEV
281 	int				offload_fwd_mark;
282 #endif
283 	u16				group_fwd_mask;
284 };
285 
286 #define br_auto_port(p) ((p)->flags & BR_AUTO_MASK)
287 #define br_promisc_port(p) ((p)->flags & BR_PROMISC)
288 
289 #define br_port_exists(dev) (dev->priv_flags & IFF_BRIDGE_PORT)
290 
291 static inline struct net_bridge_port *br_port_get_rcu(const struct net_device *dev)
292 {
293 	return rcu_dereference(dev->rx_handler_data);
294 }
295 
296 static inline struct net_bridge_port *br_port_get_rtnl(const struct net_device *dev)
297 {
298 	return br_port_exists(dev) ?
299 		rtnl_dereference(dev->rx_handler_data) : NULL;
300 }
301 
302 static inline struct net_bridge_port *br_port_get_rtnl_rcu(const struct net_device *dev)
303 {
304 	return br_port_exists(dev) ?
305 		rcu_dereference_rtnl(dev->rx_handler_data) : NULL;
306 }
307 
308 struct net_bridge {
309 	spinlock_t			lock;
310 	spinlock_t			hash_lock;
311 	struct list_head		port_list;
312 	struct net_device		*dev;
313 	struct pcpu_sw_netstats		__percpu *stats;
314 	/* These fields are accessed on each packet */
315 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
316 	u8				vlan_enabled;
317 	u8				vlan_stats_enabled;
318 	__be16				vlan_proto;
319 	u16				default_pvid;
320 	struct net_bridge_vlan_group	__rcu *vlgrp;
321 #endif
322 
323 	struct rhashtable		fdb_hash_tbl;
324 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
325 	union {
326 		struct rtable		fake_rtable;
327 		struct rt6_info		fake_rt6_info;
328 	};
329 	bool				nf_call_iptables;
330 	bool				nf_call_ip6tables;
331 	bool				nf_call_arptables;
332 #endif
333 	u16				group_fwd_mask;
334 	u16				group_fwd_mask_required;
335 
336 	/* STP */
337 	bridge_id			designated_root;
338 	bridge_id			bridge_id;
339 	u32				root_path_cost;
340 	unsigned char			topology_change;
341 	unsigned char			topology_change_detected;
342 	u16				root_port;
343 	unsigned long			max_age;
344 	unsigned long			hello_time;
345 	unsigned long			forward_delay;
346 	unsigned long			ageing_time;
347 	unsigned long			bridge_max_age;
348 	unsigned long			bridge_hello_time;
349 	unsigned long			bridge_forward_delay;
350 	unsigned long			bridge_ageing_time;
351 
352 	u8				group_addr[ETH_ALEN];
353 	bool				group_addr_set;
354 
355 	enum {
356 		BR_NO_STP, 		/* no spanning tree */
357 		BR_KERNEL_STP,		/* old STP in kernel */
358 		BR_USER_STP,		/* new RSTP in userspace */
359 	} stp_enabled;
360 
361 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
362 	unsigned char			multicast_router;
363 
364 	u8				multicast_disabled:1;
365 	u8				multicast_querier:1;
366 	u8				multicast_query_use_ifaddr:1;
367 	u8				has_ipv6_addr:1;
368 	u8				multicast_stats_enabled:1;
369 
370 	u32				hash_elasticity;
371 	u32				hash_max;
372 
373 	u32				multicast_last_member_count;
374 	u32				multicast_startup_query_count;
375 
376 	u8				multicast_igmp_version;
377 
378 	unsigned long			multicast_last_member_interval;
379 	unsigned long			multicast_membership_interval;
380 	unsigned long			multicast_querier_interval;
381 	unsigned long			multicast_query_interval;
382 	unsigned long			multicast_query_response_interval;
383 	unsigned long			multicast_startup_query_interval;
384 
385 	spinlock_t			multicast_lock;
386 	struct net_bridge_mdb_htable __rcu *mdb;
387 	struct hlist_head		router_list;
388 
389 	struct timer_list		multicast_router_timer;
390 	struct bridge_mcast_other_query	ip4_other_query;
391 	struct bridge_mcast_own_query	ip4_own_query;
392 	struct bridge_mcast_querier	ip4_querier;
393 	struct bridge_mcast_stats	__percpu *mcast_stats;
394 #if IS_ENABLED(CONFIG_IPV6)
395 	struct bridge_mcast_other_query	ip6_other_query;
396 	struct bridge_mcast_own_query	ip6_own_query;
397 	struct bridge_mcast_querier	ip6_querier;
398 	u8				multicast_mld_version;
399 #endif /* IS_ENABLED(CONFIG_IPV6) */
400 #endif
401 
402 	struct timer_list		hello_timer;
403 	struct timer_list		tcn_timer;
404 	struct timer_list		topology_change_timer;
405 	struct delayed_work		gc_work;
406 	struct kobject			*ifobj;
407 	u32				auto_cnt;
408 
409 #ifdef CONFIG_NET_SWITCHDEV
410 	int offload_fwd_mark;
411 #endif
412 	bool				neigh_suppress_enabled;
413 	bool				mtu_set_by_user;
414 	struct hlist_head		fdb_list;
415 };
416 
417 struct br_input_skb_cb {
418 	struct net_device *brdev;
419 
420 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
421 	int igmp;
422 	int mrouters_only;
423 #endif
424 
425 	bool proxyarp_replied;
426 	bool src_port_isolated;
427 
428 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
429 	bool vlan_filtered;
430 #endif
431 
432 #ifdef CONFIG_NET_SWITCHDEV
433 	int offload_fwd_mark;
434 #endif
435 };
436 
437 #define BR_INPUT_SKB_CB(__skb)	((struct br_input_skb_cb *)(__skb)->cb)
438 
439 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
440 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb)	(BR_INPUT_SKB_CB(__skb)->mrouters_only)
441 #else
442 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb)	(0)
443 #endif
444 
445 #define br_printk(level, br, format, args...)	\
446 	printk(level "%s: " format, (br)->dev->name, ##args)
447 
448 #define br_err(__br, format, args...)			\
449 	br_printk(KERN_ERR, __br, format, ##args)
450 #define br_warn(__br, format, args...)			\
451 	br_printk(KERN_WARNING, __br, format, ##args)
452 #define br_notice(__br, format, args...)		\
453 	br_printk(KERN_NOTICE, __br, format, ##args)
454 #define br_info(__br, format, args...)			\
455 	br_printk(KERN_INFO, __br, format, ##args)
456 
457 #define br_debug(br, format, args...)			\
458 	pr_debug("%s: " format,  (br)->dev->name, ##args)
459 
460 /* called under bridge lock */
461 static inline int br_is_root_bridge(const struct net_bridge *br)
462 {
463 	return !memcmp(&br->bridge_id, &br->designated_root, 8);
464 }
465 
466 /* check if a VLAN entry is global */
467 static inline bool br_vlan_is_master(const struct net_bridge_vlan *v)
468 {
469 	return v->flags & BRIDGE_VLAN_INFO_MASTER;
470 }
471 
472 /* check if a VLAN entry is used by the bridge */
473 static inline bool br_vlan_is_brentry(const struct net_bridge_vlan *v)
474 {
475 	return v->flags & BRIDGE_VLAN_INFO_BRENTRY;
476 }
477 
478 /* check if we should use the vlan entry, returns false if it's only context */
479 static inline bool br_vlan_should_use(const struct net_bridge_vlan *v)
480 {
481 	if (br_vlan_is_master(v)) {
482 		if (br_vlan_is_brentry(v))
483 			return true;
484 		else
485 			return false;
486 	}
487 
488 	return true;
489 }
490 
491 /* br_device.c */
492 void br_dev_setup(struct net_device *dev);
493 void br_dev_delete(struct net_device *dev, struct list_head *list);
494 netdev_tx_t br_dev_xmit(struct sk_buff *skb, struct net_device *dev);
495 #ifdef CONFIG_NET_POLL_CONTROLLER
496 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
497 				       struct sk_buff *skb)
498 {
499 	struct netpoll *np = p->np;
500 
501 	if (np)
502 		netpoll_send_skb(np, skb);
503 }
504 
505 int br_netpoll_enable(struct net_bridge_port *p);
506 void br_netpoll_disable(struct net_bridge_port *p);
507 #else
508 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
509 				       struct sk_buff *skb)
510 {
511 }
512 
513 static inline int br_netpoll_enable(struct net_bridge_port *p)
514 {
515 	return 0;
516 }
517 
518 static inline void br_netpoll_disable(struct net_bridge_port *p)
519 {
520 }
521 #endif
522 
523 /* br_fdb.c */
524 int br_fdb_init(void);
525 void br_fdb_fini(void);
526 int br_fdb_hash_init(struct net_bridge *br);
527 void br_fdb_hash_fini(struct net_bridge *br);
528 void br_fdb_flush(struct net_bridge *br);
529 void br_fdb_find_delete_local(struct net_bridge *br,
530 			      const struct net_bridge_port *p,
531 			      const unsigned char *addr, u16 vid);
532 void br_fdb_changeaddr(struct net_bridge_port *p, const unsigned char *newaddr);
533 void br_fdb_change_mac_address(struct net_bridge *br, const u8 *newaddr);
534 void br_fdb_cleanup(struct work_struct *work);
535 void br_fdb_delete_by_port(struct net_bridge *br,
536 			   const struct net_bridge_port *p, u16 vid, int do_all);
537 struct net_bridge_fdb_entry *br_fdb_find_rcu(struct net_bridge *br,
538 					     const unsigned char *addr,
539 					     __u16 vid);
540 int br_fdb_test_addr(struct net_device *dev, unsigned char *addr);
541 int br_fdb_fillbuf(struct net_bridge *br, void *buf, unsigned long count,
542 		   unsigned long off);
543 int br_fdb_insert(struct net_bridge *br, struct net_bridge_port *source,
544 		  const unsigned char *addr, u16 vid);
545 void br_fdb_update(struct net_bridge *br, struct net_bridge_port *source,
546 		   const unsigned char *addr, u16 vid, bool added_by_user);
547 
548 int br_fdb_delete(struct ndmsg *ndm, struct nlattr *tb[],
549 		  struct net_device *dev, const unsigned char *addr, u16 vid);
550 int br_fdb_add(struct ndmsg *nlh, struct nlattr *tb[], struct net_device *dev,
551 	       const unsigned char *addr, u16 vid, u16 nlh_flags);
552 int br_fdb_dump(struct sk_buff *skb, struct netlink_callback *cb,
553 		struct net_device *dev, struct net_device *fdev, int *idx);
554 int br_fdb_sync_static(struct net_bridge *br, struct net_bridge_port *p);
555 void br_fdb_unsync_static(struct net_bridge *br, struct net_bridge_port *p);
556 int br_fdb_external_learn_add(struct net_bridge *br, struct net_bridge_port *p,
557 			      const unsigned char *addr, u16 vid,
558 			      bool swdev_notify);
559 int br_fdb_external_learn_del(struct net_bridge *br, struct net_bridge_port *p,
560 			      const unsigned char *addr, u16 vid,
561 			      bool swdev_notify);
562 void br_fdb_offloaded_set(struct net_bridge *br, struct net_bridge_port *p,
563 			  const unsigned char *addr, u16 vid);
564 
565 /* br_forward.c */
566 enum br_pkt_type {
567 	BR_PKT_UNICAST,
568 	BR_PKT_MULTICAST,
569 	BR_PKT_BROADCAST
570 };
571 int br_dev_queue_push_xmit(struct net *net, struct sock *sk, struct sk_buff *skb);
572 void br_forward(const struct net_bridge_port *to, struct sk_buff *skb,
573 		bool local_rcv, bool local_orig);
574 int br_forward_finish(struct net *net, struct sock *sk, struct sk_buff *skb);
575 void br_flood(struct net_bridge *br, struct sk_buff *skb,
576 	      enum br_pkt_type pkt_type, bool local_rcv, bool local_orig);
577 
578 /* return true if both source port and dest port are isolated */
579 static inline bool br_skb_isolated(const struct net_bridge_port *to,
580 				   const struct sk_buff *skb)
581 {
582 	return BR_INPUT_SKB_CB(skb)->src_port_isolated &&
583 	       (to->flags & BR_ISOLATED);
584 }
585 
586 /* br_if.c */
587 void br_port_carrier_check(struct net_bridge_port *p, bool *notified);
588 int br_add_bridge(struct net *net, const char *name);
589 int br_del_bridge(struct net *net, const char *name);
590 int br_add_if(struct net_bridge *br, struct net_device *dev,
591 	      struct netlink_ext_ack *extack);
592 int br_del_if(struct net_bridge *br, struct net_device *dev);
593 void br_mtu_auto_adjust(struct net_bridge *br);
594 netdev_features_t br_features_recompute(struct net_bridge *br,
595 					netdev_features_t features);
596 void br_port_flags_change(struct net_bridge_port *port, unsigned long mask);
597 void br_manage_promisc(struct net_bridge *br);
598 
599 /* br_input.c */
600 int br_handle_frame_finish(struct net *net, struct sock *sk, struct sk_buff *skb);
601 rx_handler_result_t br_handle_frame(struct sk_buff **pskb);
602 
603 static inline bool br_rx_handler_check_rcu(const struct net_device *dev)
604 {
605 	return rcu_dereference(dev->rx_handler) == br_handle_frame;
606 }
607 
608 static inline bool br_rx_handler_check_rtnl(const struct net_device *dev)
609 {
610 	return rcu_dereference_rtnl(dev->rx_handler) == br_handle_frame;
611 }
612 
613 static inline struct net_bridge_port *br_port_get_check_rcu(const struct net_device *dev)
614 {
615 	return br_rx_handler_check_rcu(dev) ? br_port_get_rcu(dev) : NULL;
616 }
617 
618 static inline struct net_bridge_port *
619 br_port_get_check_rtnl(const struct net_device *dev)
620 {
621 	return br_rx_handler_check_rtnl(dev) ? br_port_get_rtnl_rcu(dev) : NULL;
622 }
623 
624 /* br_ioctl.c */
625 int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
626 int br_ioctl_deviceless_stub(struct net *net, unsigned int cmd,
627 			     void __user *arg);
628 
629 /* br_multicast.c */
630 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
631 extern unsigned int br_mdb_rehash_seq;
632 int br_multicast_rcv(struct net_bridge *br, struct net_bridge_port *port,
633 		     struct sk_buff *skb, u16 vid);
634 struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
635 					struct sk_buff *skb, u16 vid);
636 int br_multicast_add_port(struct net_bridge_port *port);
637 void br_multicast_del_port(struct net_bridge_port *port);
638 void br_multicast_enable_port(struct net_bridge_port *port);
639 void br_multicast_disable_port(struct net_bridge_port *port);
640 void br_multicast_init(struct net_bridge *br);
641 void br_multicast_open(struct net_bridge *br);
642 void br_multicast_stop(struct net_bridge *br);
643 void br_multicast_dev_del(struct net_bridge *br);
644 void br_multicast_flood(struct net_bridge_mdb_entry *mdst,
645 			struct sk_buff *skb, bool local_rcv, bool local_orig);
646 int br_multicast_set_router(struct net_bridge *br, unsigned long val);
647 int br_multicast_set_port_router(struct net_bridge_port *p, unsigned long val);
648 int br_multicast_toggle(struct net_bridge *br, unsigned long val);
649 int br_multicast_set_querier(struct net_bridge *br, unsigned long val);
650 int br_multicast_set_hash_max(struct net_bridge *br, unsigned long val);
651 int br_multicast_set_igmp_version(struct net_bridge *br, unsigned long val);
652 #if IS_ENABLED(CONFIG_IPV6)
653 int br_multicast_set_mld_version(struct net_bridge *br, unsigned long val);
654 #endif
655 struct net_bridge_mdb_entry *
656 br_mdb_ip_get(struct net_bridge_mdb_htable *mdb, struct br_ip *dst);
657 struct net_bridge_mdb_entry *
658 br_multicast_new_group(struct net_bridge *br, struct net_bridge_port *port,
659 		       struct br_ip *group);
660 void br_multicast_free_pg(struct rcu_head *head);
661 struct net_bridge_port_group *
662 br_multicast_new_port_group(struct net_bridge_port *port, struct br_ip *group,
663 			    struct net_bridge_port_group __rcu *next,
664 			    unsigned char flags, const unsigned char *src);
665 void br_mdb_init(void);
666 void br_mdb_uninit(void);
667 void br_mdb_notify(struct net_device *dev, struct net_bridge_port *port,
668 		   struct br_ip *group, int type, u8 flags);
669 void br_rtr_notify(struct net_device *dev, struct net_bridge_port *port,
670 		   int type);
671 void br_multicast_count(struct net_bridge *br, const struct net_bridge_port *p,
672 			const struct sk_buff *skb, u8 type, u8 dir);
673 int br_multicast_init_stats(struct net_bridge *br);
674 void br_multicast_uninit_stats(struct net_bridge *br);
675 void br_multicast_get_stats(const struct net_bridge *br,
676 			    const struct net_bridge_port *p,
677 			    struct br_mcast_stats *dest);
678 
679 #define mlock_dereference(X, br) \
680 	rcu_dereference_protected(X, lockdep_is_held(&br->multicast_lock))
681 
682 static inline bool br_multicast_is_router(struct net_bridge *br)
683 {
684 	return br->multicast_router == 2 ||
685 	       (br->multicast_router == 1 &&
686 		timer_pending(&br->multicast_router_timer));
687 }
688 
689 static inline bool
690 __br_multicast_querier_exists(struct net_bridge *br,
691 				struct bridge_mcast_other_query *querier,
692 				const bool is_ipv6)
693 {
694 	bool own_querier_enabled;
695 
696 	if (br->multicast_querier) {
697 		if (is_ipv6 && !br->has_ipv6_addr)
698 			own_querier_enabled = false;
699 		else
700 			own_querier_enabled = true;
701 	} else {
702 		own_querier_enabled = false;
703 	}
704 
705 	return time_is_before_jiffies(querier->delay_time) &&
706 	       (own_querier_enabled || timer_pending(&querier->timer));
707 }
708 
709 static inline bool br_multicast_querier_exists(struct net_bridge *br,
710 					       struct ethhdr *eth)
711 {
712 	switch (eth->h_proto) {
713 	case (htons(ETH_P_IP)):
714 		return __br_multicast_querier_exists(br,
715 			&br->ip4_other_query, false);
716 #if IS_ENABLED(CONFIG_IPV6)
717 	case (htons(ETH_P_IPV6)):
718 		return __br_multicast_querier_exists(br,
719 			&br->ip6_other_query, true);
720 #endif
721 	default:
722 		return false;
723 	}
724 }
725 
726 static inline int br_multicast_igmp_type(const struct sk_buff *skb)
727 {
728 	return BR_INPUT_SKB_CB(skb)->igmp;
729 }
730 #else
731 static inline int br_multicast_rcv(struct net_bridge *br,
732 				   struct net_bridge_port *port,
733 				   struct sk_buff *skb,
734 				   u16 vid)
735 {
736 	return 0;
737 }
738 
739 static inline struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
740 						      struct sk_buff *skb, u16 vid)
741 {
742 	return NULL;
743 }
744 
745 static inline int br_multicast_add_port(struct net_bridge_port *port)
746 {
747 	return 0;
748 }
749 
750 static inline void br_multicast_del_port(struct net_bridge_port *port)
751 {
752 }
753 
754 static inline void br_multicast_enable_port(struct net_bridge_port *port)
755 {
756 }
757 
758 static inline void br_multicast_disable_port(struct net_bridge_port *port)
759 {
760 }
761 
762 static inline void br_multicast_init(struct net_bridge *br)
763 {
764 }
765 
766 static inline void br_multicast_open(struct net_bridge *br)
767 {
768 }
769 
770 static inline void br_multicast_stop(struct net_bridge *br)
771 {
772 }
773 
774 static inline void br_multicast_dev_del(struct net_bridge *br)
775 {
776 }
777 
778 static inline void br_multicast_flood(struct net_bridge_mdb_entry *mdst,
779 				      struct sk_buff *skb,
780 				      bool local_rcv, bool local_orig)
781 {
782 }
783 
784 static inline bool br_multicast_is_router(struct net_bridge *br)
785 {
786 	return false;
787 }
788 
789 static inline bool br_multicast_querier_exists(struct net_bridge *br,
790 					       struct ethhdr *eth)
791 {
792 	return false;
793 }
794 
795 static inline void br_mdb_init(void)
796 {
797 }
798 
799 static inline void br_mdb_uninit(void)
800 {
801 }
802 
803 static inline void br_multicast_count(struct net_bridge *br,
804 				      const struct net_bridge_port *p,
805 				      const struct sk_buff *skb,
806 				      u8 type, u8 dir)
807 {
808 }
809 
810 static inline int br_multicast_init_stats(struct net_bridge *br)
811 {
812 	return 0;
813 }
814 
815 static inline void br_multicast_uninit_stats(struct net_bridge *br)
816 {
817 }
818 
819 static inline int br_multicast_igmp_type(const struct sk_buff *skb)
820 {
821 	return 0;
822 }
823 #endif
824 
825 /* br_vlan.c */
826 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
827 bool br_allowed_ingress(const struct net_bridge *br,
828 			struct net_bridge_vlan_group *vg, struct sk_buff *skb,
829 			u16 *vid);
830 bool br_allowed_egress(struct net_bridge_vlan_group *vg,
831 		       const struct sk_buff *skb);
832 bool br_should_learn(struct net_bridge_port *p, struct sk_buff *skb, u16 *vid);
833 struct sk_buff *br_handle_vlan(struct net_bridge *br,
834 			       const struct net_bridge_port *port,
835 			       struct net_bridge_vlan_group *vg,
836 			       struct sk_buff *skb);
837 int br_vlan_add(struct net_bridge *br, u16 vid, u16 flags,
838 		bool *changed);
839 int br_vlan_delete(struct net_bridge *br, u16 vid);
840 void br_vlan_flush(struct net_bridge *br);
841 struct net_bridge_vlan *br_vlan_find(struct net_bridge_vlan_group *vg, u16 vid);
842 void br_recalculate_fwd_mask(struct net_bridge *br);
843 int __br_vlan_filter_toggle(struct net_bridge *br, unsigned long val);
844 int br_vlan_filter_toggle(struct net_bridge *br, unsigned long val);
845 int __br_vlan_set_proto(struct net_bridge *br, __be16 proto);
846 int br_vlan_set_proto(struct net_bridge *br, unsigned long val);
847 int br_vlan_set_stats(struct net_bridge *br, unsigned long val);
848 int br_vlan_init(struct net_bridge *br);
849 int br_vlan_set_default_pvid(struct net_bridge *br, unsigned long val);
850 int __br_vlan_set_default_pvid(struct net_bridge *br, u16 pvid);
851 int nbp_vlan_add(struct net_bridge_port *port, u16 vid, u16 flags,
852 		 bool *changed);
853 int nbp_vlan_delete(struct net_bridge_port *port, u16 vid);
854 void nbp_vlan_flush(struct net_bridge_port *port);
855 int nbp_vlan_init(struct net_bridge_port *port);
856 int nbp_get_num_vlan_infos(struct net_bridge_port *p, u32 filter_mask);
857 void br_vlan_get_stats(const struct net_bridge_vlan *v,
858 		       struct br_vlan_stats *stats);
859 
860 static inline struct net_bridge_vlan_group *br_vlan_group(
861 					const struct net_bridge *br)
862 {
863 	return rtnl_dereference(br->vlgrp);
864 }
865 
866 static inline struct net_bridge_vlan_group *nbp_vlan_group(
867 					const struct net_bridge_port *p)
868 {
869 	return rtnl_dereference(p->vlgrp);
870 }
871 
872 static inline struct net_bridge_vlan_group *br_vlan_group_rcu(
873 					const struct net_bridge *br)
874 {
875 	return rcu_dereference(br->vlgrp);
876 }
877 
878 static inline struct net_bridge_vlan_group *nbp_vlan_group_rcu(
879 					const struct net_bridge_port *p)
880 {
881 	return rcu_dereference(p->vlgrp);
882 }
883 
884 /* Since bridge now depends on 8021Q module, but the time bridge sees the
885  * skb, the vlan tag will always be present if the frame was tagged.
886  */
887 static inline int br_vlan_get_tag(const struct sk_buff *skb, u16 *vid)
888 {
889 	int err = 0;
890 
891 	if (skb_vlan_tag_present(skb)) {
892 		*vid = skb_vlan_tag_get(skb) & VLAN_VID_MASK;
893 	} else {
894 		*vid = 0;
895 		err = -EINVAL;
896 	}
897 
898 	return err;
899 }
900 
901 static inline u16 br_get_pvid(const struct net_bridge_vlan_group *vg)
902 {
903 	if (!vg)
904 		return 0;
905 
906 	smp_rmb();
907 	return vg->pvid;
908 }
909 
910 #else
911 static inline bool br_allowed_ingress(const struct net_bridge *br,
912 				      struct net_bridge_vlan_group *vg,
913 				      struct sk_buff *skb,
914 				      u16 *vid)
915 {
916 	return true;
917 }
918 
919 static inline bool br_allowed_egress(struct net_bridge_vlan_group *vg,
920 				     const struct sk_buff *skb)
921 {
922 	return true;
923 }
924 
925 static inline bool br_should_learn(struct net_bridge_port *p,
926 				   struct sk_buff *skb, u16 *vid)
927 {
928 	return true;
929 }
930 
931 static inline struct sk_buff *br_handle_vlan(struct net_bridge *br,
932 					     const struct net_bridge_port *port,
933 					     struct net_bridge_vlan_group *vg,
934 					     struct sk_buff *skb)
935 {
936 	return skb;
937 }
938 
939 static inline int br_vlan_add(struct net_bridge *br, u16 vid, u16 flags,
940 			      bool *changed)
941 {
942 	*changed = false;
943 	return -EOPNOTSUPP;
944 }
945 
946 static inline int br_vlan_delete(struct net_bridge *br, u16 vid)
947 {
948 	return -EOPNOTSUPP;
949 }
950 
951 static inline void br_vlan_flush(struct net_bridge *br)
952 {
953 }
954 
955 static inline void br_recalculate_fwd_mask(struct net_bridge *br)
956 {
957 }
958 
959 static inline int br_vlan_init(struct net_bridge *br)
960 {
961 	return 0;
962 }
963 
964 static inline int nbp_vlan_add(struct net_bridge_port *port, u16 vid, u16 flags,
965 			       bool *changed)
966 {
967 	*changed = false;
968 	return -EOPNOTSUPP;
969 }
970 
971 static inline int nbp_vlan_delete(struct net_bridge_port *port, u16 vid)
972 {
973 	return -EOPNOTSUPP;
974 }
975 
976 static inline void nbp_vlan_flush(struct net_bridge_port *port)
977 {
978 }
979 
980 static inline struct net_bridge_vlan *br_vlan_find(struct net_bridge_vlan_group *vg,
981 						   u16 vid)
982 {
983 	return NULL;
984 }
985 
986 static inline int nbp_vlan_init(struct net_bridge_port *port)
987 {
988 	return 0;
989 }
990 
991 static inline u16 br_vlan_get_tag(const struct sk_buff *skb, u16 *tag)
992 {
993 	return 0;
994 }
995 
996 static inline u16 br_get_pvid(const struct net_bridge_vlan_group *vg)
997 {
998 	return 0;
999 }
1000 
1001 static inline int __br_vlan_filter_toggle(struct net_bridge *br,
1002 					  unsigned long val)
1003 {
1004 	return -EOPNOTSUPP;
1005 }
1006 
1007 static inline int nbp_get_num_vlan_infos(struct net_bridge_port *p,
1008 					 u32 filter_mask)
1009 {
1010 	return 0;
1011 }
1012 
1013 static inline struct net_bridge_vlan_group *br_vlan_group(
1014 					const struct net_bridge *br)
1015 {
1016 	return NULL;
1017 }
1018 
1019 static inline struct net_bridge_vlan_group *nbp_vlan_group(
1020 					const struct net_bridge_port *p)
1021 {
1022 	return NULL;
1023 }
1024 
1025 static inline struct net_bridge_vlan_group *br_vlan_group_rcu(
1026 					const struct net_bridge *br)
1027 {
1028 	return NULL;
1029 }
1030 
1031 static inline struct net_bridge_vlan_group *nbp_vlan_group_rcu(
1032 					const struct net_bridge_port *p)
1033 {
1034 	return NULL;
1035 }
1036 
1037 static inline void br_vlan_get_stats(const struct net_bridge_vlan *v,
1038 				     struct br_vlan_stats *stats)
1039 {
1040 }
1041 #endif
1042 
1043 struct nf_br_ops {
1044 	int (*br_dev_xmit_hook)(struct sk_buff *skb);
1045 };
1046 extern const struct nf_br_ops __rcu *nf_br_ops;
1047 
1048 /* br_netfilter.c */
1049 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
1050 int br_nf_core_init(void);
1051 void br_nf_core_fini(void);
1052 void br_netfilter_rtable_init(struct net_bridge *);
1053 #else
1054 static inline int br_nf_core_init(void) { return 0; }
1055 static inline void br_nf_core_fini(void) {}
1056 #define br_netfilter_rtable_init(x)
1057 #endif
1058 
1059 /* br_stp.c */
1060 void br_set_state(struct net_bridge_port *p, unsigned int state);
1061 struct net_bridge_port *br_get_port(struct net_bridge *br, u16 port_no);
1062 void br_init_port(struct net_bridge_port *p);
1063 void br_become_designated_port(struct net_bridge_port *p);
1064 
1065 void __br_set_forward_delay(struct net_bridge *br, unsigned long t);
1066 int br_set_forward_delay(struct net_bridge *br, unsigned long x);
1067 int br_set_hello_time(struct net_bridge *br, unsigned long x);
1068 int br_set_max_age(struct net_bridge *br, unsigned long x);
1069 int __set_ageing_time(struct net_device *dev, unsigned long t);
1070 int br_set_ageing_time(struct net_bridge *br, clock_t ageing_time);
1071 
1072 
1073 /* br_stp_if.c */
1074 void br_stp_enable_bridge(struct net_bridge *br);
1075 void br_stp_disable_bridge(struct net_bridge *br);
1076 void br_stp_set_enabled(struct net_bridge *br, unsigned long val);
1077 void br_stp_enable_port(struct net_bridge_port *p);
1078 void br_stp_disable_port(struct net_bridge_port *p);
1079 bool br_stp_recalculate_bridge_id(struct net_bridge *br);
1080 void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
1081 void br_stp_set_bridge_priority(struct net_bridge *br, u16 newprio);
1082 int br_stp_set_port_priority(struct net_bridge_port *p, unsigned long newprio);
1083 int br_stp_set_path_cost(struct net_bridge_port *p, unsigned long path_cost);
1084 ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);
1085 
1086 /* br_stp_bpdu.c */
1087 struct stp_proto;
1088 void br_stp_rcv(const struct stp_proto *proto, struct sk_buff *skb,
1089 		struct net_device *dev);
1090 
1091 /* br_stp_timer.c */
1092 void br_stp_timer_init(struct net_bridge *br);
1093 void br_stp_port_timer_init(struct net_bridge_port *p);
1094 unsigned long br_timer_value(const struct timer_list *timer);
1095 
1096 /* br.c */
1097 #if IS_ENABLED(CONFIG_ATM_LANE)
1098 extern int (*br_fdb_test_addr_hook)(struct net_device *dev, unsigned char *addr);
1099 #endif
1100 
1101 /* br_netlink.c */
1102 extern struct rtnl_link_ops br_link_ops;
1103 int br_netlink_init(void);
1104 void br_netlink_fini(void);
1105 void br_ifinfo_notify(int event, const struct net_bridge *br,
1106 		      const struct net_bridge_port *port);
1107 int br_setlink(struct net_device *dev, struct nlmsghdr *nlmsg, u16 flags);
1108 int br_dellink(struct net_device *dev, struct nlmsghdr *nlmsg, u16 flags);
1109 int br_getlink(struct sk_buff *skb, u32 pid, u32 seq, struct net_device *dev,
1110 	       u32 filter_mask, int nlflags);
1111 
1112 #ifdef CONFIG_SYSFS
1113 /* br_sysfs_if.c */
1114 extern const struct sysfs_ops brport_sysfs_ops;
1115 int br_sysfs_addif(struct net_bridge_port *p);
1116 int br_sysfs_renameif(struct net_bridge_port *p);
1117 
1118 /* br_sysfs_br.c */
1119 int br_sysfs_addbr(struct net_device *dev);
1120 void br_sysfs_delbr(struct net_device *dev);
1121 
1122 #else
1123 
1124 static inline int br_sysfs_addif(struct net_bridge_port *p) { return 0; }
1125 static inline int br_sysfs_renameif(struct net_bridge_port *p) { return 0; }
1126 static inline int br_sysfs_addbr(struct net_device *dev) { return 0; }
1127 static inline void br_sysfs_delbr(struct net_device *dev) { return; }
1128 #endif /* CONFIG_SYSFS */
1129 
1130 /* br_switchdev.c */
1131 #ifdef CONFIG_NET_SWITCHDEV
1132 int nbp_switchdev_mark_set(struct net_bridge_port *p);
1133 void nbp_switchdev_frame_mark(const struct net_bridge_port *p,
1134 			      struct sk_buff *skb);
1135 bool nbp_switchdev_allowed_egress(const struct net_bridge_port *p,
1136 				  const struct sk_buff *skb);
1137 int br_switchdev_set_port_flag(struct net_bridge_port *p,
1138 			       unsigned long flags,
1139 			       unsigned long mask);
1140 void br_switchdev_fdb_notify(const struct net_bridge_fdb_entry *fdb,
1141 			     int type);
1142 
1143 static inline void br_switchdev_frame_unmark(struct sk_buff *skb)
1144 {
1145 	skb->offload_fwd_mark = 0;
1146 }
1147 #else
1148 static inline int nbp_switchdev_mark_set(struct net_bridge_port *p)
1149 {
1150 	return 0;
1151 }
1152 
1153 static inline void nbp_switchdev_frame_mark(const struct net_bridge_port *p,
1154 					    struct sk_buff *skb)
1155 {
1156 }
1157 
1158 static inline bool nbp_switchdev_allowed_egress(const struct net_bridge_port *p,
1159 						const struct sk_buff *skb)
1160 {
1161 	return true;
1162 }
1163 
1164 static inline int br_switchdev_set_port_flag(struct net_bridge_port *p,
1165 					     unsigned long flags,
1166 					     unsigned long mask)
1167 {
1168 	return 0;
1169 }
1170 
1171 static inline void
1172 br_switchdev_fdb_notify(const struct net_bridge_fdb_entry *fdb, int type)
1173 {
1174 }
1175 
1176 static inline void br_switchdev_frame_unmark(struct sk_buff *skb)
1177 {
1178 }
1179 #endif /* CONFIG_NET_SWITCHDEV */
1180 
1181 /* br_arp_nd_proxy.c */
1182 void br_recalculate_neigh_suppress_enabled(struct net_bridge *br);
1183 void br_do_proxy_suppress_arp(struct sk_buff *skb, struct net_bridge *br,
1184 			      u16 vid, struct net_bridge_port *p);
1185 void br_do_suppress_nd(struct sk_buff *skb, struct net_bridge *br,
1186 		       u16 vid, struct net_bridge_port *p, struct nd_msg *msg);
1187 struct nd_msg *br_is_nd_neigh_msg(struct sk_buff *skb, struct nd_msg *m);
1188 #endif
1189