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