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