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