bridge: add template for bridge port flags
[deliverable/linux.git] / net / bridge / br_private.h
CommitLineData
1da177e4
LT
1/*
2 * Linux ethernet bridge
3 *
4 * Authors:
5 * Lennert Buytenhek <buytenh@gnu.org>
6 *
1da177e4
LT
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.
11 */
12
13#ifndef _BR_PRIVATE_H
14#define _BR_PRIVATE_H
15
16#include <linux/netdevice.h>
1da177e4 17#include <linux/if_bridge.h>
91d2c34a 18#include <linux/netpoll.h>
406818ff 19#include <linux/u64_stats_sync.h>
4adf0af6 20#include <net/route.h>
1da177e4
LT
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
9cde0708
SH
30#define BR_VERSION "2.3"
31
515853cc 32/* Control of forwarding link local multicast */
33#define BR_GROUPFWD_DEFAULT 0
34/* Don't allow forwarding control protocols like STP and LLDP */
35#define BR_GROUPFWD_RESTRICTED 0x4007u
36
9cde0708
SH
37/* Path to usermode spanning tree program */
38#define BR_STP_PROG "/sbin/bridge-stp"
8cbb512e 39
1da177e4
LT
40typedef struct bridge_id bridge_id;
41typedef struct mac_addr mac_addr;
42typedef __u16 port_id;
43
44struct bridge_id
45{
46 unsigned char prio[2];
47 unsigned char addr[6];
48};
49
50struct mac_addr
51{
52 unsigned char addr[6];
53};
54
8ef2a9a5
YH
55struct br_ip
56{
57 union {
58 __be32 ip4;
dfd56b8b 59#if IS_ENABLED(CONFIG_IPV6)
08b202b6
YH
60 struct in6_addr ip6;
61#endif
8ef2a9a5
YH
62 } u;
63 __be16 proto;
64};
65
1da177e4
LT
66struct net_bridge_fdb_entry
67{
68 struct hlist_node hlist;
69 struct net_bridge_port *dst;
70
71 struct rcu_head rcu;
7cd8861a 72 unsigned long updated;
73 unsigned long used;
1da177e4
LT
74 mac_addr addr;
75 unsigned char is_local;
76 unsigned char is_static;
77};
78
eb1d1641
HX
79struct net_bridge_port_group {
80 struct net_bridge_port *port;
e8051688 81 struct net_bridge_port_group __rcu *next;
eb1d1641
HX
82 struct hlist_node mglist;
83 struct rcu_head rcu;
84 struct timer_list timer;
8ef2a9a5 85 struct br_ip addr;
eb1d1641
HX
86};
87
88struct net_bridge_mdb_entry
89{
90 struct hlist_node hlist[2];
eb1d1641 91 struct net_bridge *br;
e8051688 92 struct net_bridge_port_group __rcu *ports;
eb1d1641
HX
93 struct rcu_head rcu;
94 struct timer_list timer;
8ef2a9a5 95 struct br_ip addr;
8a870178 96 bool mglist;
eb1d1641
HX
97};
98
99struct net_bridge_mdb_htable
100{
101 struct hlist_head *mhash;
102 struct rcu_head rcu;
103 struct net_bridge_mdb_htable *old;
104 u32 size;
105 u32 max;
106 u32 secret;
107 u32 ver;
108};
109
1da177e4
LT
110struct net_bridge_port
111{
112 struct net_bridge *br;
113 struct net_device *dev;
114 struct list_head list;
115
116 /* STP */
117 u8 priority;
118 u8 state;
119 u16 port_no;
120 unsigned char topology_change_ack;
121 unsigned char config_pending;
122 port_id port_id;
123 port_id designated_port;
124 bridge_id designated_root;
125 bridge_id designated_bridge;
126 u32 path_cost;
127 u32 designated_cost;
0c03150e 128 unsigned long designated_age;
1da177e4
LT
129
130 struct timer_list forward_delay_timer;
131 struct timer_list hold_timer;
132 struct timer_list message_age_timer;
133 struct kobject kobj;
134 struct rcu_head rcu;
3982d3d2
FA
135
136 unsigned long flags;
137#define BR_HAIRPIN_MODE 0x00000001
eb1d1641
HX
138
139#ifdef CONFIG_BRIDGE_IGMP_SNOOPING
140 u32 multicast_startup_queries_sent;
141 unsigned char multicast_router;
142 struct timer_list multicast_router_timer;
143 struct timer_list multicast_query_timer;
144 struct hlist_head mglist;
145 struct hlist_node rlist;
146#endif
e0f43752
SA
147
148#ifdef CONFIG_SYSFS
149 char sysfs_name[IFNAMSIZ];
150#endif
91d2c34a
HX
151
152#ifdef CONFIG_NET_POLL_CONTROLLER
153 struct netpoll *np;
154#endif
1da177e4
LT
155};
156
f350a0a8
JP
157#define br_port_exists(dev) (dev->priv_flags & IFF_BRIDGE_PORT)
158
b5ed54e9 159static inline struct net_bridge_port *br_port_get_rcu(const struct net_device *dev)
160{
2469ffd7
JF
161 struct net_bridge_port *port =
162 rcu_dereference_rtnl(dev->rx_handler_data);
163
b5ed54e9 164 return br_port_exists(dev) ? port : NULL;
165}
166
ec1e5610 167static inline struct net_bridge_port *br_port_get_rtnl(struct net_device *dev)
b5ed54e9 168{
ec1e5610
ED
169 return br_port_exists(dev) ?
170 rtnl_dereference(dev->rx_handler_data) : NULL;
b5ed54e9 171}
172
0eae88f3 173struct br_cpu_netstats {
406818ff
ED
174 u64 rx_packets;
175 u64 rx_bytes;
176 u64 tx_packets;
177 u64 tx_bytes;
178 struct u64_stats_sync syncp;
0eae88f3
ED
179};
180
1da177e4
LT
181struct net_bridge
182{
183 spinlock_t lock;
184 struct list_head port_list;
185 struct net_device *dev;
14bb4789 186
0eae88f3 187 struct br_cpu_netstats __percpu *stats;
1da177e4
LT
188 spinlock_t hash_lock;
189 struct hlist_head hash[BR_HASH_SIZE];
4adf0af6
SW
190#ifdef CONFIG_BRIDGE_NETFILTER
191 struct rtable fake_rtable;
4df53d8b
PM
192 bool nf_call_iptables;
193 bool nf_call_ip6tables;
194 bool nf_call_arptables;
4adf0af6 195#endif
92c0574f
SH
196 unsigned long flags;
197#define BR_SET_MAC_ADDR 0x00000001
1da177e4 198
515853cc 199 u16 group_fwd_mask;
200
1da177e4
LT
201 /* STP */
202 bridge_id designated_root;
203 bridge_id bridge_id;
204 u32 root_path_cost;
205 unsigned long max_age;
206 unsigned long hello_time;
207 unsigned long forward_delay;
208 unsigned long bridge_max_age;
209 unsigned long ageing_time;
210 unsigned long bridge_hello_time;
211 unsigned long bridge_forward_delay;
212
fda93d92 213 u8 group_addr[ETH_ALEN];
1da177e4 214 u16 root_port;
9cde0708
SH
215
216 enum {
217 BR_NO_STP, /* no spanning tree */
218 BR_KERNEL_STP, /* old STP in kernel */
219 BR_USER_STP, /* new RSTP in userspace */
220 } stp_enabled;
221
1da177e4
LT
222 unsigned char topology_change;
223 unsigned char topology_change_detected;
224
eb1d1641
HX
225#ifdef CONFIG_BRIDGE_IGMP_SNOOPING
226 unsigned char multicast_router;
227
228 u8 multicast_disabled:1;
c5c23260 229 u8 multicast_querier:1;
eb1d1641
HX
230
231 u32 hash_elasticity;
232 u32 hash_max;
233
234 u32 multicast_last_member_count;
235 u32 multicast_startup_queries_sent;
236 u32 multicast_startup_query_count;
237
238 unsigned long multicast_last_member_interval;
239 unsigned long multicast_membership_interval;
240 unsigned long multicast_querier_interval;
241 unsigned long multicast_query_interval;
242 unsigned long multicast_query_response_interval;
243 unsigned long multicast_startup_query_interval;
244
245 spinlock_t multicast_lock;
e8051688 246 struct net_bridge_mdb_htable __rcu *mdb;
eb1d1641 247 struct hlist_head router_list;
eb1d1641
HX
248
249 struct timer_list multicast_router_timer;
250 struct timer_list multicast_querier_timer;
251 struct timer_list multicast_query_timer;
252#endif
253
1da177e4
LT
254 struct timer_list hello_timer;
255 struct timer_list tcn_timer;
256 struct timer_list topology_change_timer;
257 struct timer_list gc_timer;
43b98c4a 258 struct kobject *ifobj;
1da177e4
LT
259};
260
68b7c895
HX
261struct br_input_skb_cb {
262 struct net_device *brdev;
32dec5dd 263#ifdef CONFIG_BRIDGE_IGMP_SNOOPING
eb1d1641
HX
264 int igmp;
265 int mrouters_only;
32dec5dd 266#endif
68b7c895
HX
267};
268
269#define BR_INPUT_SKB_CB(__skb) ((struct br_input_skb_cb *)(__skb)->cb)
270
32dec5dd
YH
271#ifdef CONFIG_BRIDGE_IGMP_SNOOPING
272# define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (BR_INPUT_SKB_CB(__skb)->mrouters_only)
273#else
274# define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (0)
275#endif
276
28a16c97 277#define br_printk(level, br, format, args...) \
278 printk(level "%s: " format, (br)->dev->name, ##args)
279
280#define br_err(__br, format, args...) \
281 br_printk(KERN_ERR, __br, format, ##args)
282#define br_warn(__br, format, args...) \
283 br_printk(KERN_WARNING, __br, format, ##args)
284#define br_notice(__br, format, args...) \
285 br_printk(KERN_NOTICE, __br, format, ##args)
286#define br_info(__br, format, args...) \
287 br_printk(KERN_INFO, __br, format, ##args)
288
289#define br_debug(br, format, args...) \
290 pr_debug("%s: " format, (br)->dev->name, ##args)
291
1da177e4 292extern struct notifier_block br_device_notifier;
1da177e4
LT
293
294/* called under bridge lock */
295static inline int br_is_root_bridge(const struct net_bridge *br)
296{
297 return !memcmp(&br->bridge_id, &br->designated_root, 8);
298}
299
1da177e4
LT
300/* br_device.c */
301extern void br_dev_setup(struct net_device *dev);
1ce5cce8 302extern void br_dev_delete(struct net_device *dev, struct list_head *list);
6fef4c0c
SH
303extern netdev_tx_t br_dev_xmit(struct sk_buff *skb,
304 struct net_device *dev);
cfb478da 305#ifdef CONFIG_NET_POLL_CONTROLLER
91d2c34a
HX
306static inline struct netpoll_info *br_netpoll_info(struct net_bridge *br)
307{
308 return br->dev->npinfo;
309}
310
311static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
312 struct sk_buff *skb)
313{
314 struct netpoll *np = p->np;
315
316 if (np)
317 netpoll_send_skb(np, skb);
318}
319
47be03a2 320extern int br_netpoll_enable(struct net_bridge_port *p, gfp_t gfp);
91d2c34a 321extern void br_netpoll_disable(struct net_bridge_port *p);
cfb478da 322#else
91d2c34a
HX
323static inline struct netpoll_info *br_netpoll_info(struct net_bridge *br)
324{
325 return NULL;
326}
327
9f70b0fc 328static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
91d2c34a
HX
329 struct sk_buff *skb)
330{
331}
cfb478da 332
47be03a2 333static inline int br_netpoll_enable(struct net_bridge_port *p, gfp_t gfp)
91d2c34a
HX
334{
335 return 0;
336}
337
338static inline void br_netpoll_disable(struct net_bridge_port *p)
339{
340}
cfb478da 341#endif
1da177e4
LT
342
343/* br_fdb.c */
87a596e0 344extern int br_fdb_init(void);
1da177e4 345extern void br_fdb_fini(void);
9cf63747 346extern void br_fdb_flush(struct net_bridge *br);
1da177e4
LT
347extern void br_fdb_changeaddr(struct net_bridge_port *p,
348 const unsigned char *newaddr);
43598813 349extern void br_fdb_change_mac_address(struct net_bridge *br, const u8 *newaddr);
1da177e4
LT
350extern void br_fdb_cleanup(unsigned long arg);
351extern void br_fdb_delete_by_port(struct net_bridge *br,
1a620698 352 const struct net_bridge_port *p, int do_all);
1da177e4
LT
353extern struct net_bridge_fdb_entry *__br_fdb_get(struct net_bridge *br,
354 const unsigned char *addr);
da678292 355extern int br_fdb_test_addr(struct net_device *dev, unsigned char *addr);
9d6f229f 356extern int br_fdb_fillbuf(struct net_bridge *br, void *buf,
1da177e4
LT
357 unsigned long count, unsigned long off);
358extern int br_fdb_insert(struct net_bridge *br,
359 struct net_bridge_port *source,
360 const unsigned char *addr);
361extern void br_fdb_update(struct net_bridge *br,
362 struct net_bridge_port *source,
363 const unsigned char *addr);
77162022
JF
364
365extern int br_fdb_delete(struct ndmsg *ndm,
366 struct net_device *dev,
6b6e2725 367 const unsigned char *addr);
edc7d573 368extern int br_fdb_add(struct ndmsg *nlh, struct nlattr *tb[],
77162022 369 struct net_device *dev,
6b6e2725 370 const unsigned char *addr,
77162022
JF
371 u16 nlh_flags);
372extern int br_fdb_dump(struct sk_buff *skb,
373 struct netlink_callback *cb,
374 struct net_device *dev,
375 int idx);
1da177e4
LT
376
377/* br_forward.c */
378extern void br_deliver(const struct net_bridge_port *to,
379 struct sk_buff *skb);
380extern int br_dev_queue_push_xmit(struct sk_buff *skb);
381extern void br_forward(const struct net_bridge_port *to,
7f7708f0 382 struct sk_buff *skb, struct sk_buff *skb0);
1da177e4 383extern int br_forward_finish(struct sk_buff *skb);
e081e1e3 384extern void br_flood_deliver(struct net_bridge *br, struct sk_buff *skb);
b33084be
HX
385extern void br_flood_forward(struct net_bridge *br, struct sk_buff *skb,
386 struct sk_buff *skb2);
1da177e4
LT
387
388/* br_if.c */
269def7c 389extern void br_port_carrier_check(struct net_bridge_port *p);
4aa678ba
AD
390extern int br_add_bridge(struct net *net, const char *name);
391extern int br_del_bridge(struct net *net, const char *name);
712d6954 392extern void br_net_exit(struct net *net);
1da177e4
LT
393extern int br_add_if(struct net_bridge *br,
394 struct net_device *dev);
395extern int br_del_if(struct net_bridge *br,
396 struct net_device *dev);
397extern int br_min_mtu(const struct net_bridge *br);
c8f44aff
MM
398extern netdev_features_t br_features_recompute(struct net_bridge *br,
399 netdev_features_t features);
1da177e4
LT
400
401/* br_input.c */
402extern int br_handle_frame_finish(struct sk_buff *skb);
8a4eb573 403extern rx_handler_result_t br_handle_frame(struct sk_buff **pskb);
1da177e4
LT
404
405/* br_ioctl.c */
406extern int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
881d966b 407extern int br_ioctl_deviceless_stub(struct net *net, unsigned int cmd, void __user *arg);
1da177e4 408
eb1d1641
HX
409/* br_multicast.c */
410#ifdef CONFIG_BRIDGE_IGMP_SNOOPING
411extern int br_multicast_rcv(struct net_bridge *br,
412 struct net_bridge_port *port,
413 struct sk_buff *skb);
414extern struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
415 struct sk_buff *skb);
416extern void br_multicast_add_port(struct net_bridge_port *port);
417extern void br_multicast_del_port(struct net_bridge_port *port);
418extern void br_multicast_enable_port(struct net_bridge_port *port);
419extern void br_multicast_disable_port(struct net_bridge_port *port);
420extern void br_multicast_init(struct net_bridge *br);
421extern void br_multicast_open(struct net_bridge *br);
422extern void br_multicast_stop(struct net_bridge *br);
5cb5e947
HX
423extern void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
424 struct sk_buff *skb);
425extern void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
426 struct sk_buff *skb, struct sk_buff *skb2);
0909e117
HX
427extern int br_multicast_set_router(struct net_bridge *br, unsigned long val);
428extern int br_multicast_set_port_router(struct net_bridge_port *p,
429 unsigned long val);
561f1103 430extern int br_multicast_toggle(struct net_bridge *br, unsigned long val);
c5c23260 431extern int br_multicast_set_querier(struct net_bridge *br, unsigned long val);
b195167f 432extern int br_multicast_set_hash_max(struct net_bridge *br, unsigned long val);
85b35269
SS
433
434static inline bool br_multicast_is_router(struct net_bridge *br)
435{
436 return br->multicast_router == 2 ||
437 (br->multicast_router == 1 &&
438 timer_pending(&br->multicast_router_timer));
439}
eb1d1641
HX
440#else
441static inline int br_multicast_rcv(struct net_bridge *br,
442 struct net_bridge_port *port,
443 struct sk_buff *skb)
444{
445 return 0;
446}
447
448static inline struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
449 struct sk_buff *skb)
450{
451 return NULL;
452}
453
454static inline void br_multicast_add_port(struct net_bridge_port *port)
455{
456}
457
458static inline void br_multicast_del_port(struct net_bridge_port *port)
459{
460}
461
462static inline void br_multicast_enable_port(struct net_bridge_port *port)
463{
464}
465
466static inline void br_multicast_disable_port(struct net_bridge_port *port)
467{
468}
469
470static inline void br_multicast_init(struct net_bridge *br)
471{
472}
473
474static inline void br_multicast_open(struct net_bridge *br)
475{
476}
477
478static inline void br_multicast_stop(struct net_bridge *br)
479{
480}
5cb5e947
HX
481
482static inline void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
483 struct sk_buff *skb)
484{
485}
486
487static inline void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
488 struct sk_buff *skb,
489 struct sk_buff *skb2)
490{
491}
eb1d1641
HX
492static inline bool br_multicast_is_router(struct net_bridge *br)
493{
85b35269 494 return 0;
eb1d1641 495}
85b35269 496#endif
eb1d1641 497
1da177e4 498/* br_netfilter.c */
c0909713 499#ifdef CONFIG_BRIDGE_NETFILTER
1da177e4
LT
500extern int br_netfilter_init(void);
501extern void br_netfilter_fini(void);
4adf0af6 502extern void br_netfilter_rtable_init(struct net_bridge *);
c0909713
SH
503#else
504#define br_netfilter_init() (0)
505#define br_netfilter_fini() do { } while(0)
4adf0af6 506#define br_netfilter_rtable_init(x)
c0909713 507#endif
1da177e4
LT
508
509/* br_stp.c */
510extern void br_log_state(const struct net_bridge_port *p);
511extern struct net_bridge_port *br_get_port(struct net_bridge *br,
9d6f229f 512 u16 port_no);
1da177e4
LT
513extern void br_init_port(struct net_bridge_port *p);
514extern void br_become_designated_port(struct net_bridge_port *p);
515
14f98f25 516extern int br_set_forward_delay(struct net_bridge *br, unsigned long x);
517extern int br_set_hello_time(struct net_bridge *br, unsigned long x);
518extern int br_set_max_age(struct net_bridge *br, unsigned long x);
519
520
1da177e4
LT
521/* br_stp_if.c */
522extern void br_stp_enable_bridge(struct net_bridge *br);
523extern void br_stp_disable_bridge(struct net_bridge *br);
9cde0708 524extern void br_stp_set_enabled(struct net_bridge *br, unsigned long val);
1da177e4
LT
525extern void br_stp_enable_port(struct net_bridge_port *p);
526extern void br_stp_disable_port(struct net_bridge_port *p);
edf947f1 527extern bool br_stp_recalculate_bridge_id(struct net_bridge *br);
4505a3ef 528extern void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
1da177e4
LT
529extern void br_stp_set_bridge_priority(struct net_bridge *br,
530 u16 newprio);
14f98f25 531extern int br_stp_set_port_priority(struct net_bridge_port *p,
532 unsigned long newprio);
533extern int br_stp_set_path_cost(struct net_bridge_port *p,
534 unsigned long path_cost);
1da177e4
LT
535extern ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);
536
537/* br_stp_bpdu.c */
7c85fbf0
PM
538struct stp_proto;
539extern void br_stp_rcv(const struct stp_proto *proto, struct sk_buff *skb,
540 struct net_device *dev);
1da177e4
LT
541
542/* br_stp_timer.c */
543extern void br_stp_timer_init(struct net_bridge *br);
544extern void br_stp_port_timer_init(struct net_bridge_port *p);
545extern unsigned long br_timer_value(const struct timer_list *timer);
546
547/* br.c */
e6373c4c 548#if IS_ENABLED(CONFIG_ATM_LANE)
da678292
MM
549extern int (*br_fdb_test_addr_hook)(struct net_device *dev, unsigned char *addr);
550#endif
1da177e4 551
11dc1f36 552/* br_netlink.c */
149ddd83 553extern struct rtnl_link_ops br_link_ops;
32fe21c0 554extern int br_netlink_init(void);
11dc1f36
SH
555extern void br_netlink_fini(void);
556extern void br_ifinfo_notify(int event, struct net_bridge_port *port);
e5a55a89
JF
557extern int br_setlink(struct net_device *dev, struct nlmsghdr *nlmsg);
558extern int br_getlink(struct sk_buff *skb, u32 pid, u32 seq,
559 struct net_device *dev);
11dc1f36 560
1da177e4
LT
561#ifdef CONFIG_SYSFS
562/* br_sysfs_if.c */
52cf25d0 563extern const struct sysfs_ops brport_sysfs_ops;
1da177e4 564extern int br_sysfs_addif(struct net_bridge_port *p);
e0f43752 565extern int br_sysfs_renameif(struct net_bridge_port *p);
1da177e4
LT
566
567/* br_sysfs_br.c */
568extern int br_sysfs_addbr(struct net_device *dev);
569extern void br_sysfs_delbr(struct net_device *dev);
570
571#else
572
0cb2bbbe
LJ
573static inline int br_sysfs_addif(struct net_bridge_port *p) { return 0; }
574static inline int br_sysfs_renameif(struct net_bridge_port *p) { return 0; }
575static inline int br_sysfs_addbr(struct net_device *dev) { return 0; }
576static inline void br_sysfs_delbr(struct net_device *dev) { return; }
1da177e4
LT
577#endif /* CONFIG_SYSFS */
578
579#endif
This page took 0.720808 seconds and 5 git commands to generate.