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;
118 struct net_bridge_mdb_htable
120 struct hlist_head *mhash;
122 struct net_bridge_mdb_htable *old;
129 struct net_bridge_port
131 struct net_bridge *br;
132 struct net_device *dev;
133 struct list_head list;
139 unsigned char topology_change_ack;
140 unsigned char config_pending;
142 port_id designated_port;
143 bridge_id designated_root;
144 bridge_id designated_bridge;
147 unsigned long designated_age;
149 struct timer_list forward_delay_timer;
150 struct timer_list hold_timer;
151 struct timer_list message_age_timer;
156 #define BR_HAIRPIN_MODE 0x00000001
157 #define BR_BPDU_GUARD 0x00000002
158 #define BR_ROOT_BLOCK 0x00000004
159 #define BR_MULTICAST_FAST_LEAVE 0x00000008
160 #define BR_ADMIN_COST 0x00000010
161 #define BR_LEARNING 0x00000020
162 #define BR_FLOOD 0x00000040
164 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
165 u32 multicast_startup_queries_sent;
166 unsigned char multicast_router;
167 struct timer_list multicast_router_timer;
168 struct timer_list multicast_query_timer;
169 struct hlist_head mglist;
170 struct hlist_node rlist;
174 char sysfs_name[IFNAMSIZ];
177 #ifdef CONFIG_NET_POLL_CONTROLLER
180 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
181 struct net_port_vlans __rcu *vlan_info;
185 #define br_port_exists(dev) (dev->priv_flags & IFF_BRIDGE_PORT)
187 static inline struct net_bridge_port *br_port_get_rcu(const struct net_device *dev)
189 struct net_bridge_port *port =
190 rcu_dereference_rtnl(dev->rx_handler_data);
192 return br_port_exists(dev) ? port : NULL;
195 static inline struct net_bridge_port *br_port_get_rtnl(struct net_device *dev)
197 return br_port_exists(dev) ?
198 rtnl_dereference(dev->rx_handler_data) : NULL;
201 struct br_cpu_netstats {
206 struct u64_stats_sync syncp;
212 struct list_head port_list;
213 struct net_device *dev;
215 struct br_cpu_netstats __percpu *stats;
216 spinlock_t hash_lock;
217 struct hlist_head hash[BR_HASH_SIZE];
218 #ifdef CONFIG_BRIDGE_NETFILTER
219 struct rtable fake_rtable;
220 bool nf_call_iptables;
221 bool nf_call_ip6tables;
222 bool nf_call_arptables;
227 bridge_id designated_root;
230 unsigned long max_age;
231 unsigned long hello_time;
232 unsigned long forward_delay;
233 unsigned long bridge_max_age;
234 unsigned long ageing_time;
235 unsigned long bridge_hello_time;
236 unsigned long bridge_forward_delay;
238 u8 group_addr[ETH_ALEN];
242 BR_NO_STP, /* no spanning tree */
243 BR_KERNEL_STP, /* old STP in kernel */
244 BR_USER_STP, /* new RSTP in userspace */
247 unsigned char topology_change;
248 unsigned char topology_change_detected;
250 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
251 unsigned char multicast_router;
253 u8 multicast_disabled:1;
254 u8 multicast_querier:1;
255 u8 multicast_query_use_ifaddr:1;
260 u32 multicast_last_member_count;
261 u32 multicast_startup_queries_sent;
262 u32 multicast_startup_query_count;
264 unsigned long multicast_last_member_interval;
265 unsigned long multicast_membership_interval;
266 unsigned long multicast_querier_interval;
267 unsigned long multicast_query_interval;
268 unsigned long multicast_query_response_interval;
269 unsigned long multicast_startup_query_interval;
270 unsigned long multicast_querier_delay_time;
272 spinlock_t multicast_lock;
273 struct net_bridge_mdb_htable __rcu *mdb;
274 struct hlist_head router_list;
276 struct timer_list multicast_router_timer;
277 struct timer_list multicast_querier_timer;
278 struct timer_list multicast_query_timer;
281 struct timer_list hello_timer;
282 struct timer_list tcn_timer;
283 struct timer_list topology_change_timer;
284 struct timer_list gc_timer;
285 struct kobject *ifobj;
286 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
288 struct net_port_vlans __rcu *vlan_info;
292 struct br_input_skb_cb {
293 struct net_device *brdev;
294 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
300 #define BR_INPUT_SKB_CB(__skb) ((struct br_input_skb_cb *)(__skb)->cb)
302 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
303 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (BR_INPUT_SKB_CB(__skb)->mrouters_only)
305 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (0)
308 #define br_printk(level, br, format, args...) \
309 printk(level "%s: " format, (br)->dev->name, ##args)
311 #define br_err(__br, format, args...) \
312 br_printk(KERN_ERR, __br, format, ##args)
313 #define br_warn(__br, format, args...) \
314 br_printk(KERN_WARNING, __br, format, ##args)
315 #define br_notice(__br, format, args...) \
316 br_printk(KERN_NOTICE, __br, format, ##args)
317 #define br_info(__br, format, args...) \
318 br_printk(KERN_INFO, __br, format, ##args)
320 #define br_debug(br, format, args...) \
321 pr_debug("%s: " format, (br)->dev->name, ##args)
323 extern struct notifier_block br_device_notifier;
325 /* called under bridge lock */
326 static inline int br_is_root_bridge(const struct net_bridge *br)
328 return !memcmp(&br->bridge_id, &br->designated_root, 8);
332 extern void br_dev_setup(struct net_device *dev);
333 extern void br_dev_delete(struct net_device *dev, struct list_head *list);
334 extern netdev_tx_t br_dev_xmit(struct sk_buff *skb,
335 struct net_device *dev);
336 #ifdef CONFIG_NET_POLL_CONTROLLER
337 static inline struct netpoll_info *br_netpoll_info(struct net_bridge *br)
339 return br->dev->npinfo;
342 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
345 struct netpoll *np = p->np;
348 netpoll_send_skb(np, skb);
351 extern int br_netpoll_enable(struct net_bridge_port *p, gfp_t gfp);
352 extern void br_netpoll_disable(struct net_bridge_port *p);
354 static inline struct netpoll_info *br_netpoll_info(struct net_bridge *br)
359 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
364 static inline int br_netpoll_enable(struct net_bridge_port *p, gfp_t gfp)
369 static inline void br_netpoll_disable(struct net_bridge_port *p)
375 extern int br_fdb_init(void);
376 extern void br_fdb_fini(void);
377 extern void br_fdb_flush(struct net_bridge *br);
378 extern void br_fdb_changeaddr(struct net_bridge_port *p,
379 const unsigned char *newaddr);
380 extern void br_fdb_change_mac_address(struct net_bridge *br, const u8 *newaddr);
381 extern void br_fdb_cleanup(unsigned long arg);
382 extern void br_fdb_delete_by_port(struct net_bridge *br,
383 const struct net_bridge_port *p, int do_all);
384 extern struct net_bridge_fdb_entry *__br_fdb_get(struct net_bridge *br,
385 const unsigned char *addr,
387 extern int br_fdb_test_addr(struct net_device *dev, unsigned char *addr);
388 extern int br_fdb_fillbuf(struct net_bridge *br, void *buf,
389 unsigned long count, unsigned long off);
390 extern int br_fdb_insert(struct net_bridge *br,
391 struct net_bridge_port *source,
392 const unsigned char *addr,
394 extern void br_fdb_update(struct net_bridge *br,
395 struct net_bridge_port *source,
396 const unsigned char *addr,
398 extern int fdb_delete_by_addr(struct net_bridge *br, const u8 *addr, u16 vid);
400 extern int br_fdb_delete(struct ndmsg *ndm, struct nlattr *tb[],
401 struct net_device *dev,
402 const unsigned char *addr);
403 extern int br_fdb_add(struct ndmsg *nlh, struct nlattr *tb[],
404 struct net_device *dev,
405 const unsigned char *addr,
407 extern int br_fdb_dump(struct sk_buff *skb,
408 struct netlink_callback *cb,
409 struct net_device *dev,
413 extern void br_deliver(const struct net_bridge_port *to,
414 struct sk_buff *skb);
415 extern int br_dev_queue_push_xmit(struct sk_buff *skb);
416 extern void br_forward(const struct net_bridge_port *to,
417 struct sk_buff *skb, struct sk_buff *skb0);
418 extern int br_forward_finish(struct sk_buff *skb);
419 extern void br_flood_deliver(struct net_bridge *br, struct sk_buff *skb,
421 extern void br_flood_forward(struct net_bridge *br, struct sk_buff *skb,
422 struct sk_buff *skb2, bool unicast);
425 extern void br_port_carrier_check(struct net_bridge_port *p);
426 extern int br_add_bridge(struct net *net, const char *name);
427 extern int br_del_bridge(struct net *net, const char *name);
428 extern void br_net_exit(struct net *net);
429 extern int br_add_if(struct net_bridge *br,
430 struct net_device *dev);
431 extern int br_del_if(struct net_bridge *br,
432 struct net_device *dev);
433 extern int br_min_mtu(const struct net_bridge *br);
434 extern netdev_features_t br_features_recompute(struct net_bridge *br,
435 netdev_features_t features);
438 extern int br_handle_frame_finish(struct sk_buff *skb);
439 extern rx_handler_result_t br_handle_frame(struct sk_buff **pskb);
442 extern int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
443 extern int br_ioctl_deviceless_stub(struct net *net, unsigned int cmd, void __user *arg);
446 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
447 extern unsigned int br_mdb_rehash_seq;
448 extern int br_multicast_rcv(struct net_bridge *br,
449 struct net_bridge_port *port,
450 struct sk_buff *skb);
451 extern struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
452 struct sk_buff *skb, u16 vid);
453 extern void br_multicast_add_port(struct net_bridge_port *port);
454 extern void br_multicast_del_port(struct net_bridge_port *port);
455 extern void br_multicast_enable_port(struct net_bridge_port *port);
456 extern void br_multicast_disable_port(struct net_bridge_port *port);
457 extern void br_multicast_init(struct net_bridge *br);
458 extern void br_multicast_open(struct net_bridge *br);
459 extern void br_multicast_stop(struct net_bridge *br);
460 extern void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
461 struct sk_buff *skb);
462 extern void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
463 struct sk_buff *skb, struct sk_buff *skb2);
464 extern int br_multicast_set_router(struct net_bridge *br, unsigned long val);
465 extern int br_multicast_set_port_router(struct net_bridge_port *p,
467 extern int br_multicast_toggle(struct net_bridge *br, unsigned long val);
468 extern int br_multicast_set_querier(struct net_bridge *br, unsigned long val);
469 extern int br_multicast_set_hash_max(struct net_bridge *br, unsigned long val);
470 extern struct net_bridge_mdb_entry *br_mdb_ip_get(
471 struct net_bridge_mdb_htable *mdb,
473 extern struct net_bridge_mdb_entry *br_multicast_new_group(struct net_bridge *br,
474 struct net_bridge_port *port, struct br_ip *group);
475 extern void br_multicast_free_pg(struct rcu_head *head);
476 extern struct net_bridge_port_group *br_multicast_new_port_group(
477 struct net_bridge_port *port,
479 struct net_bridge_port_group *next,
480 unsigned char state);
481 extern void br_mdb_init(void);
482 extern void br_mdb_uninit(void);
483 extern void br_mdb_notify(struct net_device *dev, struct net_bridge_port *port,
484 struct br_ip *group, int type);
486 #define mlock_dereference(X, br) \
487 rcu_dereference_protected(X, lockdep_is_held(&br->multicast_lock))
489 #if IS_ENABLED(CONFIG_IPV6)
490 #include <net/addrconf.h>
491 static inline int ipv6_is_transient_multicast(const struct in6_addr *addr)
493 if (ipv6_addr_is_multicast(addr) && IPV6_ADDR_MC_FLAG_TRANSIENT(addr))
499 static inline bool br_multicast_is_router(struct net_bridge *br)
501 return br->multicast_router == 2 ||
502 (br->multicast_router == 1 &&
503 timer_pending(&br->multicast_router_timer));
506 static inline bool br_multicast_querier_exists(struct net_bridge *br)
508 return time_is_before_jiffies(br->multicast_querier_delay_time) &&
509 (br->multicast_querier ||
510 timer_pending(&br->multicast_querier_timer));
513 static inline int br_multicast_rcv(struct net_bridge *br,
514 struct net_bridge_port *port,
520 static inline struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
521 struct sk_buff *skb, u16 vid)
526 static inline void br_multicast_add_port(struct net_bridge_port *port)
530 static inline void br_multicast_del_port(struct net_bridge_port *port)
534 static inline void br_multicast_enable_port(struct net_bridge_port *port)
538 static inline void br_multicast_disable_port(struct net_bridge_port *port)
542 static inline void br_multicast_init(struct net_bridge *br)
546 static inline void br_multicast_open(struct net_bridge *br)
550 static inline void br_multicast_stop(struct net_bridge *br)
554 static inline void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
559 static inline void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
561 struct sk_buff *skb2)
564 static inline bool br_multicast_is_router(struct net_bridge *br)
568 static inline bool br_multicast_querier_exists(struct net_bridge *br)
572 static inline void br_mdb_init(void)
575 static inline void br_mdb_uninit(void)
581 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
582 extern bool br_allowed_ingress(struct net_bridge *br, struct net_port_vlans *v,
583 struct sk_buff *skb, u16 *vid);
584 extern bool br_allowed_egress(struct net_bridge *br,
585 const struct net_port_vlans *v,
586 const struct sk_buff *skb);
587 extern struct sk_buff *br_handle_vlan(struct net_bridge *br,
588 const struct net_port_vlans *v,
589 struct sk_buff *skb);
590 extern int br_vlan_add(struct net_bridge *br, u16 vid, u16 flags);
591 extern int br_vlan_delete(struct net_bridge *br, u16 vid);
592 extern void br_vlan_flush(struct net_bridge *br);
593 extern int br_vlan_filter_toggle(struct net_bridge *br, unsigned long val);
594 extern int nbp_vlan_add(struct net_bridge_port *port, u16 vid, u16 flags);
595 extern int nbp_vlan_delete(struct net_bridge_port *port, u16 vid);
596 extern void nbp_vlan_flush(struct net_bridge_port *port);
597 extern bool nbp_vlan_find(struct net_bridge_port *port, u16 vid);
599 static inline struct net_port_vlans *br_get_vlan_info(
600 const struct net_bridge *br)
602 return rcu_dereference_rtnl(br->vlan_info);
605 static inline struct net_port_vlans *nbp_get_vlan_info(
606 const struct net_bridge_port *p)
608 return rcu_dereference_rtnl(p->vlan_info);
611 /* Since bridge now depends on 8021Q module, but the time bridge sees the
612 * skb, the vlan tag will always be present if the frame was tagged.
614 static inline int br_vlan_get_tag(const struct sk_buff *skb, u16 *vid)
618 if (vlan_tx_tag_present(skb))
619 *vid = vlan_tx_tag_get(skb) & VLAN_VID_MASK;
628 static inline u16 br_get_pvid(const struct net_port_vlans *v)
630 /* Return just the VID if it is set, or VLAN_N_VID (invalid vid) if
634 return (v->pvid & VLAN_TAG_PRESENT) ?
635 (v->pvid & ~VLAN_TAG_PRESENT) :
640 static inline bool br_allowed_ingress(struct net_bridge *br,
641 struct net_port_vlans *v,
648 static inline bool br_allowed_egress(struct net_bridge *br,
649 const struct net_port_vlans *v,
650 const struct sk_buff *skb)
655 static inline struct sk_buff *br_handle_vlan(struct net_bridge *br,
656 const struct net_port_vlans *v,
662 static inline int br_vlan_add(struct net_bridge *br, u16 vid, u16 flags)
667 static inline int br_vlan_delete(struct net_bridge *br, u16 vid)
672 static inline void br_vlan_flush(struct net_bridge *br)
676 static inline int nbp_vlan_add(struct net_bridge_port *port, u16 vid, u16 flags)
681 static inline int nbp_vlan_delete(struct net_bridge_port *port, u16 vid)
686 static inline void nbp_vlan_flush(struct net_bridge_port *port)
690 static inline struct net_port_vlans *br_get_vlan_info(
691 const struct net_bridge *br)
695 static inline struct net_port_vlans *nbp_get_vlan_info(
696 const struct net_bridge_port *p)
701 static inline bool nbp_vlan_find(struct net_bridge_port *port, u16 vid)
706 static inline u16 br_vlan_get_tag(const struct sk_buff *skb, u16 *tag)
710 static inline u16 br_get_pvid(const struct net_port_vlans *v)
712 return VLAN_N_VID; /* Returns invalid vid */
717 #ifdef CONFIG_BRIDGE_NETFILTER
718 extern int br_netfilter_init(void);
719 extern void br_netfilter_fini(void);
720 extern void br_netfilter_rtable_init(struct net_bridge *);
722 #define br_netfilter_init() (0)
723 #define br_netfilter_fini() do { } while(0)
724 #define br_netfilter_rtable_init(x)
728 extern void br_log_state(const struct net_bridge_port *p);
729 extern struct net_bridge_port *br_get_port(struct net_bridge *br,
731 extern void br_init_port(struct net_bridge_port *p);
732 extern void br_become_designated_port(struct net_bridge_port *p);
734 extern int br_set_forward_delay(struct net_bridge *br, unsigned long x);
735 extern int br_set_hello_time(struct net_bridge *br, unsigned long x);
736 extern int br_set_max_age(struct net_bridge *br, unsigned long x);
740 extern void br_stp_enable_bridge(struct net_bridge *br);
741 extern void br_stp_disable_bridge(struct net_bridge *br);
742 extern void br_stp_set_enabled(struct net_bridge *br, unsigned long val);
743 extern void br_stp_enable_port(struct net_bridge_port *p);
744 extern void br_stp_disable_port(struct net_bridge_port *p);
745 extern bool br_stp_recalculate_bridge_id(struct net_bridge *br);
746 extern void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
747 extern void br_stp_set_bridge_priority(struct net_bridge *br,
749 extern int br_stp_set_port_priority(struct net_bridge_port *p,
750 unsigned long newprio);
751 extern int br_stp_set_path_cost(struct net_bridge_port *p,
752 unsigned long path_cost);
753 extern ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);
757 extern void br_stp_rcv(const struct stp_proto *proto, struct sk_buff *skb,
758 struct net_device *dev);
761 extern void br_stp_timer_init(struct net_bridge *br);
762 extern void br_stp_port_timer_init(struct net_bridge_port *p);
763 extern unsigned long br_timer_value(const struct timer_list *timer);
766 #if IS_ENABLED(CONFIG_ATM_LANE)
767 extern int (*br_fdb_test_addr_hook)(struct net_device *dev, unsigned char *addr);
771 extern struct rtnl_link_ops br_link_ops;
772 extern int br_netlink_init(void);
773 extern void br_netlink_fini(void);
774 extern void br_ifinfo_notify(int event, struct net_bridge_port *port);
775 extern int br_setlink(struct net_device *dev, struct nlmsghdr *nlmsg);
776 extern int br_dellink(struct net_device *dev, struct nlmsghdr *nlmsg);
777 extern int br_getlink(struct sk_buff *skb, u32 pid, u32 seq,
778 struct net_device *dev, u32 filter_mask);
782 extern const struct sysfs_ops brport_sysfs_ops;
783 extern int br_sysfs_addif(struct net_bridge_port *p);
784 extern int br_sysfs_renameif(struct net_bridge_port *p);
787 extern int br_sysfs_addbr(struct net_device *dev);
788 extern void br_sysfs_delbr(struct net_device *dev);
792 static inline int br_sysfs_addif(struct net_bridge_port *p) { return 0; }
793 static inline int br_sysfs_renameif(struct net_bridge_port *p) { return 0; }
794 static inline int br_sysfs_addbr(struct net_device *dev) { return 0; }
795 static inline void br_sysfs_delbr(struct net_device *dev) { return; }
796 #endif /* CONFIG_SYSFS */