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