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 {
71 struct net_bridge_port *port;
72 struct net_bridge *br;
75 unsigned long vlan_bitmap[BR_VLAN_BITMAP_LEN];
79 struct net_bridge_fdb_entry
81 struct hlist_node hlist;
82 struct net_bridge_port *dst;
85 unsigned long updated;
88 unsigned char is_local;
89 unsigned char is_static;
92 struct net_bridge_port_group {
93 struct net_bridge_port *port;
94 struct net_bridge_port_group __rcu *next;
95 struct hlist_node mglist;
97 struct timer_list timer;
102 struct net_bridge_mdb_entry
104 struct hlist_node hlist[2];
105 struct net_bridge *br;
106 struct net_bridge_port_group __rcu *ports;
108 struct timer_list timer;
113 struct net_bridge_mdb_htable
115 struct hlist_head *mhash;
117 struct net_bridge_mdb_htable *old;
124 struct net_bridge_port
126 struct net_bridge *br;
127 struct net_device *dev;
128 struct list_head list;
134 unsigned char topology_change_ack;
135 unsigned char config_pending;
137 port_id designated_port;
138 bridge_id designated_root;
139 bridge_id designated_bridge;
142 unsigned long designated_age;
144 struct timer_list forward_delay_timer;
145 struct timer_list hold_timer;
146 struct timer_list message_age_timer;
151 #define BR_HAIRPIN_MODE 0x00000001
152 #define BR_BPDU_GUARD 0x00000002
153 #define BR_ROOT_BLOCK 0x00000004
154 #define BR_MULTICAST_FAST_LEAVE 0x00000008
156 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
157 u32 multicast_startup_queries_sent;
158 unsigned char multicast_router;
159 struct timer_list multicast_router_timer;
160 struct timer_list multicast_query_timer;
161 struct hlist_head mglist;
162 struct hlist_node rlist;
166 char sysfs_name[IFNAMSIZ];
169 #ifdef CONFIG_NET_POLL_CONTROLLER
172 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
173 struct net_port_vlans __rcu *vlan_info;
177 #define br_port_exists(dev) (dev->priv_flags & IFF_BRIDGE_PORT)
179 static inline struct net_bridge_port *br_port_get_rcu(const struct net_device *dev)
181 struct net_bridge_port *port =
182 rcu_dereference_rtnl(dev->rx_handler_data);
184 return br_port_exists(dev) ? port : NULL;
187 static inline struct net_bridge_port *br_port_get_rtnl(struct net_device *dev)
189 return br_port_exists(dev) ?
190 rtnl_dereference(dev->rx_handler_data) : NULL;
193 struct br_cpu_netstats {
198 struct u64_stats_sync syncp;
204 struct list_head port_list;
205 struct net_device *dev;
207 struct br_cpu_netstats __percpu *stats;
208 spinlock_t hash_lock;
209 struct hlist_head hash[BR_HASH_SIZE];
210 #ifdef CONFIG_BRIDGE_NETFILTER
211 struct rtable fake_rtable;
212 bool nf_call_iptables;
213 bool nf_call_ip6tables;
214 bool nf_call_arptables;
219 bridge_id designated_root;
222 unsigned long max_age;
223 unsigned long hello_time;
224 unsigned long forward_delay;
225 unsigned long bridge_max_age;
226 unsigned long ageing_time;
227 unsigned long bridge_hello_time;
228 unsigned long bridge_forward_delay;
230 u8 group_addr[ETH_ALEN];
234 BR_NO_STP, /* no spanning tree */
235 BR_KERNEL_STP, /* old STP in kernel */
236 BR_USER_STP, /* new RSTP in userspace */
239 unsigned char topology_change;
240 unsigned char topology_change_detected;
242 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
243 unsigned char multicast_router;
245 u8 multicast_disabled:1;
246 u8 multicast_querier:1;
251 u32 multicast_last_member_count;
252 u32 multicast_startup_queries_sent;
253 u32 multicast_startup_query_count;
255 unsigned long multicast_last_member_interval;
256 unsigned long multicast_membership_interval;
257 unsigned long multicast_querier_interval;
258 unsigned long multicast_query_interval;
259 unsigned long multicast_query_response_interval;
260 unsigned long multicast_startup_query_interval;
262 spinlock_t multicast_lock;
263 struct net_bridge_mdb_htable __rcu *mdb;
264 struct hlist_head router_list;
266 struct timer_list multicast_router_timer;
267 struct timer_list multicast_querier_timer;
268 struct timer_list multicast_query_timer;
271 struct timer_list hello_timer;
272 struct timer_list tcn_timer;
273 struct timer_list topology_change_timer;
274 struct timer_list gc_timer;
275 struct kobject *ifobj;
276 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
278 struct net_port_vlans __rcu *vlan_info;
282 struct br_input_skb_cb {
283 struct net_device *brdev;
284 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
290 #define BR_INPUT_SKB_CB(__skb) ((struct br_input_skb_cb *)(__skb)->cb)
292 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
293 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (BR_INPUT_SKB_CB(__skb)->mrouters_only)
295 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (0)
298 #define br_printk(level, br, format, args...) \
299 printk(level "%s: " format, (br)->dev->name, ##args)
301 #define br_err(__br, format, args...) \
302 br_printk(KERN_ERR, __br, format, ##args)
303 #define br_warn(__br, format, args...) \
304 br_printk(KERN_WARNING, __br, format, ##args)
305 #define br_notice(__br, format, args...) \
306 br_printk(KERN_NOTICE, __br, format, ##args)
307 #define br_info(__br, format, args...) \
308 br_printk(KERN_INFO, __br, format, ##args)
310 #define br_debug(br, format, args...) \
311 pr_debug("%s: " format, (br)->dev->name, ##args)
313 extern struct notifier_block br_device_notifier;
315 /* called under bridge lock */
316 static inline int br_is_root_bridge(const struct net_bridge *br)
318 return !memcmp(&br->bridge_id, &br->designated_root, 8);
322 extern void br_dev_setup(struct net_device *dev);
323 extern void br_dev_delete(struct net_device *dev, struct list_head *list);
324 extern netdev_tx_t br_dev_xmit(struct sk_buff *skb,
325 struct net_device *dev);
326 #ifdef CONFIG_NET_POLL_CONTROLLER
327 static inline struct netpoll_info *br_netpoll_info(struct net_bridge *br)
329 return br->dev->npinfo;
332 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
335 struct netpoll *np = p->np;
338 netpoll_send_skb(np, skb);
341 extern int br_netpoll_enable(struct net_bridge_port *p, gfp_t gfp);
342 extern void br_netpoll_disable(struct net_bridge_port *p);
344 static inline struct netpoll_info *br_netpoll_info(struct net_bridge *br)
349 static inline void br_netpoll_send_skb(const struct net_bridge_port *p,
354 static inline int br_netpoll_enable(struct net_bridge_port *p, gfp_t gfp)
359 static inline void br_netpoll_disable(struct net_bridge_port *p)
365 extern int br_fdb_init(void);
366 extern void br_fdb_fini(void);
367 extern void br_fdb_flush(struct net_bridge *br);
368 extern void br_fdb_changeaddr(struct net_bridge_port *p,
369 const unsigned char *newaddr);
370 extern void br_fdb_change_mac_address(struct net_bridge *br, const u8 *newaddr);
371 extern void br_fdb_cleanup(unsigned long arg);
372 extern void br_fdb_delete_by_port(struct net_bridge *br,
373 const struct net_bridge_port *p, int do_all);
374 extern struct net_bridge_fdb_entry *__br_fdb_get(struct net_bridge *br,
375 const unsigned char *addr);
376 extern int br_fdb_test_addr(struct net_device *dev, unsigned char *addr);
377 extern int br_fdb_fillbuf(struct net_bridge *br, void *buf,
378 unsigned long count, unsigned long off);
379 extern int br_fdb_insert(struct net_bridge *br,
380 struct net_bridge_port *source,
381 const unsigned char *addr);
382 extern void br_fdb_update(struct net_bridge *br,
383 struct net_bridge_port *source,
384 const unsigned char *addr);
386 extern int br_fdb_delete(struct ndmsg *ndm,
387 struct net_device *dev,
388 const unsigned char *addr);
389 extern int br_fdb_add(struct ndmsg *nlh, struct nlattr *tb[],
390 struct net_device *dev,
391 const unsigned char *addr,
393 extern int br_fdb_dump(struct sk_buff *skb,
394 struct netlink_callback *cb,
395 struct net_device *dev,
399 extern void br_deliver(const struct net_bridge_port *to,
400 struct sk_buff *skb);
401 extern int br_dev_queue_push_xmit(struct sk_buff *skb);
402 extern void br_forward(const struct net_bridge_port *to,
403 struct sk_buff *skb, struct sk_buff *skb0);
404 extern int br_forward_finish(struct sk_buff *skb);
405 extern void br_flood_deliver(struct net_bridge *br, struct sk_buff *skb);
406 extern void br_flood_forward(struct net_bridge *br, struct sk_buff *skb,
407 struct sk_buff *skb2);
410 extern void br_port_carrier_check(struct net_bridge_port *p);
411 extern int br_add_bridge(struct net *net, const char *name);
412 extern int br_del_bridge(struct net *net, const char *name);
413 extern void br_net_exit(struct net *net);
414 extern int br_add_if(struct net_bridge *br,
415 struct net_device *dev);
416 extern int br_del_if(struct net_bridge *br,
417 struct net_device *dev);
418 extern int br_min_mtu(const struct net_bridge *br);
419 extern netdev_features_t br_features_recompute(struct net_bridge *br,
420 netdev_features_t features);
423 extern int br_handle_frame_finish(struct sk_buff *skb);
424 extern rx_handler_result_t br_handle_frame(struct sk_buff **pskb);
427 extern int br_dev_ioctl(struct net_device *dev, struct ifreq *rq, int cmd);
428 extern int br_ioctl_deviceless_stub(struct net *net, unsigned int cmd, void __user *arg);
431 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
432 extern unsigned int br_mdb_rehash_seq;
433 extern int br_multicast_rcv(struct net_bridge *br,
434 struct net_bridge_port *port,
435 struct sk_buff *skb);
436 extern struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
437 struct sk_buff *skb);
438 extern void br_multicast_add_port(struct net_bridge_port *port);
439 extern void br_multicast_del_port(struct net_bridge_port *port);
440 extern void br_multicast_enable_port(struct net_bridge_port *port);
441 extern void br_multicast_disable_port(struct net_bridge_port *port);
442 extern void br_multicast_init(struct net_bridge *br);
443 extern void br_multicast_open(struct net_bridge *br);
444 extern void br_multicast_stop(struct net_bridge *br);
445 extern void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
446 struct sk_buff *skb);
447 extern void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
448 struct sk_buff *skb, struct sk_buff *skb2);
449 extern int br_multicast_set_router(struct net_bridge *br, unsigned long val);
450 extern int br_multicast_set_port_router(struct net_bridge_port *p,
452 extern int br_multicast_toggle(struct net_bridge *br, unsigned long val);
453 extern int br_multicast_set_querier(struct net_bridge *br, unsigned long val);
454 extern int br_multicast_set_hash_max(struct net_bridge *br, unsigned long val);
455 extern struct net_bridge_mdb_entry *br_mdb_ip_get(
456 struct net_bridge_mdb_htable *mdb,
458 extern struct net_bridge_mdb_entry *br_multicast_new_group(struct net_bridge *br,
459 struct net_bridge_port *port, struct br_ip *group);
460 extern void br_multicast_free_pg(struct rcu_head *head);
461 extern struct net_bridge_port_group *br_multicast_new_port_group(
462 struct net_bridge_port *port,
464 struct net_bridge_port_group *next,
465 unsigned char state);
466 extern void br_mdb_init(void);
467 extern void br_mdb_uninit(void);
468 extern void br_mdb_notify(struct net_device *dev, struct net_bridge_port *port,
469 struct br_ip *group, int type);
471 #define mlock_dereference(X, br) \
472 rcu_dereference_protected(X, lockdep_is_held(&br->multicast_lock))
474 #if IS_ENABLED(CONFIG_IPV6)
475 #include <net/addrconf.h>
476 static inline int ipv6_is_transient_multicast(const struct in6_addr *addr)
478 if (ipv6_addr_is_multicast(addr) && IPV6_ADDR_MC_FLAG_TRANSIENT(addr))
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));
491 static inline int br_multicast_rcv(struct net_bridge *br,
492 struct net_bridge_port *port,
498 static inline struct net_bridge_mdb_entry *br_mdb_get(struct net_bridge *br,
504 static inline void br_multicast_add_port(struct net_bridge_port *port)
508 static inline void br_multicast_del_port(struct net_bridge_port *port)
512 static inline void br_multicast_enable_port(struct net_bridge_port *port)
516 static inline void br_multicast_disable_port(struct net_bridge_port *port)
520 static inline void br_multicast_init(struct net_bridge *br)
524 static inline void br_multicast_open(struct net_bridge *br)
528 static inline void br_multicast_stop(struct net_bridge *br)
532 static inline void br_multicast_deliver(struct net_bridge_mdb_entry *mdst,
537 static inline void br_multicast_forward(struct net_bridge_mdb_entry *mdst,
539 struct sk_buff *skb2)
542 static inline bool br_multicast_is_router(struct net_bridge *br)
546 static inline void br_mdb_init(void)
549 static inline void br_mdb_uninit(void)
555 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
556 extern bool br_allowed_ingress(struct net_bridge *br, struct net_port_vlans *v,
557 struct sk_buff *skb);
558 extern bool br_allowed_egress(struct net_bridge *br,
559 const struct net_port_vlans *v,
560 const struct sk_buff *skb);
561 extern int br_vlan_add(struct net_bridge *br, u16 vid);
562 extern int br_vlan_delete(struct net_bridge *br, u16 vid);
563 extern void br_vlan_flush(struct net_bridge *br);
564 extern int br_vlan_filter_toggle(struct net_bridge *br, unsigned long val);
565 extern int nbp_vlan_add(struct net_bridge_port *port, u16 vid);
566 extern int nbp_vlan_delete(struct net_bridge_port *port, u16 vid);
567 extern void nbp_vlan_flush(struct net_bridge_port *port);
569 static inline struct net_port_vlans *br_get_vlan_info(
570 const struct net_bridge *br)
572 return rcu_dereference(br->vlan_info);
575 static inline struct net_port_vlans *nbp_get_vlan_info(
576 const struct net_bridge_port *p)
578 return rcu_dereference(p->vlan_info);
581 /* Since bridge now depends on 8021Q module, but the time bridge sees the
582 * skb, the vlan tag will always be present if the frame was tagged.
584 static inline int br_vlan_get_tag(const struct sk_buff *skb, u16 *vid)
588 if (vlan_tx_tag_present(skb))
589 *vid = vlan_tx_tag_get(skb) & VLAN_VID_MASK;
598 static inline bool br_allowed_ingress(struct net_bridge *br,
599 struct net_port_vlans *v,
605 static inline bool br_allowed_egress(struct net_bridge *br,
606 const struct net_port_vlans *v,
607 const struct sk_buff *skb)
612 static inline int br_vlan_add(struct net_bridge *br, u16 vid)
617 static inline int br_vlan_delete(struct net_bridge *br, u16 vid)
622 static inline void br_vlan_flush(struct net_bridge *br)
626 static inline int nbp_vlan_add(struct net_bridge_port *port, u16 vid)
631 static inline int nbp_vlan_delete(struct net_bridge_port *port, u16 vid)
636 static inline void nbp_vlan_flush(struct net_bridge_port *port)
640 static inline struct net_port_vlans *br_get_vlan_info(
641 const struct net_bridge *br)
645 static inline struct net_port_vlans *nbp_get_vlan_info(
646 const struct net_bridge_port *p)
651 static inline u16 br_vlan_get_tag(const struct sk_buff *skb)
658 #ifdef CONFIG_BRIDGE_NETFILTER
659 extern int br_netfilter_init(void);
660 extern void br_netfilter_fini(void);
661 extern void br_netfilter_rtable_init(struct net_bridge *);
663 #define br_netfilter_init() (0)
664 #define br_netfilter_fini() do { } while(0)
665 #define br_netfilter_rtable_init(x)
669 extern void br_log_state(const struct net_bridge_port *p);
670 extern struct net_bridge_port *br_get_port(struct net_bridge *br,
672 extern void br_init_port(struct net_bridge_port *p);
673 extern void br_become_designated_port(struct net_bridge_port *p);
675 extern int br_set_forward_delay(struct net_bridge *br, unsigned long x);
676 extern int br_set_hello_time(struct net_bridge *br, unsigned long x);
677 extern int br_set_max_age(struct net_bridge *br, unsigned long x);
681 extern void br_stp_enable_bridge(struct net_bridge *br);
682 extern void br_stp_disable_bridge(struct net_bridge *br);
683 extern void br_stp_set_enabled(struct net_bridge *br, unsigned long val);
684 extern void br_stp_enable_port(struct net_bridge_port *p);
685 extern void br_stp_disable_port(struct net_bridge_port *p);
686 extern bool br_stp_recalculate_bridge_id(struct net_bridge *br);
687 extern void br_stp_change_bridge_id(struct net_bridge *br, const unsigned char *a);
688 extern void br_stp_set_bridge_priority(struct net_bridge *br,
690 extern int br_stp_set_port_priority(struct net_bridge_port *p,
691 unsigned long newprio);
692 extern int br_stp_set_path_cost(struct net_bridge_port *p,
693 unsigned long path_cost);
694 extern ssize_t br_show_bridge_id(char *buf, const struct bridge_id *id);
698 extern void br_stp_rcv(const struct stp_proto *proto, struct sk_buff *skb,
699 struct net_device *dev);
702 extern void br_stp_timer_init(struct net_bridge *br);
703 extern void br_stp_port_timer_init(struct net_bridge_port *p);
704 extern unsigned long br_timer_value(const struct timer_list *timer);
707 #if IS_ENABLED(CONFIG_ATM_LANE)
708 extern int (*br_fdb_test_addr_hook)(struct net_device *dev, unsigned char *addr);
712 extern struct rtnl_link_ops br_link_ops;
713 extern int br_netlink_init(void);
714 extern void br_netlink_fini(void);
715 extern void br_ifinfo_notify(int event, struct net_bridge_port *port);
716 extern int br_setlink(struct net_device *dev, struct nlmsghdr *nlmsg);
717 extern int br_dellink(struct net_device *dev, struct nlmsghdr *nlmsg);
718 extern int br_getlink(struct sk_buff *skb, u32 pid, u32 seq,
719 struct net_device *dev, u32 filter_mask);
723 extern const struct sysfs_ops brport_sysfs_ops;
724 extern int br_sysfs_addif(struct net_bridge_port *p);
725 extern int br_sysfs_renameif(struct net_bridge_port *p);
728 extern int br_sysfs_addbr(struct net_device *dev);
729 extern void br_sysfs_delbr(struct net_device *dev);
733 static inline int br_sysfs_addif(struct net_bridge_port *p) { return 0; }
734 static inline int br_sysfs_renameif(struct net_bridge_port *p) { return 0; }
735 static inline int br_sysfs_addbr(struct net_device *dev) { return 0; }
736 static inline void br_sysfs_delbr(struct net_device *dev) { return; }
737 #endif /* CONFIG_SYSFS */