xref: /openbmc/linux/net/bridge/br_private.h (revision 515853cc)
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 
22 #define BR_HASH_BITS 8
23 #define BR_HASH_SIZE (1 << BR_HASH_BITS)
24 
25 #define BR_HOLD_TIME (1*HZ)
26 
27 #define BR_PORT_BITS	10
28 #define BR_MAX_PORTS	(1<<BR_PORT_BITS)
29 
30 #define BR_VERSION	"2.3"
31 
32 /* Control of forwarding link local multicast */
33 #define BR_GROUPFWD_DEFAULT	0
34 /* Don't allow forwarding control protocols like STP and LLDP */
35 #define BR_GROUPFWD_RESTRICTED	0x4007u
36 
37 /* Path to usermode spanning tree program */
38 #define BR_STP_PROG	"/sbin/bridge-stp"
39 
40 typedef struct bridge_id bridge_id;
41 typedef struct mac_addr mac_addr;
42 typedef __u16 port_id;
43 
44 struct bridge_id
45 {
46 	unsigned char	prio[2];
47 	unsigned char	addr[6];
48 };
49 
50 struct mac_addr
51 {
52 	unsigned char	addr[6];
53 };
54 
55 struct br_ip
56 {
57 	union {
58 		__be32	ip4;
59 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
60 		struct in6_addr ip6;
61 #endif
62 	} u;
63 	__be16		proto;
64 };
65 
66 struct net_bridge_fdb_entry
67 {
68 	struct hlist_node		hlist;
69 	struct net_bridge_port		*dst;
70 
71 	struct rcu_head			rcu;
72 	unsigned long			updated;
73 	unsigned long			used;
74 	mac_addr			addr;
75 	unsigned char			is_local;
76 	unsigned char			is_static;
77 };
78 
79 struct net_bridge_port_group {
80 	struct net_bridge_port		*port;
81 	struct net_bridge_port_group __rcu *next;
82 	struct hlist_node		mglist;
83 	struct rcu_head			rcu;
84 	struct timer_list		timer;
85 	struct timer_list		query_timer;
86 	struct br_ip			addr;
87 	u32				queries_sent;
88 };
89 
90 struct net_bridge_mdb_entry
91 {
92 	struct hlist_node		hlist[2];
93 	struct net_bridge		*br;
94 	struct net_bridge_port_group __rcu *ports;
95 	struct rcu_head			rcu;
96 	struct timer_list		timer;
97 	struct timer_list		query_timer;
98 	struct br_ip			addr;
99 	bool				mglist;
100 	u32				queries_sent;
101 };
102 
103 struct net_bridge_mdb_htable
104 {
105 	struct hlist_head		*mhash;
106 	struct rcu_head			rcu;
107 	struct net_bridge_mdb_htable	*old;
108 	u32				size;
109 	u32				max;
110 	u32				secret;
111 	u32				ver;
112 };
113 
114 struct net_bridge_port
115 {
116 	struct net_bridge		*br;
117 	struct net_device		*dev;
118 	struct list_head		list;
119 
120 	/* STP */
121 	u8				priority;
122 	u8				state;
123 	u16				port_no;
124 	unsigned char			topology_change_ack;
125 	unsigned char			config_pending;
126 	port_id				port_id;
127 	port_id				designated_port;
128 	bridge_id			designated_root;
129 	bridge_id			designated_bridge;
130 	u32				path_cost;
131 	u32				designated_cost;
132 	unsigned long			designated_age;
133 
134 	struct timer_list		forward_delay_timer;
135 	struct timer_list		hold_timer;
136 	struct timer_list		message_age_timer;
137 	struct kobject			kobj;
138 	struct rcu_head			rcu;
139 
140 	unsigned long 			flags;
141 #define BR_HAIRPIN_MODE		0x00000001
142 
143 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
144 	u32				multicast_startup_queries_sent;
145 	unsigned char			multicast_router;
146 	struct timer_list		multicast_router_timer;
147 	struct timer_list		multicast_query_timer;
148 	struct hlist_head		mglist;
149 	struct hlist_node		rlist;
150 #endif
151 
152 #ifdef CONFIG_SYSFS
153 	char				sysfs_name[IFNAMSIZ];
154 #endif
155 
156 #ifdef CONFIG_NET_POLL_CONTROLLER
157 	struct netpoll			*np;
158 #endif
159 };
160 
161 #define br_port_exists(dev) (dev->priv_flags & IFF_BRIDGE_PORT)
162 
163 static inline struct net_bridge_port *br_port_get_rcu(const struct net_device *dev)
164 {
165 	struct net_bridge_port *port = rcu_dereference(dev->rx_handler_data);
166 	return br_port_exists(dev) ? port : NULL;
167 }
168 
169 static inline struct net_bridge_port *br_port_get_rtnl(struct net_device *dev)
170 {
171 	return br_port_exists(dev) ?
172 		rtnl_dereference(dev->rx_handler_data) : NULL;
173 }
174 
175 struct br_cpu_netstats {
176 	u64			rx_packets;
177 	u64			rx_bytes;
178 	u64			tx_packets;
179 	u64			tx_bytes;
180 	struct u64_stats_sync	syncp;
181 };
182 
183 struct net_bridge
184 {
185 	spinlock_t			lock;
186 	struct list_head		port_list;
187 	struct net_device		*dev;
188 
189 	struct br_cpu_netstats __percpu *stats;
190 	spinlock_t			hash_lock;
191 	struct hlist_head		hash[BR_HASH_SIZE];
192 #ifdef CONFIG_BRIDGE_NETFILTER
193 	struct rtable 			fake_rtable;
194 	bool				nf_call_iptables;
195 	bool				nf_call_ip6tables;
196 	bool				nf_call_arptables;
197 #endif
198 	unsigned long			flags;
199 #define BR_SET_MAC_ADDR		0x00000001
200 
201 	u16				group_fwd_mask;
202 
203 	/* STP */
204 	bridge_id			designated_root;
205 	bridge_id			bridge_id;
206 	u32				root_path_cost;
207 	unsigned long			max_age;
208 	unsigned long			hello_time;
209 	unsigned long			forward_delay;
210 	unsigned long			bridge_max_age;
211 	unsigned long			ageing_time;
212 	unsigned long			bridge_hello_time;
213 	unsigned long			bridge_forward_delay;
214 
215 	u8				group_addr[ETH_ALEN];
216 	u16				root_port;
217 
218 	enum {
219 		BR_NO_STP, 		/* no spanning tree */
220 		BR_KERNEL_STP,		/* old STP in kernel */
221 		BR_USER_STP,		/* new RSTP in userspace */
222 	} stp_enabled;
223 
224 	unsigned char			topology_change;
225 	unsigned char			topology_change_detected;
226 
227 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
228 	unsigned char			multicast_router;
229 
230 	u8				multicast_disabled:1;
231 
232 	u32				hash_elasticity;
233 	u32				hash_max;
234 
235 	u32				multicast_last_member_count;
236 	u32				multicast_startup_queries_sent;
237 	u32				multicast_startup_query_count;
238 
239 	unsigned long			multicast_last_member_interval;
240 	unsigned long			multicast_membership_interval;
241 	unsigned long			multicast_querier_interval;
242 	unsigned long			multicast_query_interval;
243 	unsigned long			multicast_query_response_interval;
244 	unsigned long			multicast_startup_query_interval;
245 
246 	spinlock_t			multicast_lock;
247 	struct net_bridge_mdb_htable __rcu *mdb;
248 	struct hlist_head		router_list;
249 
250 	struct timer_list		multicast_router_timer;
251 	struct timer_list		multicast_querier_timer;
252 	struct timer_list		multicast_query_timer;
253 #endif
254 
255 	struct timer_list		hello_timer;
256 	struct timer_list		tcn_timer;
257 	struct timer_list		topology_change_timer;
258 	struct timer_list		gc_timer;
259 	struct kobject			*ifobj;
260 };
261 
262 struct br_input_skb_cb {
263 	struct net_device *brdev;
264 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
265 	int igmp;
266 	int mrouters_only;
267 #endif
268 };
269 
270 #define BR_INPUT_SKB_CB(__skb)	((struct br_input_skb_cb *)(__skb)->cb)
271 
272 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
273 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb)	(BR_INPUT_SKB_CB(__skb)->mrouters_only)
274 #else
275 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb)	(0)
276 #endif
277 
278 #define br_printk(level, br, format, args...)	\
279 	printk(level "%s: " format, (br)->dev->name, ##args)
280 
281 #define br_err(__br, format, args...)			\
282 	br_printk(KERN_ERR, __br, format, ##args)
283 #define br_warn(__br, format, args...)			\
284 	br_printk(KERN_WARNING, __br, format, ##args)
285 #define br_notice(__br, format, args...)		\
286 	br_printk(KERN_NOTICE, __br, format, ##args)
287 #define br_info(__br, format, args...)			\
288 	br_printk(KERN_INFO, __br, format, ##args)
289 
290 #define br_debug(br, format, args...)			\
291 	pr_debug("%s: " format,  (br)->dev->name, ##args)
292 
293 extern struct notifier_block br_device_notifier;
294 extern const u8 br_group_address[ETH_ALEN];
295 
296 /* called under bridge lock */
297 static inline int br_is_root_bridge(const struct net_bridge *br)
298 {
299 	return !memcmp(&br->bridge_id, &br->designated_root, 8);
300 }
301 
302 /* br_device.c */
303 extern void br_dev_setup(struct net_device *dev);
304 extern netdev_tx_t br_dev_xmit(struct sk_buff *skb,
305 			       struct net_device *dev);
306 #ifdef CONFIG_NET_POLL_CONTROLLER
307 static inline struct netpoll_info *br_netpoll_info(struct net_bridge *br)
308 {
309 	return br->dev->npinfo;
310 }
311 
312 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
313 				       struct sk_buff *skb)
314 {
315 	struct netpoll *np = p->np;
316 
317 	if (np)
318 		netpoll_send_skb(np, skb);
319 }
320 
321 extern int br_netpoll_enable(struct net_bridge_port *p);
322 extern void br_netpoll_disable(struct net_bridge_port *p);
323 #else
324 static inline struct netpoll_info *br_netpoll_info(struct net_bridge *br)
325 {
326 	return NULL;
327 }
328 
329 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
330 				       struct sk_buff *skb)
331 {
332 }
333 
334 static inline int br_netpoll_enable(struct net_bridge_port *p)
335 {
336 	return 0;
337 }
338 
339 static inline void br_netpoll_disable(struct net_bridge_port *p)
340 {
341 }
342 #endif
343 
344 /* br_fdb.c */
345 extern int br_fdb_init(void);
346 extern void br_fdb_fini(void);
347 extern void br_fdb_flush(struct net_bridge *br);
348 extern void br_fdb_changeaddr(struct net_bridge_port *p,
349 			      const unsigned char *newaddr);
350 extern void br_fdb_cleanup(unsigned long arg);
351 extern void br_fdb_delete_by_port(struct net_bridge *br,
352 				  const struct net_bridge_port *p, int do_all);
353 extern struct net_bridge_fdb_entry *__br_fdb_get(struct net_bridge *br,
354 						 const unsigned char *addr);
355 extern int br_fdb_test_addr(struct net_device *dev, unsigned char *addr);
356 extern int br_fdb_fillbuf(struct net_bridge *br, void *buf,
357 			  unsigned long count, unsigned long off);
358 extern int br_fdb_insert(struct net_bridge *br,
359 			 struct net_bridge_port *source,
360 			 const unsigned char *addr);
361 extern void br_fdb_update(struct net_bridge *br,
362 			  struct net_bridge_port *source,
363 			  const unsigned char *addr);
364 extern int br_fdb_dump(struct sk_buff *skb, struct netlink_callback *cb);
365 extern int br_fdb_add(struct sk_buff *skb, struct nlmsghdr *nlh, void *arg);
366 extern int br_fdb_delete(struct sk_buff *skb, struct nlmsghdr *nlh, void *arg);
367 
368 /* br_forward.c */
369 extern void br_deliver(const struct net_bridge_port *to,
370 		struct sk_buff *skb);
371 extern int br_dev_queue_push_xmit(struct sk_buff *skb);
372 extern void br_forward(const struct net_bridge_port *to,
373 		struct sk_buff *skb, struct sk_buff *skb0);
374 extern int br_forward_finish(struct sk_buff *skb);
375 extern void br_flood_deliver(struct net_bridge *br, struct sk_buff *skb);
376 extern void br_flood_forward(struct net_bridge *br, struct sk_buff *skb,
377 			     struct sk_buff *skb2);
378 
379 /* br_if.c */
380 extern void br_port_carrier_check(struct net_bridge_port *p);
381 extern int br_add_bridge(struct net *net, const char *name);
382 extern int br_del_bridge(struct net *net, const char *name);
383 extern void br_net_exit(struct net *net);
384 extern int br_add_if(struct net_bridge *br,
385 	      struct net_device *dev);
386 extern int br_del_if(struct net_bridge *br,
387 	      struct net_device *dev);
388 extern int br_min_mtu(const struct net_bridge *br);
389 extern u32 br_features_recompute(struct net_bridge *br, u32 features);
390 
391 /* br_input.c */
392 extern int br_handle_frame_finish(struct sk_buff *skb);
393 extern rx_handler_result_t br_handle_frame(struct sk_buff **pskb);
394 
395 /* br_ioctl.c */
396 extern int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
397 extern int br_ioctl_deviceless_stub(struct net *net, unsigned int cmd, void __user *arg);
398 
399 /* br_multicast.c */
400 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
401 extern int br_multicast_rcv(struct net_bridge *br,
402 			    struct net_bridge_port *port,
403 			    struct sk_buff *skb);
404 extern struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
405 					       struct sk_buff *skb);
406 extern void br_multicast_add_port(struct net_bridge_port *port);
407 extern void br_multicast_del_port(struct net_bridge_port *port);
408 extern void br_multicast_enable_port(struct net_bridge_port *port);
409 extern void br_multicast_disable_port(struct net_bridge_port *port);
410 extern void br_multicast_init(struct net_bridge *br);
411 extern void br_multicast_open(struct net_bridge *br);
412 extern void br_multicast_stop(struct net_bridge *br);
413 extern void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
414 				 struct sk_buff *skb);
415 extern void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
416 				 struct sk_buff *skb, struct sk_buff *skb2);
417 extern int br_multicast_set_router(struct net_bridge *br, unsigned long val);
418 extern int br_multicast_set_port_router(struct net_bridge_port *p,
419 					unsigned long val);
420 extern int br_multicast_toggle(struct net_bridge *br, unsigned long val);
421 extern int br_multicast_set_hash_max(struct net_bridge *br, unsigned long val);
422 
423 static inline bool br_multicast_is_router(struct net_bridge *br)
424 {
425 	return br->multicast_router == 2 ||
426 	       (br->multicast_router == 1 &&
427 		timer_pending(&br->multicast_router_timer));
428 }
429 #else
430 static inline int br_multicast_rcv(struct net_bridge *br,
431 				   struct net_bridge_port *port,
432 				   struct sk_buff *skb)
433 {
434 	return 0;
435 }
436 
437 static inline struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
438 						      struct sk_buff *skb)
439 {
440 	return NULL;
441 }
442 
443 static inline void br_multicast_add_port(struct net_bridge_port *port)
444 {
445 }
446 
447 static inline void br_multicast_del_port(struct net_bridge_port *port)
448 {
449 }
450 
451 static inline void br_multicast_enable_port(struct net_bridge_port *port)
452 {
453 }
454 
455 static inline void br_multicast_disable_port(struct net_bridge_port *port)
456 {
457 }
458 
459 static inline void br_multicast_init(struct net_bridge *br)
460 {
461 }
462 
463 static inline void br_multicast_open(struct net_bridge *br)
464 {
465 }
466 
467 static inline void br_multicast_stop(struct net_bridge *br)
468 {
469 }
470 
471 static inline void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
472 					struct sk_buff *skb)
473 {
474 }
475 
476 static inline void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
477 					struct sk_buff *skb,
478 					struct sk_buff *skb2)
479 {
480 }
481 static inline bool br_multicast_is_router(struct net_bridge *br)
482 {
483 	return 0;
484 }
485 #endif
486 
487 /* br_netfilter.c */
488 #ifdef CONFIG_BRIDGE_NETFILTER
489 extern int br_netfilter_init(void);
490 extern void br_netfilter_fini(void);
491 extern void br_netfilter_rtable_init(struct net_bridge *);
492 #else
493 #define br_netfilter_init()	(0)
494 #define br_netfilter_fini()	do { } while(0)
495 #define br_netfilter_rtable_init(x)
496 #endif
497 
498 /* br_stp.c */
499 extern void br_log_state(const struct net_bridge_port *p);
500 extern struct net_bridge_port *br_get_port(struct net_bridge *br,
501 					   u16 port_no);
502 extern void br_init_port(struct net_bridge_port *p);
503 extern void br_become_designated_port(struct net_bridge_port *p);
504 
505 extern int br_set_forward_delay(struct net_bridge *br, unsigned long x);
506 extern int br_set_hello_time(struct net_bridge *br, unsigned long x);
507 extern int br_set_max_age(struct net_bridge *br, unsigned long x);
508 
509 
510 /* br_stp_if.c */
511 extern void br_stp_enable_bridge(struct net_bridge *br);
512 extern void br_stp_disable_bridge(struct net_bridge *br);
513 extern void br_stp_set_enabled(struct net_bridge *br, unsigned long val);
514 extern void br_stp_enable_port(struct net_bridge_port *p);
515 extern void br_stp_disable_port(struct net_bridge_port *p);
516 extern bool br_stp_recalculate_bridge_id(struct net_bridge *br);
517 extern void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
518 extern void br_stp_set_bridge_priority(struct net_bridge *br,
519 				       u16 newprio);
520 extern int br_stp_set_port_priority(struct net_bridge_port *p,
521 				    unsigned long newprio);
522 extern int br_stp_set_path_cost(struct net_bridge_port *p,
523 				unsigned long path_cost);
524 extern ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);
525 
526 /* br_stp_bpdu.c */
527 struct stp_proto;
528 extern void br_stp_rcv(const struct stp_proto *proto, struct sk_buff *skb,
529 		       struct net_device *dev);
530 
531 /* br_stp_timer.c */
532 extern void br_stp_timer_init(struct net_bridge *br);
533 extern void br_stp_port_timer_init(struct net_bridge_port *p);
534 extern unsigned long br_timer_value(const struct timer_list *timer);
535 
536 /* br.c */
537 #if defined(CONFIG_ATM_LANE) || defined(CONFIG_ATM_LANE_MODULE)
538 extern int (*br_fdb_test_addr_hook)(struct net_device *dev, unsigned char *addr);
539 #endif
540 
541 /* br_netlink.c */
542 extern int br_netlink_init(void);
543 extern void br_netlink_fini(void);
544 extern void br_ifinfo_notify(int event, struct net_bridge_port *port);
545 
546 #ifdef CONFIG_SYSFS
547 /* br_sysfs_if.c */
548 extern const struct sysfs_ops brport_sysfs_ops;
549 extern int br_sysfs_addif(struct net_bridge_port *p);
550 extern int br_sysfs_renameif(struct net_bridge_port *p);
551 
552 /* br_sysfs_br.c */
553 extern int br_sysfs_addbr(struct net_device *dev);
554 extern void br_sysfs_delbr(struct net_device *dev);
555 
556 #else
557 
558 #define br_sysfs_addif(p)	(0)
559 #define br_sysfs_renameif(p)	(0)
560 #define br_sysfs_addbr(dev)	(0)
561 #define br_sysfs_delbr(dev)	do { } while(0)
562 #endif /* CONFIG_SYSFS */
563 
564 #endif
565