xref: /openbmc/linux/net/bridge/br_private.h (revision 81bdf5bd)
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 #ifdef CONFIG_SYSFS
144 	char				sysfs_name[IFNAMSIZ];
145 #endif
146 };
147 
148 struct br_cpu_netstats {
149 	unsigned long	rx_packets;
150 	unsigned long	rx_bytes;
151 	unsigned long	tx_packets;
152 	unsigned long	tx_bytes;
153 };
154 
155 struct net_bridge
156 {
157 	spinlock_t			lock;
158 	struct list_head		port_list;
159 	struct net_device		*dev;
160 
161 	struct br_cpu_netstats __percpu *stats;
162 	spinlock_t			hash_lock;
163 	struct hlist_head		hash[BR_HASH_SIZE];
164 	unsigned long			feature_mask;
165 #ifdef CONFIG_BRIDGE_NETFILTER
166 	struct rtable 			fake_rtable;
167 #endif
168 	unsigned long			flags;
169 #define BR_SET_MAC_ADDR		0x00000001
170 
171 	/* STP */
172 	bridge_id			designated_root;
173 	bridge_id			bridge_id;
174 	u32				root_path_cost;
175 	unsigned long			max_age;
176 	unsigned long			hello_time;
177 	unsigned long			forward_delay;
178 	unsigned long			bridge_max_age;
179 	unsigned long			ageing_time;
180 	unsigned long			bridge_hello_time;
181 	unsigned long			bridge_forward_delay;
182 
183 	u8				group_addr[ETH_ALEN];
184 	u16				root_port;
185 
186 	enum {
187 		BR_NO_STP, 		/* no spanning tree */
188 		BR_KERNEL_STP,		/* old STP in kernel */
189 		BR_USER_STP,		/* new RSTP in userspace */
190 	} stp_enabled;
191 
192 	unsigned char			topology_change;
193 	unsigned char			topology_change_detected;
194 
195 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
196 	unsigned char			multicast_router;
197 
198 	u8				multicast_disabled:1;
199 
200 	u32				hash_elasticity;
201 	u32				hash_max;
202 
203 	u32				multicast_last_member_count;
204 	u32				multicast_startup_queries_sent;
205 	u32				multicast_startup_query_count;
206 
207 	unsigned long			multicast_last_member_interval;
208 	unsigned long			multicast_membership_interval;
209 	unsigned long			multicast_querier_interval;
210 	unsigned long			multicast_query_interval;
211 	unsigned long			multicast_query_response_interval;
212 	unsigned long			multicast_startup_query_interval;
213 
214 	spinlock_t			multicast_lock;
215 	struct net_bridge_mdb_htable	*mdb;
216 	struct hlist_head		router_list;
217 	struct hlist_head		mglist;
218 
219 	struct timer_list		multicast_router_timer;
220 	struct timer_list		multicast_querier_timer;
221 	struct timer_list		multicast_query_timer;
222 #endif
223 
224 	struct timer_list		hello_timer;
225 	struct timer_list		tcn_timer;
226 	struct timer_list		topology_change_timer;
227 	struct timer_list		gc_timer;
228 	struct kobject			*ifobj;
229 };
230 
231 struct br_input_skb_cb {
232 	struct net_device *brdev;
233 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
234 	int igmp;
235 	int mrouters_only;
236 #endif
237 };
238 
239 #define BR_INPUT_SKB_CB(__skb)	((struct br_input_skb_cb *)(__skb)->cb)
240 
241 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
242 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb)	(BR_INPUT_SKB_CB(__skb)->mrouters_only)
243 #else
244 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb)	(0)
245 #endif
246 
247 #define br_printk(level, br, format, args...)	\
248 	printk(level "%s: " format, (br)->dev->name, ##args)
249 
250 #define br_err(__br, format, args...)			\
251 	br_printk(KERN_ERR, __br, format, ##args)
252 #define br_warn(__br, format, args...)			\
253 	br_printk(KERN_WARNING, __br, format, ##args)
254 #define br_notice(__br, format, args...)		\
255 	br_printk(KERN_NOTICE, __br, format, ##args)
256 #define br_info(__br, format, args...)			\
257 	br_printk(KERN_INFO, __br, format, ##args)
258 
259 #define br_debug(br, format, args...)			\
260 	pr_debug("%s: " format,  (br)->dev->name, ##args)
261 
262 extern struct notifier_block br_device_notifier;
263 extern const u8 br_group_address[ETH_ALEN];
264 
265 /* called under bridge lock */
266 static inline int br_is_root_bridge(const struct net_bridge *br)
267 {
268 	return !memcmp(&br->bridge_id, &br->designated_root, 8);
269 }
270 
271 static inline struct net_bridge_port *br_port(const struct net_device *dev)
272 {
273 	return rcu_dereference(dev->br_port);
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 extern void br_netpoll_cleanup(struct net_device *dev);
282 extern void br_netpoll_enable(struct net_bridge *br,
283 			      struct net_device *dev);
284 extern void br_netpoll_disable(struct net_bridge *br,
285 			       struct net_device *dev);
286 #else
287 #define br_netpoll_cleanup(br)
288 #define br_netpoll_enable(br, dev)
289 #define br_netpoll_disable(br, dev)
290 
291 #endif
292 
293 /* br_fdb.c */
294 extern int br_fdb_init(void);
295 extern void br_fdb_fini(void);
296 extern void br_fdb_flush(struct net_bridge *br);
297 extern void br_fdb_changeaddr(struct net_bridge_port *p,
298 			      const unsigned char *newaddr);
299 extern void br_fdb_cleanup(unsigned long arg);
300 extern void br_fdb_delete_by_port(struct net_bridge *br,
301 				  const struct net_bridge_port *p, int do_all);
302 extern struct net_bridge_fdb_entry *__br_fdb_get(struct net_bridge *br,
303 						 const unsigned char *addr);
304 extern int br_fdb_test_addr(struct net_device *dev, unsigned char *addr);
305 extern int br_fdb_fillbuf(struct net_bridge *br, void *buf,
306 			  unsigned long count, unsigned long off);
307 extern int br_fdb_insert(struct net_bridge *br,
308 			 struct net_bridge_port *source,
309 			 const unsigned char *addr);
310 extern void br_fdb_update(struct net_bridge *br,
311 			  struct net_bridge_port *source,
312 			  const unsigned char *addr);
313 
314 /* br_forward.c */
315 extern void br_deliver(const struct net_bridge_port *to,
316 		struct sk_buff *skb);
317 extern int br_dev_queue_push_xmit(struct sk_buff *skb);
318 extern void br_forward(const struct net_bridge_port *to,
319 		struct sk_buff *skb, struct sk_buff *skb0);
320 extern int br_forward_finish(struct sk_buff *skb);
321 extern void br_flood_deliver(struct net_bridge *br, struct sk_buff *skb);
322 extern void br_flood_forward(struct net_bridge *br, struct sk_buff *skb,
323 			     struct sk_buff *skb2);
324 
325 /* br_if.c */
326 extern void br_port_carrier_check(struct net_bridge_port *p);
327 extern int br_add_bridge(struct net *net, const char *name);
328 extern int br_del_bridge(struct net *net, const char *name);
329 extern void br_net_exit(struct net *net);
330 extern int br_add_if(struct net_bridge *br,
331 	      struct net_device *dev);
332 extern int br_del_if(struct net_bridge *br,
333 	      struct net_device *dev);
334 extern int br_min_mtu(const struct net_bridge *br);
335 extern void br_features_recompute(struct net_bridge *br);
336 
337 /* br_input.c */
338 extern int br_handle_frame_finish(struct sk_buff *skb);
339 extern struct sk_buff *br_handle_frame(struct net_bridge_port *p,
340 				       struct sk_buff *skb);
341 
342 /* br_ioctl.c */
343 extern int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
344 extern int br_ioctl_deviceless_stub(struct net *net, unsigned int cmd, void __user *arg);
345 
346 /* br_multicast.c */
347 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
348 extern int br_multicast_rcv(struct net_bridge *br,
349 			    struct net_bridge_port *port,
350 			    struct sk_buff *skb);
351 extern struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
352 					       struct sk_buff *skb);
353 extern void br_multicast_add_port(struct net_bridge_port *port);
354 extern void br_multicast_del_port(struct net_bridge_port *port);
355 extern void br_multicast_enable_port(struct net_bridge_port *port);
356 extern void br_multicast_disable_port(struct net_bridge_port *port);
357 extern void br_multicast_init(struct net_bridge *br);
358 extern void br_multicast_open(struct net_bridge *br);
359 extern void br_multicast_stop(struct net_bridge *br);
360 extern void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
361 				 struct sk_buff *skb);
362 extern void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
363 				 struct sk_buff *skb, struct sk_buff *skb2);
364 extern int br_multicast_set_router(struct net_bridge *br, unsigned long val);
365 extern int br_multicast_set_port_router(struct net_bridge_port *p,
366 					unsigned long val);
367 extern int br_multicast_toggle(struct net_bridge *br, unsigned long val);
368 extern int br_multicast_set_hash_max(struct net_bridge *br, unsigned long val);
369 
370 static inline bool br_multicast_is_router(struct net_bridge *br)
371 {
372 	return br->multicast_router == 2 ||
373 	       (br->multicast_router == 1 &&
374 		timer_pending(&br->multicast_router_timer));
375 }
376 #else
377 static inline int br_multicast_rcv(struct net_bridge *br,
378 				   struct net_bridge_port *port,
379 				   struct sk_buff *skb)
380 {
381 	return 0;
382 }
383 
384 static inline struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
385 						      struct sk_buff *skb)
386 {
387 	return NULL;
388 }
389 
390 static inline void br_multicast_add_port(struct net_bridge_port *port)
391 {
392 }
393 
394 static inline void br_multicast_del_port(struct net_bridge_port *port)
395 {
396 }
397 
398 static inline void br_multicast_enable_port(struct net_bridge_port *port)
399 {
400 }
401 
402 static inline void br_multicast_disable_port(struct net_bridge_port *port)
403 {
404 }
405 
406 static inline void br_multicast_init(struct net_bridge *br)
407 {
408 }
409 
410 static inline void br_multicast_open(struct net_bridge *br)
411 {
412 }
413 
414 static inline void br_multicast_stop(struct net_bridge *br)
415 {
416 }
417 
418 static inline void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
419 					struct sk_buff *skb)
420 {
421 }
422 
423 static inline void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
424 					struct sk_buff *skb,
425 					struct sk_buff *skb2)
426 {
427 }
428 static inline bool br_multicast_is_router(struct net_bridge *br)
429 {
430 	return 0;
431 }
432 #endif
433 
434 /* br_netfilter.c */
435 #ifdef CONFIG_BRIDGE_NETFILTER
436 extern int br_netfilter_init(void);
437 extern void br_netfilter_fini(void);
438 extern void br_netfilter_rtable_init(struct net_bridge *);
439 #else
440 #define br_netfilter_init()	(0)
441 #define br_netfilter_fini()	do { } while(0)
442 #define br_netfilter_rtable_init(x)
443 #endif
444 
445 /* br_stp.c */
446 extern void br_log_state(const struct net_bridge_port *p);
447 extern struct net_bridge_port *br_get_port(struct net_bridge *br,
448 					   u16 port_no);
449 extern void br_init_port(struct net_bridge_port *p);
450 extern void br_become_designated_port(struct net_bridge_port *p);
451 
452 /* br_stp_if.c */
453 extern void br_stp_enable_bridge(struct net_bridge *br);
454 extern void br_stp_disable_bridge(struct net_bridge *br);
455 extern void br_stp_set_enabled(struct net_bridge *br, unsigned long val);
456 extern void br_stp_enable_port(struct net_bridge_port *p);
457 extern void br_stp_disable_port(struct net_bridge_port *p);
458 extern void br_stp_recalculate_bridge_id(struct net_bridge *br);
459 extern void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
460 extern void br_stp_set_bridge_priority(struct net_bridge *br,
461 				       u16 newprio);
462 extern void br_stp_set_port_priority(struct net_bridge_port *p,
463 				     u8 newprio);
464 extern void br_stp_set_path_cost(struct net_bridge_port *p,
465 				 u32 path_cost);
466 extern ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);
467 
468 /* br_stp_bpdu.c */
469 struct stp_proto;
470 extern void br_stp_rcv(const struct stp_proto *proto, struct sk_buff *skb,
471 		       struct net_device *dev);
472 
473 /* br_stp_timer.c */
474 extern void br_stp_timer_init(struct net_bridge *br);
475 extern void br_stp_port_timer_init(struct net_bridge_port *p);
476 extern unsigned long br_timer_value(const struct timer_list *timer);
477 
478 /* br.c */
479 #if defined(CONFIG_ATM_LANE) || defined(CONFIG_ATM_LANE_MODULE)
480 extern int (*br_fdb_test_addr_hook)(struct net_device *dev, unsigned char *addr);
481 #endif
482 
483 /* br_netlink.c */
484 extern int br_netlink_init(void);
485 extern void br_netlink_fini(void);
486 extern void br_ifinfo_notify(int event, struct net_bridge_port *port);
487 
488 #ifdef CONFIG_SYSFS
489 /* br_sysfs_if.c */
490 extern const struct sysfs_ops brport_sysfs_ops;
491 extern int br_sysfs_addif(struct net_bridge_port *p);
492 extern int br_sysfs_renameif(struct net_bridge_port *p);
493 
494 /* br_sysfs_br.c */
495 extern int br_sysfs_addbr(struct net_device *dev);
496 extern void br_sysfs_delbr(struct net_device *dev);
497 
498 #else
499 
500 #define br_sysfs_addif(p)	(0)
501 #define br_sysfs_renameif(p)	(0)
502 #define br_sysfs_addbr(dev)	(0)
503 #define br_sysfs_delbr(dev)	do { } while(0)
504 #endif /* CONFIG_SYSFS */
505 
506 #endif
507