xref: /openbmc/linux/net/bridge/br_private.h (revision ac062e84)
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_PORT_DEBOUNCE (HZ/10)
30 
31 #define BR_VERSION	"2.2"
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 delayed_work		carrier_check;
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 	unsigned char			stp_enabled;
114 	unsigned char			topology_change;
115 	unsigned char			topology_change_detected;
116 
117 	struct timer_list		hello_timer;
118 	struct timer_list		tcn_timer;
119 	struct timer_list		topology_change_timer;
120 	struct timer_list		gc_timer;
121 	struct kobject			ifobj;
122 };
123 
124 extern struct notifier_block br_device_notifier;
125 extern const u8 br_group_address[ETH_ALEN];
126 
127 /* called under bridge lock */
128 static inline int br_is_root_bridge(const struct net_bridge *br)
129 {
130 	return !memcmp(&br->bridge_id, &br->designated_root, 8);
131 }
132 
133 
134 /* br_device.c */
135 extern void br_dev_setup(struct net_device *dev);
136 extern int br_dev_xmit(struct sk_buff *skb, struct net_device *dev);
137 
138 /* br_fdb.c */
139 extern void br_fdb_init(void);
140 extern void br_fdb_fini(void);
141 extern void br_fdb_changeaddr(struct net_bridge_port *p,
142 			      const unsigned char *newaddr);
143 extern void br_fdb_cleanup(unsigned long arg);
144 extern void br_fdb_delete_by_port(struct net_bridge *br,
145 				  const struct net_bridge_port *p, int do_all);
146 extern struct net_bridge_fdb_entry *__br_fdb_get(struct net_bridge *br,
147 						 const unsigned char *addr);
148 extern struct net_bridge_fdb_entry *br_fdb_get(struct net_bridge *br,
149 					       unsigned char *addr);
150 extern void br_fdb_put(struct net_bridge_fdb_entry *ent);
151 extern int br_fdb_fillbuf(struct net_bridge *br, void *buf,
152 			  unsigned long count, unsigned long off);
153 extern int br_fdb_insert(struct net_bridge *br,
154 			 struct net_bridge_port *source,
155 			 const unsigned char *addr);
156 extern void br_fdb_update(struct net_bridge *br,
157 			  struct net_bridge_port *source,
158 			  const unsigned char *addr);
159 
160 /* br_forward.c */
161 extern void br_deliver(const struct net_bridge_port *to,
162 		struct sk_buff *skb);
163 extern int br_dev_queue_push_xmit(struct sk_buff *skb);
164 extern void br_forward(const struct net_bridge_port *to,
165 		struct sk_buff *skb);
166 extern int br_forward_finish(struct sk_buff *skb);
167 extern void br_flood_deliver(struct net_bridge *br,
168 		      struct sk_buff *skb,
169 		      int clone);
170 extern void br_flood_forward(struct net_bridge *br,
171 		      struct sk_buff *skb,
172 		      int clone);
173 
174 /* br_if.c */
175 extern int br_add_bridge(const char *name);
176 extern int br_del_bridge(const char *name);
177 extern void br_cleanup_bridges(void);
178 extern int br_add_if(struct net_bridge *br,
179 	      struct net_device *dev);
180 extern int br_del_if(struct net_bridge *br,
181 	      struct net_device *dev);
182 extern int br_min_mtu(const struct net_bridge *br);
183 extern void br_features_recompute(struct net_bridge *br);
184 
185 /* br_input.c */
186 extern int br_handle_frame_finish(struct sk_buff *skb);
187 extern int br_handle_frame(struct net_bridge_port *p, struct sk_buff **pskb);
188 
189 /* br_ioctl.c */
190 extern int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
191 extern int br_ioctl_deviceless_stub(unsigned int cmd, void __user *arg);
192 
193 /* br_netfilter.c */
194 #ifdef CONFIG_BRIDGE_NETFILTER
195 extern int br_netfilter_init(void);
196 extern void br_netfilter_fini(void);
197 #else
198 #define br_netfilter_init()	(0)
199 #define br_netfilter_fini()	do { } while(0)
200 #endif
201 
202 /* br_stp.c */
203 extern void br_log_state(const struct net_bridge_port *p);
204 extern struct net_bridge_port *br_get_port(struct net_bridge *br,
205 					   u16 port_no);
206 extern void br_init_port(struct net_bridge_port *p);
207 extern void br_become_designated_port(struct net_bridge_port *p);
208 
209 /* br_stp_if.c */
210 extern void br_stp_enable_bridge(struct net_bridge *br);
211 extern void br_stp_disable_bridge(struct net_bridge *br);
212 extern void br_stp_enable_port(struct net_bridge_port *p);
213 extern void br_stp_disable_port(struct net_bridge_port *p);
214 extern void br_stp_recalculate_bridge_id(struct net_bridge *br);
215 extern void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
216 extern void br_stp_set_bridge_priority(struct net_bridge *br,
217 				       u16 newprio);
218 extern void br_stp_set_port_priority(struct net_bridge_port *p,
219 				     u8 newprio);
220 extern void br_stp_set_path_cost(struct net_bridge_port *p,
221 				 u32 path_cost);
222 extern ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);
223 
224 /* br_stp_bpdu.c */
225 extern int br_stp_rcv(struct sk_buff *skb, struct net_device *dev,
226 		      struct packet_type *pt, struct net_device *orig_dev);
227 
228 /* br_stp_timer.c */
229 extern void br_stp_timer_init(struct net_bridge *br);
230 extern void br_stp_port_timer_init(struct net_bridge_port *p);
231 extern unsigned long br_timer_value(const struct timer_list *timer);
232 
233 /* br.c */
234 extern struct net_bridge_fdb_entry *(*br_fdb_get_hook)(struct net_bridge *br,
235 						       unsigned char *addr);
236 extern void (*br_fdb_put_hook)(struct net_bridge_fdb_entry *ent);
237 
238 
239 /* br_netlink.c */
240 extern void br_netlink_init(void);
241 extern void br_netlink_fini(void);
242 extern void br_ifinfo_notify(int event, struct net_bridge_port *port);
243 
244 #ifdef CONFIG_SYSFS
245 /* br_sysfs_if.c */
246 extern struct sysfs_ops brport_sysfs_ops;
247 extern int br_sysfs_addif(struct net_bridge_port *p);
248 
249 /* br_sysfs_br.c */
250 extern int br_sysfs_addbr(struct net_device *dev);
251 extern void br_sysfs_delbr(struct net_device *dev);
252 
253 #else
254 
255 #define br_sysfs_addif(p)	(0)
256 #define br_sysfs_addbr(dev)	(0)
257 #define br_sysfs_delbr(dev)	do { } while(0)
258 #endif /* CONFIG_SYSFS */
259 
260 #endif
261