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