xref: /linux/net/bridge/br_private.h (revision c537b994505099b7197e7d3125b942ecbcc51eb6)
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.2"
30 
31 typedef struct bridge_id bridge_id;
32 typedef struct mac_addr mac_addr;
33 typedef __u16 port_id;
34 
35 struct bridge_id
36 {
37 	unsigned char	prio[2];
38 	unsigned char	addr[6];
39 };
40 
41 struct mac_addr
42 {
43 	unsigned char	addr[6];
44 };
45 
46 struct net_bridge_fdb_entry
47 {
48 	struct hlist_node		hlist;
49 	struct net_bridge_port		*dst;
50 
51 	struct rcu_head			rcu;
52 	atomic_t			use_count;
53 	unsigned long			ageing_timer;
54 	mac_addr			addr;
55 	unsigned char			is_local;
56 	unsigned char			is_static;
57 };
58 
59 struct net_bridge_port
60 {
61 	struct net_bridge		*br;
62 	struct net_device		*dev;
63 	struct list_head		list;
64 
65 	/* STP */
66 	u8				priority;
67 	u8				state;
68 	u16				port_no;
69 	unsigned char			topology_change_ack;
70 	unsigned char			config_pending;
71 	port_id				port_id;
72 	port_id				designated_port;
73 	bridge_id			designated_root;
74 	bridge_id			designated_bridge;
75 	u32				path_cost;
76 	u32				designated_cost;
77 
78 	struct timer_list		forward_delay_timer;
79 	struct timer_list		hold_timer;
80 	struct timer_list		message_age_timer;
81 	struct kobject			kobj;
82 	struct rcu_head			rcu;
83 };
84 
85 struct net_bridge
86 {
87 	spinlock_t			lock;
88 	struct list_head		port_list;
89 	struct net_device		*dev;
90 	struct net_device_stats		statistics;
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 
96 	/* STP */
97 	bridge_id			designated_root;
98 	bridge_id			bridge_id;
99 	u32				root_path_cost;
100 	unsigned long			max_age;
101 	unsigned long			hello_time;
102 	unsigned long			forward_delay;
103 	unsigned long			bridge_max_age;
104 	unsigned long			ageing_time;
105 	unsigned long			bridge_hello_time;
106 	unsigned long			bridge_forward_delay;
107 
108 	u8				group_addr[ETH_ALEN];
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 u8 br_group_address[ETH_ALEN];
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 				  const struct net_bridge_port *p, int do_all);
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 void br_port_carrier_check(struct net_bridge_port *p);
173 extern int br_add_bridge(const char *name);
174 extern int br_del_bridge(const char *name);
175 extern void br_cleanup_bridges(void);
176 extern int br_add_if(struct net_bridge *br,
177 	      struct net_device *dev);
178 extern int br_del_if(struct net_bridge *br,
179 	      struct net_device *dev);
180 extern int br_min_mtu(const struct net_bridge *br);
181 extern void br_features_recompute(struct net_bridge *br);
182 
183 /* br_input.c */
184 extern int br_handle_frame_finish(struct sk_buff *skb);
185 extern int br_handle_frame(struct net_bridge_port *p, struct sk_buff **pskb);
186 
187 /* br_ioctl.c */
188 extern int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
189 extern int br_ioctl_deviceless_stub(unsigned int cmd, void __user *arg);
190 
191 /* br_netfilter.c */
192 #ifdef CONFIG_BRIDGE_NETFILTER
193 extern int br_netfilter_init(void);
194 extern void br_netfilter_fini(void);
195 #else
196 #define br_netfilter_init()	(0)
197 #define br_netfilter_fini()	do { } while(0)
198 #endif
199 
200 /* br_stp.c */
201 extern void br_log_state(const struct net_bridge_port *p);
202 extern struct net_bridge_port *br_get_port(struct net_bridge *br,
203 					   u16 port_no);
204 extern void br_init_port(struct net_bridge_port *p);
205 extern void br_become_designated_port(struct net_bridge_port *p);
206 
207 /* br_stp_if.c */
208 extern void br_stp_enable_bridge(struct net_bridge *br);
209 extern void br_stp_disable_bridge(struct net_bridge *br);
210 extern void br_stp_enable_port(struct net_bridge_port *p);
211 extern void br_stp_disable_port(struct net_bridge_port *p);
212 extern void br_stp_recalculate_bridge_id(struct net_bridge *br);
213 extern void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
214 extern void br_stp_set_bridge_priority(struct net_bridge *br,
215 				       u16 newprio);
216 extern void br_stp_set_port_priority(struct net_bridge_port *p,
217 				     u8 newprio);
218 extern void br_stp_set_path_cost(struct net_bridge_port *p,
219 				 u32 path_cost);
220 extern ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);
221 
222 /* br_stp_bpdu.c */
223 extern int br_stp_rcv(struct sk_buff *skb, struct net_device *dev,
224 		      struct packet_type *pt, struct net_device *orig_dev);
225 
226 /* br_stp_timer.c */
227 extern void br_stp_timer_init(struct net_bridge *br);
228 extern void br_stp_port_timer_init(struct net_bridge_port *p);
229 extern unsigned long br_timer_value(const struct timer_list *timer);
230 
231 /* br.c */
232 extern struct net_bridge_fdb_entry *(*br_fdb_get_hook)(struct net_bridge *br,
233 						       unsigned char *addr);
234 extern void (*br_fdb_put_hook)(struct net_bridge_fdb_entry *ent);
235 
236 
237 /* br_netlink.c */
238 extern void br_netlink_init(void);
239 extern void br_netlink_fini(void);
240 extern void br_ifinfo_notify(int event, struct net_bridge_port *port);
241 
242 #ifdef CONFIG_SYSFS
243 /* br_sysfs_if.c */
244 extern struct sysfs_ops brport_sysfs_ops;
245 extern int br_sysfs_addif(struct net_bridge_port *p);
246 
247 /* br_sysfs_br.c */
248 extern int br_sysfs_addbr(struct net_device *dev);
249 extern void br_sysfs_delbr(struct net_device *dev);
250 
251 #else
252 
253 #define br_sysfs_addif(p)	(0)
254 #define br_sysfs_addbr(dev)	(0)
255 #define br_sysfs_delbr(dev)	do { } while(0)
256 #endif /* CONFIG_SYSFS */
257 
258 #endif
259