bridge: add RCU annotations to bridge port lookup
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / net / bridge / br_private.h
blob84aac7734bfc7e2c219680dc48d8c3ba75ca6924
1 /*
2 * Linux ethernet bridge
4 * Authors:
5 * Lennert Buytenhek <buytenh@gnu.org>
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.
13 #ifndef _BR_PRIVATE_H
14 #define _BR_PRIVATE_H
16 #include <linux/netdevice.h>
17 #include <linux/if_bridge.h>
18 #include <linux/netpoll.h>
19 #include <linux/u64_stats_sync.h>
20 #include <net/route.h>
22 #define BR_HASH_BITS 8
23 #define BR_HASH_SIZE (1 << BR_HASH_BITS)
25 #define BR_HOLD_TIME (1*HZ)
27 #define BR_PORT_BITS 10
28 #define BR_MAX_PORTS (1<<BR_PORT_BITS)
30 #define BR_VERSION "2.3"
32 /* Path to usermode spanning tree program */
33 #define BR_STP_PROG "/sbin/bridge-stp"
35 typedef struct bridge_id bridge_id;
36 typedef struct mac_addr mac_addr;
37 typedef __u16 port_id;
39 struct bridge_id
41 unsigned char prio[2];
42 unsigned char addr[6];
45 struct mac_addr
47 unsigned char addr[6];
50 struct br_ip
52 union {
53 __be32 ip4;
54 #if defined(CONFIG_IPV6) || defined(CONFIG_IPV6_MODULE)
55 struct in6_addr ip6;
56 #endif
57 } u;
58 __be16 proto;
61 struct net_bridge_fdb_entry
63 struct hlist_node hlist;
64 struct net_bridge_port *dst;
66 struct rcu_head rcu;
67 unsigned long ageing_timer;
68 mac_addr addr;
69 unsigned char is_local;
70 unsigned char is_static;
73 struct net_bridge_port_group {
74 struct net_bridge_port *port;
75 struct net_bridge_port_group __rcu *next;
76 struct hlist_node mglist;
77 struct rcu_head rcu;
78 struct timer_list timer;
79 struct timer_list query_timer;
80 struct br_ip addr;
81 u32 queries_sent;
84 struct net_bridge_mdb_entry
86 struct hlist_node hlist[2];
87 struct hlist_node mglist;
88 struct net_bridge *br;
89 struct net_bridge_port_group __rcu *ports;
90 struct rcu_head rcu;
91 struct timer_list timer;
92 struct timer_list query_timer;
93 struct br_ip addr;
94 u32 queries_sent;
97 struct net_bridge_mdb_htable
99 struct hlist_head *mhash;
100 struct rcu_head rcu;
101 struct net_bridge_mdb_htable *old;
102 u32 size;
103 u32 max;
104 u32 secret;
105 u32 ver;
108 struct net_bridge_port
110 struct net_bridge *br;
111 struct net_device *dev;
112 struct list_head list;
114 /* STP */
115 u8 priority;
116 u8 state;
117 u16 port_no;
118 unsigned char topology_change_ack;
119 unsigned char config_pending;
120 port_id port_id;
121 port_id designated_port;
122 bridge_id designated_root;
123 bridge_id designated_bridge;
124 u32 path_cost;
125 u32 designated_cost;
127 struct timer_list forward_delay_timer;
128 struct timer_list hold_timer;
129 struct timer_list message_age_timer;
130 struct kobject kobj;
131 struct rcu_head rcu;
133 unsigned long flags;
134 #define BR_HAIRPIN_MODE 0x00000001
136 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
137 u32 multicast_startup_queries_sent;
138 unsigned char multicast_router;
139 struct timer_list multicast_router_timer;
140 struct timer_list multicast_query_timer;
141 struct hlist_head mglist;
142 struct hlist_node rlist;
143 #endif
145 #ifdef CONFIG_SYSFS
146 char sysfs_name[IFNAMSIZ];
147 #endif
149 #ifdef CONFIG_NET_POLL_CONTROLLER
150 struct netpoll *np;
151 #endif
154 #define br_port_exists(dev) (dev->priv_flags & IFF_BRIDGE_PORT)
156 static inline struct net_bridge_port *br_port_get_rcu(const struct net_device *dev)
158 struct net_bridge_port *port = rcu_dereference(dev->rx_handler_data);
159 return br_port_exists(dev) ? port : NULL;
162 static inline struct net_bridge_port *br_port_get_rtnl(struct net_device *dev)
164 return br_port_exists(dev) ?
165 rtnl_dereference(dev->rx_handler_data) : NULL;
168 struct br_cpu_netstats {
169 u64 rx_packets;
170 u64 rx_bytes;
171 u64 tx_packets;
172 u64 tx_bytes;
173 struct u64_stats_sync syncp;
176 struct net_bridge
178 spinlock_t lock;
179 struct list_head port_list;
180 struct net_device *dev;
182 struct br_cpu_netstats __percpu *stats;
183 spinlock_t hash_lock;
184 struct hlist_head hash[BR_HASH_SIZE];
185 unsigned long feature_mask;
186 #ifdef CONFIG_BRIDGE_NETFILTER
187 struct rtable fake_rtable;
188 bool nf_call_iptables;
189 bool nf_call_ip6tables;
190 bool nf_call_arptables;
191 #endif
192 unsigned long flags;
193 #define BR_SET_MAC_ADDR 0x00000001
195 /* STP */
196 bridge_id designated_root;
197 bridge_id bridge_id;
198 u32 root_path_cost;
199 unsigned long max_age;
200 unsigned long hello_time;
201 unsigned long forward_delay;
202 unsigned long bridge_max_age;
203 unsigned long ageing_time;
204 unsigned long bridge_hello_time;
205 unsigned long bridge_forward_delay;
207 u8 group_addr[ETH_ALEN];
208 u16 root_port;
210 enum {
211 BR_NO_STP, /* no spanning tree */
212 BR_KERNEL_STP, /* old STP in kernel */
213 BR_USER_STP, /* new RSTP in userspace */
214 } stp_enabled;
216 unsigned char topology_change;
217 unsigned char topology_change_detected;
219 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
220 unsigned char multicast_router;
222 u8 multicast_disabled:1;
224 u32 hash_elasticity;
225 u32 hash_max;
227 u32 multicast_last_member_count;
228 u32 multicast_startup_queries_sent;
229 u32 multicast_startup_query_count;
231 unsigned long multicast_last_member_interval;
232 unsigned long multicast_membership_interval;
233 unsigned long multicast_querier_interval;
234 unsigned long multicast_query_interval;
235 unsigned long multicast_query_response_interval;
236 unsigned long multicast_startup_query_interval;
238 spinlock_t multicast_lock;
239 struct net_bridge_mdb_htable __rcu *mdb;
240 struct hlist_head router_list;
241 struct hlist_head mglist;
243 struct timer_list multicast_router_timer;
244 struct timer_list multicast_querier_timer;
245 struct timer_list multicast_query_timer;
246 #endif
248 struct timer_list hello_timer;
249 struct timer_list tcn_timer;
250 struct timer_list topology_change_timer;
251 struct timer_list gc_timer;
252 struct kobject *ifobj;
255 struct br_input_skb_cb {
256 struct net_device *brdev;
257 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
258 int igmp;
259 int mrouters_only;
260 #endif
263 #define BR_INPUT_SKB_CB(__skb) ((struct br_input_skb_cb *)(__skb)->cb)
265 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
266 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (BR_INPUT_SKB_CB(__skb)->mrouters_only)
267 #else
268 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (0)
269 #endif
271 #define br_printk(level, br, format, args...) \
272 printk(level "%s: " format, (br)->dev->name, ##args)
274 #define br_err(__br, format, args...) \
275 br_printk(KERN_ERR, __br, format, ##args)
276 #define br_warn(__br, format, args...) \
277 br_printk(KERN_WARNING, __br, format, ##args)
278 #define br_notice(__br, format, args...) \
279 br_printk(KERN_NOTICE, __br, format, ##args)
280 #define br_info(__br, format, args...) \
281 br_printk(KERN_INFO, __br, format, ##args)
283 #define br_debug(br, format, args...) \
284 pr_debug("%s: " format, (br)->dev->name, ##args)
286 extern struct notifier_block br_device_notifier;
287 extern const u8 br_group_address[ETH_ALEN];
289 /* called under bridge lock */
290 static inline int br_is_root_bridge(const struct net_bridge *br)
292 return !memcmp(&br->bridge_id, &br->designated_root, 8);
295 /* br_device.c */
296 extern void br_dev_setup(struct net_device *dev);
297 extern netdev_tx_t br_dev_xmit(struct sk_buff *skb,
298 struct net_device *dev);
299 #ifdef CONFIG_NET_POLL_CONTROLLER
300 static inline struct netpoll_info *br_netpoll_info(struct net_bridge *br)
302 return br->dev->npinfo;
305 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
306 struct sk_buff *skb)
308 struct netpoll *np = p->np;
310 if (np)
311 netpoll_send_skb(np, skb);
314 extern int br_netpoll_enable(struct net_bridge_port *p);
315 extern void br_netpoll_disable(struct net_bridge_port *p);
316 #else
317 static inline struct netpoll_info *br_netpoll_info(struct net_bridge *br)
319 return NULL;
322 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
323 struct sk_buff *skb)
327 static inline int br_netpoll_enable(struct net_bridge_port *p)
329 return 0;
332 static inline void br_netpoll_disable(struct net_bridge_port *p)
335 #endif
337 /* br_fdb.c */
338 extern int br_fdb_init(void);
339 extern void br_fdb_fini(void);
340 extern void br_fdb_flush(struct net_bridge *br);
341 extern void br_fdb_changeaddr(struct net_bridge_port *p,
342 const unsigned char *newaddr);
343 extern void br_fdb_cleanup(unsigned long arg);
344 extern void br_fdb_delete_by_port(struct net_bridge *br,
345 const struct net_bridge_port *p, int do_all);
346 extern struct net_bridge_fdb_entry *__br_fdb_get(struct net_bridge *br,
347 const unsigned char *addr);
348 extern int br_fdb_test_addr(struct net_device *dev, unsigned char *addr);
349 extern int br_fdb_fillbuf(struct net_bridge *br, void *buf,
350 unsigned long count, unsigned long off);
351 extern int br_fdb_insert(struct net_bridge *br,
352 struct net_bridge_port *source,
353 const unsigned char *addr);
354 extern void br_fdb_update(struct net_bridge *br,
355 struct net_bridge_port *source,
356 const unsigned char *addr);
358 /* br_forward.c */
359 extern void br_deliver(const struct net_bridge_port *to,
360 struct sk_buff *skb);
361 extern int br_dev_queue_push_xmit(struct sk_buff *skb);
362 extern void br_forward(const struct net_bridge_port *to,
363 struct sk_buff *skb, struct sk_buff *skb0);
364 extern int br_forward_finish(struct sk_buff *skb);
365 extern void br_flood_deliver(struct net_bridge *br, struct sk_buff *skb);
366 extern void br_flood_forward(struct net_bridge *br, struct sk_buff *skb,
367 struct sk_buff *skb2);
369 /* br_if.c */
370 extern void br_port_carrier_check(struct net_bridge_port *p);
371 extern int br_add_bridge(struct net *net, const char *name);
372 extern int br_del_bridge(struct net *net, const char *name);
373 extern void br_net_exit(struct net *net);
374 extern int br_add_if(struct net_bridge *br,
375 struct net_device *dev);
376 extern int br_del_if(struct net_bridge *br,
377 struct net_device *dev);
378 extern int br_min_mtu(const struct net_bridge *br);
379 extern void br_features_recompute(struct net_bridge *br);
381 /* br_input.c */
382 extern int br_handle_frame_finish(struct sk_buff *skb);
383 extern struct sk_buff *br_handle_frame(struct sk_buff *skb);
385 /* br_ioctl.c */
386 extern int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
387 extern int br_ioctl_deviceless_stub(struct net *net, unsigned int cmd, void __user *arg);
389 /* br_multicast.c */
390 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
391 extern int br_multicast_rcv(struct net_bridge *br,
392 struct net_bridge_port *port,
393 struct sk_buff *skb);
394 extern struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
395 struct sk_buff *skb);
396 extern void br_multicast_add_port(struct net_bridge_port *port);
397 extern void br_multicast_del_port(struct net_bridge_port *port);
398 extern void br_multicast_enable_port(struct net_bridge_port *port);
399 extern void br_multicast_disable_port(struct net_bridge_port *port);
400 extern void br_multicast_init(struct net_bridge *br);
401 extern void br_multicast_open(struct net_bridge *br);
402 extern void br_multicast_stop(struct net_bridge *br);
403 extern void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
404 struct sk_buff *skb);
405 extern void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
406 struct sk_buff *skb, struct sk_buff *skb2);
407 extern int br_multicast_set_router(struct net_bridge *br, unsigned long val);
408 extern int br_multicast_set_port_router(struct net_bridge_port *p,
409 unsigned long val);
410 extern int br_multicast_toggle(struct net_bridge *br, unsigned long val);
411 extern int br_multicast_set_hash_max(struct net_bridge *br, unsigned long val);
413 static inline bool br_multicast_is_router(struct net_bridge *br)
415 return br->multicast_router == 2 ||
416 (br->multicast_router == 1 &&
417 timer_pending(&br->multicast_router_timer));
419 #else
420 static inline int br_multicast_rcv(struct net_bridge *br,
421 struct net_bridge_port *port,
422 struct sk_buff *skb)
424 return 0;
427 static inline struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
428 struct sk_buff *skb)
430 return NULL;
433 static inline void br_multicast_add_port(struct net_bridge_port *port)
437 static inline void br_multicast_del_port(struct net_bridge_port *port)
441 static inline void br_multicast_enable_port(struct net_bridge_port *port)
445 static inline void br_multicast_disable_port(struct net_bridge_port *port)
449 static inline void br_multicast_init(struct net_bridge *br)
453 static inline void br_multicast_open(struct net_bridge *br)
457 static inline void br_multicast_stop(struct net_bridge *br)
461 static inline void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
462 struct sk_buff *skb)
466 static inline void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
467 struct sk_buff *skb,
468 struct sk_buff *skb2)
471 static inline bool br_multicast_is_router(struct net_bridge *br)
473 return 0;
475 #endif
477 /* br_netfilter.c */
478 #ifdef CONFIG_BRIDGE_NETFILTER
479 extern int br_netfilter_init(void);
480 extern void br_netfilter_fini(void);
481 extern void br_netfilter_rtable_init(struct net_bridge *);
482 #else
483 #define br_netfilter_init() (0)
484 #define br_netfilter_fini() do { } while(0)
485 #define br_netfilter_rtable_init(x)
486 #endif
488 /* br_stp.c */
489 extern void br_log_state(const struct net_bridge_port *p);
490 extern struct net_bridge_port *br_get_port(struct net_bridge *br,
491 u16 port_no);
492 extern void br_init_port(struct net_bridge_port *p);
493 extern void br_become_designated_port(struct net_bridge_port *p);
495 /* br_stp_if.c */
496 extern void br_stp_enable_bridge(struct net_bridge *br);
497 extern void br_stp_disable_bridge(struct net_bridge *br);
498 extern void br_stp_set_enabled(struct net_bridge *br, unsigned long val);
499 extern void br_stp_enable_port(struct net_bridge_port *p);
500 extern void br_stp_disable_port(struct net_bridge_port *p);
501 extern void br_stp_recalculate_bridge_id(struct net_bridge *br);
502 extern void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
503 extern void br_stp_set_bridge_priority(struct net_bridge *br,
504 u16 newprio);
505 extern void br_stp_set_port_priority(struct net_bridge_port *p,
506 u8 newprio);
507 extern void br_stp_set_path_cost(struct net_bridge_port *p,
508 u32 path_cost);
509 extern ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);
511 /* br_stp_bpdu.c */
512 struct stp_proto;
513 extern void br_stp_rcv(const struct stp_proto *proto, struct sk_buff *skb,
514 struct net_device *dev);
516 /* br_stp_timer.c */
517 extern void br_stp_timer_init(struct net_bridge *br);
518 extern void br_stp_port_timer_init(struct net_bridge_port *p);
519 extern unsigned long br_timer_value(const struct timer_list *timer);
521 /* br.c */
522 #if defined(CONFIG_ATM_LANE) || defined(CONFIG_ATM_LANE_MODULE)
523 extern int (*br_fdb_test_addr_hook)(struct net_device *dev, unsigned char *addr);
524 #endif
526 /* br_netlink.c */
527 extern int br_netlink_init(void);
528 extern void br_netlink_fini(void);
529 extern void br_ifinfo_notify(int event, struct net_bridge_port *port);
531 #ifdef CONFIG_SYSFS
532 /* br_sysfs_if.c */
533 extern const struct sysfs_ops brport_sysfs_ops;
534 extern int br_sysfs_addif(struct net_bridge_port *p);
535 extern int br_sysfs_renameif(struct net_bridge_port *p);
537 /* br_sysfs_br.c */
538 extern int br_sysfs_addbr(struct net_device *dev);
539 extern void br_sysfs_delbr(struct net_device *dev);
541 #else
543 #define br_sysfs_addif(p) (0)
544 #define br_sysfs_renameif(p) (0)
545 #define br_sysfs_addbr(dev) (0)
546 #define br_sysfs_delbr(dev) do { } while(0)
547 #endif /* CONFIG_SYSFS */
549 #endif