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