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