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)
69 struct net_port_vlans {
73 struct net_bridge_port *port;
74 struct net_bridge *br;
77 unsigned long vlan_bitmap[BR_VLAN_BITMAP_LEN];
78 unsigned long untagged_bitmap[BR_VLAN_BITMAP_LEN];
82 struct net_bridge_fdb_entry
84 struct hlist_node hlist;
85 struct net_bridge_port *dst;
88 unsigned long updated;
91 unsigned char is_local;
92 unsigned char is_static;
96 struct net_bridge_port_group {
97 struct net_bridge_port *port;
98 struct net_bridge_port_group __rcu *next;
99 struct hlist_node mglist;
101 struct timer_list timer;
106 struct net_bridge_mdb_entry
108 struct hlist_node hlist[2];
109 struct net_bridge *br;
110 struct net_bridge_port_group __rcu *ports;
112 struct timer_list timer;
117 struct net_bridge_mdb_htable
119 struct hlist_head *mhash;
121 struct net_bridge_mdb_htable *old;
128 struct net_bridge_port
130 struct net_bridge *br;
131 struct net_device *dev;
132 struct list_head list;
138 unsigned char topology_change_ack;
139 unsigned char config_pending;
141 port_id designated_port;
142 bridge_id designated_root;
143 bridge_id designated_bridge;
146 unsigned long designated_age;
148 struct timer_list forward_delay_timer;
149 struct timer_list hold_timer;
150 struct timer_list message_age_timer;
155 #define BR_HAIRPIN_MODE 0x00000001
156 #define BR_BPDU_GUARD 0x00000002
157 #define BR_ROOT_BLOCK 0x00000004
158 #define BR_MULTICAST_FAST_LEAVE 0x00000008
160 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
161 u32 multicast_startup_queries_sent;
162 unsigned char multicast_router;
163 struct timer_list multicast_router_timer;
164 struct timer_list multicast_query_timer;
165 struct hlist_head mglist;
166 struct hlist_node rlist;
170 char sysfs_name[IFNAMSIZ];
173 #ifdef CONFIG_NET_POLL_CONTROLLER
176 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
177 struct net_port_vlans __rcu *vlan_info;
181 #define br_port_exists(dev) (dev->priv_flags & IFF_BRIDGE_PORT)
183 static inline struct net_bridge_port *br_port_get_rcu(const struct net_device *dev)
185 struct net_bridge_port *port =
186 rcu_dereference_rtnl(dev->rx_handler_data);
188 return br_port_exists(dev) ? port : NULL;
191 static inline struct net_bridge_port *br_port_get_rtnl(struct net_device *dev)
193 return br_port_exists(dev) ?
194 rtnl_dereference(dev->rx_handler_data) : NULL;
197 struct br_cpu_netstats {
202 struct u64_stats_sync syncp;
208 struct list_head port_list;
209 struct net_device *dev;
211 struct br_cpu_netstats __percpu *stats;
212 spinlock_t hash_lock;
213 struct hlist_head hash[BR_HASH_SIZE];
214 #ifdef CONFIG_BRIDGE_NETFILTER
215 struct rtable fake_rtable;
216 bool nf_call_iptables;
217 bool nf_call_ip6tables;
218 bool nf_call_arptables;
223 bridge_id designated_root;
226 unsigned long max_age;
227 unsigned long hello_time;
228 unsigned long forward_delay;
229 unsigned long bridge_max_age;
230 unsigned long ageing_time;
231 unsigned long bridge_hello_time;
232 unsigned long bridge_forward_delay;
234 u8 group_addr[ETH_ALEN];
238 BR_NO_STP, /* no spanning tree */
239 BR_KERNEL_STP, /* old STP in kernel */
240 BR_USER_STP, /* new RSTP in userspace */
243 unsigned char topology_change;
244 unsigned char topology_change_detected;
246 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
247 unsigned char multicast_router;
249 u8 multicast_disabled:1;
250 u8 multicast_querier:1;
255 u32 multicast_last_member_count;
256 u32 multicast_startup_queries_sent;
257 u32 multicast_startup_query_count;
259 unsigned long multicast_last_member_interval;
260 unsigned long multicast_membership_interval;
261 unsigned long multicast_querier_interval;
262 unsigned long multicast_query_interval;
263 unsigned long multicast_query_response_interval;
264 unsigned long multicast_startup_query_interval;
266 spinlock_t multicast_lock;
267 struct net_bridge_mdb_htable __rcu *mdb;
268 struct hlist_head router_list;
270 struct timer_list multicast_router_timer;
271 struct timer_list multicast_querier_timer;
272 struct timer_list multicast_query_timer;
275 struct timer_list hello_timer;
276 struct timer_list tcn_timer;
277 struct timer_list topology_change_timer;
278 struct timer_list gc_timer;
279 struct kobject *ifobj;
280 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
282 struct net_port_vlans __rcu *vlan_info;
286 struct br_input_skb_cb {
287 struct net_device *brdev;
288 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
294 #define BR_INPUT_SKB_CB(__skb) ((struct br_input_skb_cb *)(__skb)->cb)
296 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
297 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (BR_INPUT_SKB_CB(__skb)->mrouters_only)
299 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (0)
302 #define br_printk(level, br, format, args...) \
303 printk(level "%s: " format, (br)->dev->name, ##args)
305 #define br_err(__br, format, args...) \
306 br_printk(KERN_ERR, __br, format, ##args)
307 #define br_warn(__br, format, args...) \
308 br_printk(KERN_WARNING, __br, format, ##args)
309 #define br_notice(__br, format, args...) \
310 br_printk(KERN_NOTICE, __br, format, ##args)
311 #define br_info(__br, format, args...) \
312 br_printk(KERN_INFO, __br, format, ##args)
314 #define br_debug(br, format, args...) \
315 pr_debug("%s: " format, (br)->dev->name, ##args)
317 extern struct notifier_block br_device_notifier;
319 /* called under bridge lock */
320 static inline int br_is_root_bridge(const struct net_bridge *br)
322 return !memcmp(&br->bridge_id, &br->designated_root, 8);
326 extern void br_dev_setup(struct net_device *dev);
327 extern void br_dev_delete(struct net_device *dev, struct list_head *list);
328 extern netdev_tx_t br_dev_xmit(struct sk_buff *skb,
329 struct net_device *dev);
330 #ifdef CONFIG_NET_POLL_CONTROLLER
331 static inline struct netpoll_info *br_netpoll_info(struct net_bridge *br)
333 return br->dev->npinfo;
336 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
339 struct netpoll *np = p->np;
342 netpoll_send_skb(np, skb);
345 extern int br_netpoll_enable(struct net_bridge_port *p, gfp_t gfp);
346 extern void br_netpoll_disable(struct net_bridge_port *p);
348 static inline struct netpoll_info *br_netpoll_info(struct net_bridge *br)
353 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
358 static inline int br_netpoll_enable(struct net_bridge_port *p, gfp_t gfp)
363 static inline void br_netpoll_disable(struct net_bridge_port *p)
369 extern int br_fdb_init(void);
370 extern void br_fdb_fini(void);
371 extern void br_fdb_flush(struct net_bridge *br);
372 extern void br_fdb_changeaddr(struct net_bridge_port *p,
373 const unsigned char *newaddr);
374 extern void br_fdb_change_mac_address(struct net_bridge *br, const u8 *newaddr);
375 extern void br_fdb_cleanup(unsigned long arg);
376 extern void br_fdb_delete_by_port(struct net_bridge *br,
377 const struct net_bridge_port *p, int do_all);
378 extern struct net_bridge_fdb_entry *__br_fdb_get(struct net_bridge *br,
379 const unsigned char *addr,
381 extern int br_fdb_test_addr(struct net_device *dev, unsigned char *addr);
382 extern int br_fdb_fillbuf(struct net_bridge *br, void *buf,
383 unsigned long count, unsigned long off);
384 extern int br_fdb_insert(struct net_bridge *br,
385 struct net_bridge_port *source,
386 const unsigned char *addr,
388 extern void br_fdb_update(struct net_bridge *br,
389 struct net_bridge_port *source,
390 const unsigned char *addr,
392 extern int fdb_delete_by_addr(struct net_bridge *br, const u8 *addr, u16 vid);
394 extern int br_fdb_delete(struct ndmsg *ndm, struct nlattr *tb[],
395 struct net_device *dev,
396 const unsigned char *addr);
397 extern int br_fdb_add(struct ndmsg *nlh, struct nlattr *tb[],
398 struct net_device *dev,
399 const unsigned char *addr,
401 extern int br_fdb_dump(struct sk_buff *skb,
402 struct netlink_callback *cb,
403 struct net_device *dev,
407 extern void br_deliver(const struct net_bridge_port *to,
408 struct sk_buff *skb);
409 extern int br_dev_queue_push_xmit(struct sk_buff *skb);
410 extern void br_forward(const struct net_bridge_port *to,
411 struct sk_buff *skb, struct sk_buff *skb0);
412 extern int br_forward_finish(struct sk_buff *skb);
413 extern void br_flood_deliver(struct net_bridge *br, struct sk_buff *skb);
414 extern void br_flood_forward(struct net_bridge *br, struct sk_buff *skb,
415 struct sk_buff *skb2);
418 extern void br_port_carrier_check(struct net_bridge_port *p);
419 extern int br_add_bridge(struct net *net, const char *name);
420 extern int br_del_bridge(struct net *net, const char *name);
421 extern void br_net_exit(struct net *net);
422 extern int br_add_if(struct net_bridge *br,
423 struct net_device *dev);
424 extern int br_del_if(struct net_bridge *br,
425 struct net_device *dev);
426 extern int br_min_mtu(const struct net_bridge *br);
427 extern netdev_features_t br_features_recompute(struct net_bridge *br,
428 netdev_features_t features);
431 extern int br_handle_frame_finish(struct sk_buff *skb);
432 extern rx_handler_result_t br_handle_frame(struct sk_buff **pskb);
435 extern int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
436 extern int br_ioctl_deviceless_stub(struct net *net, unsigned int cmd, void __user *arg);
439 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
440 extern unsigned int br_mdb_rehash_seq;
441 extern int br_multicast_rcv(struct net_bridge *br,
442 struct net_bridge_port *port,
443 struct sk_buff *skb);
444 extern struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
445 struct sk_buff *skb, u16 vid);
446 extern void br_multicast_add_port(struct net_bridge_port *port);
447 extern void br_multicast_del_port(struct net_bridge_port *port);
448 extern void br_multicast_enable_port(struct net_bridge_port *port);
449 extern void br_multicast_disable_port(struct net_bridge_port *port);
450 extern void br_multicast_init(struct net_bridge *br);
451 extern void br_multicast_open(struct net_bridge *br);
452 extern void br_multicast_stop(struct net_bridge *br);
453 extern void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
454 struct sk_buff *skb);
455 extern void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
456 struct sk_buff *skb, struct sk_buff *skb2);
457 extern int br_multicast_set_router(struct net_bridge *br, unsigned long val);
458 extern int br_multicast_set_port_router(struct net_bridge_port *p,
460 extern int br_multicast_toggle(struct net_bridge *br, unsigned long val);
461 extern int br_multicast_set_querier(struct net_bridge *br, unsigned long val);
462 extern int br_multicast_set_hash_max(struct net_bridge *br, unsigned long val);
463 extern struct net_bridge_mdb_entry *br_mdb_ip_get(
464 struct net_bridge_mdb_htable *mdb,
466 extern struct net_bridge_mdb_entry *br_multicast_new_group(struct net_bridge *br,
467 struct net_bridge_port *port, struct br_ip *group);
468 extern void br_multicast_free_pg(struct rcu_head *head);
469 extern struct net_bridge_port_group *br_multicast_new_port_group(
470 struct net_bridge_port *port,
472 struct net_bridge_port_group *next,
473 unsigned char state);
474 extern void br_mdb_init(void);
475 extern void br_mdb_uninit(void);
476 extern void br_mdb_notify(struct net_device *dev, struct net_bridge_port *port,
477 struct br_ip *group, int type);
479 #define mlock_dereference(X, br) \
480 rcu_dereference_protected(X, lockdep_is_held(&br->multicast_lock))
482 #if IS_ENABLED(CONFIG_IPV6)
483 #include <net/addrconf.h>
484 static inline int ipv6_is_transient_multicast(const struct in6_addr *addr)
486 if (ipv6_addr_is_multicast(addr) && IPV6_ADDR_MC_FLAG_TRANSIENT(addr))
492 static inline bool br_multicast_is_router(struct net_bridge *br)
494 return br->multicast_router == 2 ||
495 (br->multicast_router == 1 &&
496 timer_pending(&br->multicast_router_timer));
499 static inline int br_multicast_rcv(struct net_bridge *br,
500 struct net_bridge_port *port,
506 static inline struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
507 struct sk_buff *skb, u16 vid)
512 static inline void br_multicast_add_port(struct net_bridge_port *port)
516 static inline void br_multicast_del_port(struct net_bridge_port *port)
520 static inline void br_multicast_enable_port(struct net_bridge_port *port)
524 static inline void br_multicast_disable_port(struct net_bridge_port *port)
528 static inline void br_multicast_init(struct net_bridge *br)
532 static inline void br_multicast_open(struct net_bridge *br)
536 static inline void br_multicast_stop(struct net_bridge *br)
540 static inline void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
545 static inline void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
547 struct sk_buff *skb2)
550 static inline bool br_multicast_is_router(struct net_bridge *br)
554 static inline void br_mdb_init(void)
557 static inline void br_mdb_uninit(void)
563 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
564 extern bool br_allowed_ingress(struct net_bridge *br, struct net_port_vlans *v,
565 struct sk_buff *skb, u16 *vid);
566 extern bool br_allowed_egress(struct net_bridge *br,
567 const struct net_port_vlans *v,
568 const struct sk_buff *skb);
569 extern struct sk_buff *br_handle_vlan(struct net_bridge *br,
570 const struct net_port_vlans *v,
571 struct sk_buff *skb);
572 extern int br_vlan_add(struct net_bridge *br, u16 vid, u16 flags);
573 extern int br_vlan_delete(struct net_bridge *br, u16 vid);
574 extern void br_vlan_flush(struct net_bridge *br);
575 extern int br_vlan_filter_toggle(struct net_bridge *br, unsigned long val);
576 extern int nbp_vlan_add(struct net_bridge_port *port, u16 vid, u16 flags);
577 extern int nbp_vlan_delete(struct net_bridge_port *port, u16 vid);
578 extern void nbp_vlan_flush(struct net_bridge_port *port);
579 extern bool nbp_vlan_find(struct net_bridge_port *port, u16 vid);
581 static inline struct net_port_vlans *br_get_vlan_info(
582 const struct net_bridge *br)
584 return rcu_dereference_rtnl(br->vlan_info);
587 static inline struct net_port_vlans *nbp_get_vlan_info(
588 const struct net_bridge_port *p)
590 return rcu_dereference_rtnl(p->vlan_info);
593 /* Since bridge now depends on 8021Q module, but the time bridge sees the
594 * skb, the vlan tag will always be present if the frame was tagged.
596 static inline int br_vlan_get_tag(const struct sk_buff *skb, u16 *vid)
600 if (vlan_tx_tag_present(skb))
601 *vid = vlan_tx_tag_get(skb) & VLAN_VID_MASK;
610 static inline u16 br_get_pvid(const struct net_port_vlans *v)
612 /* Return just the VID if it is set, or VLAN_N_VID (invalid vid) if
616 return (v->pvid & VLAN_TAG_PRESENT) ?
617 (v->pvid & ~VLAN_TAG_PRESENT) :
622 static inline bool br_allowed_ingress(struct net_bridge *br,
623 struct net_port_vlans *v,
630 static inline bool br_allowed_egress(struct net_bridge *br,
631 const struct net_port_vlans *v,
632 const struct sk_buff *skb)
637 static inline struct sk_buff *br_handle_vlan(struct net_bridge *br,
638 const struct net_port_vlans *v,
644 static inline int br_vlan_add(struct net_bridge *br, u16 vid, u16 flags)
649 static inline int br_vlan_delete(struct net_bridge *br, u16 vid)
654 static inline void br_vlan_flush(struct net_bridge *br)
658 static inline int nbp_vlan_add(struct net_bridge_port *port, u16 vid, u16 flags)
663 static inline int nbp_vlan_delete(struct net_bridge_port *port, u16 vid)
668 static inline void nbp_vlan_flush(struct net_bridge_port *port)
672 static inline struct net_port_vlans *br_get_vlan_info(
673 const struct net_bridge *br)
677 static inline struct net_port_vlans *nbp_get_vlan_info(
678 const struct net_bridge_port *p)
683 static inline bool nbp_vlan_find(struct net_bridge_port *port, u16 vid)
688 static inline u16 br_vlan_get_tag(const struct sk_buff *skb, u16 *tag)
692 static inline u16 br_get_pvid(const struct net_port_vlans *v)
694 return VLAN_N_VID; /* Returns invalid vid */
699 #ifdef CONFIG_BRIDGE_NETFILTER
700 extern int br_netfilter_init(void);
701 extern void br_netfilter_fini(void);
702 extern void br_netfilter_rtable_init(struct net_bridge *);
704 #define br_netfilter_init() (0)
705 #define br_netfilter_fini() do { } while(0)
706 #define br_netfilter_rtable_init(x)
710 extern void br_log_state(const struct net_bridge_port *p);
711 extern struct net_bridge_port *br_get_port(struct net_bridge *br,
713 extern void br_init_port(struct net_bridge_port *p);
714 extern void br_become_designated_port(struct net_bridge_port *p);
716 extern int br_set_forward_delay(struct net_bridge *br, unsigned long x);
717 extern int br_set_hello_time(struct net_bridge *br, unsigned long x);
718 extern int br_set_max_age(struct net_bridge *br, unsigned long x);
722 extern void br_stp_enable_bridge(struct net_bridge *br);
723 extern void br_stp_disable_bridge(struct net_bridge *br);
724 extern void br_stp_set_enabled(struct net_bridge *br, unsigned long val);
725 extern void br_stp_enable_port(struct net_bridge_port *p);
726 extern void br_stp_disable_port(struct net_bridge_port *p);
727 extern bool br_stp_recalculate_bridge_id(struct net_bridge *br);
728 extern void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
729 extern void br_stp_set_bridge_priority(struct net_bridge *br,
731 extern int br_stp_set_port_priority(struct net_bridge_port *p,
732 unsigned long newprio);
733 extern int br_stp_set_path_cost(struct net_bridge_port *p,
734 unsigned long path_cost);
735 extern ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);
739 extern void br_stp_rcv(const struct stp_proto *proto, struct sk_buff *skb,
740 struct net_device *dev);
743 extern void br_stp_timer_init(struct net_bridge *br);
744 extern void br_stp_port_timer_init(struct net_bridge_port *p);
745 extern unsigned long br_timer_value(const struct timer_list *timer);
748 #if IS_ENABLED(CONFIG_ATM_LANE)
749 extern int (*br_fdb_test_addr_hook)(struct net_device *dev, unsigned char *addr);
753 extern struct rtnl_link_ops br_link_ops;
754 extern int br_netlink_init(void);
755 extern void br_netlink_fini(void);
756 extern void br_ifinfo_notify(int event, struct net_bridge_port *port);
757 extern int br_setlink(struct net_device *dev, struct nlmsghdr *nlmsg);
758 extern int br_dellink(struct net_device *dev, struct nlmsghdr *nlmsg);
759 extern int br_getlink(struct sk_buff *skb, u32 pid, u32 seq,
760 struct net_device *dev, u32 filter_mask);
764 extern const struct sysfs_ops brport_sysfs_ops;
765 extern int br_sysfs_addif(struct net_bridge_port *p);
766 extern int br_sysfs_renameif(struct net_bridge_port *p);
769 extern int br_sysfs_addbr(struct net_device *dev);
770 extern void br_sysfs_delbr(struct net_device *dev);
774 static inline int br_sysfs_addif(struct net_bridge_port *p) { return 0; }
775 static inline int br_sysfs_renameif(struct net_bridge_port *p) { return 0; }
776 static inline int br_sysfs_addbr(struct net_device *dev) { return 0; }
777 static inline void br_sysfs_delbr(struct net_device *dev) { return; }
778 #endif /* CONFIG_SYSFS */