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