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