xref: /openbmc/linux/net/bridge/br_private.h (revision 64c70b1c)
1 /*
2  *	Linux ethernet bridge
3  *
4  *	Authors:
5  *	Lennert Buytenhek		<buytenh@gnu.org>
6  *
7  *	$Id: br_private.h,v 1.7 2001/12/24 00:59:55 davem Exp $
8  *
9  *	This program is free software; you can redistribute it and/or
10  *	modify it under the terms of the GNU General Public License
11  *	as published by the Free Software Foundation; either version
12  *	2 of the License, or (at your option) any later version.
13  */
14 
15 #ifndef _BR_PRIVATE_H
16 #define _BR_PRIVATE_H
17 
18 #include <linux/netdevice.h>
19 #include <linux/if_bridge.h>
20 
21 #define BR_HASH_BITS 8
22 #define BR_HASH_SIZE (1 << BR_HASH_BITS)
23 
24 #define BR_HOLD_TIME (1*HZ)
25 
26 #define BR_PORT_BITS	10
27 #define BR_MAX_PORTS	(1<<BR_PORT_BITS)
28 
29 #define BR_VERSION	"2.3"
30 
31 /* Path to usermode spanning tree program */
32 #define BR_STP_PROG	"/sbin/bridge-stp"
33 
34 typedef struct bridge_id bridge_id;
35 typedef struct mac_addr mac_addr;
36 typedef __u16 port_id;
37 
38 struct bridge_id
39 {
40 	unsigned char	prio[2];
41 	unsigned char	addr[6];
42 };
43 
44 struct mac_addr
45 {
46 	unsigned char	addr[6];
47 };
48 
49 struct net_bridge_fdb_entry
50 {
51 	struct hlist_node		hlist;
52 	struct net_bridge_port		*dst;
53 
54 	struct rcu_head			rcu;
55 	atomic_t			use_count;
56 	unsigned long			ageing_timer;
57 	mac_addr			addr;
58 	unsigned char			is_local;
59 	unsigned char			is_static;
60 };
61 
62 struct net_bridge_port
63 {
64 	struct net_bridge		*br;
65 	struct net_device		*dev;
66 	struct list_head		list;
67 
68 	/* STP */
69 	u8				priority;
70 	u8				state;
71 	u16				port_no;
72 	unsigned char			topology_change_ack;
73 	unsigned char			config_pending;
74 	port_id				port_id;
75 	port_id				designated_port;
76 	bridge_id			designated_root;
77 	bridge_id			designated_bridge;
78 	u32				path_cost;
79 	u32				designated_cost;
80 
81 	struct timer_list		forward_delay_timer;
82 	struct timer_list		hold_timer;
83 	struct timer_list		message_age_timer;
84 	struct kobject			kobj;
85 	struct rcu_head			rcu;
86 };
87 
88 struct net_bridge
89 {
90 	spinlock_t			lock;
91 	struct list_head		port_list;
92 	struct net_device		*dev;
93 	struct net_device_stats		statistics;
94 	spinlock_t			hash_lock;
95 	struct hlist_head		hash[BR_HASH_SIZE];
96 	struct list_head		age_list;
97 	unsigned long			feature_mask;
98 
99 	/* STP */
100 	bridge_id			designated_root;
101 	bridge_id			bridge_id;
102 	u32				root_path_cost;
103 	unsigned long			max_age;
104 	unsigned long			hello_time;
105 	unsigned long			forward_delay;
106 	unsigned long			bridge_max_age;
107 	unsigned long			ageing_time;
108 	unsigned long			bridge_hello_time;
109 	unsigned long			bridge_forward_delay;
110 
111 	u8				group_addr[ETH_ALEN];
112 	u16				root_port;
113 
114 	enum {
115 		BR_NO_STP, 		/* no spanning tree */
116 		BR_KERNEL_STP,		/* old STP in kernel */
117 		BR_USER_STP,		/* new RSTP in userspace */
118 	} stp_enabled;
119 
120 	unsigned char			topology_change;
121 	unsigned char			topology_change_detected;
122 
123 	struct timer_list		hello_timer;
124 	struct timer_list		tcn_timer;
125 	struct timer_list		topology_change_timer;
126 	struct timer_list		gc_timer;
127 	struct kobject			ifobj;
128 };
129 
130 extern struct notifier_block br_device_notifier;
131 extern const u8 br_group_address[ETH_ALEN];
132 
133 /* called under bridge lock */
134 static inline int br_is_root_bridge(const struct net_bridge *br)
135 {
136 	return !memcmp(&br->bridge_id, &br->designated_root, 8);
137 }
138 
139 /* br_device.c */
140 extern void br_dev_setup(struct net_device *dev);
141 extern int br_dev_xmit(struct sk_buff *skb, struct net_device *dev);
142 
143 /* br_fdb.c */
144 extern int br_fdb_init(void);
145 extern void br_fdb_fini(void);
146 extern void br_fdb_flush(struct net_bridge *br);
147 extern void br_fdb_changeaddr(struct net_bridge_port *p,
148 			      const unsigned char *newaddr);
149 extern void br_fdb_cleanup(unsigned long arg);
150 extern void br_fdb_delete_by_port(struct net_bridge *br,
151 				  const struct net_bridge_port *p, int do_all);
152 extern struct net_bridge_fdb_entry *__br_fdb_get(struct net_bridge *br,
153 						 const unsigned char *addr);
154 extern struct net_bridge_fdb_entry *br_fdb_get(struct net_bridge *br,
155 					       unsigned char *addr);
156 extern void br_fdb_put(struct net_bridge_fdb_entry *ent);
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,
174 		      struct sk_buff *skb,
175 		      int clone);
176 extern void br_flood_forward(struct net_bridge *br,
177 		      struct sk_buff *skb,
178 		      int clone);
179 
180 /* br_if.c */
181 extern void br_port_carrier_check(struct net_bridge_port *p);
182 extern int br_add_bridge(const char *name);
183 extern int br_del_bridge(const char *name);
184 extern void br_cleanup_bridges(void);
185 extern int br_add_if(struct net_bridge *br,
186 	      struct net_device *dev);
187 extern int br_del_if(struct net_bridge *br,
188 	      struct net_device *dev);
189 extern int br_min_mtu(const struct net_bridge *br);
190 extern void br_features_recompute(struct net_bridge *br);
191 
192 /* br_input.c */
193 extern int br_handle_frame_finish(struct sk_buff *skb);
194 extern struct sk_buff *br_handle_frame(struct net_bridge_port *p,
195 				       struct sk_buff *skb);
196 
197 /* br_ioctl.c */
198 extern int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
199 extern int br_ioctl_deviceless_stub(unsigned int cmd, void __user *arg);
200 
201 /* br_netfilter.c */
202 #ifdef CONFIG_BRIDGE_NETFILTER
203 extern int br_netfilter_init(void);
204 extern void br_netfilter_fini(void);
205 #else
206 #define br_netfilter_init()	(0)
207 #define br_netfilter_fini()	do { } while(0)
208 #endif
209 
210 /* br_stp.c */
211 extern void br_log_state(const struct net_bridge_port *p);
212 extern struct net_bridge_port *br_get_port(struct net_bridge *br,
213 					   u16 port_no);
214 extern void br_init_port(struct net_bridge_port *p);
215 extern void br_become_designated_port(struct net_bridge_port *p);
216 
217 /* br_stp_if.c */
218 extern void br_stp_enable_bridge(struct net_bridge *br);
219 extern void br_stp_disable_bridge(struct net_bridge *br);
220 extern void br_stp_set_enabled(struct net_bridge *br, unsigned long val);
221 extern void br_stp_enable_port(struct net_bridge_port *p);
222 extern void br_stp_disable_port(struct net_bridge_port *p);
223 extern void br_stp_recalculate_bridge_id(struct net_bridge *br);
224 extern void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
225 extern void br_stp_set_bridge_priority(struct net_bridge *br,
226 				       u16 newprio);
227 extern void br_stp_set_port_priority(struct net_bridge_port *p,
228 				     u8 newprio);
229 extern void br_stp_set_path_cost(struct net_bridge_port *p,
230 				 u32 path_cost);
231 extern ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);
232 
233 /* br_stp_bpdu.c */
234 extern int br_stp_rcv(struct sk_buff *skb, struct net_device *dev,
235 		      struct packet_type *pt, struct net_device *orig_dev);
236 
237 /* br_stp_timer.c */
238 extern void br_stp_timer_init(struct net_bridge *br);
239 extern void br_stp_port_timer_init(struct net_bridge_port *p);
240 extern unsigned long br_timer_value(const struct timer_list *timer);
241 
242 /* br.c */
243 extern struct net_bridge_fdb_entry *(*br_fdb_get_hook)(struct net_bridge *br,
244 						       unsigned char *addr);
245 extern void (*br_fdb_put_hook)(struct net_bridge_fdb_entry *ent);
246 
247 
248 /* br_netlink.c */
249 extern int br_netlink_init(void);
250 extern void br_netlink_fini(void);
251 extern void br_ifinfo_notify(int event, struct net_bridge_port *port);
252 
253 #ifdef CONFIG_SYSFS
254 /* br_sysfs_if.c */
255 extern struct sysfs_ops brport_sysfs_ops;
256 extern int br_sysfs_addif(struct net_bridge_port *p);
257 
258 /* br_sysfs_br.c */
259 extern int br_sysfs_addbr(struct net_device *dev);
260 extern void br_sysfs_delbr(struct net_device *dev);
261 
262 #else
263 
264 #define br_sysfs_addif(p)	(0)
265 #define br_sysfs_addbr(dev)	(0)
266 #define br_sysfs_delbr(dev)	do { } while(0)
267 #endif /* CONFIG_SYSFS */
268 
269 #endif
270