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
];
78 unsigned long untagged_bitmap
[BR_VLAN_BITMAP_LEN
];
82 struct net_bridge_fdb_entry
84 struct hlist_node hlist
;
85 struct net_bridge_port
*dst
;
88 unsigned long updated
;
91 unsigned char is_local
;
92 unsigned char is_static
;
96 struct net_bridge_port_group
{
97 struct net_bridge_port
*port
;
98 struct net_bridge_port_group __rcu
*next
;
99 struct hlist_node mglist
;
101 struct timer_list timer
;
106 struct net_bridge_mdb_entry
108 struct hlist_node hlist
[2];
109 struct net_bridge
*br
;
110 struct net_bridge_port_group __rcu
*ports
;
112 struct timer_list timer
;
117 struct net_bridge_mdb_htable
119 struct hlist_head
*mhash
;
121 struct net_bridge_mdb_htable
*old
;
128 struct net_bridge_port
130 struct net_bridge
*br
;
131 struct net_device
*dev
;
132 struct list_head list
;
138 unsigned char topology_change_ack
;
139 unsigned char config_pending
;
141 port_id designated_port
;
142 bridge_id designated_root
;
143 bridge_id designated_bridge
;
146 unsigned long designated_age
;
148 struct timer_list forward_delay_timer
;
149 struct timer_list hold_timer
;
150 struct timer_list message_age_timer
;
155 #define BR_HAIRPIN_MODE 0x00000001
156 #define BR_BPDU_GUARD 0x00000002
157 #define BR_ROOT_BLOCK 0x00000004
158 #define BR_MULTICAST_FAST_LEAVE 0x00000008
159 #define BR_ADMIN_COST 0x00000010
161 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
162 u32 multicast_startup_queries_sent
;
163 unsigned char multicast_router
;
164 struct timer_list multicast_router_timer
;
165 struct timer_list multicast_query_timer
;
166 struct hlist_head mglist
;
167 struct hlist_node rlist
;
171 char sysfs_name
[IFNAMSIZ
];
174 #ifdef CONFIG_NET_POLL_CONTROLLER
177 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
178 struct net_port_vlans __rcu
*vlan_info
;
182 #define br_port_exists(dev) (dev->priv_flags & IFF_BRIDGE_PORT)
184 static inline struct net_bridge_port
*br_port_get_rcu(const struct net_device
*dev
)
186 struct net_bridge_port
*port
=
187 rcu_dereference_rtnl(dev
->rx_handler_data
);
189 return br_port_exists(dev
) ? port
: NULL
;
192 static inline struct net_bridge_port
*br_port_get_rtnl(struct net_device
*dev
)
194 return br_port_exists(dev
) ?
195 rtnl_dereference(dev
->rx_handler_data
) : NULL
;
198 struct br_cpu_netstats
{
203 struct u64_stats_sync syncp
;
209 struct list_head port_list
;
210 struct net_device
*dev
;
212 struct br_cpu_netstats __percpu
*stats
;
213 spinlock_t hash_lock
;
214 struct hlist_head hash
[BR_HASH_SIZE
];
215 #ifdef CONFIG_BRIDGE_NETFILTER
216 struct rtable fake_rtable
;
217 bool nf_call_iptables
;
218 bool nf_call_ip6tables
;
219 bool nf_call_arptables
;
224 bridge_id designated_root
;
227 unsigned long max_age
;
228 unsigned long hello_time
;
229 unsigned long forward_delay
;
230 unsigned long bridge_max_age
;
231 unsigned long ageing_time
;
232 unsigned long bridge_hello_time
;
233 unsigned long bridge_forward_delay
;
235 u8 group_addr
[ETH_ALEN
];
239 BR_NO_STP
, /* no spanning tree */
240 BR_KERNEL_STP
, /* old STP in kernel */
241 BR_USER_STP
, /* new RSTP in userspace */
244 unsigned char topology_change
;
245 unsigned char topology_change_detected
;
247 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
248 unsigned char multicast_router
;
250 u8 multicast_disabled
:1;
251 u8 multicast_querier
:1;
256 u32 multicast_last_member_count
;
257 u32 multicast_startup_queries_sent
;
258 u32 multicast_startup_query_count
;
260 unsigned long multicast_last_member_interval
;
261 unsigned long multicast_membership_interval
;
262 unsigned long multicast_querier_interval
;
263 unsigned long multicast_query_interval
;
264 unsigned long multicast_query_response_interval
;
265 unsigned long multicast_startup_query_interval
;
267 spinlock_t multicast_lock
;
268 struct net_bridge_mdb_htable __rcu
*mdb
;
269 struct hlist_head router_list
;
271 struct timer_list multicast_router_timer
;
272 struct timer_list multicast_querier_timer
;
273 struct timer_list multicast_query_timer
;
276 struct timer_list hello_timer
;
277 struct timer_list tcn_timer
;
278 struct timer_list topology_change_timer
;
279 struct timer_list gc_timer
;
280 struct kobject
*ifobj
;
281 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
283 struct net_port_vlans __rcu
*vlan_info
;
287 struct br_input_skb_cb
{
288 struct net_device
*brdev
;
289 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
295 #define BR_INPUT_SKB_CB(__skb) ((struct br_input_skb_cb *)(__skb)->cb)
297 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
298 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (BR_INPUT_SKB_CB(__skb)->mrouters_only)
300 # define BR_INPUT_SKB_CB_MROUTERS_ONLY(__skb) (0)
303 #define br_printk(level, br, format, args...) \
304 printk(level "%s: " format, (br)->dev->name, ##args)
306 #define br_err(__br, format, args...) \
307 br_printk(KERN_ERR, __br, format, ##args)
308 #define br_warn(__br, format, args...) \
309 br_printk(KERN_WARNING, __br, format, ##args)
310 #define br_notice(__br, format, args...) \
311 br_printk(KERN_NOTICE, __br, format, ##args)
312 #define br_info(__br, format, args...) \
313 br_printk(KERN_INFO, __br, format, ##args)
315 #define br_debug(br, format, args...) \
316 pr_debug("%s: " format, (br)->dev->name, ##args)
318 extern struct notifier_block br_device_notifier
;
320 /* called under bridge lock */
321 static inline int br_is_root_bridge(const struct net_bridge
*br
)
323 return !memcmp(&br
->bridge_id
, &br
->designated_root
, 8);
327 extern void br_dev_setup(struct net_device
*dev
);
328 extern void br_dev_delete(struct net_device
*dev
, struct list_head
*list
);
329 extern netdev_tx_t
br_dev_xmit(struct sk_buff
*skb
,
330 struct net_device
*dev
);
331 #ifdef CONFIG_NET_POLL_CONTROLLER
332 static inline struct netpoll_info
*br_netpoll_info(struct net_bridge
*br
)
334 return br
->dev
->npinfo
;
337 static inline void br_netpoll_send_skb(const struct net_bridge_port
*p
,
340 struct netpoll
*np
= p
->np
;
343 netpoll_send_skb(np
, skb
);
346 extern int br_netpoll_enable(struct net_bridge_port
*p
, gfp_t gfp
);
347 extern void br_netpoll_disable(struct net_bridge_port
*p
);
349 static inline struct netpoll_info
*br_netpoll_info(struct net_bridge
*br
)
354 static inline void br_netpoll_send_skb(const struct net_bridge_port
*p
,
359 static inline int br_netpoll_enable(struct net_bridge_port
*p
, gfp_t gfp
)
364 static inline void br_netpoll_disable(struct net_bridge_port
*p
)
370 extern int br_fdb_init(void);
371 extern void br_fdb_fini(void);
372 extern void br_fdb_flush(struct net_bridge
*br
);
373 extern void br_fdb_changeaddr(struct net_bridge_port
*p
,
374 const unsigned char *newaddr
);
375 extern void br_fdb_change_mac_address(struct net_bridge
*br
, const u8
*newaddr
);
376 extern void br_fdb_cleanup(unsigned long arg
);
377 extern void br_fdb_delete_by_port(struct net_bridge
*br
,
378 const struct net_bridge_port
*p
, int do_all
);
379 extern struct net_bridge_fdb_entry
*__br_fdb_get(struct net_bridge
*br
,
380 const unsigned char *addr
,
382 extern int br_fdb_test_addr(struct net_device
*dev
, unsigned char *addr
);
383 extern int br_fdb_fillbuf(struct net_bridge
*br
, void *buf
,
384 unsigned long count
, unsigned long off
);
385 extern int br_fdb_insert(struct net_bridge
*br
,
386 struct net_bridge_port
*source
,
387 const unsigned char *addr
,
389 extern void br_fdb_update(struct net_bridge
*br
,
390 struct net_bridge_port
*source
,
391 const unsigned char *addr
,
393 extern int fdb_delete_by_addr(struct net_bridge
*br
, const u8
*addr
, u16 vid
);
395 extern int br_fdb_delete(struct ndmsg
*ndm
, struct nlattr
*tb
[],
396 struct net_device
*dev
,
397 const unsigned char *addr
);
398 extern int br_fdb_add(struct ndmsg
*nlh
, struct nlattr
*tb
[],
399 struct net_device
*dev
,
400 const unsigned char *addr
,
402 extern int br_fdb_dump(struct sk_buff
*skb
,
403 struct netlink_callback
*cb
,
404 struct net_device
*dev
,
408 extern void br_deliver(const struct net_bridge_port
*to
,
409 struct sk_buff
*skb
);
410 extern int br_dev_queue_push_xmit(struct sk_buff
*skb
);
411 extern void br_forward(const struct net_bridge_port
*to
,
412 struct sk_buff
*skb
, struct sk_buff
*skb0
);
413 extern int br_forward_finish(struct sk_buff
*skb
);
414 extern void br_flood_deliver(struct net_bridge
*br
, struct sk_buff
*skb
);
415 extern void br_flood_forward(struct net_bridge
*br
, struct sk_buff
*skb
,
416 struct sk_buff
*skb2
);
419 extern void br_port_carrier_check(struct net_bridge_port
*p
);
420 extern int br_add_bridge(struct net
*net
, const char *name
);
421 extern int br_del_bridge(struct net
*net
, const char *name
);
422 extern void br_net_exit(struct net
*net
);
423 extern int br_add_if(struct net_bridge
*br
,
424 struct net_device
*dev
);
425 extern int br_del_if(struct net_bridge
*br
,
426 struct net_device
*dev
);
427 extern int br_min_mtu(const struct net_bridge
*br
);
428 extern netdev_features_t
br_features_recompute(struct net_bridge
*br
,
429 netdev_features_t features
);
432 extern int br_handle_frame_finish(struct sk_buff
*skb
);
433 extern rx_handler_result_t
br_handle_frame(struct sk_buff
**pskb
);
436 extern int br_dev_ioctl(struct net_device
*dev
, struct ifreq
*rq
, int cmd
);
437 extern int br_ioctl_deviceless_stub(struct net
*net
, unsigned int cmd
, void __user
*arg
);
440 #ifdef CONFIG_BRIDGE_IGMP_SNOOPING
441 extern unsigned int br_mdb_rehash_seq
;
442 extern int br_multicast_rcv(struct net_bridge
*br
,
443 struct net_bridge_port
*port
,
444 struct sk_buff
*skb
);
445 extern struct net_bridge_mdb_entry
*br_mdb_get(struct net_bridge
*br
,
446 struct sk_buff
*skb
, u16 vid
);
447 extern void br_multicast_add_port(struct net_bridge_port
*port
);
448 extern void br_multicast_del_port(struct net_bridge_port
*port
);
449 extern void br_multicast_enable_port(struct net_bridge_port
*port
);
450 extern void br_multicast_disable_port(struct net_bridge_port
*port
);
451 extern void br_multicast_init(struct net_bridge
*br
);
452 extern void br_multicast_open(struct net_bridge
*br
);
453 extern void br_multicast_stop(struct net_bridge
*br
);
454 extern void br_multicast_deliver(struct net_bridge_mdb_entry
*mdst
,
455 struct sk_buff
*skb
);
456 extern void br_multicast_forward(struct net_bridge_mdb_entry
*mdst
,
457 struct sk_buff
*skb
, struct sk_buff
*skb2
);
458 extern int br_multicast_set_router(struct net_bridge
*br
, unsigned long val
);
459 extern int br_multicast_set_port_router(struct net_bridge_port
*p
,
461 extern int br_multicast_toggle(struct net_bridge
*br
, unsigned long val
);
462 extern int br_multicast_set_querier(struct net_bridge
*br
, unsigned long val
);
463 extern int br_multicast_set_hash_max(struct net_bridge
*br
, unsigned long val
);
464 extern struct net_bridge_mdb_entry
*br_mdb_ip_get(
465 struct net_bridge_mdb_htable
*mdb
,
467 extern struct net_bridge_mdb_entry
*br_multicast_new_group(struct net_bridge
*br
,
468 struct net_bridge_port
*port
, struct br_ip
*group
);
469 extern void br_multicast_free_pg(struct rcu_head
*head
);
470 extern struct net_bridge_port_group
*br_multicast_new_port_group(
471 struct net_bridge_port
*port
,
473 struct net_bridge_port_group
*next
,
474 unsigned char state
);
475 extern void br_mdb_init(void);
476 extern void br_mdb_uninit(void);
477 extern void br_mdb_notify(struct net_device
*dev
, struct net_bridge_port
*port
,
478 struct br_ip
*group
, int type
);
480 #define mlock_dereference(X, br) \
481 rcu_dereference_protected(X, lockdep_is_held(&br->multicast_lock))
483 #if IS_ENABLED(CONFIG_IPV6)
484 #include <net/addrconf.h>
485 static inline int ipv6_is_transient_multicast(const struct in6_addr
*addr
)
487 if (ipv6_addr_is_multicast(addr
) && IPV6_ADDR_MC_FLAG_TRANSIENT(addr
))
493 static inline bool br_multicast_is_router(struct net_bridge
*br
)
495 return br
->multicast_router
== 2 ||
496 (br
->multicast_router
== 1 &&
497 timer_pending(&br
->multicast_router_timer
));
500 static inline int br_multicast_rcv(struct net_bridge
*br
,
501 struct net_bridge_port
*port
,
507 static inline struct net_bridge_mdb_entry
*br_mdb_get(struct net_bridge
*br
,
508 struct sk_buff
*skb
, u16 vid
)
513 static inline void br_multicast_add_port(struct net_bridge_port
*port
)
517 static inline void br_multicast_del_port(struct net_bridge_port
*port
)
521 static inline void br_multicast_enable_port(struct net_bridge_port
*port
)
525 static inline void br_multicast_disable_port(struct net_bridge_port
*port
)
529 static inline void br_multicast_init(struct net_bridge
*br
)
533 static inline void br_multicast_open(struct net_bridge
*br
)
537 static inline void br_multicast_stop(struct net_bridge
*br
)
541 static inline void br_multicast_deliver(struct net_bridge_mdb_entry
*mdst
,
546 static inline void br_multicast_forward(struct net_bridge_mdb_entry
*mdst
,
548 struct sk_buff
*skb2
)
551 static inline bool br_multicast_is_router(struct net_bridge
*br
)
555 static inline void br_mdb_init(void)
558 static inline void br_mdb_uninit(void)
564 #ifdef CONFIG_BRIDGE_VLAN_FILTERING
565 extern bool br_allowed_ingress(struct net_bridge
*br
, struct net_port_vlans
*v
,
566 struct sk_buff
*skb
, u16
*vid
);
567 extern bool br_allowed_egress(struct net_bridge
*br
,
568 const struct net_port_vlans
*v
,
569 const struct sk_buff
*skb
);
570 extern struct sk_buff
*br_handle_vlan(struct net_bridge
*br
,
571 const struct net_port_vlans
*v
,
572 struct sk_buff
*skb
);
573 extern int br_vlan_add(struct net_bridge
*br
, u16 vid
, u16 flags
);
574 extern int br_vlan_delete(struct net_bridge
*br
, u16 vid
);
575 extern void br_vlan_flush(struct net_bridge
*br
);
576 extern int br_vlan_filter_toggle(struct net_bridge
*br
, unsigned long val
);
577 extern int nbp_vlan_add(struct net_bridge_port
*port
, u16 vid
, u16 flags
);
578 extern int nbp_vlan_delete(struct net_bridge_port
*port
, u16 vid
);
579 extern void nbp_vlan_flush(struct net_bridge_port
*port
);
580 extern bool nbp_vlan_find(struct net_bridge_port
*port
, u16 vid
);
582 static inline struct net_port_vlans
*br_get_vlan_info(
583 const struct net_bridge
*br
)
585 return rcu_dereference_rtnl(br
->vlan_info
);
588 static inline struct net_port_vlans
*nbp_get_vlan_info(
589 const struct net_bridge_port
*p
)
591 return rcu_dereference_rtnl(p
->vlan_info
);
594 /* Since bridge now depends on 8021Q module, but the time bridge sees the
595 * skb, the vlan tag will always be present if the frame was tagged.
597 static inline int br_vlan_get_tag(const struct sk_buff
*skb
, u16
*vid
)
601 if (vlan_tx_tag_present(skb
))
602 *vid
= vlan_tx_tag_get(skb
) & VLAN_VID_MASK
;
611 static inline u16
br_get_pvid(const struct net_port_vlans
*v
)
613 /* Return just the VID if it is set, or VLAN_N_VID (invalid vid) if
617 return (v
->pvid
& VLAN_TAG_PRESENT
) ?
618 (v
->pvid
& ~VLAN_TAG_PRESENT
) :
623 static inline bool br_allowed_ingress(struct net_bridge
*br
,
624 struct net_port_vlans
*v
,
631 static inline bool br_allowed_egress(struct net_bridge
*br
,
632 const struct net_port_vlans
*v
,
633 const struct sk_buff
*skb
)
638 static inline struct sk_buff
*br_handle_vlan(struct net_bridge
*br
,
639 const struct net_port_vlans
*v
,
645 static inline int br_vlan_add(struct net_bridge
*br
, u16 vid
, u16 flags
)
650 static inline int br_vlan_delete(struct net_bridge
*br
, u16 vid
)
655 static inline void br_vlan_flush(struct net_bridge
*br
)
659 static inline int nbp_vlan_add(struct net_bridge_port
*port
, u16 vid
, u16 flags
)
664 static inline int nbp_vlan_delete(struct net_bridge_port
*port
, u16 vid
)
669 static inline void nbp_vlan_flush(struct net_bridge_port
*port
)
673 static inline struct net_port_vlans
*br_get_vlan_info(
674 const struct net_bridge
*br
)
678 static inline struct net_port_vlans
*nbp_get_vlan_info(
679 const struct net_bridge_port
*p
)
684 static inline bool nbp_vlan_find(struct net_bridge_port
*port
, u16 vid
)
689 static inline u16
br_vlan_get_tag(const struct sk_buff
*skb
, u16
*tag
)
693 static inline u16
br_get_pvid(const struct net_port_vlans
*v
)
695 return VLAN_N_VID
; /* Returns invalid vid */
700 #ifdef CONFIG_BRIDGE_NETFILTER
701 extern int br_netfilter_init(void);
702 extern void br_netfilter_fini(void);
703 extern void br_netfilter_rtable_init(struct net_bridge
*);
705 #define br_netfilter_init() (0)
706 #define br_netfilter_fini() do { } while(0)
707 #define br_netfilter_rtable_init(x)
711 extern void br_log_state(const struct net_bridge_port
*p
);
712 extern struct net_bridge_port
*br_get_port(struct net_bridge
*br
,
714 extern void br_init_port(struct net_bridge_port
*p
);
715 extern void br_become_designated_port(struct net_bridge_port
*p
);
717 extern int br_set_forward_delay(struct net_bridge
*br
, unsigned long x
);
718 extern int br_set_hello_time(struct net_bridge
*br
, unsigned long x
);
719 extern int br_set_max_age(struct net_bridge
*br
, unsigned long x
);
723 extern void br_stp_enable_bridge(struct net_bridge
*br
);
724 extern void br_stp_disable_bridge(struct net_bridge
*br
);
725 extern void br_stp_set_enabled(struct net_bridge
*br
, unsigned long val
);
726 extern void br_stp_enable_port(struct net_bridge_port
*p
);
727 extern void br_stp_disable_port(struct net_bridge_port
*p
);
728 extern bool br_stp_recalculate_bridge_id(struct net_bridge
*br
);
729 extern void br_stp_change_bridge_id(struct net_bridge
*br
, const unsigned char *a
);
730 extern void br_stp_set_bridge_priority(struct net_bridge
*br
,
732 extern int br_stp_set_port_priority(struct net_bridge_port
*p
,
733 unsigned long newprio
);
734 extern int br_stp_set_path_cost(struct net_bridge_port
*p
,
735 unsigned long path_cost
);
736 extern ssize_t
br_show_bridge_id(char *buf
, const struct bridge_id
*id
);
740 extern void br_stp_rcv(const struct stp_proto
*proto
, struct sk_buff
*skb
,
741 struct net_device
*dev
);
744 extern void br_stp_timer_init(struct net_bridge
*br
);
745 extern void br_stp_port_timer_init(struct net_bridge_port
*p
);
746 extern unsigned long br_timer_value(const struct timer_list
*timer
);
749 #if IS_ENABLED(CONFIG_ATM_LANE)
750 extern int (*br_fdb_test_addr_hook
)(struct net_device
*dev
, unsigned char *addr
);
754 extern struct rtnl_link_ops br_link_ops
;
755 extern int br_netlink_init(void);
756 extern void br_netlink_fini(void);
757 extern void br_ifinfo_notify(int event
, struct net_bridge_port
*port
);
758 extern int br_setlink(struct net_device
*dev
, struct nlmsghdr
*nlmsg
);
759 extern int br_dellink(struct net_device
*dev
, struct nlmsghdr
*nlmsg
);
760 extern int br_getlink(struct sk_buff
*skb
, u32 pid
, u32 seq
,
761 struct net_device
*dev
, u32 filter_mask
);
765 extern const struct sysfs_ops brport_sysfs_ops
;
766 extern int br_sysfs_addif(struct net_bridge_port
*p
);
767 extern int br_sysfs_renameif(struct net_bridge_port
*p
);
770 extern int br_sysfs_addbr(struct net_device
*dev
);
771 extern void br_sysfs_delbr(struct net_device
*dev
);
775 static inline int br_sysfs_addif(struct net_bridge_port
*p
) { return 0; }
776 static inline int br_sysfs_renameif(struct net_bridge_port
*p
) { return 0; }
777 static inline int br_sysfs_addbr(struct net_device
*dev
) { return 0; }
778 static inline void br_sysfs_delbr(struct net_device
*dev
) { return; }
779 #endif /* CONFIG_SYSFS */