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