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