xref: /openbmc/linux/net/bridge/br_private.h (revision 4433f420)
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/miscdevice.h>
20 #include <linux/if_bridge.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_PORT_DEBOUNCE (HZ/10)
31 
32 typedef struct bridge_id bridge_id;
33 typedef struct mac_addr mac_addr;
34 typedef __u16 port_id;
35 
36 struct bridge_id
37 {
38 	unsigned char	prio[2];
39 	unsigned char	addr[6];
40 };
41 
42 struct mac_addr
43 {
44 	unsigned char	addr[6];
45 };
46 
47 struct net_bridge_fdb_entry
48 {
49 	struct hlist_node		hlist;
50 	struct net_bridge_port		*dst;
51 
52 	struct rcu_head			rcu;
53 	atomic_t			use_count;
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 work_struct		carrier_check;
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 	struct net_device_stats		statistics;
93 	spinlock_t			hash_lock;
94 	struct hlist_head		hash[BR_HASH_SIZE];
95 	struct list_head		age_list;
96 
97 	/* STP */
98 	bridge_id			designated_root;
99 	bridge_id			bridge_id;
100 	u32				root_path_cost;
101 	unsigned long			max_age;
102 	unsigned long			hello_time;
103 	unsigned long			forward_delay;
104 	unsigned long			bridge_max_age;
105 	unsigned long			ageing_time;
106 	unsigned long			bridge_hello_time;
107 	unsigned long			bridge_forward_delay;
108 
109 	u16				root_port;
110 	unsigned char			stp_enabled;
111 	unsigned char			topology_change;
112 	unsigned char			topology_change_detected;
113 
114 	struct timer_list		hello_timer;
115 	struct timer_list		tcn_timer;
116 	struct timer_list		topology_change_timer;
117 	struct timer_list		gc_timer;
118 	struct kobject			ifobj;
119 };
120 
121 extern struct notifier_block br_device_notifier;
122 extern const unsigned char bridge_ula[6];
123 
124 /* called under bridge lock */
125 static inline int br_is_root_bridge(const struct net_bridge *br)
126 {
127 	return !memcmp(&br->bridge_id, &br->designated_root, 8);
128 }
129 
130 
131 /* br_device.c */
132 extern void br_dev_setup(struct net_device *dev);
133 extern int br_dev_xmit(struct sk_buff *skb, struct net_device *dev);
134 
135 /* br_fdb.c */
136 extern void br_fdb_init(void);
137 extern void br_fdb_fini(void);
138 extern void br_fdb_changeaddr(struct net_bridge_port *p,
139 			      const unsigned char *newaddr);
140 extern void br_fdb_cleanup(unsigned long arg);
141 extern void br_fdb_delete_by_port(struct net_bridge *br,
142 			   struct net_bridge_port *p);
143 extern struct net_bridge_fdb_entry *__br_fdb_get(struct net_bridge *br,
144 						 const unsigned char *addr);
145 extern struct net_bridge_fdb_entry *br_fdb_get(struct net_bridge *br,
146 					       unsigned char *addr);
147 extern void br_fdb_put(struct net_bridge_fdb_entry *ent);
148 extern int br_fdb_fillbuf(struct net_bridge *br, void *buf,
149 			  unsigned long count, unsigned long off);
150 extern int br_fdb_insert(struct net_bridge *br,
151 			 struct net_bridge_port *source,
152 			 const unsigned char *addr);
153 extern void br_fdb_update(struct net_bridge *br,
154 			  struct net_bridge_port *source,
155 			  const unsigned char *addr);
156 
157 /* br_forward.c */
158 extern void br_deliver(const struct net_bridge_port *to,
159 		struct sk_buff *skb);
160 extern int br_dev_queue_push_xmit(struct sk_buff *skb);
161 extern void br_forward(const struct net_bridge_port *to,
162 		struct sk_buff *skb);
163 extern int br_forward_finish(struct sk_buff *skb);
164 extern void br_flood_deliver(struct net_bridge *br,
165 		      struct sk_buff *skb,
166 		      int clone);
167 extern void br_flood_forward(struct net_bridge *br,
168 		      struct sk_buff *skb,
169 		      int clone);
170 
171 /* br_if.c */
172 extern int br_add_bridge(const char *name);
173 extern int br_del_bridge(const char *name);
174 extern void br_cleanup_bridges(void);
175 extern int br_add_if(struct net_bridge *br,
176 	      struct net_device *dev);
177 extern int br_del_if(struct net_bridge *br,
178 	      struct net_device *dev);
179 extern int br_min_mtu(const struct net_bridge *br);
180 extern void br_features_recompute(struct net_bridge *br);
181 
182 /* br_input.c */
183 extern int br_handle_frame_finish(struct sk_buff *skb);
184 extern int br_handle_frame(struct net_bridge_port *p, struct sk_buff **pskb);
185 
186 /* br_ioctl.c */
187 extern int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
188 extern int br_ioctl_deviceless_stub(unsigned int cmd, void __user *arg);
189 
190 /* br_netfilter.c */
191 extern int br_netfilter_init(void);
192 extern void br_netfilter_fini(void);
193 
194 /* br_stp.c */
195 extern void br_log_state(const struct net_bridge_port *p);
196 extern struct net_bridge_port *br_get_port(struct net_bridge *br,
197 				    	   u16 port_no);
198 extern void br_init_port(struct net_bridge_port *p);
199 extern void br_become_designated_port(struct net_bridge_port *p);
200 
201 /* br_stp_if.c */
202 extern void br_stp_enable_bridge(struct net_bridge *br);
203 extern void br_stp_disable_bridge(struct net_bridge *br);
204 extern void br_stp_enable_port(struct net_bridge_port *p);
205 extern void br_stp_disable_port(struct net_bridge_port *p);
206 extern void br_stp_recalculate_bridge_id(struct net_bridge *br);
207 extern void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
208 extern void br_stp_set_bridge_priority(struct net_bridge *br,
209 				       u16 newprio);
210 extern void br_stp_set_port_priority(struct net_bridge_port *p,
211 				     u8 newprio);
212 extern void br_stp_set_path_cost(struct net_bridge_port *p,
213 				 u32 path_cost);
214 extern ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);
215 
216 /* br_stp_bpdu.c */
217 extern int br_stp_handle_bpdu(struct sk_buff *skb);
218 
219 /* br_stp_timer.c */
220 extern void br_stp_timer_init(struct net_bridge *br);
221 extern void br_stp_port_timer_init(struct net_bridge_port *p);
222 extern unsigned long br_timer_value(const struct timer_list *timer);
223 
224 /* br.c */
225 extern struct net_bridge_fdb_entry *(*br_fdb_get_hook)(struct net_bridge *br,
226 						       unsigned char *addr);
227 extern void (*br_fdb_put_hook)(struct net_bridge_fdb_entry *ent);
228 
229 
230 #ifdef CONFIG_SYSFS
231 /* br_sysfs_if.c */
232 extern int br_sysfs_addif(struct net_bridge_port *p);
233 extern void br_sysfs_removeif(struct net_bridge_port *p);
234 extern void br_sysfs_freeif(struct net_bridge_port *p);
235 
236 /* br_sysfs_br.c */
237 extern int br_sysfs_addbr(struct net_device *dev);
238 extern void br_sysfs_delbr(struct net_device *dev);
239 
240 #else
241 
242 #define br_sysfs_addif(p)	(0)
243 #define br_sysfs_removeif(p)	do { } while(0)
244 #define br_sysfs_freeif(p)	kfree(p)
245 #define br_sysfs_addbr(dev)	(0)
246 #define br_sysfs_delbr(dev)	do { } while(0)
247 #endif /* CONFIG_SYSFS */
248 
249 #endif
250