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