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