2 * Linux ethernet bridge
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.
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>
21 #include <linux/if_vlan.h>
23 #define BR_HASH_BITS 8
24 #define BR_HASH_SIZE (1 << BR_HASH_BITS)
26 #define BR_HOLD_TIME (1*HZ)
28 #define BR_PORT_BITS 10
29 #define BR_MAX_PORTS (1<<BR_PORT_BITS)
30 #define BR_VLAN_BITMAP_LEN BITS_TO_LONGS(VLAN_N_VID)
32 #define BR_VERSION "2.3"
34 /* Control of forwarding link local multicast */
35 #define BR_GROUPFWD_DEFAULT 0
36 /* Don't allow forwarding control protocols like STP and LLDP */
37 #define BR_GROUPFWD_RESTRICTED 0x4007u
39 /* Path to usermode spanning tree program */
40 #define BR_STP_PROG "/sbin/bridge-stp"
42 typedef struct bridge_id bridge_id;
43 typedef struct mac_addr mac_addr;
44 typedef __u16 port_id;
48 unsigned char prio[2];
49 unsigned char addr[6];
54 unsigned char addr[6];
61 #if IS_ENABLED(CONFIG_IPV6)
68 struct net_port_vlans {
71 struct net_bridge_port *port;
72 struct net_bridge *br;
75 unsigned long vlan_bitmap[BR_VLAN_BITMAP_LEN];
78 struct net_bridge_fdb_entry
80 struct hlist_node hlist;
81 struct net_bridge_port *dst;
84 unsigned long updated;
87 unsigned char is_local;
88 unsigned char is_static;
91 struct net_bridge_port_group {
92 struct net_bridge_port *port;
93 struct net_bridge_port_group __rcu *next;
94 struct hlist_node mglist;
96 struct timer_list timer;
101 struct net_bridge_mdb_entry
103 struct hlist_node hlist[2];
104 struct net_bridge *br;
105 struct net_bridge_port_group __rcu *ports;
107 struct timer_list timer;
112 struct net_bridge_mdb_htable
114 struct hlist_head *mhash;
116 struct net_bridge_mdb_htable *old;
123 struct net_bridge_port
125 struct net_bridge *br;
126 struct net_device *dev;
127 struct list_head list;
133 unsigned char topology_change_ack;
134 unsigned char config_pending;
136 port_id designated_port;
137 bridge_id designated_root;
138 bridge_id designated_bridge;
141 unsigned long designated_age;
143 struct timer_list forward_delay_timer;
144 struct timer_list hold_timer;
145 struct timer_list message_age_timer;
150 #define BR_HAIRPIN_MODE 0x00000001
151 #define BR_BPDU_GUARD 0x00000002
152 #define BR_ROOT_BLOCK 0x00000004
153 #define BR_MULTICAST_FAST_LEAVE 0x00000008
155 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
156 u32 multicast_startup_queries_sent;
157 unsigned char multicast_router;
158 struct timer_list multicast_router_timer;
159 struct timer_list multicast_query_timer;
160 struct hlist_head mglist;
161 struct hlist_node rlist;
165 char sysfs_name[IFNAMSIZ];
168 #ifdef CONFIG_NET_POLL_CONTROLLER
171 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
172 struct net_port_vlans __rcu *vlan_info;
176 #define br_port_exists(dev) (dev->priv_flags & IFF_BRIDGE_PORT)
178 static inline struct net_bridge_port *br_port_get_rcu(const struct net_device *dev)
180 struct net_bridge_port *port =
181 rcu_dereference_rtnl(dev->rx_handler_data);
183 return br_port_exists(dev) ? port : NULL;
186 static inline struct net_bridge_port *br_port_get_rtnl(struct net_device *dev)
188 return br_port_exists(dev) ?
189 rtnl_dereference(dev->rx_handler_data) : NULL;
192 struct br_cpu_netstats {
197 struct u64_stats_sync syncp;
203 struct list_head port_list;
204 struct net_device *dev;
206 struct br_cpu_netstats __percpu *stats;
207 spinlock_t hash_lock;
208 struct hlist_head hash[BR_HASH_SIZE];
209 #ifdef CONFIG_BRIDGE_NETFILTER
210 struct rtable fake_rtable;
211 bool nf_call_iptables;
212 bool nf_call_ip6tables;
213 bool nf_call_arptables;
218 bridge_id designated_root;
221 unsigned long max_age;
222 unsigned long hello_time;
223 unsigned long forward_delay;
224 unsigned long bridge_max_age;
225 unsigned long ageing_time;
226 unsigned long bridge_hello_time;
227 unsigned long bridge_forward_delay;
229 u8 group_addr[ETH_ALEN];
233 BR_NO_STP, /* no spanning tree */
234 BR_KERNEL_STP, /* old STP in kernel */
235 BR_USER_STP, /* new RSTP in userspace */
238 unsigned char topology_change;
239 unsigned char topology_change_detected;
241 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
242 unsigned char multicast_router;
244 u8 multicast_disabled:1;
245 u8 multicast_querier:1;
250 u32 multicast_last_member_count;
251 u32 multicast_startup_queries_sent;
252 u32 multicast_startup_query_count;
254 unsigned long multicast_last_member_interval;
255 unsigned long multicast_membership_interval;
256 unsigned long multicast_querier_interval;
257 unsigned long multicast_query_interval;
258 unsigned long multicast_query_response_interval;
259 unsigned long multicast_startup_query_interval;
261 spinlock_t multicast_lock;
262 struct net_bridge_mdb_htable __rcu *mdb;
263 struct hlist_head router_list;
265 struct timer_list multicast_router_timer;
266 struct timer_list multicast_querier_timer;
267 struct timer_list multicast_query_timer;
270 struct timer_list hello_timer;
271 struct timer_list tcn_timer;
272 struct timer_list topology_change_timer;
273 struct timer_list gc_timer;
274 struct kobject *ifobj;
275 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
277 struct net_port_vlans __rcu *vlan_info;
281 struct br_input_skb_cb {
282 struct net_device *brdev;
283 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
289 #define BR_INPUT_SKB_CB(__skb) ((struct br_input_skb_cb *)(__skb)->cb)
291 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
292 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (BR_INPUT_SKB_CB(__skb)->mrouters_only)
294 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (0)
297 #define br_printk(level, br, format, args...) \
298 printk(level "%s: " format, (br)->dev->name, ##args)
300 #define br_err(__br, format, args...) \
301 br_printk(KERN_ERR, __br, format, ##args)
302 #define br_warn(__br, format, args...) \
303 br_printk(KERN_WARNING, __br, format, ##args)
304 #define br_notice(__br, format, args...) \
305 br_printk(KERN_NOTICE, __br, format, ##args)
306 #define br_info(__br, format, args...) \
307 br_printk(KERN_INFO, __br, format, ##args)
309 #define br_debug(br, format, args...) \
310 pr_debug("%s: " format, (br)->dev->name, ##args)
312 extern struct notifier_block br_device_notifier;
314 /* called under bridge lock */
315 static inline int br_is_root_bridge(const struct net_bridge *br)
317 return !memcmp(&br->bridge_id, &br->designated_root, 8);
321 extern void br_dev_setup(struct net_device *dev);
322 extern void br_dev_delete(struct net_device *dev, struct list_head *list);
323 extern netdev_tx_t br_dev_xmit(struct sk_buff *skb,
324 struct net_device *dev);
325 #ifdef CONFIG_NET_POLL_CONTROLLER
326 static inline struct netpoll_info *br_netpoll_info(struct net_bridge *br)
328 return br->dev->npinfo;
331 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
334 struct netpoll *np = p->np;
337 netpoll_send_skb(np, skb);
340 extern int br_netpoll_enable(struct net_bridge_port *p, gfp_t gfp);
341 extern void br_netpoll_disable(struct net_bridge_port *p);
343 static inline struct netpoll_info *br_netpoll_info(struct net_bridge *br)
348 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
353 static inline int br_netpoll_enable(struct net_bridge_port *p, gfp_t gfp)
358 static inline void br_netpoll_disable(struct net_bridge_port *p)
364 extern int br_fdb_init(void);
365 extern void br_fdb_fini(void);
366 extern void br_fdb_flush(struct net_bridge *br);
367 extern void br_fdb_changeaddr(struct net_bridge_port *p,
368 const unsigned char *newaddr);
369 extern void br_fdb_change_mac_address(struct net_bridge *br, const u8 *newaddr);
370 extern void br_fdb_cleanup(unsigned long arg);
371 extern void br_fdb_delete_by_port(struct net_bridge *br,
372 const struct net_bridge_port *p, int do_all);
373 extern struct net_bridge_fdb_entry *__br_fdb_get(struct net_bridge *br,
374 const unsigned char *addr);
375 extern int br_fdb_test_addr(struct net_device *dev, unsigned char *addr);
376 extern int br_fdb_fillbuf(struct net_bridge *br, void *buf,
377 unsigned long count, unsigned long off);
378 extern int br_fdb_insert(struct net_bridge *br,
379 struct net_bridge_port *source,
380 const unsigned char *addr);
381 extern void br_fdb_update(struct net_bridge *br,
382 struct net_bridge_port *source,
383 const unsigned char *addr);
385 extern int br_fdb_delete(struct ndmsg *ndm,
386 struct net_device *dev,
387 const unsigned char *addr);
388 extern int br_fdb_add(struct ndmsg *nlh, struct nlattr *tb[],
389 struct net_device *dev,
390 const unsigned char *addr,
392 extern int br_fdb_dump(struct sk_buff *skb,
393 struct netlink_callback *cb,
394 struct net_device *dev,
398 extern void br_deliver(const struct net_bridge_port *to,
399 struct sk_buff *skb);
400 extern int br_dev_queue_push_xmit(struct sk_buff *skb);
401 extern void br_forward(const struct net_bridge_port *to,
402 struct sk_buff *skb, struct sk_buff *skb0);
403 extern int br_forward_finish(struct sk_buff *skb);
404 extern void br_flood_deliver(struct net_bridge *br, struct sk_buff *skb);
405 extern void br_flood_forward(struct net_bridge *br, struct sk_buff *skb,
406 struct sk_buff *skb2);
409 extern void br_port_carrier_check(struct net_bridge_port *p);
410 extern int br_add_bridge(struct net *net, const char *name);
411 extern int br_del_bridge(struct net *net, const char *name);
412 extern void br_net_exit(struct net *net);
413 extern int br_add_if(struct net_bridge *br,
414 struct net_device *dev);
415 extern int br_del_if(struct net_bridge *br,
416 struct net_device *dev);
417 extern int br_min_mtu(const struct net_bridge *br);
418 extern netdev_features_t br_features_recompute(struct net_bridge *br,
419 netdev_features_t features);
422 extern int br_handle_frame_finish(struct sk_buff *skb);
423 extern rx_handler_result_t br_handle_frame(struct sk_buff **pskb);
426 extern int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
427 extern int br_ioctl_deviceless_stub(struct net *net, unsigned int cmd, void __user *arg);
430 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
431 extern unsigned int br_mdb_rehash_seq;
432 extern int br_multicast_rcv(struct net_bridge *br,
433 struct net_bridge_port *port,
434 struct sk_buff *skb);
435 extern struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
436 struct sk_buff *skb);
437 extern void br_multicast_add_port(struct net_bridge_port *port);
438 extern void br_multicast_del_port(struct net_bridge_port *port);
439 extern void br_multicast_enable_port(struct net_bridge_port *port);
440 extern void br_multicast_disable_port(struct net_bridge_port *port);
441 extern void br_multicast_init(struct net_bridge *br);
442 extern void br_multicast_open(struct net_bridge *br);
443 extern void br_multicast_stop(struct net_bridge *br);
444 extern void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
445 struct sk_buff *skb);
446 extern void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
447 struct sk_buff *skb, struct sk_buff *skb2);
448 extern int br_multicast_set_router(struct net_bridge *br, unsigned long val);
449 extern int br_multicast_set_port_router(struct net_bridge_port *p,
451 extern int br_multicast_toggle(struct net_bridge *br, unsigned long val);
452 extern int br_multicast_set_querier(struct net_bridge *br, unsigned long val);
453 extern int br_multicast_set_hash_max(struct net_bridge *br, unsigned long val);
454 extern struct net_bridge_mdb_entry *br_mdb_ip_get(
455 struct net_bridge_mdb_htable *mdb,
457 extern struct net_bridge_mdb_entry *br_multicast_new_group(struct net_bridge *br,
458 struct net_bridge_port *port, struct br_ip *group);
459 extern void br_multicast_free_pg(struct rcu_head *head);
460 extern struct net_bridge_port_group *br_multicast_new_port_group(
461 struct net_bridge_port *port,
463 struct net_bridge_port_group *next,
464 unsigned char state);
465 extern void br_mdb_init(void);
466 extern void br_mdb_uninit(void);
467 extern void br_mdb_notify(struct net_device *dev, struct net_bridge_port *port,
468 struct br_ip *group, int type);
470 #define mlock_dereference(X, br) \
471 rcu_dereference_protected(X, lockdep_is_held(&br->multicast_lock))
473 #if IS_ENABLED(CONFIG_IPV6)
474 #include <net/addrconf.h>
475 static inline int ipv6_is_transient_multicast(const struct in6_addr *addr)
477 if (ipv6_addr_is_multicast(addr) && IPV6_ADDR_MC_FLAG_TRANSIENT(addr))
483 static inline bool br_multicast_is_router(struct net_bridge *br)
485 return br->multicast_router == 2 ||
486 (br->multicast_router == 1 &&
487 timer_pending(&br->multicast_router_timer));
490 static inline int br_multicast_rcv(struct net_bridge *br,
491 struct net_bridge_port *port,
497 static inline struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
503 static inline void br_multicast_add_port(struct net_bridge_port *port)
507 static inline void br_multicast_del_port(struct net_bridge_port *port)
511 static inline void br_multicast_enable_port(struct net_bridge_port *port)
515 static inline void br_multicast_disable_port(struct net_bridge_port *port)
519 static inline void br_multicast_init(struct net_bridge *br)
523 static inline void br_multicast_open(struct net_bridge *br)
527 static inline void br_multicast_stop(struct net_bridge *br)
531 static inline void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
536 static inline void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
538 struct sk_buff *skb2)
541 static inline bool br_multicast_is_router(struct net_bridge *br)
545 static inline void br_mdb_init(void)
548 static inline void br_mdb_uninit(void)
554 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
555 extern int br_vlan_add(struct net_bridge *br, u16 vid);
556 extern int br_vlan_delete(struct net_bridge *br, u16 vid);
557 extern void br_vlan_flush(struct net_bridge *br);
558 extern int br_vlan_filter_toggle(struct net_bridge *br, unsigned long val);
559 extern int nbp_vlan_add(struct net_bridge_port *port, u16 vid);
560 extern int nbp_vlan_delete(struct net_bridge_port *port, u16 vid);
561 extern void nbp_vlan_flush(struct net_bridge_port *port);
563 static inline int br_vlan_add(struct net_bridge *br, u16 vid)
568 static inline int br_vlan_delete(struct net_bridge *br, u16 vid)
573 static inline void br_vlan_flush(struct net_bridge *br)
577 static inline int nbp_vlan_add(struct net_bridge_port *port, u16 vid)
582 static inline int nbp_vlan_delete(struct net_bridge_port *port, u16 vid)
587 static inline void nbp_vlan_flush(struct net_bridge_port *port)
594 #ifdef CONFIG_BRIDGE_NETFILTER
595 extern int br_netfilter_init(void);
596 extern void br_netfilter_fini(void);
597 extern void br_netfilter_rtable_init(struct net_bridge *);
599 #define br_netfilter_init() (0)
600 #define br_netfilter_fini() do { } while(0)
601 #define br_netfilter_rtable_init(x)
605 extern void br_log_state(const struct net_bridge_port *p);
606 extern struct net_bridge_port *br_get_port(struct net_bridge *br,
608 extern void br_init_port(struct net_bridge_port *p);
609 extern void br_become_designated_port(struct net_bridge_port *p);
611 extern int br_set_forward_delay(struct net_bridge *br, unsigned long x);
612 extern int br_set_hello_time(struct net_bridge *br, unsigned long x);
613 extern int br_set_max_age(struct net_bridge *br, unsigned long x);
617 extern void br_stp_enable_bridge(struct net_bridge *br);
618 extern void br_stp_disable_bridge(struct net_bridge *br);
619 extern void br_stp_set_enabled(struct net_bridge *br, unsigned long val);
620 extern void br_stp_enable_port(struct net_bridge_port *p);
621 extern void br_stp_disable_port(struct net_bridge_port *p);
622 extern bool br_stp_recalculate_bridge_id(struct net_bridge *br);
623 extern void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
624 extern void br_stp_set_bridge_priority(struct net_bridge *br,
626 extern int br_stp_set_port_priority(struct net_bridge_port *p,
627 unsigned long newprio);
628 extern int br_stp_set_path_cost(struct net_bridge_port *p,
629 unsigned long path_cost);
630 extern ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);
634 extern void br_stp_rcv(const struct stp_proto *proto, struct sk_buff *skb,
635 struct net_device *dev);
638 extern void br_stp_timer_init(struct net_bridge *br);
639 extern void br_stp_port_timer_init(struct net_bridge_port *p);
640 extern unsigned long br_timer_value(const struct timer_list *timer);
643 #if IS_ENABLED(CONFIG_ATM_LANE)
644 extern int (*br_fdb_test_addr_hook)(struct net_device *dev, unsigned char *addr);
648 extern struct rtnl_link_ops br_link_ops;
649 extern int br_netlink_init(void);
650 extern void br_netlink_fini(void);
651 extern void br_ifinfo_notify(int event, struct net_bridge_port *port);
652 extern int br_setlink(struct net_device *dev, struct nlmsghdr *nlmsg);
653 extern int br_getlink(struct sk_buff *skb, u32 pid, u32 seq,
654 struct net_device *dev);
658 extern const struct sysfs_ops brport_sysfs_ops;
659 extern int br_sysfs_addif(struct net_bridge_port *p);
660 extern int br_sysfs_renameif(struct net_bridge_port *p);
663 extern int br_sysfs_addbr(struct net_device *dev);
664 extern void br_sysfs_delbr(struct net_device *dev);
668 static inline int br_sysfs_addif(struct net_bridge_port *p) { return 0; }
669 static inline int br_sysfs_renameif(struct net_bridge_port *p) { return 0; }
670 static inline int br_sysfs_addbr(struct net_device *dev) { return 0; }
671 static inline void br_sysfs_delbr(struct net_device *dev) { return; }
672 #endif /* CONFIG_SYSFS */