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