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