xref: /openbmc/linux/net/bridge/br_private.h (revision 705e0dea)
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 kobj_to_brport(obj)	container_of(obj, struct net_bridge_port, kobj)
287 
288 #define br_auto_port(p) ((p)->flags & BR_AUTO_MASK)
289 #define br_promisc_port(p) ((p)->flags & BR_PROMISC)
290 
291 #define br_port_exists(dev) (dev->priv_flags & IFF_BRIDGE_PORT)
292 
293 static inline struct net_bridge_port *br_port_get_rcu(const struct net_device *dev)
294 {
295 	return rcu_dereference(dev->rx_handler_data);
296 }
297 
298 static inline struct net_bridge_port *br_port_get_rtnl(const struct net_device *dev)
299 {
300 	return br_port_exists(dev) ?
301 		rtnl_dereference(dev->rx_handler_data) : NULL;
302 }
303 
304 static inline struct net_bridge_port *br_port_get_rtnl_rcu(const struct net_device *dev)
305 {
306 	return br_port_exists(dev) ?
307 		rcu_dereference_rtnl(dev->rx_handler_data) : NULL;
308 }
309 
310 struct net_bridge {
311 	spinlock_t			lock;
312 	spinlock_t			hash_lock;
313 	struct list_head		port_list;
314 	struct net_device		*dev;
315 	struct pcpu_sw_netstats		__percpu *stats;
316 	/* These fields are accessed on each packet */
317 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
318 	u8				vlan_enabled;
319 	u8				vlan_stats_enabled;
320 	__be16				vlan_proto;
321 	u16				default_pvid;
322 	struct net_bridge_vlan_group	__rcu *vlgrp;
323 #endif
324 
325 	struct rhashtable		fdb_hash_tbl;
326 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
327 	union {
328 		struct rtable		fake_rtable;
329 		struct rt6_info		fake_rt6_info;
330 	};
331 	bool				nf_call_iptables;
332 	bool				nf_call_ip6tables;
333 	bool				nf_call_arptables;
334 #endif
335 	u16				group_fwd_mask;
336 	u16				group_fwd_mask_required;
337 
338 	/* STP */
339 	bridge_id			designated_root;
340 	bridge_id			bridge_id;
341 	u32				root_path_cost;
342 	unsigned char			topology_change;
343 	unsigned char			topology_change_detected;
344 	u16				root_port;
345 	unsigned long			max_age;
346 	unsigned long			hello_time;
347 	unsigned long			forward_delay;
348 	unsigned long			ageing_time;
349 	unsigned long			bridge_max_age;
350 	unsigned long			bridge_hello_time;
351 	unsigned long			bridge_forward_delay;
352 	unsigned long			bridge_ageing_time;
353 
354 	u8				group_addr[ETH_ALEN];
355 	bool				group_addr_set;
356 
357 	enum {
358 		BR_NO_STP, 		/* no spanning tree */
359 		BR_KERNEL_STP,		/* old STP in kernel */
360 		BR_USER_STP,		/* new RSTP in userspace */
361 	} stp_enabled;
362 
363 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
364 	unsigned char			multicast_router;
365 
366 	u8				multicast_disabled:1;
367 	u8				multicast_querier:1;
368 	u8				multicast_query_use_ifaddr:1;
369 	u8				has_ipv6_addr:1;
370 	u8				multicast_stats_enabled:1;
371 
372 	u32				hash_elasticity;
373 	u32				hash_max;
374 
375 	u32				multicast_last_member_count;
376 	u32				multicast_startup_query_count;
377 
378 	u8				multicast_igmp_version;
379 
380 	unsigned long			multicast_last_member_interval;
381 	unsigned long			multicast_membership_interval;
382 	unsigned long			multicast_querier_interval;
383 	unsigned long			multicast_query_interval;
384 	unsigned long			multicast_query_response_interval;
385 	unsigned long			multicast_startup_query_interval;
386 
387 	spinlock_t			multicast_lock;
388 	struct net_bridge_mdb_htable __rcu *mdb;
389 	struct hlist_head		router_list;
390 
391 	struct timer_list		multicast_router_timer;
392 	struct bridge_mcast_other_query	ip4_other_query;
393 	struct bridge_mcast_own_query	ip4_own_query;
394 	struct bridge_mcast_querier	ip4_querier;
395 	struct bridge_mcast_stats	__percpu *mcast_stats;
396 #if IS_ENABLED(CONFIG_IPV6)
397 	struct bridge_mcast_other_query	ip6_other_query;
398 	struct bridge_mcast_own_query	ip6_own_query;
399 	struct bridge_mcast_querier	ip6_querier;
400 	u8				multicast_mld_version;
401 #endif /* IS_ENABLED(CONFIG_IPV6) */
402 #endif
403 
404 	struct timer_list		hello_timer;
405 	struct timer_list		tcn_timer;
406 	struct timer_list		topology_change_timer;
407 	struct delayed_work		gc_work;
408 	struct kobject			*ifobj;
409 	u32				auto_cnt;
410 
411 #ifdef CONFIG_NET_SWITCHDEV
412 	int offload_fwd_mark;
413 #endif
414 	bool				neigh_suppress_enabled;
415 	bool				mtu_set_by_user;
416 	struct hlist_head		fdb_list;
417 };
418 
419 struct br_input_skb_cb {
420 	struct net_device *brdev;
421 
422 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
423 	int igmp;
424 	int mrouters_only;
425 #endif
426 
427 	bool proxyarp_replied;
428 	bool src_port_isolated;
429 
430 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
431 	bool vlan_filtered;
432 #endif
433 
434 #ifdef CONFIG_NET_SWITCHDEV
435 	int offload_fwd_mark;
436 #endif
437 };
438 
439 #define BR_INPUT_SKB_CB(__skb)	((struct br_input_skb_cb *)(__skb)->cb)
440 
441 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
442 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb)	(BR_INPUT_SKB_CB(__skb)->mrouters_only)
443 #else
444 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb)	(0)
445 #endif
446 
447 #define br_printk(level, br, format, args...)	\
448 	printk(level "%s: " format, (br)->dev->name, ##args)
449 
450 #define br_err(__br, format, args...)			\
451 	br_printk(KERN_ERR, __br, format, ##args)
452 #define br_warn(__br, format, args...)			\
453 	br_printk(KERN_WARNING, __br, format, ##args)
454 #define br_notice(__br, format, args...)		\
455 	br_printk(KERN_NOTICE, __br, format, ##args)
456 #define br_info(__br, format, args...)			\
457 	br_printk(KERN_INFO, __br, format, ##args)
458 
459 #define br_debug(br, format, args...)			\
460 	pr_debug("%s: " format,  (br)->dev->name, ##args)
461 
462 /* called under bridge lock */
463 static inline int br_is_root_bridge(const struct net_bridge *br)
464 {
465 	return !memcmp(&br->bridge_id, &br->designated_root, 8);
466 }
467 
468 /* check if a VLAN entry is global */
469 static inline bool br_vlan_is_master(const struct net_bridge_vlan *v)
470 {
471 	return v->flags & BRIDGE_VLAN_INFO_MASTER;
472 }
473 
474 /* check if a VLAN entry is used by the bridge */
475 static inline bool br_vlan_is_brentry(const struct net_bridge_vlan *v)
476 {
477 	return v->flags & BRIDGE_VLAN_INFO_BRENTRY;
478 }
479 
480 /* check if we should use the vlan entry, returns false if it's only context */
481 static inline bool br_vlan_should_use(const struct net_bridge_vlan *v)
482 {
483 	if (br_vlan_is_master(v)) {
484 		if (br_vlan_is_brentry(v))
485 			return true;
486 		else
487 			return false;
488 	}
489 
490 	return true;
491 }
492 
493 /* br_device.c */
494 void br_dev_setup(struct net_device *dev);
495 void br_dev_delete(struct net_device *dev, struct list_head *list);
496 netdev_tx_t br_dev_xmit(struct sk_buff *skb, struct net_device *dev);
497 #ifdef CONFIG_NET_POLL_CONTROLLER
498 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
499 				       struct sk_buff *skb)
500 {
501 	struct netpoll *np = p->np;
502 
503 	if (np)
504 		netpoll_send_skb(np, skb);
505 }
506 
507 int br_netpoll_enable(struct net_bridge_port *p);
508 void br_netpoll_disable(struct net_bridge_port *p);
509 #else
510 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
511 				       struct sk_buff *skb)
512 {
513 }
514 
515 static inline int br_netpoll_enable(struct net_bridge_port *p)
516 {
517 	return 0;
518 }
519 
520 static inline void br_netpoll_disable(struct net_bridge_port *p)
521 {
522 }
523 #endif
524 
525 /* br_fdb.c */
526 int br_fdb_init(void);
527 void br_fdb_fini(void);
528 int br_fdb_hash_init(struct net_bridge *br);
529 void br_fdb_hash_fini(struct net_bridge *br);
530 void br_fdb_flush(struct net_bridge *br);
531 void br_fdb_find_delete_local(struct net_bridge *br,
532 			      const struct net_bridge_port *p,
533 			      const unsigned char *addr, u16 vid);
534 void br_fdb_changeaddr(struct net_bridge_port *p, const unsigned char *newaddr);
535 void br_fdb_change_mac_address(struct net_bridge *br, const u8 *newaddr);
536 void br_fdb_cleanup(struct work_struct *work);
537 void br_fdb_delete_by_port(struct net_bridge *br,
538 			   const struct net_bridge_port *p, u16 vid, int do_all);
539 struct net_bridge_fdb_entry *br_fdb_find_rcu(struct net_bridge *br,
540 					     const unsigned char *addr,
541 					     __u16 vid);
542 int br_fdb_test_addr(struct net_device *dev, unsigned char *addr);
543 int br_fdb_fillbuf(struct net_bridge *br, void *buf, unsigned long count,
544 		   unsigned long off);
545 int br_fdb_insert(struct net_bridge *br, struct net_bridge_port *source,
546 		  const unsigned char *addr, u16 vid);
547 void br_fdb_update(struct net_bridge *br, struct net_bridge_port *source,
548 		   const unsigned char *addr, u16 vid, bool added_by_user);
549 
550 int br_fdb_delete(struct ndmsg *ndm, struct nlattr *tb[],
551 		  struct net_device *dev, const unsigned char *addr, u16 vid);
552 int br_fdb_add(struct ndmsg *nlh, struct nlattr *tb[], struct net_device *dev,
553 	       const unsigned char *addr, u16 vid, u16 nlh_flags);
554 int br_fdb_dump(struct sk_buff *skb, struct netlink_callback *cb,
555 		struct net_device *dev, struct net_device *fdev, int *idx);
556 int br_fdb_sync_static(struct net_bridge *br, struct net_bridge_port *p);
557 void br_fdb_unsync_static(struct net_bridge *br, struct net_bridge_port *p);
558 int br_fdb_external_learn_add(struct net_bridge *br, struct net_bridge_port *p,
559 			      const unsigned char *addr, u16 vid,
560 			      bool swdev_notify);
561 int br_fdb_external_learn_del(struct net_bridge *br, struct net_bridge_port *p,
562 			      const unsigned char *addr, u16 vid,
563 			      bool swdev_notify);
564 void br_fdb_offloaded_set(struct net_bridge *br, struct net_bridge_port *p,
565 			  const unsigned char *addr, u16 vid);
566 
567 /* br_forward.c */
568 enum br_pkt_type {
569 	BR_PKT_UNICAST,
570 	BR_PKT_MULTICAST,
571 	BR_PKT_BROADCAST
572 };
573 int br_dev_queue_push_xmit(struct net *net, struct sock *sk, struct sk_buff *skb);
574 void br_forward(const struct net_bridge_port *to, struct sk_buff *skb,
575 		bool local_rcv, bool local_orig);
576 int br_forward_finish(struct net *net, struct sock *sk, struct sk_buff *skb);
577 void br_flood(struct net_bridge *br, struct sk_buff *skb,
578 	      enum br_pkt_type pkt_type, bool local_rcv, bool local_orig);
579 
580 /* return true if both source port and dest port are isolated */
581 static inline bool br_skb_isolated(const struct net_bridge_port *to,
582 				   const struct sk_buff *skb)
583 {
584 	return BR_INPUT_SKB_CB(skb)->src_port_isolated &&
585 	       (to->flags & BR_ISOLATED);
586 }
587 
588 /* br_if.c */
589 void br_port_carrier_check(struct net_bridge_port *p, bool *notified);
590 int br_add_bridge(struct net *net, const char *name);
591 int br_del_bridge(struct net *net, const char *name);
592 int br_add_if(struct net_bridge *br, struct net_device *dev,
593 	      struct netlink_ext_ack *extack);
594 int br_del_if(struct net_bridge *br, struct net_device *dev);
595 void br_mtu_auto_adjust(struct net_bridge *br);
596 netdev_features_t br_features_recompute(struct net_bridge *br,
597 					netdev_features_t features);
598 void br_port_flags_change(struct net_bridge_port *port, unsigned long mask);
599 void br_manage_promisc(struct net_bridge *br);
600 
601 /* br_input.c */
602 int br_handle_frame_finish(struct net *net, struct sock *sk, struct sk_buff *skb);
603 rx_handler_result_t br_handle_frame(struct sk_buff **pskb);
604 
605 static inline bool br_rx_handler_check_rcu(const struct net_device *dev)
606 {
607 	return rcu_dereference(dev->rx_handler) == br_handle_frame;
608 }
609 
610 static inline bool br_rx_handler_check_rtnl(const struct net_device *dev)
611 {
612 	return rcu_dereference_rtnl(dev->rx_handler) == br_handle_frame;
613 }
614 
615 static inline struct net_bridge_port *br_port_get_check_rcu(const struct net_device *dev)
616 {
617 	return br_rx_handler_check_rcu(dev) ? br_port_get_rcu(dev) : NULL;
618 }
619 
620 static inline struct net_bridge_port *
621 br_port_get_check_rtnl(const struct net_device *dev)
622 {
623 	return br_rx_handler_check_rtnl(dev) ? br_port_get_rtnl_rcu(dev) : NULL;
624 }
625 
626 /* br_ioctl.c */
627 int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
628 int br_ioctl_deviceless_stub(struct net *net, unsigned int cmd,
629 			     void __user *arg);
630 
631 /* br_multicast.c */
632 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
633 extern unsigned int br_mdb_rehash_seq;
634 int br_multicast_rcv(struct net_bridge *br, struct net_bridge_port *port,
635 		     struct sk_buff *skb, u16 vid);
636 struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
637 					struct sk_buff *skb, u16 vid);
638 int br_multicast_add_port(struct net_bridge_port *port);
639 void br_multicast_del_port(struct net_bridge_port *port);
640 void br_multicast_enable_port(struct net_bridge_port *port);
641 void br_multicast_disable_port(struct net_bridge_port *port);
642 void br_multicast_init(struct net_bridge *br);
643 void br_multicast_open(struct net_bridge *br);
644 void br_multicast_stop(struct net_bridge *br);
645 void br_multicast_dev_del(struct net_bridge *br);
646 void br_multicast_flood(struct net_bridge_mdb_entry *mdst,
647 			struct sk_buff *skb, bool local_rcv, bool local_orig);
648 int br_multicast_set_router(struct net_bridge *br, unsigned long val);
649 int br_multicast_set_port_router(struct net_bridge_port *p, unsigned long val);
650 int br_multicast_toggle(struct net_bridge *br, unsigned long val);
651 int br_multicast_set_querier(struct net_bridge *br, unsigned long val);
652 int br_multicast_set_hash_max(struct net_bridge *br, unsigned long val);
653 int br_multicast_set_igmp_version(struct net_bridge *br, unsigned long val);
654 #if IS_ENABLED(CONFIG_IPV6)
655 int br_multicast_set_mld_version(struct net_bridge *br, unsigned long val);
656 #endif
657 struct net_bridge_mdb_entry *
658 br_mdb_ip_get(struct net_bridge_mdb_htable *mdb, struct br_ip *dst);
659 struct net_bridge_mdb_entry *
660 br_multicast_new_group(struct net_bridge *br, struct net_bridge_port *port,
661 		       struct br_ip *group);
662 void br_multicast_free_pg(struct rcu_head *head);
663 struct net_bridge_port_group *
664 br_multicast_new_port_group(struct net_bridge_port *port, struct br_ip *group,
665 			    struct net_bridge_port_group __rcu *next,
666 			    unsigned char flags, const unsigned char *src);
667 void br_mdb_init(void);
668 void br_mdb_uninit(void);
669 void br_mdb_notify(struct net_device *dev, struct net_bridge_port *port,
670 		   struct br_ip *group, int type, u8 flags);
671 void br_rtr_notify(struct net_device *dev, struct net_bridge_port *port,
672 		   int type);
673 void br_multicast_count(struct net_bridge *br, const struct net_bridge_port *p,
674 			const struct sk_buff *skb, u8 type, u8 dir);
675 int br_multicast_init_stats(struct net_bridge *br);
676 void br_multicast_uninit_stats(struct net_bridge *br);
677 void br_multicast_get_stats(const struct net_bridge *br,
678 			    const struct net_bridge_port *p,
679 			    struct br_mcast_stats *dest);
680 
681 #define mlock_dereference(X, br) \
682 	rcu_dereference_protected(X, lockdep_is_held(&br->multicast_lock))
683 
684 static inline bool br_multicast_is_router(struct net_bridge *br)
685 {
686 	return br->multicast_router == 2 ||
687 	       (br->multicast_router == 1 &&
688 		timer_pending(&br->multicast_router_timer));
689 }
690 
691 static inline bool
692 __br_multicast_querier_exists(struct net_bridge *br,
693 				struct bridge_mcast_other_query *querier,
694 				const bool is_ipv6)
695 {
696 	bool own_querier_enabled;
697 
698 	if (br->multicast_querier) {
699 		if (is_ipv6 && !br->has_ipv6_addr)
700 			own_querier_enabled = false;
701 		else
702 			own_querier_enabled = true;
703 	} else {
704 		own_querier_enabled = false;
705 	}
706 
707 	return time_is_before_jiffies(querier->delay_time) &&
708 	       (own_querier_enabled || timer_pending(&querier->timer));
709 }
710 
711 static inline bool br_multicast_querier_exists(struct net_bridge *br,
712 					       struct ethhdr *eth)
713 {
714 	switch (eth->h_proto) {
715 	case (htons(ETH_P_IP)):
716 		return __br_multicast_querier_exists(br,
717 			&br->ip4_other_query, false);
718 #if IS_ENABLED(CONFIG_IPV6)
719 	case (htons(ETH_P_IPV6)):
720 		return __br_multicast_querier_exists(br,
721 			&br->ip6_other_query, true);
722 #endif
723 	default:
724 		return false;
725 	}
726 }
727 
728 static inline int br_multicast_igmp_type(const struct sk_buff *skb)
729 {
730 	return BR_INPUT_SKB_CB(skb)->igmp;
731 }
732 #else
733 static inline int br_multicast_rcv(struct net_bridge *br,
734 				   struct net_bridge_port *port,
735 				   struct sk_buff *skb,
736 				   u16 vid)
737 {
738 	return 0;
739 }
740 
741 static inline struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
742 						      struct sk_buff *skb, u16 vid)
743 {
744 	return NULL;
745 }
746 
747 static inline int br_multicast_add_port(struct net_bridge_port *port)
748 {
749 	return 0;
750 }
751 
752 static inline void br_multicast_del_port(struct net_bridge_port *port)
753 {
754 }
755 
756 static inline void br_multicast_enable_port(struct net_bridge_port *port)
757 {
758 }
759 
760 static inline void br_multicast_disable_port(struct net_bridge_port *port)
761 {
762 }
763 
764 static inline void br_multicast_init(struct net_bridge *br)
765 {
766 }
767 
768 static inline void br_multicast_open(struct net_bridge *br)
769 {
770 }
771 
772 static inline void br_multicast_stop(struct net_bridge *br)
773 {
774 }
775 
776 static inline void br_multicast_dev_del(struct net_bridge *br)
777 {
778 }
779 
780 static inline void br_multicast_flood(struct net_bridge_mdb_entry *mdst,
781 				      struct sk_buff *skb,
782 				      bool local_rcv, bool local_orig)
783 {
784 }
785 
786 static inline bool br_multicast_is_router(struct net_bridge *br)
787 {
788 	return false;
789 }
790 
791 static inline bool br_multicast_querier_exists(struct net_bridge *br,
792 					       struct ethhdr *eth)
793 {
794 	return false;
795 }
796 
797 static inline void br_mdb_init(void)
798 {
799 }
800 
801 static inline void br_mdb_uninit(void)
802 {
803 }
804 
805 static inline void br_multicast_count(struct net_bridge *br,
806 				      const struct net_bridge_port *p,
807 				      const struct sk_buff *skb,
808 				      u8 type, u8 dir)
809 {
810 }
811 
812 static inline int br_multicast_init_stats(struct net_bridge *br)
813 {
814 	return 0;
815 }
816 
817 static inline void br_multicast_uninit_stats(struct net_bridge *br)
818 {
819 }
820 
821 static inline int br_multicast_igmp_type(const struct sk_buff *skb)
822 {
823 	return 0;
824 }
825 #endif
826 
827 /* br_vlan.c */
828 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
829 bool br_allowed_ingress(const struct net_bridge *br,
830 			struct net_bridge_vlan_group *vg, struct sk_buff *skb,
831 			u16 *vid);
832 bool br_allowed_egress(struct net_bridge_vlan_group *vg,
833 		       const struct sk_buff *skb);
834 bool br_should_learn(struct net_bridge_port *p, struct sk_buff *skb, u16 *vid);
835 struct sk_buff *br_handle_vlan(struct net_bridge *br,
836 			       const struct net_bridge_port *port,
837 			       struct net_bridge_vlan_group *vg,
838 			       struct sk_buff *skb);
839 int br_vlan_add(struct net_bridge *br, u16 vid, u16 flags,
840 		bool *changed);
841 int br_vlan_delete(struct net_bridge *br, u16 vid);
842 void br_vlan_flush(struct net_bridge *br);
843 struct net_bridge_vlan *br_vlan_find(struct net_bridge_vlan_group *vg, u16 vid);
844 void br_recalculate_fwd_mask(struct net_bridge *br);
845 int __br_vlan_filter_toggle(struct net_bridge *br, unsigned long val);
846 int br_vlan_filter_toggle(struct net_bridge *br, unsigned long val);
847 int __br_vlan_set_proto(struct net_bridge *br, __be16 proto);
848 int br_vlan_set_proto(struct net_bridge *br, unsigned long val);
849 int br_vlan_set_stats(struct net_bridge *br, unsigned long val);
850 int br_vlan_init(struct net_bridge *br);
851 int br_vlan_set_default_pvid(struct net_bridge *br, unsigned long val);
852 int __br_vlan_set_default_pvid(struct net_bridge *br, u16 pvid);
853 int nbp_vlan_add(struct net_bridge_port *port, u16 vid, u16 flags,
854 		 bool *changed);
855 int nbp_vlan_delete(struct net_bridge_port *port, u16 vid);
856 void nbp_vlan_flush(struct net_bridge_port *port);
857 int nbp_vlan_init(struct net_bridge_port *port);
858 int nbp_get_num_vlan_infos(struct net_bridge_port *p, u32 filter_mask);
859 void br_vlan_get_stats(const struct net_bridge_vlan *v,
860 		       struct br_vlan_stats *stats);
861 
862 static inline struct net_bridge_vlan_group *br_vlan_group(
863 					const struct net_bridge *br)
864 {
865 	return rtnl_dereference(br->vlgrp);
866 }
867 
868 static inline struct net_bridge_vlan_group *nbp_vlan_group(
869 					const struct net_bridge_port *p)
870 {
871 	return rtnl_dereference(p->vlgrp);
872 }
873 
874 static inline struct net_bridge_vlan_group *br_vlan_group_rcu(
875 					const struct net_bridge *br)
876 {
877 	return rcu_dereference(br->vlgrp);
878 }
879 
880 static inline struct net_bridge_vlan_group *nbp_vlan_group_rcu(
881 					const struct net_bridge_port *p)
882 {
883 	return rcu_dereference(p->vlgrp);
884 }
885 
886 /* Since bridge now depends on 8021Q module, but the time bridge sees the
887  * skb, the vlan tag will always be present if the frame was tagged.
888  */
889 static inline int br_vlan_get_tag(const struct sk_buff *skb, u16 *vid)
890 {
891 	int err = 0;
892 
893 	if (skb_vlan_tag_present(skb)) {
894 		*vid = skb_vlan_tag_get(skb) & VLAN_VID_MASK;
895 	} else {
896 		*vid = 0;
897 		err = -EINVAL;
898 	}
899 
900 	return err;
901 }
902 
903 static inline u16 br_get_pvid(const struct net_bridge_vlan_group *vg)
904 {
905 	if (!vg)
906 		return 0;
907 
908 	smp_rmb();
909 	return vg->pvid;
910 }
911 
912 #else
913 static inline bool br_allowed_ingress(const struct net_bridge *br,
914 				      struct net_bridge_vlan_group *vg,
915 				      struct sk_buff *skb,
916 				      u16 *vid)
917 {
918 	return true;
919 }
920 
921 static inline bool br_allowed_egress(struct net_bridge_vlan_group *vg,
922 				     const struct sk_buff *skb)
923 {
924 	return true;
925 }
926 
927 static inline bool br_should_learn(struct net_bridge_port *p,
928 				   struct sk_buff *skb, u16 *vid)
929 {
930 	return true;
931 }
932 
933 static inline struct sk_buff *br_handle_vlan(struct net_bridge *br,
934 					     const struct net_bridge_port *port,
935 					     struct net_bridge_vlan_group *vg,
936 					     struct sk_buff *skb)
937 {
938 	return skb;
939 }
940 
941 static inline int br_vlan_add(struct net_bridge *br, u16 vid, u16 flags,
942 			      bool *changed)
943 {
944 	*changed = false;
945 	return -EOPNOTSUPP;
946 }
947 
948 static inline int br_vlan_delete(struct net_bridge *br, u16 vid)
949 {
950 	return -EOPNOTSUPP;
951 }
952 
953 static inline void br_vlan_flush(struct net_bridge *br)
954 {
955 }
956 
957 static inline void br_recalculate_fwd_mask(struct net_bridge *br)
958 {
959 }
960 
961 static inline int br_vlan_init(struct net_bridge *br)
962 {
963 	return 0;
964 }
965 
966 static inline int nbp_vlan_add(struct net_bridge_port *port, u16 vid, u16 flags,
967 			       bool *changed)
968 {
969 	*changed = false;
970 	return -EOPNOTSUPP;
971 }
972 
973 static inline int nbp_vlan_delete(struct net_bridge_port *port, u16 vid)
974 {
975 	return -EOPNOTSUPP;
976 }
977 
978 static inline void nbp_vlan_flush(struct net_bridge_port *port)
979 {
980 }
981 
982 static inline struct net_bridge_vlan *br_vlan_find(struct net_bridge_vlan_group *vg,
983 						   u16 vid)
984 {
985 	return NULL;
986 }
987 
988 static inline int nbp_vlan_init(struct net_bridge_port *port)
989 {
990 	return 0;
991 }
992 
993 static inline u16 br_vlan_get_tag(const struct sk_buff *skb, u16 *tag)
994 {
995 	return 0;
996 }
997 
998 static inline u16 br_get_pvid(const struct net_bridge_vlan_group *vg)
999 {
1000 	return 0;
1001 }
1002 
1003 static inline int __br_vlan_filter_toggle(struct net_bridge *br,
1004 					  unsigned long val)
1005 {
1006 	return -EOPNOTSUPP;
1007 }
1008 
1009 static inline int nbp_get_num_vlan_infos(struct net_bridge_port *p,
1010 					 u32 filter_mask)
1011 {
1012 	return 0;
1013 }
1014 
1015 static inline struct net_bridge_vlan_group *br_vlan_group(
1016 					const struct net_bridge *br)
1017 {
1018 	return NULL;
1019 }
1020 
1021 static inline struct net_bridge_vlan_group *nbp_vlan_group(
1022 					const struct net_bridge_port *p)
1023 {
1024 	return NULL;
1025 }
1026 
1027 static inline struct net_bridge_vlan_group *br_vlan_group_rcu(
1028 					const struct net_bridge *br)
1029 {
1030 	return NULL;
1031 }
1032 
1033 static inline struct net_bridge_vlan_group *nbp_vlan_group_rcu(
1034 					const struct net_bridge_port *p)
1035 {
1036 	return NULL;
1037 }
1038 
1039 static inline void br_vlan_get_stats(const struct net_bridge_vlan *v,
1040 				     struct br_vlan_stats *stats)
1041 {
1042 }
1043 #endif
1044 
1045 struct nf_br_ops {
1046 	int (*br_dev_xmit_hook)(struct sk_buff *skb);
1047 };
1048 extern const struct nf_br_ops __rcu *nf_br_ops;
1049 
1050 /* br_netfilter.c */
1051 #if IS_ENABLED(CONFIG_BRIDGE_NETFILTER)
1052 int br_nf_core_init(void);
1053 void br_nf_core_fini(void);
1054 void br_netfilter_rtable_init(struct net_bridge *);
1055 #else
1056 static inline int br_nf_core_init(void) { return 0; }
1057 static inline void br_nf_core_fini(void) {}
1058 #define br_netfilter_rtable_init(x)
1059 #endif
1060 
1061 /* br_stp.c */
1062 void br_set_state(struct net_bridge_port *p, unsigned int state);
1063 struct net_bridge_port *br_get_port(struct net_bridge *br, u16 port_no);
1064 void br_init_port(struct net_bridge_port *p);
1065 void br_become_designated_port(struct net_bridge_port *p);
1066 
1067 void __br_set_forward_delay(struct net_bridge *br, unsigned long t);
1068 int br_set_forward_delay(struct net_bridge *br, unsigned long x);
1069 int br_set_hello_time(struct net_bridge *br, unsigned long x);
1070 int br_set_max_age(struct net_bridge *br, unsigned long x);
1071 int __set_ageing_time(struct net_device *dev, unsigned long t);
1072 int br_set_ageing_time(struct net_bridge *br, clock_t ageing_time);
1073 
1074 
1075 /* br_stp_if.c */
1076 void br_stp_enable_bridge(struct net_bridge *br);
1077 void br_stp_disable_bridge(struct net_bridge *br);
1078 void br_stp_set_enabled(struct net_bridge *br, unsigned long val);
1079 void br_stp_enable_port(struct net_bridge_port *p);
1080 void br_stp_disable_port(struct net_bridge_port *p);
1081 bool br_stp_recalculate_bridge_id(struct net_bridge *br);
1082 void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
1083 void br_stp_set_bridge_priority(struct net_bridge *br, u16 newprio);
1084 int br_stp_set_port_priority(struct net_bridge_port *p, unsigned long newprio);
1085 int br_stp_set_path_cost(struct net_bridge_port *p, unsigned long path_cost);
1086 ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);
1087 
1088 /* br_stp_bpdu.c */
1089 struct stp_proto;
1090 void br_stp_rcv(const struct stp_proto *proto, struct sk_buff *skb,
1091 		struct net_device *dev);
1092 
1093 /* br_stp_timer.c */
1094 void br_stp_timer_init(struct net_bridge *br);
1095 void br_stp_port_timer_init(struct net_bridge_port *p);
1096 unsigned long br_timer_value(const struct timer_list *timer);
1097 
1098 /* br.c */
1099 #if IS_ENABLED(CONFIG_ATM_LANE)
1100 extern int (*br_fdb_test_addr_hook)(struct net_device *dev, unsigned char *addr);
1101 #endif
1102 
1103 /* br_netlink.c */
1104 extern struct rtnl_link_ops br_link_ops;
1105 int br_netlink_init(void);
1106 void br_netlink_fini(void);
1107 void br_ifinfo_notify(int event, const struct net_bridge *br,
1108 		      const struct net_bridge_port *port);
1109 int br_setlink(struct net_device *dev, struct nlmsghdr *nlmsg, u16 flags);
1110 int br_dellink(struct net_device *dev, struct nlmsghdr *nlmsg, u16 flags);
1111 int br_getlink(struct sk_buff *skb, u32 pid, u32 seq, struct net_device *dev,
1112 	       u32 filter_mask, int nlflags);
1113 
1114 #ifdef CONFIG_SYSFS
1115 /* br_sysfs_if.c */
1116 extern const struct sysfs_ops brport_sysfs_ops;
1117 int br_sysfs_addif(struct net_bridge_port *p);
1118 int br_sysfs_renameif(struct net_bridge_port *p);
1119 
1120 /* br_sysfs_br.c */
1121 int br_sysfs_addbr(struct net_device *dev);
1122 void br_sysfs_delbr(struct net_device *dev);
1123 
1124 #else
1125 
1126 static inline int br_sysfs_addif(struct net_bridge_port *p) { return 0; }
1127 static inline int br_sysfs_renameif(struct net_bridge_port *p) { return 0; }
1128 static inline int br_sysfs_addbr(struct net_device *dev) { return 0; }
1129 static inline void br_sysfs_delbr(struct net_device *dev) { return; }
1130 #endif /* CONFIG_SYSFS */
1131 
1132 /* br_switchdev.c */
1133 #ifdef CONFIG_NET_SWITCHDEV
1134 int nbp_switchdev_mark_set(struct net_bridge_port *p);
1135 void nbp_switchdev_frame_mark(const struct net_bridge_port *p,
1136 			      struct sk_buff *skb);
1137 bool nbp_switchdev_allowed_egress(const struct net_bridge_port *p,
1138 				  const struct sk_buff *skb);
1139 int br_switchdev_set_port_flag(struct net_bridge_port *p,
1140 			       unsigned long flags,
1141 			       unsigned long mask);
1142 void br_switchdev_fdb_notify(const struct net_bridge_fdb_entry *fdb,
1143 			     int type);
1144 int br_switchdev_port_vlan_add(struct net_device *dev, u16 vid, u16 flags);
1145 int br_switchdev_port_vlan_del(struct net_device *dev, u16 vid);
1146 
1147 static inline void br_switchdev_frame_unmark(struct sk_buff *skb)
1148 {
1149 	skb->offload_fwd_mark = 0;
1150 }
1151 #else
1152 static inline int nbp_switchdev_mark_set(struct net_bridge_port *p)
1153 {
1154 	return 0;
1155 }
1156 
1157 static inline void nbp_switchdev_frame_mark(const struct net_bridge_port *p,
1158 					    struct sk_buff *skb)
1159 {
1160 }
1161 
1162 static inline bool nbp_switchdev_allowed_egress(const struct net_bridge_port *p,
1163 						const struct sk_buff *skb)
1164 {
1165 	return true;
1166 }
1167 
1168 static inline int br_switchdev_set_port_flag(struct net_bridge_port *p,
1169 					     unsigned long flags,
1170 					     unsigned long mask)
1171 {
1172 	return 0;
1173 }
1174 
1175 static inline int br_switchdev_port_vlan_add(struct net_device *dev,
1176 					     u16 vid, u16 flags)
1177 {
1178 	return -EOPNOTSUPP;
1179 }
1180 
1181 static inline int br_switchdev_port_vlan_del(struct net_device *dev, u16 vid)
1182 {
1183 	return -EOPNOTSUPP;
1184 }
1185 
1186 static inline void
1187 br_switchdev_fdb_notify(const struct net_bridge_fdb_entry *fdb, int type)
1188 {
1189 }
1190 
1191 static inline void br_switchdev_frame_unmark(struct sk_buff *skb)
1192 {
1193 }
1194 #endif /* CONFIG_NET_SWITCHDEV */
1195 
1196 /* br_arp_nd_proxy.c */
1197 void br_recalculate_neigh_suppress_enabled(struct net_bridge *br);
1198 void br_do_proxy_suppress_arp(struct sk_buff *skb, struct net_bridge *br,
1199 			      u16 vid, struct net_bridge_port *p);
1200 void br_do_suppress_nd(struct sk_buff *skb, struct net_bridge *br,
1201 		       u16 vid, struct net_bridge_port *p, struct nd_msg *msg);
1202 struct nd_msg *br_is_nd_neigh_msg(struct sk_buff *skb, struct nd_msg *m);
1203 #endif
1204