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];
81 struct net_bridge_fdb_entry
83 struct hlist_node hlist;
84 struct net_bridge_port *dst;
87 unsigned long updated;
90 unsigned char is_local;
91 unsigned char is_static;
95 struct net_bridge_port_group {
96 struct net_bridge_port *port;
97 struct net_bridge_port_group __rcu *next;
98 struct hlist_node mglist;
100 struct timer_list timer;
105 struct net_bridge_mdb_entry
107 struct hlist_node hlist[2];
108 struct net_bridge *br;
109 struct net_bridge_port_group __rcu *ports;
111 struct timer_list timer;
116 struct net_bridge_mdb_htable
118 struct hlist_head *mhash;
120 struct net_bridge_mdb_htable *old;
127 struct net_bridge_port
129 struct net_bridge *br;
130 struct net_device *dev;
131 struct list_head list;
137 unsigned char topology_change_ack;
138 unsigned char config_pending;
140 port_id designated_port;
141 bridge_id designated_root;
142 bridge_id designated_bridge;
145 unsigned long designated_age;
147 struct timer_list forward_delay_timer;
148 struct timer_list hold_timer;
149 struct timer_list message_age_timer;
154 #define BR_HAIRPIN_MODE 0x00000001
155 #define BR_BPDU_GUARD 0x00000002
156 #define BR_ROOT_BLOCK 0x00000004
157 #define BR_MULTICAST_FAST_LEAVE 0x00000008
159 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
160 u32 multicast_startup_queries_sent;
161 unsigned char multicast_router;
162 struct timer_list multicast_router_timer;
163 struct timer_list multicast_query_timer;
164 struct hlist_head mglist;
165 struct hlist_node rlist;
169 char sysfs_name[IFNAMSIZ];
172 #ifdef CONFIG_NET_POLL_CONTROLLER
175 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
176 struct net_port_vlans __rcu *vlan_info;
180 #define br_port_exists(dev) (dev->priv_flags & IFF_BRIDGE_PORT)
182 static inline struct net_bridge_port *br_port_get_rcu(const struct net_device *dev)
184 struct net_bridge_port *port =
185 rcu_dereference_rtnl(dev->rx_handler_data);
187 return br_port_exists(dev) ? port : NULL;
190 static inline struct net_bridge_port *br_port_get_rtnl(struct net_device *dev)
192 return br_port_exists(dev) ?
193 rtnl_dereference(dev->rx_handler_data) : NULL;
196 struct br_cpu_netstats {
201 struct u64_stats_sync syncp;
207 struct list_head port_list;
208 struct net_device *dev;
210 struct br_cpu_netstats __percpu *stats;
211 spinlock_t hash_lock;
212 struct hlist_head hash[BR_HASH_SIZE];
213 #ifdef CONFIG_BRIDGE_NETFILTER
214 struct rtable fake_rtable;
215 bool nf_call_iptables;
216 bool nf_call_ip6tables;
217 bool nf_call_arptables;
222 bridge_id designated_root;
225 unsigned long max_age;
226 unsigned long hello_time;
227 unsigned long forward_delay;
228 unsigned long bridge_max_age;
229 unsigned long ageing_time;
230 unsigned long bridge_hello_time;
231 unsigned long bridge_forward_delay;
233 u8 group_addr[ETH_ALEN];
237 BR_NO_STP, /* no spanning tree */
238 BR_KERNEL_STP, /* old STP in kernel */
239 BR_USER_STP, /* new RSTP in userspace */
242 unsigned char topology_change;
243 unsigned char topology_change_detected;
245 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
246 unsigned char multicast_router;
248 u8 multicast_disabled:1;
249 u8 multicast_querier:1;
254 u32 multicast_last_member_count;
255 u32 multicast_startup_queries_sent;
256 u32 multicast_startup_query_count;
258 unsigned long multicast_last_member_interval;
259 unsigned long multicast_membership_interval;
260 unsigned long multicast_querier_interval;
261 unsigned long multicast_query_interval;
262 unsigned long multicast_query_response_interval;
263 unsigned long multicast_startup_query_interval;
265 spinlock_t multicast_lock;
266 struct net_bridge_mdb_htable __rcu *mdb;
267 struct hlist_head router_list;
269 struct timer_list multicast_router_timer;
270 struct timer_list multicast_querier_timer;
271 struct timer_list multicast_query_timer;
274 struct timer_list hello_timer;
275 struct timer_list tcn_timer;
276 struct timer_list topology_change_timer;
277 struct timer_list gc_timer;
278 struct kobject *ifobj;
279 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
281 struct net_port_vlans __rcu *vlan_info;
285 struct br_input_skb_cb {
286 struct net_device *brdev;
287 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
293 #define BR_INPUT_SKB_CB(__skb) ((struct br_input_skb_cb *)(__skb)->cb)
295 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
296 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (BR_INPUT_SKB_CB(__skb)->mrouters_only)
298 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (0)
301 #define br_printk(level, br, format, args...) \
302 printk(level "%s: " format, (br)->dev->name, ##args)
304 #define br_err(__br, format, args...) \
305 br_printk(KERN_ERR, __br, format, ##args)
306 #define br_warn(__br, format, args...) \
307 br_printk(KERN_WARNING, __br, format, ##args)
308 #define br_notice(__br, format, args...) \
309 br_printk(KERN_NOTICE, __br, format, ##args)
310 #define br_info(__br, format, args...) \
311 br_printk(KERN_INFO, __br, format, ##args)
313 #define br_debug(br, format, args...) \
314 pr_debug("%s: " format, (br)->dev->name, ##args)
316 extern struct notifier_block br_device_notifier;
318 /* called under bridge lock */
319 static inline int br_is_root_bridge(const struct net_bridge *br)
321 return !memcmp(&br->bridge_id, &br->designated_root, 8);
325 extern void br_dev_setup(struct net_device *dev);
326 extern void br_dev_delete(struct net_device *dev, struct list_head *list);
327 extern netdev_tx_t br_dev_xmit(struct sk_buff *skb,
328 struct net_device *dev);
329 #ifdef CONFIG_NET_POLL_CONTROLLER
330 static inline struct netpoll_info *br_netpoll_info(struct net_bridge *br)
332 return br->dev->npinfo;
335 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
338 struct netpoll *np = p->np;
341 netpoll_send_skb(np, skb);
344 extern int br_netpoll_enable(struct net_bridge_port *p, gfp_t gfp);
345 extern void br_netpoll_disable(struct net_bridge_port *p);
347 static inline struct netpoll_info *br_netpoll_info(struct net_bridge *br)
352 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
357 static inline int br_netpoll_enable(struct net_bridge_port *p, gfp_t gfp)
362 static inline void br_netpoll_disable(struct net_bridge_port *p)
368 extern int br_fdb_init(void);
369 extern void br_fdb_fini(void);
370 extern void br_fdb_flush(struct net_bridge *br);
371 extern void br_fdb_changeaddr(struct net_bridge_port *p,
372 const unsigned char *newaddr);
373 extern void br_fdb_change_mac_address(struct net_bridge *br, const u8 *newaddr);
374 extern void br_fdb_cleanup(unsigned long arg);
375 extern void br_fdb_delete_by_port(struct net_bridge *br,
376 const struct net_bridge_port *p, int do_all);
377 extern struct net_bridge_fdb_entry *__br_fdb_get(struct net_bridge *br,
378 const unsigned char *addr,
380 extern int br_fdb_test_addr(struct net_device *dev, unsigned char *addr);
381 extern int br_fdb_fillbuf(struct net_bridge *br, void *buf,
382 unsigned long count, unsigned long off);
383 extern int br_fdb_insert(struct net_bridge *br,
384 struct net_bridge_port *source,
385 const unsigned char *addr);
386 extern void br_fdb_update(struct net_bridge *br,
387 struct net_bridge_port *source,
388 const unsigned char *addr,
391 extern int br_fdb_delete(struct ndmsg *ndm, struct nlattr *tb[],
392 struct net_device *dev,
393 const unsigned char *addr);
394 extern int br_fdb_add(struct ndmsg *nlh, struct nlattr *tb[],
395 struct net_device *dev,
396 const unsigned char *addr,
398 extern int br_fdb_dump(struct sk_buff *skb,
399 struct netlink_callback *cb,
400 struct net_device *dev,
404 extern void br_deliver(const struct net_bridge_port *to,
405 struct sk_buff *skb);
406 extern int br_dev_queue_push_xmit(struct sk_buff *skb);
407 extern void br_forward(const struct net_bridge_port *to,
408 struct sk_buff *skb, struct sk_buff *skb0);
409 extern int br_forward_finish(struct sk_buff *skb);
410 extern void br_flood_deliver(struct net_bridge *br, struct sk_buff *skb);
411 extern void br_flood_forward(struct net_bridge *br, struct sk_buff *skb,
412 struct sk_buff *skb2);
415 extern void br_port_carrier_check(struct net_bridge_port *p);
416 extern int br_add_bridge(struct net *net, const char *name);
417 extern int br_del_bridge(struct net *net, const char *name);
418 extern void br_net_exit(struct net *net);
419 extern int br_add_if(struct net_bridge *br,
420 struct net_device *dev);
421 extern int br_del_if(struct net_bridge *br,
422 struct net_device *dev);
423 extern int br_min_mtu(const struct net_bridge *br);
424 extern netdev_features_t br_features_recompute(struct net_bridge *br,
425 netdev_features_t features);
428 extern int br_handle_frame_finish(struct sk_buff *skb);
429 extern rx_handler_result_t br_handle_frame(struct sk_buff **pskb);
432 extern int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
433 extern int br_ioctl_deviceless_stub(struct net *net, unsigned int cmd, void __user *arg);
436 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
437 extern unsigned int br_mdb_rehash_seq;
438 extern int br_multicast_rcv(struct net_bridge *br,
439 struct net_bridge_port *port,
440 struct sk_buff *skb);
441 extern struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
442 struct sk_buff *skb);
443 extern void br_multicast_add_port(struct net_bridge_port *port);
444 extern void br_multicast_del_port(struct net_bridge_port *port);
445 extern void br_multicast_enable_port(struct net_bridge_port *port);
446 extern void br_multicast_disable_port(struct net_bridge_port *port);
447 extern void br_multicast_init(struct net_bridge *br);
448 extern void br_multicast_open(struct net_bridge *br);
449 extern void br_multicast_stop(struct net_bridge *br);
450 extern void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
451 struct sk_buff *skb);
452 extern void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
453 struct sk_buff *skb, struct sk_buff *skb2);
454 extern int br_multicast_set_router(struct net_bridge *br, unsigned long val);
455 extern int br_multicast_set_port_router(struct net_bridge_port *p,
457 extern int br_multicast_toggle(struct net_bridge *br, unsigned long val);
458 extern int br_multicast_set_querier(struct net_bridge *br, unsigned long val);
459 extern int br_multicast_set_hash_max(struct net_bridge *br, unsigned long val);
460 extern struct net_bridge_mdb_entry *br_mdb_ip_get(
461 struct net_bridge_mdb_htable *mdb,
463 extern struct net_bridge_mdb_entry *br_multicast_new_group(struct net_bridge *br,
464 struct net_bridge_port *port, struct br_ip *group);
465 extern void br_multicast_free_pg(struct rcu_head *head);
466 extern struct net_bridge_port_group *br_multicast_new_port_group(
467 struct net_bridge_port *port,
469 struct net_bridge_port_group *next,
470 unsigned char state);
471 extern void br_mdb_init(void);
472 extern void br_mdb_uninit(void);
473 extern void br_mdb_notify(struct net_device *dev, struct net_bridge_port *port,
474 struct br_ip *group, int type);
476 #define mlock_dereference(X, br) \
477 rcu_dereference_protected(X, lockdep_is_held(&br->multicast_lock))
479 #if IS_ENABLED(CONFIG_IPV6)
480 #include <net/addrconf.h>
481 static inline int ipv6_is_transient_multicast(const struct in6_addr *addr)
483 if (ipv6_addr_is_multicast(addr) && IPV6_ADDR_MC_FLAG_TRANSIENT(addr))
489 static inline bool br_multicast_is_router(struct net_bridge *br)
491 return br->multicast_router == 2 ||
492 (br->multicast_router == 1 &&
493 timer_pending(&br->multicast_router_timer));
496 static inline int br_multicast_rcv(struct net_bridge *br,
497 struct net_bridge_port *port,
503 static inline struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
509 static inline void br_multicast_add_port(struct net_bridge_port *port)
513 static inline void br_multicast_del_port(struct net_bridge_port *port)
517 static inline void br_multicast_enable_port(struct net_bridge_port *port)
521 static inline void br_multicast_disable_port(struct net_bridge_port *port)
525 static inline void br_multicast_init(struct net_bridge *br)
529 static inline void br_multicast_open(struct net_bridge *br)
533 static inline void br_multicast_stop(struct net_bridge *br)
537 static inline void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
542 static inline void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
544 struct sk_buff *skb2)
547 static inline bool br_multicast_is_router(struct net_bridge *br)
551 static inline void br_mdb_init(void)
554 static inline void br_mdb_uninit(void)
560 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
561 extern bool br_allowed_ingress(struct net_bridge *br, struct net_port_vlans *v,
562 struct sk_buff *skb, u16 *vid);
563 extern bool br_allowed_egress(struct net_bridge *br,
564 const struct net_port_vlans *v,
565 const struct sk_buff *skb);
566 extern struct sk_buff *br_handle_vlan(struct net_bridge *br,
567 const struct net_port_vlans *v,
568 struct sk_buff *skb);
569 extern int br_vlan_add(struct net_bridge *br, u16 vid, u16 flags);
570 extern int br_vlan_delete(struct net_bridge *br, u16 vid);
571 extern void br_vlan_flush(struct net_bridge *br);
572 extern int br_vlan_filter_toggle(struct net_bridge *br, unsigned long val);
573 extern int nbp_vlan_add(struct net_bridge_port *port, u16 vid, u16 flags);
574 extern int nbp_vlan_delete(struct net_bridge_port *port, u16 vid);
575 extern void nbp_vlan_flush(struct net_bridge_port *port);
577 static inline struct net_port_vlans *br_get_vlan_info(
578 const struct net_bridge *br)
580 return rcu_dereference_rtnl(br->vlan_info);
583 static inline struct net_port_vlans *nbp_get_vlan_info(
584 const struct net_bridge_port *p)
586 return rcu_dereference_rtnl(p->vlan_info);
589 /* Since bridge now depends on 8021Q module, but the time bridge sees the
590 * skb, the vlan tag will always be present if the frame was tagged.
592 static inline int br_vlan_get_tag(const struct sk_buff *skb, u16 *vid)
596 if (vlan_tx_tag_present(skb))
597 *vid = vlan_tx_tag_get(skb) & VLAN_VID_MASK;
606 static inline u16 br_get_pvid(const struct net_port_vlans *v)
608 /* Return just the VID if it is set, or VLAN_N_VID (invalid vid) if
612 return (v->pvid & VLAN_TAG_PRESENT) ?
613 (v->pvid & ~VLAN_TAG_PRESENT) :
618 static inline bool br_allowed_ingress(struct net_bridge *br,
619 struct net_port_vlans *v,
626 static inline bool br_allowed_egress(struct net_bridge *br,
627 const struct net_port_vlans *v,
628 const struct sk_buff *skb)
633 static inline struct sk_buff *br_handle_vlan(struct net_bridge *br,
634 const struct net_port_vlans *v,
640 static inline int br_vlan_add(struct net_bridge *br, u16 vid, u16 flags)
645 static inline int br_vlan_delete(struct net_bridge *br, u16 vid)
650 static inline void br_vlan_flush(struct net_bridge *br)
654 static inline int nbp_vlan_add(struct net_bridge_port *port, u16 vid, u16 flags)
659 static inline int nbp_vlan_delete(struct net_bridge_port *port, u16 vid)
664 static inline void nbp_vlan_flush(struct net_bridge_port *port)
668 static inline struct net_port_vlans *br_get_vlan_info(
669 const struct net_bridge *br)
673 static inline struct net_port_vlans *nbp_get_vlan_info(
674 const struct net_bridge_port *p)
679 static inline u16 br_vlan_get_tag(const struct sk_buff *skb, u16 *tag)
683 static inline u16 br_get_pvid(const struct net_port_vlans *v)
685 return VLAN_N_VID; /* Returns invalid vid */
690 #ifdef CONFIG_BRIDGE_NETFILTER
691 extern int br_netfilter_init(void);
692 extern void br_netfilter_fini(void);
693 extern void br_netfilter_rtable_init(struct net_bridge *);
695 #define br_netfilter_init() (0)
696 #define br_netfilter_fini() do { } while(0)
697 #define br_netfilter_rtable_init(x)
701 extern void br_log_state(const struct net_bridge_port *p);
702 extern struct net_bridge_port *br_get_port(struct net_bridge *br,
704 extern void br_init_port(struct net_bridge_port *p);
705 extern void br_become_designated_port(struct net_bridge_port *p);
707 extern int br_set_forward_delay(struct net_bridge *br, unsigned long x);
708 extern int br_set_hello_time(struct net_bridge *br, unsigned long x);
709 extern int br_set_max_age(struct net_bridge *br, unsigned long x);
713 extern void br_stp_enable_bridge(struct net_bridge *br);
714 extern void br_stp_disable_bridge(struct net_bridge *br);
715 extern void br_stp_set_enabled(struct net_bridge *br, unsigned long val);
716 extern void br_stp_enable_port(struct net_bridge_port *p);
717 extern void br_stp_disable_port(struct net_bridge_port *p);
718 extern bool br_stp_recalculate_bridge_id(struct net_bridge *br);
719 extern void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
720 extern void br_stp_set_bridge_priority(struct net_bridge *br,
722 extern int br_stp_set_port_priority(struct net_bridge_port *p,
723 unsigned long newprio);
724 extern int br_stp_set_path_cost(struct net_bridge_port *p,
725 unsigned long path_cost);
726 extern ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);
730 extern void br_stp_rcv(const struct stp_proto *proto, struct sk_buff *skb,
731 struct net_device *dev);
734 extern void br_stp_timer_init(struct net_bridge *br);
735 extern void br_stp_port_timer_init(struct net_bridge_port *p);
736 extern unsigned long br_timer_value(const struct timer_list *timer);
739 #if IS_ENABLED(CONFIG_ATM_LANE)
740 extern int (*br_fdb_test_addr_hook)(struct net_device *dev, unsigned char *addr);
744 extern struct rtnl_link_ops br_link_ops;
745 extern int br_netlink_init(void);
746 extern void br_netlink_fini(void);
747 extern void br_ifinfo_notify(int event, struct net_bridge_port *port);
748 extern int br_setlink(struct net_device *dev, struct nlmsghdr *nlmsg);
749 extern int br_dellink(struct net_device *dev, struct nlmsghdr *nlmsg);
750 extern int br_getlink(struct sk_buff *skb, u32 pid, u32 seq,
751 struct net_device *dev, u32 filter_mask);
755 extern const struct sysfs_ops brport_sysfs_ops;
756 extern int br_sysfs_addif(struct net_bridge_port *p);
757 extern int br_sysfs_renameif(struct net_bridge_port *p);
760 extern int br_sysfs_addbr(struct net_device *dev);
761 extern void br_sysfs_delbr(struct net_device *dev);
765 static inline int br_sysfs_addif(struct net_bridge_port *p) { return 0; }
766 static inline int br_sysfs_renameif(struct net_bridge_port *p) { return 0; }
767 static inline int br_sysfs_addbr(struct net_device *dev) { return 0; }
768 static inline void br_sysfs_delbr(struct net_device *dev) { return; }
769 #endif /* CONFIG_SYSFS */