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