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
162 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
163 u32 multicast_startup_queries_sent;
164 unsigned char multicast_router;
165 struct timer_list multicast_router_timer;
166 struct timer_list multicast_query_timer;
167 struct hlist_head mglist;
168 struct hlist_node rlist;
172 char sysfs_name[IFNAMSIZ];
175 #ifdef CONFIG_NET_POLL_CONTROLLER
178 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
179 struct net_port_vlans __rcu *vlan_info;
183 #define br_port_exists(dev) (dev->priv_flags & IFF_BRIDGE_PORT)
185 static inline struct net_bridge_port *br_port_get_rcu(const struct net_device *dev)
187 struct net_bridge_port *port =
188 rcu_dereference_rtnl(dev->rx_handler_data);
190 return br_port_exists(dev) ? port : NULL;
193 static inline struct net_bridge_port *br_port_get_rtnl(struct net_device *dev)
195 return br_port_exists(dev) ?
196 rtnl_dereference(dev->rx_handler_data) : NULL;
199 struct br_cpu_netstats {
204 struct u64_stats_sync syncp;
210 struct list_head port_list;
211 struct net_device *dev;
213 struct br_cpu_netstats __percpu *stats;
214 spinlock_t hash_lock;
215 struct hlist_head hash[BR_HASH_SIZE];
216 #ifdef CONFIG_BRIDGE_NETFILTER
217 struct rtable fake_rtable;
218 bool nf_call_iptables;
219 bool nf_call_ip6tables;
220 bool nf_call_arptables;
225 bridge_id designated_root;
228 unsigned long max_age;
229 unsigned long hello_time;
230 unsigned long forward_delay;
231 unsigned long bridge_max_age;
232 unsigned long ageing_time;
233 unsigned long bridge_hello_time;
234 unsigned long bridge_forward_delay;
236 u8 group_addr[ETH_ALEN];
240 BR_NO_STP, /* no spanning tree */
241 BR_KERNEL_STP, /* old STP in kernel */
242 BR_USER_STP, /* new RSTP in userspace */
245 unsigned char topology_change;
246 unsigned char topology_change_detected;
248 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
249 unsigned char multicast_router;
251 u8 multicast_disabled:1;
252 u8 multicast_querier:1;
253 u8 multicast_query_use_ifaddr:1;
258 u32 multicast_last_member_count;
259 u32 multicast_startup_queries_sent;
260 u32 multicast_startup_query_count;
262 unsigned long multicast_last_member_interval;
263 unsigned long multicast_membership_interval;
264 unsigned long multicast_querier_interval;
265 unsigned long multicast_query_interval;
266 unsigned long multicast_query_response_interval;
267 unsigned long multicast_startup_query_interval;
269 spinlock_t multicast_lock;
270 struct net_bridge_mdb_htable __rcu *mdb;
271 struct hlist_head router_list;
273 struct timer_list multicast_router_timer;
274 struct timer_list multicast_querier_timer;
275 struct timer_list multicast_query_timer;
278 struct timer_list hello_timer;
279 struct timer_list tcn_timer;
280 struct timer_list topology_change_timer;
281 struct timer_list gc_timer;
282 struct kobject *ifobj;
283 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
285 struct net_port_vlans __rcu *vlan_info;
289 struct br_input_skb_cb {
290 struct net_device *brdev;
291 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
297 #define BR_INPUT_SKB_CB(__skb) ((struct br_input_skb_cb *)(__skb)->cb)
299 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
300 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (BR_INPUT_SKB_CB(__skb)->mrouters_only)
302 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (0)
305 #define br_printk(level, br, format, args...) \
306 printk(level "%s: " format, (br)->dev->name, ##args)
308 #define br_err(__br, format, args...) \
309 br_printk(KERN_ERR, __br, format, ##args)
310 #define br_warn(__br, format, args...) \
311 br_printk(KERN_WARNING, __br, format, ##args)
312 #define br_notice(__br, format, args...) \
313 br_printk(KERN_NOTICE, __br, format, ##args)
314 #define br_info(__br, format, args...) \
315 br_printk(KERN_INFO, __br, format, ##args)
317 #define br_debug(br, format, args...) \
318 pr_debug("%s: " format, (br)->dev->name, ##args)
320 extern struct notifier_block br_device_notifier;
322 /* called under bridge lock */
323 static inline int br_is_root_bridge(const struct net_bridge *br)
325 return !memcmp(&br->bridge_id, &br->designated_root, 8);
329 extern void br_dev_setup(struct net_device *dev);
330 extern void br_dev_delete(struct net_device *dev, struct list_head *list);
331 extern netdev_tx_t br_dev_xmit(struct sk_buff *skb,
332 struct net_device *dev);
333 #ifdef CONFIG_NET_POLL_CONTROLLER
334 static inline struct netpoll_info *br_netpoll_info(struct net_bridge *br)
336 return br->dev->npinfo;
339 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
342 struct netpoll *np = p->np;
345 netpoll_send_skb(np, skb);
348 extern int br_netpoll_enable(struct net_bridge_port *p, gfp_t gfp);
349 extern void br_netpoll_disable(struct net_bridge_port *p);
351 static inline struct netpoll_info *br_netpoll_info(struct net_bridge *br)
356 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
361 static inline int br_netpoll_enable(struct net_bridge_port *p, gfp_t gfp)
366 static inline void br_netpoll_disable(struct net_bridge_port *p)
372 extern int br_fdb_init(void);
373 extern void br_fdb_fini(void);
374 extern void br_fdb_flush(struct net_bridge *br);
375 extern void br_fdb_changeaddr(struct net_bridge_port *p,
376 const unsigned char *newaddr);
377 extern void br_fdb_change_mac_address(struct net_bridge *br, const u8 *newaddr);
378 extern void br_fdb_cleanup(unsigned long arg);
379 extern void br_fdb_delete_by_port(struct net_bridge *br,
380 const struct net_bridge_port *p, int do_all);
381 extern struct net_bridge_fdb_entry *__br_fdb_get(struct net_bridge *br,
382 const unsigned char *addr,
384 extern int br_fdb_test_addr(struct net_device *dev, unsigned char *addr);
385 extern int br_fdb_fillbuf(struct net_bridge *br, void *buf,
386 unsigned long count, unsigned long off);
387 extern int br_fdb_insert(struct net_bridge *br,
388 struct net_bridge_port *source,
389 const unsigned char *addr,
391 extern void br_fdb_update(struct net_bridge *br,
392 struct net_bridge_port *source,
393 const unsigned char *addr,
395 extern int fdb_delete_by_addr(struct net_bridge *br, const u8 *addr, u16 vid);
397 extern int br_fdb_delete(struct ndmsg *ndm, struct nlattr *tb[],
398 struct net_device *dev,
399 const unsigned char *addr);
400 extern int br_fdb_add(struct ndmsg *nlh, struct nlattr *tb[],
401 struct net_device *dev,
402 const unsigned char *addr,
404 extern int br_fdb_dump(struct sk_buff *skb,
405 struct netlink_callback *cb,
406 struct net_device *dev,
410 extern void br_deliver(const struct net_bridge_port *to,
411 struct sk_buff *skb);
412 extern int br_dev_queue_push_xmit(struct sk_buff *skb);
413 extern void br_forward(const struct net_bridge_port *to,
414 struct sk_buff *skb, struct sk_buff *skb0);
415 extern int br_forward_finish(struct sk_buff *skb);
416 extern void br_flood_deliver(struct net_bridge *br, struct sk_buff *skb);
417 extern void br_flood_forward(struct net_bridge *br, struct sk_buff *skb,
418 struct sk_buff *skb2);
421 extern void br_port_carrier_check(struct net_bridge_port *p);
422 extern int br_add_bridge(struct net *net, const char *name);
423 extern int br_del_bridge(struct net *net, const char *name);
424 extern void br_net_exit(struct net *net);
425 extern int br_add_if(struct net_bridge *br,
426 struct net_device *dev);
427 extern int br_del_if(struct net_bridge *br,
428 struct net_device *dev);
429 extern int br_min_mtu(const struct net_bridge *br);
430 extern netdev_features_t br_features_recompute(struct net_bridge *br,
431 netdev_features_t features);
434 extern int br_handle_frame_finish(struct sk_buff *skb);
435 extern rx_handler_result_t br_handle_frame(struct sk_buff **pskb);
438 extern int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
439 extern int br_ioctl_deviceless_stub(struct net *net, unsigned int cmd, void __user *arg);
442 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
443 extern unsigned int br_mdb_rehash_seq;
444 extern int br_multicast_rcv(struct net_bridge *br,
445 struct net_bridge_port *port,
446 struct sk_buff *skb);
447 extern struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
448 struct sk_buff *skb, u16 vid);
449 extern void br_multicast_add_port(struct net_bridge_port *port);
450 extern void br_multicast_del_port(struct net_bridge_port *port);
451 extern void br_multicast_enable_port(struct net_bridge_port *port);
452 extern void br_multicast_disable_port(struct net_bridge_port *port);
453 extern void br_multicast_init(struct net_bridge *br);
454 extern void br_multicast_open(struct net_bridge *br);
455 extern void br_multicast_stop(struct net_bridge *br);
456 extern void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
457 struct sk_buff *skb);
458 extern void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
459 struct sk_buff *skb, struct sk_buff *skb2);
460 extern int br_multicast_set_router(struct net_bridge *br, unsigned long val);
461 extern int br_multicast_set_port_router(struct net_bridge_port *p,
463 extern int br_multicast_toggle(struct net_bridge *br, unsigned long val);
464 extern int br_multicast_set_querier(struct net_bridge *br, unsigned long val);
465 extern int br_multicast_set_hash_max(struct net_bridge *br, unsigned long val);
466 extern struct net_bridge_mdb_entry *br_mdb_ip_get(
467 struct net_bridge_mdb_htable *mdb,
469 extern struct net_bridge_mdb_entry *br_multicast_new_group(struct net_bridge *br,
470 struct net_bridge_port *port, struct br_ip *group);
471 extern void br_multicast_free_pg(struct rcu_head *head);
472 extern struct net_bridge_port_group *br_multicast_new_port_group(
473 struct net_bridge_port *port,
475 struct net_bridge_port_group *next,
476 unsigned char state);
477 extern void br_mdb_init(void);
478 extern void br_mdb_uninit(void);
479 extern void br_mdb_notify(struct net_device *dev, struct net_bridge_port *port,
480 struct br_ip *group, int type);
482 #define mlock_dereference(X, br) \
483 rcu_dereference_protected(X, lockdep_is_held(&br->multicast_lock))
485 #if IS_ENABLED(CONFIG_IPV6)
486 #include <net/addrconf.h>
487 static inline int ipv6_is_transient_multicast(const struct in6_addr *addr)
489 if (ipv6_addr_is_multicast(addr) && IPV6_ADDR_MC_FLAG_TRANSIENT(addr))
495 static inline bool br_multicast_is_router(struct net_bridge *br)
497 return br->multicast_router == 2 ||
498 (br->multicast_router == 1 &&
499 timer_pending(&br->multicast_router_timer));
502 static inline int br_multicast_rcv(struct net_bridge *br,
503 struct net_bridge_port *port,
509 static inline struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
510 struct sk_buff *skb, u16 vid)
515 static inline void br_multicast_add_port(struct net_bridge_port *port)
519 static inline void br_multicast_del_port(struct net_bridge_port *port)
523 static inline void br_multicast_enable_port(struct net_bridge_port *port)
527 static inline void br_multicast_disable_port(struct net_bridge_port *port)
531 static inline void br_multicast_init(struct net_bridge *br)
535 static inline void br_multicast_open(struct net_bridge *br)
539 static inline void br_multicast_stop(struct net_bridge *br)
543 static inline void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
548 static inline void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
550 struct sk_buff *skb2)
553 static inline bool br_multicast_is_router(struct net_bridge *br)
557 static inline void br_mdb_init(void)
560 static inline void br_mdb_uninit(void)
566 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
567 extern bool br_allowed_ingress(struct net_bridge *br, struct net_port_vlans *v,
568 struct sk_buff *skb, u16 *vid);
569 extern bool br_allowed_egress(struct net_bridge *br,
570 const struct net_port_vlans *v,
571 const struct sk_buff *skb);
572 extern struct sk_buff *br_handle_vlan(struct net_bridge *br,
573 const struct net_port_vlans *v,
574 struct sk_buff *skb);
575 extern int br_vlan_add(struct net_bridge *br, u16 vid, u16 flags);
576 extern int br_vlan_delete(struct net_bridge *br, u16 vid);
577 extern void br_vlan_flush(struct net_bridge *br);
578 extern int br_vlan_filter_toggle(struct net_bridge *br, unsigned long val);
579 extern int nbp_vlan_add(struct net_bridge_port *port, u16 vid, u16 flags);
580 extern int nbp_vlan_delete(struct net_bridge_port *port, u16 vid);
581 extern void nbp_vlan_flush(struct net_bridge_port *port);
582 extern bool nbp_vlan_find(struct net_bridge_port *port, u16 vid);
584 static inline struct net_port_vlans *br_get_vlan_info(
585 const struct net_bridge *br)
587 return rcu_dereference_rtnl(br->vlan_info);
590 static inline struct net_port_vlans *nbp_get_vlan_info(
591 const struct net_bridge_port *p)
593 return rcu_dereference_rtnl(p->vlan_info);
596 /* Since bridge now depends on 8021Q module, but the time bridge sees the
597 * skb, the vlan tag will always be present if the frame was tagged.
599 static inline int br_vlan_get_tag(const struct sk_buff *skb, u16 *vid)
603 if (vlan_tx_tag_present(skb))
604 *vid = vlan_tx_tag_get(skb) & VLAN_VID_MASK;
613 static inline u16 br_get_pvid(const struct net_port_vlans *v)
615 /* Return just the VID if it is set, or VLAN_N_VID (invalid vid) if
619 return (v->pvid & VLAN_TAG_PRESENT) ?
620 (v->pvid & ~VLAN_TAG_PRESENT) :
625 static inline bool br_allowed_ingress(struct net_bridge *br,
626 struct net_port_vlans *v,
633 static inline bool br_allowed_egress(struct net_bridge *br,
634 const struct net_port_vlans *v,
635 const struct sk_buff *skb)
640 static inline struct sk_buff *br_handle_vlan(struct net_bridge *br,
641 const struct net_port_vlans *v,
647 static inline int br_vlan_add(struct net_bridge *br, u16 vid, u16 flags)
652 static inline int br_vlan_delete(struct net_bridge *br, u16 vid)
657 static inline void br_vlan_flush(struct net_bridge *br)
661 static inline int nbp_vlan_add(struct net_bridge_port *port, u16 vid, u16 flags)
666 static inline int nbp_vlan_delete(struct net_bridge_port *port, u16 vid)
671 static inline void nbp_vlan_flush(struct net_bridge_port *port)
675 static inline struct net_port_vlans *br_get_vlan_info(
676 const struct net_bridge *br)
680 static inline struct net_port_vlans *nbp_get_vlan_info(
681 const struct net_bridge_port *p)
686 static inline bool nbp_vlan_find(struct net_bridge_port *port, u16 vid)
691 static inline u16 br_vlan_get_tag(const struct sk_buff *skb, u16 *tag)
695 static inline u16 br_get_pvid(const struct net_port_vlans *v)
697 return VLAN_N_VID; /* Returns invalid vid */
702 #ifdef CONFIG_BRIDGE_NETFILTER
703 extern int br_netfilter_init(void);
704 extern void br_netfilter_fini(void);
705 extern void br_netfilter_rtable_init(struct net_bridge *);
707 #define br_netfilter_init() (0)
708 #define br_netfilter_fini() do { } while(0)
709 #define br_netfilter_rtable_init(x)
713 extern void br_log_state(const struct net_bridge_port *p);
714 extern struct net_bridge_port *br_get_port(struct net_bridge *br,
716 extern void br_init_port(struct net_bridge_port *p);
717 extern void br_become_designated_port(struct net_bridge_port *p);
719 extern int br_set_forward_delay(struct net_bridge *br, unsigned long x);
720 extern int br_set_hello_time(struct net_bridge *br, unsigned long x);
721 extern int br_set_max_age(struct net_bridge *br, unsigned long x);
725 extern void br_stp_enable_bridge(struct net_bridge *br);
726 extern void br_stp_disable_bridge(struct net_bridge *br);
727 extern void br_stp_set_enabled(struct net_bridge *br, unsigned long val);
728 extern void br_stp_enable_port(struct net_bridge_port *p);
729 extern void br_stp_disable_port(struct net_bridge_port *p);
730 extern bool br_stp_recalculate_bridge_id(struct net_bridge *br);
731 extern void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
732 extern void br_stp_set_bridge_priority(struct net_bridge *br,
734 extern int br_stp_set_port_priority(struct net_bridge_port *p,
735 unsigned long newprio);
736 extern int br_stp_set_path_cost(struct net_bridge_port *p,
737 unsigned long path_cost);
738 extern ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);
742 extern void br_stp_rcv(const struct stp_proto *proto, struct sk_buff *skb,
743 struct net_device *dev);
746 extern void br_stp_timer_init(struct net_bridge *br);
747 extern void br_stp_port_timer_init(struct net_bridge_port *p);
748 extern unsigned long br_timer_value(const struct timer_list *timer);
751 #if IS_ENABLED(CONFIG_ATM_LANE)
752 extern int (*br_fdb_test_addr_hook)(struct net_device *dev, unsigned char *addr);
756 extern struct rtnl_link_ops br_link_ops;
757 extern int br_netlink_init(void);
758 extern void br_netlink_fini(void);
759 extern void br_ifinfo_notify(int event, struct net_bridge_port *port);
760 extern int br_setlink(struct net_device *dev, struct nlmsghdr *nlmsg);
761 extern int br_dellink(struct net_device *dev, struct nlmsghdr *nlmsg);
762 extern int br_getlink(struct sk_buff *skb, u32 pid, u32 seq,
763 struct net_device *dev, u32 filter_mask);
767 extern const struct sysfs_ops brport_sysfs_ops;
768 extern int br_sysfs_addif(struct net_bridge_port *p);
769 extern int br_sysfs_renameif(struct net_bridge_port *p);
772 extern int br_sysfs_addbr(struct net_device *dev);
773 extern void br_sysfs_delbr(struct net_device *dev);
777 static inline int br_sysfs_addif(struct net_bridge_port *p) { return 0; }
778 static inline int br_sysfs_renameif(struct net_bridge_port *p) { return 0; }
779 static inline int br_sysfs_addbr(struct net_device *dev) { return 0; }
780 static inline void br_sysfs_delbr(struct net_device *dev) { return; }
781 #endif /* CONFIG_SYSFS */