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