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 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
71 struct bridge_mcast_query {
72 struct timer_list timer;
77 struct bridge_mcast_querier {
78 struct timer_list timer;
79 unsigned long delay_time;
83 struct net_port_vlans {
87 struct net_bridge_port *port;
88 struct net_bridge *br;
91 unsigned long vlan_bitmap[BR_VLAN_BITMAP_LEN];
92 unsigned long untagged_bitmap[BR_VLAN_BITMAP_LEN];
96 struct net_bridge_fdb_entry
98 struct hlist_node hlist;
99 struct net_bridge_port *dst;
102 unsigned long updated;
105 unsigned char is_local;
106 unsigned char is_static;
110 struct net_bridge_port_group {
111 struct net_bridge_port *port;
112 struct net_bridge_port_group __rcu *next;
113 struct hlist_node mglist;
115 struct timer_list timer;
120 struct net_bridge_mdb_entry
122 struct hlist_node hlist[2];
123 struct net_bridge *br;
124 struct net_bridge_port_group __rcu *ports;
126 struct timer_list timer;
132 struct net_bridge_mdb_htable
134 struct hlist_head *mhash;
136 struct net_bridge_mdb_htable *old;
143 struct net_bridge_port
145 struct net_bridge *br;
146 struct net_device *dev;
147 struct list_head list;
153 unsigned char topology_change_ack;
154 unsigned char config_pending;
156 port_id designated_port;
157 bridge_id designated_root;
158 bridge_id designated_bridge;
161 unsigned long designated_age;
163 struct timer_list forward_delay_timer;
164 struct timer_list hold_timer;
165 struct timer_list message_age_timer;
170 #define BR_HAIRPIN_MODE 0x00000001
171 #define BR_BPDU_GUARD 0x00000002
172 #define BR_ROOT_BLOCK 0x00000004
173 #define BR_MULTICAST_FAST_LEAVE 0x00000008
174 #define BR_ADMIN_COST 0x00000010
175 #define BR_LEARNING 0x00000020
176 #define BR_FLOOD 0x00000040
178 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
179 struct bridge_mcast_query ip4_query;
180 #if IS_ENABLED(CONFIG_IPV6)
181 struct bridge_mcast_query ip6_query;
182 #endif /* IS_ENABLED(CONFIG_IPV6) */
183 unsigned char multicast_router;
184 struct timer_list multicast_router_timer;
185 struct hlist_head mglist;
186 struct hlist_node rlist;
190 char sysfs_name[IFNAMSIZ];
193 #ifdef CONFIG_NET_POLL_CONTROLLER
196 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
197 struct net_port_vlans __rcu *vlan_info;
201 #define br_port_exists(dev) (dev->priv_flags & IFF_BRIDGE_PORT)
203 static inline struct net_bridge_port *br_port_get_rcu(const struct net_device *dev)
205 struct net_bridge_port *port =
206 rcu_dereference_rtnl(dev->rx_handler_data);
208 return br_port_exists(dev) ? port : NULL;
211 static inline struct net_bridge_port *br_port_get_rtnl(struct net_device *dev)
213 return br_port_exists(dev) ?
214 rtnl_dereference(dev->rx_handler_data) : NULL;
217 struct br_cpu_netstats {
222 struct u64_stats_sync syncp;
228 struct list_head port_list;
229 struct net_device *dev;
231 struct br_cpu_netstats __percpu *stats;
232 spinlock_t hash_lock;
233 struct hlist_head hash[BR_HASH_SIZE];
234 #ifdef CONFIG_BRIDGE_NETFILTER
235 struct rtable fake_rtable;
236 bool nf_call_iptables;
237 bool nf_call_ip6tables;
238 bool nf_call_arptables;
243 bridge_id designated_root;
246 unsigned long max_age;
247 unsigned long hello_time;
248 unsigned long forward_delay;
249 unsigned long bridge_max_age;
250 unsigned long ageing_time;
251 unsigned long bridge_hello_time;
252 unsigned long bridge_forward_delay;
254 u8 group_addr[ETH_ALEN];
258 BR_NO_STP, /* no spanning tree */
259 BR_KERNEL_STP, /* old STP in kernel */
260 BR_USER_STP, /* new RSTP in userspace */
263 unsigned char topology_change;
264 unsigned char topology_change_detected;
266 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
267 unsigned char multicast_router;
269 u8 multicast_disabled:1;
270 u8 multicast_querier:1;
271 u8 multicast_query_use_ifaddr:1;
276 u32 multicast_last_member_count;
277 u32 multicast_startup_query_count;
279 unsigned long multicast_last_member_interval;
280 unsigned long multicast_membership_interval;
281 unsigned long multicast_querier_interval;
282 unsigned long multicast_query_interval;
283 unsigned long multicast_query_response_interval;
284 unsigned long multicast_startup_query_interval;
286 spinlock_t multicast_lock;
287 struct net_bridge_mdb_htable __rcu *mdb;
288 struct hlist_head router_list;
290 struct timer_list multicast_router_timer;
291 struct bridge_mcast_querier ip4_querier;
292 struct bridge_mcast_query ip4_query;
293 #if IS_ENABLED(CONFIG_IPV6)
294 struct bridge_mcast_querier ip6_querier;
295 struct bridge_mcast_query ip6_query;
296 #endif /* IS_ENABLED(CONFIG_IPV6) */
299 struct timer_list hello_timer;
300 struct timer_list tcn_timer;
301 struct timer_list topology_change_timer;
302 struct timer_list gc_timer;
303 struct kobject *ifobj;
304 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
306 struct net_port_vlans __rcu *vlan_info;
310 struct br_input_skb_cb {
311 struct net_device *brdev;
312 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
318 #define BR_INPUT_SKB_CB(__skb) ((struct br_input_skb_cb *)(__skb)->cb)
320 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
321 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (BR_INPUT_SKB_CB(__skb)->mrouters_only)
323 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (0)
326 #define br_printk(level, br, format, args...) \
327 printk(level "%s: " format, (br)->dev->name, ##args)
329 #define br_err(__br, format, args...) \
330 br_printk(KERN_ERR, __br, format, ##args)
331 #define br_warn(__br, format, args...) \
332 br_printk(KERN_WARNING, __br, format, ##args)
333 #define br_notice(__br, format, args...) \
334 br_printk(KERN_NOTICE, __br, format, ##args)
335 #define br_info(__br, format, args...) \
336 br_printk(KERN_INFO, __br, format, ##args)
338 #define br_debug(br, format, args...) \
339 pr_debug("%s: " format, (br)->dev->name, ##args)
341 extern struct notifier_block br_device_notifier;
343 /* called under bridge lock */
344 static inline int br_is_root_bridge(const struct net_bridge *br)
346 return !memcmp(&br->bridge_id, &br->designated_root, 8);
350 extern void br_dev_setup(struct net_device *dev);
351 extern void br_dev_delete(struct net_device *dev, struct list_head *list);
352 extern netdev_tx_t br_dev_xmit(struct sk_buff *skb,
353 struct net_device *dev);
354 #ifdef CONFIG_NET_POLL_CONTROLLER
355 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
358 struct netpoll *np = p->np;
361 netpoll_send_skb(np, skb);
364 extern int br_netpoll_enable(struct net_bridge_port *p, gfp_t gfp);
365 extern void br_netpoll_disable(struct net_bridge_port *p);
367 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
372 static inline int br_netpoll_enable(struct net_bridge_port *p, gfp_t gfp)
377 static inline void br_netpoll_disable(struct net_bridge_port *p)
383 extern int br_fdb_init(void);
384 extern void br_fdb_fini(void);
385 extern void br_fdb_flush(struct net_bridge *br);
386 extern void br_fdb_changeaddr(struct net_bridge_port *p,
387 const unsigned char *newaddr);
388 extern void br_fdb_change_mac_address(struct net_bridge *br, const u8 *newaddr);
389 extern void br_fdb_cleanup(unsigned long arg);
390 extern void br_fdb_delete_by_port(struct net_bridge *br,
391 const struct net_bridge_port *p, int do_all);
392 extern struct net_bridge_fdb_entry *__br_fdb_get(struct net_bridge *br,
393 const unsigned char *addr,
395 extern int br_fdb_test_addr(struct net_device *dev, unsigned char *addr);
396 extern int br_fdb_fillbuf(struct net_bridge *br, void *buf,
397 unsigned long count, unsigned long off);
398 extern int br_fdb_insert(struct net_bridge *br,
399 struct net_bridge_port *source,
400 const unsigned char *addr,
402 extern void br_fdb_update(struct net_bridge *br,
403 struct net_bridge_port *source,
404 const unsigned char *addr,
406 extern int fdb_delete_by_addr(struct net_bridge *br, const u8 *addr, u16 vid);
408 extern int br_fdb_delete(struct ndmsg *ndm, struct nlattr *tb[],
409 struct net_device *dev,
410 const unsigned char *addr);
411 extern int br_fdb_add(struct ndmsg *nlh, struct nlattr *tb[],
412 struct net_device *dev,
413 const unsigned char *addr,
415 extern int br_fdb_dump(struct sk_buff *skb,
416 struct netlink_callback *cb,
417 struct net_device *dev,
421 extern void br_deliver(const struct net_bridge_port *to,
422 struct sk_buff *skb);
423 extern int br_dev_queue_push_xmit(struct sk_buff *skb);
424 extern void br_forward(const struct net_bridge_port *to,
425 struct sk_buff *skb, struct sk_buff *skb0);
426 extern int br_forward_finish(struct sk_buff *skb);
427 extern void br_flood_deliver(struct net_bridge *br, struct sk_buff *skb,
429 extern void br_flood_forward(struct net_bridge *br, struct sk_buff *skb,
430 struct sk_buff *skb2, bool unicast);
433 extern void br_port_carrier_check(struct net_bridge_port *p);
434 extern int br_add_bridge(struct net *net, const char *name);
435 extern int br_del_bridge(struct net *net, const char *name);
436 extern void br_net_exit(struct net *net);
437 extern int br_add_if(struct net_bridge *br,
438 struct net_device *dev);
439 extern int br_del_if(struct net_bridge *br,
440 struct net_device *dev);
441 extern int br_min_mtu(const struct net_bridge *br);
442 extern netdev_features_t br_features_recompute(struct net_bridge *br,
443 netdev_features_t features);
446 extern int br_handle_frame_finish(struct sk_buff *skb);
447 extern rx_handler_result_t br_handle_frame(struct sk_buff **pskb);
450 extern int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
451 extern int br_ioctl_deviceless_stub(struct net *net, unsigned int cmd, void __user *arg);
454 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
455 extern unsigned int br_mdb_rehash_seq;
456 extern int br_multicast_rcv(struct net_bridge *br,
457 struct net_bridge_port *port,
458 struct sk_buff *skb);
459 extern struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
460 struct sk_buff *skb, u16 vid);
461 extern void br_multicast_add_port(struct net_bridge_port *port);
462 extern void br_multicast_del_port(struct net_bridge_port *port);
463 extern void br_multicast_enable_port(struct net_bridge_port *port);
464 extern void br_multicast_disable_port(struct net_bridge_port *port);
465 extern void br_multicast_init(struct net_bridge *br);
466 extern void br_multicast_open(struct net_bridge *br);
467 extern void br_multicast_stop(struct net_bridge *br);
468 extern void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
469 struct sk_buff *skb);
470 extern void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
471 struct sk_buff *skb, struct sk_buff *skb2);
472 extern int br_multicast_set_router(struct net_bridge *br, unsigned long val);
473 extern int br_multicast_set_port_router(struct net_bridge_port *p,
475 extern int br_multicast_toggle(struct net_bridge *br, unsigned long val);
476 extern int br_multicast_set_querier(struct net_bridge *br, unsigned long val);
477 extern int br_multicast_set_hash_max(struct net_bridge *br, unsigned long val);
478 extern struct net_bridge_mdb_entry *br_mdb_ip_get(
479 struct net_bridge_mdb_htable *mdb,
481 extern struct net_bridge_mdb_entry *br_multicast_new_group(struct net_bridge *br,
482 struct net_bridge_port *port, struct br_ip *group);
483 extern void br_multicast_free_pg(struct rcu_head *head);
484 extern struct net_bridge_port_group *br_multicast_new_port_group(
485 struct net_bridge_port *port,
487 struct net_bridge_port_group __rcu *next,
488 unsigned char state);
489 extern void br_mdb_init(void);
490 extern void br_mdb_uninit(void);
491 extern void br_mdb_notify(struct net_device *dev, struct net_bridge_port *port,
492 struct br_ip *group, int type);
494 #define mlock_dereference(X, br) \
495 rcu_dereference_protected(X, lockdep_is_held(&br->multicast_lock))
497 static inline bool br_multicast_is_router(struct net_bridge *br)
499 return br->multicast_router == 2 ||
500 (br->multicast_router == 1 &&
501 timer_pending(&br->multicast_router_timer));
505 __br_multicast_querier_exists(struct net_bridge *br,
506 struct bridge_mcast_querier *querier)
508 return time_is_before_jiffies(querier->delay_time) &&
509 (br->multicast_querier || timer_pending(&querier->timer));
512 static inline bool br_multicast_querier_exists(struct net_bridge *br,
515 switch (eth->h_proto) {
516 case (htons(ETH_P_IP)):
517 return __br_multicast_querier_exists(br, &br->ip4_querier);
518 #if IS_ENABLED(CONFIG_IPV6)
519 case (htons(ETH_P_IPV6)):
520 return __br_multicast_querier_exists(br, &br->ip6_querier);
527 static inline int br_multicast_rcv(struct net_bridge *br,
528 struct net_bridge_port *port,
534 static inline struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
535 struct sk_buff *skb, u16 vid)
540 static inline void br_multicast_add_port(struct net_bridge_port *port)
544 static inline void br_multicast_del_port(struct net_bridge_port *port)
548 static inline void br_multicast_enable_port(struct net_bridge_port *port)
552 static inline void br_multicast_disable_port(struct net_bridge_port *port)
556 static inline void br_multicast_init(struct net_bridge *br)
560 static inline void br_multicast_open(struct net_bridge *br)
564 static inline void br_multicast_stop(struct net_bridge *br)
568 static inline void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
573 static inline void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
575 struct sk_buff *skb2)
578 static inline bool br_multicast_is_router(struct net_bridge *br)
582 static inline bool br_multicast_querier_exists(struct net_bridge *br,
587 static inline void br_mdb_init(void)
590 static inline void br_mdb_uninit(void)
596 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
597 extern bool br_allowed_ingress(struct net_bridge *br, struct net_port_vlans *v,
598 struct sk_buff *skb, u16 *vid);
599 extern bool br_allowed_egress(struct net_bridge *br,
600 const struct net_port_vlans *v,
601 const struct sk_buff *skb);
602 extern struct sk_buff *br_handle_vlan(struct net_bridge *br,
603 const struct net_port_vlans *v,
604 struct sk_buff *skb);
605 extern int br_vlan_add(struct net_bridge *br, u16 vid, u16 flags);
606 extern int br_vlan_delete(struct net_bridge *br, u16 vid);
607 extern void br_vlan_flush(struct net_bridge *br);
608 extern int br_vlan_filter_toggle(struct net_bridge *br, unsigned long val);
609 extern int nbp_vlan_add(struct net_bridge_port *port, u16 vid, u16 flags);
610 extern int nbp_vlan_delete(struct net_bridge_port *port, u16 vid);
611 extern void nbp_vlan_flush(struct net_bridge_port *port);
612 extern bool nbp_vlan_find(struct net_bridge_port *port, u16 vid);
614 static inline struct net_port_vlans *br_get_vlan_info(
615 const struct net_bridge *br)
617 return rcu_dereference_rtnl(br->vlan_info);
620 static inline struct net_port_vlans *nbp_get_vlan_info(
621 const struct net_bridge_port *p)
623 return rcu_dereference_rtnl(p->vlan_info);
626 /* Since bridge now depends on 8021Q module, but the time bridge sees the
627 * skb, the vlan tag will always be present if the frame was tagged.
629 static inline int br_vlan_get_tag(const struct sk_buff *skb, u16 *vid)
633 if (vlan_tx_tag_present(skb))
634 *vid = vlan_tx_tag_get(skb) & VLAN_VID_MASK;
643 static inline u16 br_get_pvid(const struct net_port_vlans *v)
645 /* Return just the VID if it is set, or VLAN_N_VID (invalid vid) if
649 return (v->pvid & VLAN_TAG_PRESENT) ?
650 (v->pvid & ~VLAN_TAG_PRESENT) :
655 static inline bool br_allowed_ingress(struct net_bridge *br,
656 struct net_port_vlans *v,
663 static inline bool br_allowed_egress(struct net_bridge *br,
664 const struct net_port_vlans *v,
665 const struct sk_buff *skb)
670 static inline struct sk_buff *br_handle_vlan(struct net_bridge *br,
671 const struct net_port_vlans *v,
677 static inline int br_vlan_add(struct net_bridge *br, u16 vid, u16 flags)
682 static inline int br_vlan_delete(struct net_bridge *br, u16 vid)
687 static inline void br_vlan_flush(struct net_bridge *br)
691 static inline int nbp_vlan_add(struct net_bridge_port *port, u16 vid, u16 flags)
696 static inline int nbp_vlan_delete(struct net_bridge_port *port, u16 vid)
701 static inline void nbp_vlan_flush(struct net_bridge_port *port)
705 static inline struct net_port_vlans *br_get_vlan_info(
706 const struct net_bridge *br)
710 static inline struct net_port_vlans *nbp_get_vlan_info(
711 const struct net_bridge_port *p)
716 static inline bool nbp_vlan_find(struct net_bridge_port *port, u16 vid)
721 static inline u16 br_vlan_get_tag(const struct sk_buff *skb, u16 *tag)
725 static inline u16 br_get_pvid(const struct net_port_vlans *v)
727 return VLAN_N_VID; /* Returns invalid vid */
732 #ifdef CONFIG_BRIDGE_NETFILTER
733 extern int br_netfilter_init(void);
734 extern void br_netfilter_fini(void);
735 extern void br_netfilter_rtable_init(struct net_bridge *);
737 #define br_netfilter_init() (0)
738 #define br_netfilter_fini() do { } while(0)
739 #define br_netfilter_rtable_init(x)
743 extern void br_log_state(const struct net_bridge_port *p);
744 extern struct net_bridge_port *br_get_port(struct net_bridge *br,
746 extern void br_init_port(struct net_bridge_port *p);
747 extern void br_become_designated_port(struct net_bridge_port *p);
749 extern int br_set_forward_delay(struct net_bridge *br, unsigned long x);
750 extern int br_set_hello_time(struct net_bridge *br, unsigned long x);
751 extern int br_set_max_age(struct net_bridge *br, unsigned long x);
755 extern void br_stp_enable_bridge(struct net_bridge *br);
756 extern void br_stp_disable_bridge(struct net_bridge *br);
757 extern void br_stp_set_enabled(struct net_bridge *br, unsigned long val);
758 extern void br_stp_enable_port(struct net_bridge_port *p);
759 extern void br_stp_disable_port(struct net_bridge_port *p);
760 extern bool br_stp_recalculate_bridge_id(struct net_bridge *br);
761 extern void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
762 extern void br_stp_set_bridge_priority(struct net_bridge *br,
764 extern int br_stp_set_port_priority(struct net_bridge_port *p,
765 unsigned long newprio);
766 extern int br_stp_set_path_cost(struct net_bridge_port *p,
767 unsigned long path_cost);
768 extern ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);
772 extern void br_stp_rcv(const struct stp_proto *proto, struct sk_buff *skb,
773 struct net_device *dev);
776 extern void br_stp_timer_init(struct net_bridge *br);
777 extern void br_stp_port_timer_init(struct net_bridge_port *p);
778 extern unsigned long br_timer_value(const struct timer_list *timer);
781 #if IS_ENABLED(CONFIG_ATM_LANE)
782 extern int (*br_fdb_test_addr_hook)(struct net_device *dev, unsigned char *addr);
786 extern struct rtnl_link_ops br_link_ops;
787 extern int br_netlink_init(void);
788 extern void br_netlink_fini(void);
789 extern void br_ifinfo_notify(int event, struct net_bridge_port *port);
790 extern int br_setlink(struct net_device *dev, struct nlmsghdr *nlmsg);
791 extern int br_dellink(struct net_device *dev, struct nlmsghdr *nlmsg);
792 extern int br_getlink(struct sk_buff *skb, u32 pid, u32 seq,
793 struct net_device *dev, u32 filter_mask);
797 extern const struct sysfs_ops brport_sysfs_ops;
798 extern int br_sysfs_addif(struct net_bridge_port *p);
799 extern int br_sysfs_renameif(struct net_bridge_port *p);
802 extern int br_sysfs_addbr(struct net_device *dev);
803 extern void br_sysfs_delbr(struct net_device *dev);
807 static inline int br_sysfs_addif(struct net_bridge_port *p) { return 0; }
808 static inline int br_sysfs_renameif(struct net_bridge_port *p) { return 0; }
809 static inline int br_sysfs_addbr(struct net_device *dev) { return 0; }
810 static inline void br_sysfs_delbr(struct net_device *dev) { return; }
811 #endif /* CONFIG_SYSFS */