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 {
72 struct net_bridge_port *port;
73 struct net_bridge *br;
76 unsigned long vlan_bitmap[BR_VLAN_BITMAP_LEN];
80 struct net_bridge_fdb_entry
82 struct hlist_node hlist;
83 struct net_bridge_port *dst;
86 unsigned long updated;
89 unsigned char is_local;
90 unsigned char is_static;
93 struct net_bridge_port_group {
94 struct net_bridge_port *port;
95 struct net_bridge_port_group __rcu *next;
96 struct hlist_node mglist;
98 struct timer_list timer;
103 struct net_bridge_mdb_entry
105 struct hlist_node hlist[2];
106 struct net_bridge *br;
107 struct net_bridge_port_group __rcu *ports;
109 struct timer_list timer;
114 struct net_bridge_mdb_htable
116 struct hlist_head *mhash;
118 struct net_bridge_mdb_htable *old;
125 struct net_bridge_port
127 struct net_bridge *br;
128 struct net_device *dev;
129 struct list_head list;
135 unsigned char topology_change_ack;
136 unsigned char config_pending;
138 port_id designated_port;
139 bridge_id designated_root;
140 bridge_id designated_bridge;
143 unsigned long designated_age;
145 struct timer_list forward_delay_timer;
146 struct timer_list hold_timer;
147 struct timer_list message_age_timer;
152 #define BR_HAIRPIN_MODE 0x00000001
153 #define BR_BPDU_GUARD 0x00000002
154 #define BR_ROOT_BLOCK 0x00000004
155 #define BR_MULTICAST_FAST_LEAVE 0x00000008
157 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
158 u32 multicast_startup_queries_sent;
159 unsigned char multicast_router;
160 struct timer_list multicast_router_timer;
161 struct timer_list multicast_query_timer;
162 struct hlist_head mglist;
163 struct hlist_node rlist;
167 char sysfs_name[IFNAMSIZ];
170 #ifdef CONFIG_NET_POLL_CONTROLLER
173 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
174 struct net_port_vlans __rcu *vlan_info;
178 #define br_port_exists(dev) (dev->priv_flags & IFF_BRIDGE_PORT)
180 static inline struct net_bridge_port *br_port_get_rcu(const struct net_device *dev)
182 struct net_bridge_port *port =
183 rcu_dereference_rtnl(dev->rx_handler_data);
185 return br_port_exists(dev) ? port : NULL;
188 static inline struct net_bridge_port *br_port_get_rtnl(struct net_device *dev)
190 return br_port_exists(dev) ?
191 rtnl_dereference(dev->rx_handler_data) : NULL;
194 struct br_cpu_netstats {
199 struct u64_stats_sync syncp;
205 struct list_head port_list;
206 struct net_device *dev;
208 struct br_cpu_netstats __percpu *stats;
209 spinlock_t hash_lock;
210 struct hlist_head hash[BR_HASH_SIZE];
211 #ifdef CONFIG_BRIDGE_NETFILTER
212 struct rtable fake_rtable;
213 bool nf_call_iptables;
214 bool nf_call_ip6tables;
215 bool nf_call_arptables;
220 bridge_id designated_root;
223 unsigned long max_age;
224 unsigned long hello_time;
225 unsigned long forward_delay;
226 unsigned long bridge_max_age;
227 unsigned long ageing_time;
228 unsigned long bridge_hello_time;
229 unsigned long bridge_forward_delay;
231 u8 group_addr[ETH_ALEN];
235 BR_NO_STP, /* no spanning tree */
236 BR_KERNEL_STP, /* old STP in kernel */
237 BR_USER_STP, /* new RSTP in userspace */
240 unsigned char topology_change;
241 unsigned char topology_change_detected;
243 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
244 unsigned char multicast_router;
246 u8 multicast_disabled:1;
247 u8 multicast_querier:1;
252 u32 multicast_last_member_count;
253 u32 multicast_startup_queries_sent;
254 u32 multicast_startup_query_count;
256 unsigned long multicast_last_member_interval;
257 unsigned long multicast_membership_interval;
258 unsigned long multicast_querier_interval;
259 unsigned long multicast_query_interval;
260 unsigned long multicast_query_response_interval;
261 unsigned long multicast_startup_query_interval;
263 spinlock_t multicast_lock;
264 struct net_bridge_mdb_htable __rcu *mdb;
265 struct hlist_head router_list;
267 struct timer_list multicast_router_timer;
268 struct timer_list multicast_querier_timer;
269 struct timer_list multicast_query_timer;
272 struct timer_list hello_timer;
273 struct timer_list tcn_timer;
274 struct timer_list topology_change_timer;
275 struct timer_list gc_timer;
276 struct kobject *ifobj;
277 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
279 struct net_port_vlans __rcu *vlan_info;
283 struct br_input_skb_cb {
284 struct net_device *brdev;
285 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
291 #define BR_INPUT_SKB_CB(__skb) ((struct br_input_skb_cb *)(__skb)->cb)
293 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
294 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (BR_INPUT_SKB_CB(__skb)->mrouters_only)
296 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (0)
299 #define br_printk(level, br, format, args...) \
300 printk(level "%s: " format, (br)->dev->name, ##args)
302 #define br_err(__br, format, args...) \
303 br_printk(KERN_ERR, __br, format, ##args)
304 #define br_warn(__br, format, args...) \
305 br_printk(KERN_WARNING, __br, format, ##args)
306 #define br_notice(__br, format, args...) \
307 br_printk(KERN_NOTICE, __br, format, ##args)
308 #define br_info(__br, format, args...) \
309 br_printk(KERN_INFO, __br, format, ##args)
311 #define br_debug(br, format, args...) \
312 pr_debug("%s: " format, (br)->dev->name, ##args)
314 extern struct notifier_block br_device_notifier;
316 /* called under bridge lock */
317 static inline int br_is_root_bridge(const struct net_bridge *br)
319 return !memcmp(&br->bridge_id, &br->designated_root, 8);
323 extern void br_dev_setup(struct net_device *dev);
324 extern void br_dev_delete(struct net_device *dev, struct list_head *list);
325 extern netdev_tx_t br_dev_xmit(struct sk_buff *skb,
326 struct net_device *dev);
327 #ifdef CONFIG_NET_POLL_CONTROLLER
328 static inline struct netpoll_info *br_netpoll_info(struct net_bridge *br)
330 return br->dev->npinfo;
333 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
336 struct netpoll *np = p->np;
339 netpoll_send_skb(np, skb);
342 extern int br_netpoll_enable(struct net_bridge_port *p, gfp_t gfp);
343 extern void br_netpoll_disable(struct net_bridge_port *p);
345 static inline struct netpoll_info *br_netpoll_info(struct net_bridge *br)
350 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
355 static inline int br_netpoll_enable(struct net_bridge_port *p, gfp_t gfp)
360 static inline void br_netpoll_disable(struct net_bridge_port *p)
366 extern int br_fdb_init(void);
367 extern void br_fdb_fini(void);
368 extern void br_fdb_flush(struct net_bridge *br);
369 extern void br_fdb_changeaddr(struct net_bridge_port *p,
370 const unsigned char *newaddr);
371 extern void br_fdb_change_mac_address(struct net_bridge *br, const u8 *newaddr);
372 extern void br_fdb_cleanup(unsigned long arg);
373 extern void br_fdb_delete_by_port(struct net_bridge *br,
374 const struct net_bridge_port *p, int do_all);
375 extern struct net_bridge_fdb_entry *__br_fdb_get(struct net_bridge *br,
376 const unsigned char *addr);
377 extern int br_fdb_test_addr(struct net_device *dev, unsigned char *addr);
378 extern int br_fdb_fillbuf(struct net_bridge *br, void *buf,
379 unsigned long count, unsigned long off);
380 extern int br_fdb_insert(struct net_bridge *br,
381 struct net_bridge_port *source,
382 const unsigned char *addr);
383 extern void br_fdb_update(struct net_bridge *br,
384 struct net_bridge_port *source,
385 const unsigned char *addr);
387 extern int br_fdb_delete(struct ndmsg *ndm,
388 struct net_device *dev,
389 const unsigned char *addr);
390 extern int br_fdb_add(struct ndmsg *nlh, struct nlattr *tb[],
391 struct net_device *dev,
392 const unsigned char *addr,
394 extern int br_fdb_dump(struct sk_buff *skb,
395 struct netlink_callback *cb,
396 struct net_device *dev,
400 extern void br_deliver(const struct net_bridge_port *to,
401 struct sk_buff *skb);
402 extern int br_dev_queue_push_xmit(struct sk_buff *skb);
403 extern void br_forward(const struct net_bridge_port *to,
404 struct sk_buff *skb, struct sk_buff *skb0);
405 extern int br_forward_finish(struct sk_buff *skb);
406 extern void br_flood_deliver(struct net_bridge *br, struct sk_buff *skb);
407 extern void br_flood_forward(struct net_bridge *br, struct sk_buff *skb,
408 struct sk_buff *skb2);
411 extern void br_port_carrier_check(struct net_bridge_port *p);
412 extern int br_add_bridge(struct net *net, const char *name);
413 extern int br_del_bridge(struct net *net, const char *name);
414 extern void br_net_exit(struct net *net);
415 extern int br_add_if(struct net_bridge *br,
416 struct net_device *dev);
417 extern int br_del_if(struct net_bridge *br,
418 struct net_device *dev);
419 extern int br_min_mtu(const struct net_bridge *br);
420 extern netdev_features_t br_features_recompute(struct net_bridge *br,
421 netdev_features_t features);
424 extern int br_handle_frame_finish(struct sk_buff *skb);
425 extern rx_handler_result_t br_handle_frame(struct sk_buff **pskb);
428 extern int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
429 extern int br_ioctl_deviceless_stub(struct net *net, unsigned int cmd, void __user *arg);
432 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
433 extern unsigned int br_mdb_rehash_seq;
434 extern int br_multicast_rcv(struct net_bridge *br,
435 struct net_bridge_port *port,
436 struct sk_buff *skb);
437 extern struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
438 struct sk_buff *skb);
439 extern void br_multicast_add_port(struct net_bridge_port *port);
440 extern void br_multicast_del_port(struct net_bridge_port *port);
441 extern void br_multicast_enable_port(struct net_bridge_port *port);
442 extern void br_multicast_disable_port(struct net_bridge_port *port);
443 extern void br_multicast_init(struct net_bridge *br);
444 extern void br_multicast_open(struct net_bridge *br);
445 extern void br_multicast_stop(struct net_bridge *br);
446 extern void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
447 struct sk_buff *skb);
448 extern void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
449 struct sk_buff *skb, struct sk_buff *skb2);
450 extern int br_multicast_set_router(struct net_bridge *br, unsigned long val);
451 extern int br_multicast_set_port_router(struct net_bridge_port *p,
453 extern int br_multicast_toggle(struct net_bridge *br, unsigned long val);
454 extern int br_multicast_set_querier(struct net_bridge *br, unsigned long val);
455 extern int br_multicast_set_hash_max(struct net_bridge *br, unsigned long val);
456 extern struct net_bridge_mdb_entry *br_mdb_ip_get(
457 struct net_bridge_mdb_htable *mdb,
459 extern struct net_bridge_mdb_entry *br_multicast_new_group(struct net_bridge *br,
460 struct net_bridge_port *port, struct br_ip *group);
461 extern void br_multicast_free_pg(struct rcu_head *head);
462 extern struct net_bridge_port_group *br_multicast_new_port_group(
463 struct net_bridge_port *port,
465 struct net_bridge_port_group *next,
466 unsigned char state);
467 extern void br_mdb_init(void);
468 extern void br_mdb_uninit(void);
469 extern void br_mdb_notify(struct net_device *dev, struct net_bridge_port *port,
470 struct br_ip *group, int type);
472 #define mlock_dereference(X, br) \
473 rcu_dereference_protected(X, lockdep_is_held(&br->multicast_lock))
475 #if IS_ENABLED(CONFIG_IPV6)
476 #include <net/addrconf.h>
477 static inline int ipv6_is_transient_multicast(const struct in6_addr *addr)
479 if (ipv6_addr_is_multicast(addr) && IPV6_ADDR_MC_FLAG_TRANSIENT(addr))
485 static inline bool br_multicast_is_router(struct net_bridge *br)
487 return br->multicast_router == 2 ||
488 (br->multicast_router == 1 &&
489 timer_pending(&br->multicast_router_timer));
492 static inline int br_multicast_rcv(struct net_bridge *br,
493 struct net_bridge_port *port,
499 static inline struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
505 static inline void br_multicast_add_port(struct net_bridge_port *port)
509 static inline void br_multicast_del_port(struct net_bridge_port *port)
513 static inline void br_multicast_enable_port(struct net_bridge_port *port)
517 static inline void br_multicast_disable_port(struct net_bridge_port *port)
521 static inline void br_multicast_init(struct net_bridge *br)
525 static inline void br_multicast_open(struct net_bridge *br)
529 static inline void br_multicast_stop(struct net_bridge *br)
533 static inline void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
538 static inline void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
540 struct sk_buff *skb2)
543 static inline bool br_multicast_is_router(struct net_bridge *br)
547 static inline void br_mdb_init(void)
550 static inline void br_mdb_uninit(void)
556 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
557 extern bool br_allowed_ingress(struct net_bridge *br, struct net_port_vlans *v,
558 struct sk_buff *skb, u16 *vid);
559 extern bool br_allowed_egress(struct net_bridge *br,
560 const struct net_port_vlans *v,
561 const struct sk_buff *skb);
562 extern struct sk_buff *br_handle_vlan(struct net_bridge *br,
563 const struct net_port_vlans *v,
564 struct sk_buff *skb);
565 extern int br_vlan_add(struct net_bridge *br, u16 vid, u16 flags);
566 extern int br_vlan_delete(struct net_bridge *br, u16 vid);
567 extern void br_vlan_flush(struct net_bridge *br);
568 extern int br_vlan_filter_toggle(struct net_bridge *br, unsigned long val);
569 extern int nbp_vlan_add(struct net_bridge_port *port, u16 vid, u16 flags);
570 extern int nbp_vlan_delete(struct net_bridge_port *port, u16 vid);
571 extern void nbp_vlan_flush(struct net_bridge_port *port);
573 static inline struct net_port_vlans *br_get_vlan_info(
574 const struct net_bridge *br)
576 return rcu_dereference(br->vlan_info);
579 static inline struct net_port_vlans *nbp_get_vlan_info(
580 const struct net_bridge_port *p)
582 return rcu_dereference(p->vlan_info);
585 /* Since bridge now depends on 8021Q module, but the time bridge sees the
586 * skb, the vlan tag will always be present if the frame was tagged.
588 static inline int br_vlan_get_tag(const struct sk_buff *skb, u16 *vid)
592 if (vlan_tx_tag_present(skb))
593 *vid = vlan_tx_tag_get(skb) & VLAN_VID_MASK;
602 static inline u16 br_get_pvid(const struct net_port_vlans *v)
604 /* Return just the VID if it is set, or VLAN_N_VID (invalid vid) if
608 return (v->pvid & VLAN_TAG_PRESENT) ?
609 (v->pvid & ~VLAN_TAG_PRESENT) :
614 static inline bool br_allowed_ingress(struct net_bridge *br,
615 struct net_port_vlans *v,
622 static inline bool br_allowed_egress(struct net_bridge *br,
623 const struct net_port_vlans *v,
624 const struct sk_buff *skb)
629 static inline struct sk_buff *br_handle_vlan(struct net_bridge *br,
630 const struct net_port_vlans *v,
636 static inline int br_vlan_add(struct net_bridge *br, u16 vid, u16 flags)
641 static inline int br_vlan_delete(struct net_bridge *br, u16 vid)
646 static inline void br_vlan_flush(struct net_bridge *br)
650 static inline int nbp_vlan_add(struct net_bridge_port *port, u16 vid, u16 flags)
655 static inline int nbp_vlan_delete(struct net_bridge_port *port, u16 vid)
660 static inline void nbp_vlan_flush(struct net_bridge_port *port)
664 static inline struct net_port_vlans *br_get_vlan_info(
665 const struct net_bridge *br)
669 static inline struct net_port_vlans *nbp_get_vlan_info(
670 const struct net_bridge_port *p)
675 static inline u16 br_vlan_get_tag(const struct sk_buff *skb, u16 *tag)
679 static inline u16 br_get_pvid(const struct net_port_vlans *v)
681 return VLAN_N_VID; /* Returns invalid vid */
686 #ifdef CONFIG_BRIDGE_NETFILTER
687 extern int br_netfilter_init(void);
688 extern void br_netfilter_fini(void);
689 extern void br_netfilter_rtable_init(struct net_bridge *);
691 #define br_netfilter_init() (0)
692 #define br_netfilter_fini() do { } while(0)
693 #define br_netfilter_rtable_init(x)
697 extern void br_log_state(const struct net_bridge_port *p);
698 extern struct net_bridge_port *br_get_port(struct net_bridge *br,
700 extern void br_init_port(struct net_bridge_port *p);
701 extern void br_become_designated_port(struct net_bridge_port *p);
703 extern int br_set_forward_delay(struct net_bridge *br, unsigned long x);
704 extern int br_set_hello_time(struct net_bridge *br, unsigned long x);
705 extern int br_set_max_age(struct net_bridge *br, unsigned long x);
709 extern void br_stp_enable_bridge(struct net_bridge *br);
710 extern void br_stp_disable_bridge(struct net_bridge *br);
711 extern void br_stp_set_enabled(struct net_bridge *br, unsigned long val);
712 extern void br_stp_enable_port(struct net_bridge_port *p);
713 extern void br_stp_disable_port(struct net_bridge_port *p);
714 extern bool br_stp_recalculate_bridge_id(struct net_bridge *br);
715 extern void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
716 extern void br_stp_set_bridge_priority(struct net_bridge *br,
718 extern int br_stp_set_port_priority(struct net_bridge_port *p,
719 unsigned long newprio);
720 extern int br_stp_set_path_cost(struct net_bridge_port *p,
721 unsigned long path_cost);
722 extern ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);
726 extern void br_stp_rcv(const struct stp_proto *proto, struct sk_buff *skb,
727 struct net_device *dev);
730 extern void br_stp_timer_init(struct net_bridge *br);
731 extern void br_stp_port_timer_init(struct net_bridge_port *p);
732 extern unsigned long br_timer_value(const struct timer_list *timer);
735 #if IS_ENABLED(CONFIG_ATM_LANE)
736 extern int (*br_fdb_test_addr_hook)(struct net_device *dev, unsigned char *addr);
740 extern struct rtnl_link_ops br_link_ops;
741 extern int br_netlink_init(void);
742 extern void br_netlink_fini(void);
743 extern void br_ifinfo_notify(int event, struct net_bridge_port *port);
744 extern int br_setlink(struct net_device *dev, struct nlmsghdr *nlmsg);
745 extern int br_dellink(struct net_device *dev, struct nlmsghdr *nlmsg);
746 extern int br_getlink(struct sk_buff *skb, u32 pid, u32 seq,
747 struct net_device *dev, u32 filter_mask);
751 extern const struct sysfs_ops brport_sysfs_ops;
752 extern int br_sysfs_addif(struct net_bridge_port *p);
753 extern int br_sysfs_renameif(struct net_bridge_port *p);
756 extern int br_sysfs_addbr(struct net_device *dev);
757 extern void br_sysfs_delbr(struct net_device *dev);
761 static inline int br_sysfs_addif(struct net_bridge_port *p) { return 0; }
762 static inline int br_sysfs_renameif(struct net_bridge_port *p) { return 0; }
763 static inline int br_sysfs_addbr(struct net_device *dev) { return 0; }
764 static inline void br_sysfs_delbr(struct net_device *dev) { return; }
765 #endif /* CONFIG_SYSFS */