xref: /linux/net/bridge/br_private.h (revision 6000fc4d6f3e55ad52cce8d76317187fe01af2aa)
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
61 {
62 	struct net_bridge		*br;
63 	struct net_device		*dev;
64 	struct list_head		list;
65 
66 	/* STP */
67 	u8				priority;
68 	u8				state;
69 	u16				port_no;
70 	unsigned char			topology_change_ack;
71 	unsigned char			config_pending;
72 	port_id				port_id;
73 	port_id				designated_port;
74 	bridge_id			designated_root;
75 	bridge_id			designated_bridge;
76 	u32				path_cost;
77 	u32				designated_cost;
78 
79 	struct timer_list		forward_delay_timer;
80 	struct timer_list		hold_timer;
81 	struct timer_list		message_age_timer;
82 	struct kobject			kobj;
83 	struct rcu_head			rcu;
84 };
85 
86 struct net_bridge
87 {
88 	spinlock_t			lock;
89 	struct list_head		port_list;
90 	struct net_device		*dev;
91 	spinlock_t			hash_lock;
92 	struct hlist_head		hash[BR_HASH_SIZE];
93 	struct list_head		age_list;
94 	unsigned long			feature_mask;
95 #ifdef CONFIG_BRIDGE_NETFILTER
96 	struct rtable 			fake_rtable;
97 #endif
98 	unsigned long			flags;
99 #define BR_SET_MAC_ADDR		0x00000001
100 
101 	/* STP */
102 	bridge_id			designated_root;
103 	bridge_id			bridge_id;
104 	u32				root_path_cost;
105 	unsigned long			max_age;
106 	unsigned long			hello_time;
107 	unsigned long			forward_delay;
108 	unsigned long			bridge_max_age;
109 	unsigned long			ageing_time;
110 	unsigned long			bridge_hello_time;
111 	unsigned long			bridge_forward_delay;
112 
113 	u8				group_addr[ETH_ALEN];
114 	u16				root_port;
115 
116 	enum {
117 		BR_NO_STP, 		/* no spanning tree */
118 		BR_KERNEL_STP,		/* old STP in kernel */
119 		BR_USER_STP,		/* new RSTP in userspace */
120 	} stp_enabled;
121 
122 	unsigned char			topology_change;
123 	unsigned char			topology_change_detected;
124 
125 	struct timer_list		hello_timer;
126 	struct timer_list		tcn_timer;
127 	struct timer_list		topology_change_timer;
128 	struct timer_list		gc_timer;
129 	struct kobject			*ifobj;
130 };
131 
132 extern struct notifier_block br_device_notifier;
133 extern const u8 br_group_address[ETH_ALEN];
134 
135 /* called under bridge lock */
136 static inline int br_is_root_bridge(const struct net_bridge *br)
137 {
138 	return !memcmp(&br->bridge_id, &br->designated_root, 8);
139 }
140 
141 /* br_device.c */
142 extern void br_dev_setup(struct net_device *dev);
143 extern int br_dev_xmit(struct sk_buff *skb, struct net_device *dev);
144 
145 /* br_fdb.c */
146 extern int br_fdb_init(void);
147 extern void br_fdb_fini(void);
148 extern void br_fdb_flush(struct net_bridge *br);
149 extern void br_fdb_changeaddr(struct net_bridge_port *p,
150 			      const unsigned char *newaddr);
151 extern void br_fdb_cleanup(unsigned long arg);
152 extern void br_fdb_delete_by_port(struct net_bridge *br,
153 				  const struct net_bridge_port *p, int do_all);
154 extern struct net_bridge_fdb_entry *__br_fdb_get(struct net_bridge *br,
155 						 const unsigned char *addr);
156 extern int br_fdb_test_addr(struct net_device *dev, unsigned char *addr);
157 extern int br_fdb_fillbuf(struct net_bridge *br, void *buf,
158 			  unsigned long count, unsigned long off);
159 extern int br_fdb_insert(struct net_bridge *br,
160 			 struct net_bridge_port *source,
161 			 const unsigned char *addr);
162 extern void br_fdb_update(struct net_bridge *br,
163 			  struct net_bridge_port *source,
164 			  const unsigned char *addr);
165 
166 /* br_forward.c */
167 extern void br_deliver(const struct net_bridge_port *to,
168 		struct sk_buff *skb);
169 extern int br_dev_queue_push_xmit(struct sk_buff *skb);
170 extern void br_forward(const struct net_bridge_port *to,
171 		struct sk_buff *skb);
172 extern int br_forward_finish(struct sk_buff *skb);
173 extern void br_flood_deliver(struct net_bridge *br, struct sk_buff *skb);
174 extern void br_flood_forward(struct net_bridge *br, struct sk_buff *skb);
175 
176 /* br_if.c */
177 extern void br_port_carrier_check(struct net_bridge_port *p);
178 extern int br_add_bridge(struct net *net, const char *name);
179 extern int br_del_bridge(struct net *net, const char *name);
180 extern void br_net_exit(struct net *net);
181 extern int br_add_if(struct net_bridge *br,
182 	      struct net_device *dev);
183 extern int br_del_if(struct net_bridge *br,
184 	      struct net_device *dev);
185 extern int br_min_mtu(const struct net_bridge *br);
186 extern void br_features_recompute(struct net_bridge *br);
187 
188 /* br_input.c */
189 extern int br_handle_frame_finish(struct sk_buff *skb);
190 extern struct sk_buff *br_handle_frame(struct net_bridge_port *p,
191 				       struct sk_buff *skb);
192 
193 /* br_ioctl.c */
194 extern int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
195 extern int br_ioctl_deviceless_stub(struct net *net, unsigned int cmd, void __user *arg);
196 
197 /* br_netfilter.c */
198 #ifdef CONFIG_BRIDGE_NETFILTER
199 extern int br_netfilter_init(void);
200 extern void br_netfilter_fini(void);
201 extern void br_netfilter_rtable_init(struct net_bridge *);
202 #else
203 #define br_netfilter_init()	(0)
204 #define br_netfilter_fini()	do { } while(0)
205 #define br_netfilter_rtable_init(x)
206 #endif
207 
208 /* br_stp.c */
209 extern void br_log_state(const struct net_bridge_port *p);
210 extern struct net_bridge_port *br_get_port(struct net_bridge *br,
211 					   u16 port_no);
212 extern void br_init_port(struct net_bridge_port *p);
213 extern void br_become_designated_port(struct net_bridge_port *p);
214 
215 /* br_stp_if.c */
216 extern void br_stp_enable_bridge(struct net_bridge *br);
217 extern void br_stp_disable_bridge(struct net_bridge *br);
218 extern void br_stp_set_enabled(struct net_bridge *br, unsigned long val);
219 extern void br_stp_enable_port(struct net_bridge_port *p);
220 extern void br_stp_disable_port(struct net_bridge_port *p);
221 extern void br_stp_recalculate_bridge_id(struct net_bridge *br);
222 extern void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
223 extern void br_stp_set_bridge_priority(struct net_bridge *br,
224 				       u16 newprio);
225 extern void br_stp_set_port_priority(struct net_bridge_port *p,
226 				     u8 newprio);
227 extern void br_stp_set_path_cost(struct net_bridge_port *p,
228 				 u32 path_cost);
229 extern ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);
230 
231 /* br_stp_bpdu.c */
232 struct stp_proto;
233 extern void br_stp_rcv(const struct stp_proto *proto, struct sk_buff *skb,
234 		       struct net_device *dev);
235 
236 /* br_stp_timer.c */
237 extern void br_stp_timer_init(struct net_bridge *br);
238 extern void br_stp_port_timer_init(struct net_bridge_port *p);
239 extern unsigned long br_timer_value(const struct timer_list *timer);
240 
241 /* br.c */
242 #if defined(CONFIG_ATM_LANE) || defined(CONFIG_ATM_LANE_MODULE)
243 extern int (*br_fdb_test_addr_hook)(struct net_device *dev, unsigned char *addr);
244 #endif
245 
246 /* br_netlink.c */
247 extern int br_netlink_init(void);
248 extern void br_netlink_fini(void);
249 extern void br_ifinfo_notify(int event, struct net_bridge_port *port);
250 
251 #ifdef CONFIG_SYSFS
252 /* br_sysfs_if.c */
253 extern struct sysfs_ops brport_sysfs_ops;
254 extern int br_sysfs_addif(struct net_bridge_port *p);
255 
256 /* br_sysfs_br.c */
257 extern int br_sysfs_addbr(struct net_device *dev);
258 extern void br_sysfs_delbr(struct net_device *dev);
259 
260 #else
261 
262 #define br_sysfs_addif(p)	(0)
263 #define br_sysfs_addbr(dev)	(0)
264 #define br_sysfs_delbr(dev)	do { } while(0)
265 #endif /* CONFIG_SYSFS */
266 
267 #endif
268