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[ETH_ALEN];
54 unsigned char addr[ETH_ALEN];
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;
107 unsigned char added_by_user;
111 struct net_bridge_port_group {
112 struct net_bridge_port *port;
113 struct net_bridge_port_group __rcu *next;
114 struct hlist_node mglist;
116 struct timer_list timer;
121 struct net_bridge_mdb_entry
123 struct hlist_node hlist[2];
124 struct net_bridge *br;
125 struct net_bridge_port_group __rcu *ports;
127 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
177 #define BR_AUTO_MASK (BR_FLOOD | BR_LEARNING)
179 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
180 struct bridge_mcast_query ip4_query;
181 #if IS_ENABLED(CONFIG_IPV6)
182 struct bridge_mcast_query ip6_query;
183 #endif /* IS_ENABLED(CONFIG_IPV6) */
184 unsigned char multicast_router;
185 struct timer_list multicast_router_timer;
186 struct hlist_head mglist;
187 struct hlist_node rlist;
191 char sysfs_name[IFNAMSIZ];
194 #ifdef CONFIG_NET_POLL_CONTROLLER
197 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
198 struct net_port_vlans __rcu *vlan_info;
202 #define br_auto_port(p) ((p)->flags & BR_AUTO_MASK)
204 #define br_port_exists(dev) (dev->priv_flags & IFF_BRIDGE_PORT)
206 static inline struct net_bridge_port *br_port_get_rcu(const struct net_device *dev)
208 return rcu_dereference(dev->rx_handler_data);
211 static inline struct net_bridge_port *br_port_get_rtnl(const struct net_device *dev)
213 return br_port_exists(dev) ?
214 rtnl_dereference(dev->rx_handler_data) : NULL;
220 struct list_head port_list;
221 struct net_device *dev;
223 struct pcpu_sw_netstats __percpu *stats;
224 spinlock_t hash_lock;
225 struct hlist_head hash[BR_HASH_SIZE];
226 #ifdef CONFIG_BRIDGE_NETFILTER
227 struct rtable fake_rtable;
228 bool nf_call_iptables;
229 bool nf_call_ip6tables;
230 bool nf_call_arptables;
235 bridge_id designated_root;
238 unsigned long max_age;
239 unsigned long hello_time;
240 unsigned long forward_delay;
241 unsigned long bridge_max_age;
242 unsigned long ageing_time;
243 unsigned long bridge_hello_time;
244 unsigned long bridge_forward_delay;
246 u8 group_addr[ETH_ALEN];
250 BR_NO_STP, /* no spanning tree */
251 BR_KERNEL_STP, /* old STP in kernel */
252 BR_USER_STP, /* new RSTP in userspace */
255 unsigned char topology_change;
256 unsigned char topology_change_detected;
258 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
259 unsigned char multicast_router;
261 u8 multicast_disabled:1;
262 u8 multicast_querier:1;
263 u8 multicast_query_use_ifaddr:1;
268 u32 multicast_last_member_count;
269 u32 multicast_startup_query_count;
271 unsigned long multicast_last_member_interval;
272 unsigned long multicast_membership_interval;
273 unsigned long multicast_querier_interval;
274 unsigned long multicast_query_interval;
275 unsigned long multicast_query_response_interval;
276 unsigned long multicast_startup_query_interval;
278 spinlock_t multicast_lock;
279 struct net_bridge_mdb_htable __rcu *mdb;
280 struct hlist_head router_list;
282 struct timer_list multicast_router_timer;
283 struct bridge_mcast_querier ip4_querier;
284 struct bridge_mcast_query ip4_query;
285 #if IS_ENABLED(CONFIG_IPV6)
286 struct bridge_mcast_querier ip6_querier;
287 struct bridge_mcast_query ip6_query;
288 #endif /* IS_ENABLED(CONFIG_IPV6) */
291 struct timer_list hello_timer;
292 struct timer_list tcn_timer;
293 struct timer_list topology_change_timer;
294 struct timer_list gc_timer;
295 struct kobject *ifobj;
297 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
299 struct net_port_vlans __rcu *vlan_info;
303 struct br_input_skb_cb {
304 struct net_device *brdev;
305 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
311 #define BR_INPUT_SKB_CB(__skb) ((struct br_input_skb_cb *)(__skb)->cb)
313 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
314 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (BR_INPUT_SKB_CB(__skb)->mrouters_only)
316 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (0)
319 #define br_printk(level, br, format, args...) \
320 printk(level "%s: " format, (br)->dev->name, ##args)
322 #define br_err(__br, format, args...) \
323 br_printk(KERN_ERR, __br, format, ##args)
324 #define br_warn(__br, format, args...) \
325 br_printk(KERN_WARNING, __br, format, ##args)
326 #define br_notice(__br, format, args...) \
327 br_printk(KERN_NOTICE, __br, format, ##args)
328 #define br_info(__br, format, args...) \
329 br_printk(KERN_INFO, __br, format, ##args)
331 #define br_debug(br, format, args...) \
332 pr_debug("%s: " format, (br)->dev->name, ##args)
334 extern struct notifier_block br_device_notifier;
336 /* called under bridge lock */
337 static inline int br_is_root_bridge(const struct net_bridge *br)
339 return !memcmp(&br->bridge_id, &br->designated_root, 8);
343 void br_dev_setup(struct net_device *dev);
344 void br_dev_delete(struct net_device *dev, struct list_head *list);
345 netdev_tx_t br_dev_xmit(struct sk_buff *skb, struct net_device *dev);
346 #ifdef CONFIG_NET_POLL_CONTROLLER
347 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
350 struct netpoll *np = p->np;
353 netpoll_send_skb(np, skb);
356 int br_netpoll_enable(struct net_bridge_port *p);
357 void br_netpoll_disable(struct net_bridge_port *p);
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)
369 static inline void br_netpoll_disable(struct net_bridge_port *p)
375 int br_fdb_init(void);
376 void br_fdb_fini(void);
377 void br_fdb_flush(struct net_bridge *br);
378 void br_fdb_find_delete_local(struct net_bridge *br,
379 const struct net_bridge_port *p,
380 const unsigned char *addr, u16 vid);
381 void br_fdb_changeaddr(struct net_bridge_port *p, const unsigned char *newaddr);
382 void br_fdb_change_mac_address(struct net_bridge *br, const u8 *newaddr);
383 void br_fdb_cleanup(unsigned long arg);
384 void br_fdb_delete_by_port(struct net_bridge *br,
385 const struct net_bridge_port *p, int do_all);
386 struct net_bridge_fdb_entry *__br_fdb_get(struct net_bridge *br,
387 const unsigned char *addr, __u16 vid);
388 int br_fdb_test_addr(struct net_device *dev, unsigned char *addr);
389 int br_fdb_fillbuf(struct net_bridge *br, void *buf, unsigned long count,
391 int br_fdb_insert(struct net_bridge *br, struct net_bridge_port *source,
392 const unsigned char *addr, u16 vid);
393 void br_fdb_update(struct net_bridge *br, struct net_bridge_port *source,
394 const unsigned char *addr, u16 vid, bool added_by_user);
396 int br_fdb_delete(struct ndmsg *ndm, struct nlattr *tb[],
397 struct net_device *dev, const unsigned char *addr);
398 int br_fdb_add(struct ndmsg *nlh, struct nlattr *tb[], struct net_device *dev,
399 const unsigned char *addr, u16 nlh_flags);
400 int br_fdb_dump(struct sk_buff *skb, struct netlink_callback *cb,
401 struct net_device *dev, int idx);
404 void br_deliver(const struct net_bridge_port *to, struct sk_buff *skb);
405 int br_dev_queue_push_xmit(struct sk_buff *skb);
406 void br_forward(const struct net_bridge_port *to,
407 struct sk_buff *skb, struct sk_buff *skb0);
408 int br_forward_finish(struct sk_buff *skb);
409 void br_flood_deliver(struct net_bridge *br, struct sk_buff *skb, bool unicast);
410 void br_flood_forward(struct net_bridge *br, struct sk_buff *skb,
411 struct sk_buff *skb2, bool unicast);
414 void br_port_carrier_check(struct net_bridge_port *p);
415 int br_add_bridge(struct net *net, const char *name);
416 int br_del_bridge(struct net *net, const char *name);
417 int br_add_if(struct net_bridge *br, struct net_device *dev);
418 int br_del_if(struct net_bridge *br, struct net_device *dev);
419 int br_min_mtu(const struct net_bridge *br);
420 netdev_features_t br_features_recompute(struct net_bridge *br,
421 netdev_features_t features);
422 void br_port_flags_change(struct net_bridge_port *port, unsigned long mask);
425 int br_handle_frame_finish(struct sk_buff *skb);
426 rx_handler_result_t br_handle_frame(struct sk_buff **pskb);
428 static inline bool br_rx_handler_check_rcu(const struct net_device *dev)
430 return rcu_dereference(dev->rx_handler) == br_handle_frame;
433 static inline struct net_bridge_port *br_port_get_check_rcu(const struct net_device *dev)
435 return br_rx_handler_check_rcu(dev) ? br_port_get_rcu(dev) : NULL;
439 int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
440 int br_ioctl_deviceless_stub(struct net *net, unsigned int cmd,
444 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
445 extern unsigned int br_mdb_rehash_seq;
446 int br_multicast_rcv(struct net_bridge *br, struct net_bridge_port *port,
447 struct sk_buff *skb, u16 vid);
448 struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
449 struct sk_buff *skb, u16 vid);
450 void br_multicast_add_port(struct net_bridge_port *port);
451 void br_multicast_del_port(struct net_bridge_port *port);
452 void br_multicast_enable_port(struct net_bridge_port *port);
453 void br_multicast_disable_port(struct net_bridge_port *port);
454 void br_multicast_init(struct net_bridge *br);
455 void br_multicast_open(struct net_bridge *br);
456 void br_multicast_stop(struct net_bridge *br);
457 void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
458 struct sk_buff *skb);
459 void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
460 struct sk_buff *skb, struct sk_buff *skb2);
461 int br_multicast_set_router(struct net_bridge *br, unsigned long val);
462 int br_multicast_set_port_router(struct net_bridge_port *p, unsigned long val);
463 int br_multicast_toggle(struct net_bridge *br, unsigned long val);
464 int br_multicast_set_querier(struct net_bridge *br, unsigned long val);
465 int br_multicast_set_hash_max(struct net_bridge *br, unsigned long val);
466 struct net_bridge_mdb_entry *
467 br_mdb_ip_get(struct net_bridge_mdb_htable *mdb, struct br_ip *dst);
468 struct net_bridge_mdb_entry *
469 br_multicast_new_group(struct net_bridge *br, struct net_bridge_port *port,
470 struct br_ip *group);
471 void br_multicast_free_pg(struct rcu_head *head);
472 struct net_bridge_port_group *
473 br_multicast_new_port_group(struct net_bridge_port *port, struct br_ip *group,
474 struct net_bridge_port_group __rcu *next,
475 unsigned char state);
476 void br_mdb_init(void);
477 void br_mdb_uninit(void);
478 void br_mdb_notify(struct net_device *dev, struct net_bridge_port *port,
479 struct br_ip *group, int type);
481 #define mlock_dereference(X, br) \
482 rcu_dereference_protected(X, lockdep_is_held(&br->multicast_lock))
484 static inline bool br_multicast_is_router(struct net_bridge *br)
486 return br->multicast_router == 2 ||
487 (br->multicast_router == 1 &&
488 timer_pending(&br->multicast_router_timer));
492 __br_multicast_querier_exists(struct net_bridge *br,
493 struct bridge_mcast_querier *querier)
495 return time_is_before_jiffies(querier->delay_time) &&
496 (br->multicast_querier || timer_pending(&querier->timer));
499 static inline bool br_multicast_querier_exists(struct net_bridge *br,
502 switch (eth->h_proto) {
503 case (htons(ETH_P_IP)):
504 return __br_multicast_querier_exists(br, &br->ip4_querier);
505 #if IS_ENABLED(CONFIG_IPV6)
506 case (htons(ETH_P_IPV6)):
507 return __br_multicast_querier_exists(br, &br->ip6_querier);
514 static inline int br_multicast_rcv(struct net_bridge *br,
515 struct net_bridge_port *port,
522 static inline struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
523 struct sk_buff *skb, u16 vid)
528 static inline void br_multicast_add_port(struct net_bridge_port *port)
532 static inline void br_multicast_del_port(struct net_bridge_port *port)
536 static inline void br_multicast_enable_port(struct net_bridge_port *port)
540 static inline void br_multicast_disable_port(struct net_bridge_port *port)
544 static inline void br_multicast_init(struct net_bridge *br)
548 static inline void br_multicast_open(struct net_bridge *br)
552 static inline void br_multicast_stop(struct net_bridge *br)
556 static inline void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
561 static inline void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
563 struct sk_buff *skb2)
566 static inline bool br_multicast_is_router(struct net_bridge *br)
570 static inline bool br_multicast_querier_exists(struct net_bridge *br,
575 static inline void br_mdb_init(void)
578 static inline void br_mdb_uninit(void)
584 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
585 bool br_allowed_ingress(struct net_bridge *br, struct net_port_vlans *v,
586 struct sk_buff *skb, u16 *vid);
587 bool br_allowed_egress(struct net_bridge *br, const struct net_port_vlans *v,
588 const struct sk_buff *skb);
589 struct sk_buff *br_handle_vlan(struct net_bridge *br,
590 const struct net_port_vlans *v,
591 struct sk_buff *skb);
592 int br_vlan_add(struct net_bridge *br, u16 vid, u16 flags);
593 int br_vlan_delete(struct net_bridge *br, u16 vid);
594 void br_vlan_flush(struct net_bridge *br);
595 bool br_vlan_find(struct net_bridge *br, u16 vid);
596 int br_vlan_filter_toggle(struct net_bridge *br, unsigned long val);
597 int nbp_vlan_add(struct net_bridge_port *port, u16 vid, u16 flags);
598 int nbp_vlan_delete(struct net_bridge_port *port, u16 vid);
599 void nbp_vlan_flush(struct net_bridge_port *port);
600 bool nbp_vlan_find(struct net_bridge_port *port, u16 vid);
602 static inline struct net_port_vlans *br_get_vlan_info(
603 const struct net_bridge *br)
605 return rcu_dereference_rtnl(br->vlan_info);
608 static inline struct net_port_vlans *nbp_get_vlan_info(
609 const struct net_bridge_port *p)
611 return rcu_dereference_rtnl(p->vlan_info);
614 /* Since bridge now depends on 8021Q module, but the time bridge sees the
615 * skb, the vlan tag will always be present if the frame was tagged.
617 static inline int br_vlan_get_tag(const struct sk_buff *skb, u16 *vid)
621 if (vlan_tx_tag_present(skb))
622 *vid = vlan_tx_tag_get(skb) & VLAN_VID_MASK;
631 static inline u16 br_get_pvid(const struct net_port_vlans *v)
633 /* Return just the VID if it is set, or VLAN_N_VID (invalid vid) if
637 return v->pvid ?: VLAN_N_VID;
641 static inline bool br_allowed_ingress(struct net_bridge *br,
642 struct net_port_vlans *v,
649 static inline bool br_allowed_egress(struct net_bridge *br,
650 const struct net_port_vlans *v,
651 const struct sk_buff *skb)
656 static inline struct sk_buff *br_handle_vlan(struct net_bridge *br,
657 const struct net_port_vlans *v,
663 static inline int br_vlan_add(struct net_bridge *br, u16 vid, u16 flags)
668 static inline int br_vlan_delete(struct net_bridge *br, u16 vid)
673 static inline void br_vlan_flush(struct net_bridge *br)
677 static inline bool br_vlan_find(struct net_bridge *br, u16 vid)
682 static inline int nbp_vlan_add(struct net_bridge_port *port, u16 vid, u16 flags)
687 static inline int nbp_vlan_delete(struct net_bridge_port *port, u16 vid)
692 static inline void nbp_vlan_flush(struct net_bridge_port *port)
696 static inline struct net_port_vlans *br_get_vlan_info(
697 const struct net_bridge *br)
701 static inline struct net_port_vlans *nbp_get_vlan_info(
702 const struct net_bridge_port *p)
707 static inline bool nbp_vlan_find(struct net_bridge_port *port, u16 vid)
712 static inline u16 br_vlan_get_tag(const struct sk_buff *skb, u16 *tag)
716 static inline u16 br_get_pvid(const struct net_port_vlans *v)
718 return VLAN_N_VID; /* Returns invalid vid */
723 #ifdef CONFIG_BRIDGE_NETFILTER
724 int br_netfilter_init(void);
725 void br_netfilter_fini(void);
726 void br_netfilter_rtable_init(struct net_bridge *);
728 #define br_netfilter_init() (0)
729 #define br_netfilter_fini() do { } while (0)
730 #define br_netfilter_rtable_init(x)
734 void br_log_state(const struct net_bridge_port *p);
735 struct net_bridge_port *br_get_port(struct net_bridge *br, u16 port_no);
736 void br_init_port(struct net_bridge_port *p);
737 void br_become_designated_port(struct net_bridge_port *p);
739 void __br_set_forward_delay(struct net_bridge *br, unsigned long t);
740 int br_set_forward_delay(struct net_bridge *br, unsigned long x);
741 int br_set_hello_time(struct net_bridge *br, unsigned long x);
742 int br_set_max_age(struct net_bridge *br, unsigned long x);
746 void br_stp_enable_bridge(struct net_bridge *br);
747 void br_stp_disable_bridge(struct net_bridge *br);
748 void br_stp_set_enabled(struct net_bridge *br, unsigned long val);
749 void br_stp_enable_port(struct net_bridge_port *p);
750 void br_stp_disable_port(struct net_bridge_port *p);
751 bool br_stp_recalculate_bridge_id(struct net_bridge *br);
752 void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
753 void br_stp_set_bridge_priority(struct net_bridge *br, u16 newprio);
754 int br_stp_set_port_priority(struct net_bridge_port *p, unsigned long newprio);
755 int br_stp_set_path_cost(struct net_bridge_port *p, unsigned long path_cost);
756 ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);
760 void br_stp_rcv(const struct stp_proto *proto, struct sk_buff *skb,
761 struct net_device *dev);
764 void br_stp_timer_init(struct net_bridge *br);
765 void br_stp_port_timer_init(struct net_bridge_port *p);
766 unsigned long br_timer_value(const struct timer_list *timer);
769 #if IS_ENABLED(CONFIG_ATM_LANE)
770 extern int (*br_fdb_test_addr_hook)(struct net_device *dev, unsigned char *addr);
774 extern struct rtnl_link_ops br_link_ops;
775 int br_netlink_init(void);
776 void br_netlink_fini(void);
777 void br_ifinfo_notify(int event, struct net_bridge_port *port);
778 int br_setlink(struct net_device *dev, struct nlmsghdr *nlmsg);
779 int br_dellink(struct net_device *dev, struct nlmsghdr *nlmsg);
780 int br_getlink(struct sk_buff *skb, u32 pid, u32 seq, struct net_device *dev,
785 extern const struct sysfs_ops brport_sysfs_ops;
786 int br_sysfs_addif(struct net_bridge_port *p);
787 int br_sysfs_renameif(struct net_bridge_port *p);
790 int br_sysfs_addbr(struct net_device *dev);
791 void br_sysfs_delbr(struct net_device *dev);
795 static inline int br_sysfs_addif(struct net_bridge_port *p) { return 0; }
796 static inline int br_sysfs_renameif(struct net_bridge_port *p) { return 0; }
797 static inline int br_sysfs_addbr(struct net_device *dev) { return 0; }
798 static inline void br_sysfs_delbr(struct net_device *dev) { return; }
799 #endif /* CONFIG_SYSFS */