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