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