1 // SPDX-License-Identifier: GPL-2.0-or-later
4 * Linux ethernet bridge
7 * Lennert Buytenhek <buytenh@gnu.org>
10 #include <linux/kernel.h>
11 #include <linux/netdevice.h>
12 #include <linux/etherdevice.h>
13 #include <linux/netpoll.h>
14 #include <linux/ethtool.h>
15 #include <linux/if_arp.h>
16 #include <linux/module.h>
17 #include <linux/init.h>
18 #include <linux/rtnetlink.h>
19 #include <linux/if_ether.h>
20 #include <linux/slab.h>
23 #include <linux/if_vlan.h>
24 #include <net/switchdev.h>
25 #include <net/net_namespace.h>
27 #include "br_private.h"
30 * Determine initial path cost based on speed.
31 * using recommendations from 802.1d standard
33 * Since driver might sleep need to not be holding any locks.
35 static int port_cost(struct net_device *dev)
37 struct ethtool_link_ksettings ecmd;
39 if (!__ethtool_get_link_ksettings(dev, &ecmd)) {
40 switch (ecmd.base.speed) {
52 /* Old silly heuristics based on name */
53 if (!strncmp(dev->name, "lec", 3))
56 if (!strncmp(dev->name, "plip", 4))
59 return 100; /* assume old 10Mbps */
63 /* Check for port carrier transitions. */
64 void br_port_carrier_check(struct net_bridge_port *p, bool *notified)
66 struct net_device *dev = p->dev;
67 struct net_bridge *br = p->br;
69 if (!(p->flags & BR_ADMIN_COST) &&
70 netif_running(dev) && netif_oper_up(dev))
71 p->path_cost = port_cost(dev);
74 if (!netif_running(br->dev))
77 spin_lock_bh(&br->lock);
78 if (netif_running(dev) && netif_oper_up(dev)) {
79 if (p->state == BR_STATE_DISABLED) {
80 br_stp_enable_port(p);
84 if (p->state != BR_STATE_DISABLED) {
85 br_stp_disable_port(p);
89 spin_unlock_bh(&br->lock);
92 static void br_port_set_promisc(struct net_bridge_port *p)
96 if (br_promisc_port(p))
99 err = dev_set_promiscuity(p->dev, 1);
103 br_fdb_unsync_static(p->br, p);
104 p->flags |= BR_PROMISC;
107 static void br_port_clear_promisc(struct net_bridge_port *p)
111 /* Check if the port is already non-promisc or if it doesn't
112 * support UNICAST filtering. Without unicast filtering support
113 * we'll end up re-enabling promisc mode anyway, so just check for
116 if (!br_promisc_port(p) || !(p->dev->priv_flags & IFF_UNICAST_FLT))
119 /* Since we'll be clearing the promisc mode, program the port
120 * first so that we don't have interruption in traffic.
122 err = br_fdb_sync_static(p->br, p);
126 dev_set_promiscuity(p->dev, -1);
127 p->flags &= ~BR_PROMISC;
130 /* When a port is added or removed or when certain port flags
131 * change, this function is called to automatically manage
132 * promiscuity setting of all the bridge ports. We are always called
133 * under RTNL so can skip using rcu primitives.
135 void br_manage_promisc(struct net_bridge *br)
137 struct net_bridge_port *p;
138 bool set_all = false;
140 /* If vlan filtering is disabled or bridge interface is placed
141 * into promiscuous mode, place all ports in promiscuous mode.
143 if ((br->dev->flags & IFF_PROMISC) || !br_vlan_enabled(br->dev))
146 list_for_each_entry(p, &br->port_list, list) {
148 br_port_set_promisc(p);
150 /* If the number of auto-ports is <= 1, then all other
151 * ports will have their output configuration
152 * statically specified through fdbs. Since ingress
153 * on the auto-port becomes forwarding/egress to other
154 * ports and egress configuration is statically known,
155 * we can say that ingress configuration of the
156 * auto-port is also statically known.
157 * This lets us disable promiscuous mode and write
160 if ((p->dev->priv_flags & IFF_UNICAST_FLT) &&
161 (br->auto_cnt == 0 ||
162 (br->auto_cnt == 1 && br_auto_port(p))))
163 br_port_clear_promisc(p);
165 br_port_set_promisc(p);
170 int nbp_backup_change(struct net_bridge_port *p,
171 struct net_device *backup_dev)
173 struct net_bridge_port *old_backup = rtnl_dereference(p->backup_port);
174 struct net_bridge_port *backup_p = NULL;
179 if (!netif_is_bridge_port(backup_dev))
182 backup_p = br_port_get_rtnl(backup_dev);
183 if (backup_p->br != p->br)
190 if (old_backup == backup_p)
193 /* if the backup link is already set, clear it */
195 old_backup->backup_redirected_cnt--;
198 backup_p->backup_redirected_cnt++;
199 rcu_assign_pointer(p->backup_port, backup_p);
204 static void nbp_backup_clear(struct net_bridge_port *p)
206 nbp_backup_change(p, NULL);
207 if (p->backup_redirected_cnt) {
208 struct net_bridge_port *cur_p;
210 list_for_each_entry(cur_p, &p->br->port_list, list) {
211 struct net_bridge_port *backup_p;
213 backup_p = rtnl_dereference(cur_p->backup_port);
215 nbp_backup_change(cur_p, NULL);
219 WARN_ON(rcu_access_pointer(p->backup_port) || p->backup_redirected_cnt);
222 static void nbp_update_port_count(struct net_bridge *br)
224 struct net_bridge_port *p;
227 list_for_each_entry(p, &br->port_list, list) {
231 if (br->auto_cnt != cnt) {
233 br_manage_promisc(br);
237 static void nbp_delete_promisc(struct net_bridge_port *p)
239 /* If port is currently promiscuous, unset promiscuity.
240 * Otherwise, it is a static port so remove all addresses
243 dev_set_allmulti(p->dev, -1);
244 if (br_promisc_port(p))
245 dev_set_promiscuity(p->dev, -1);
247 br_fdb_unsync_static(p->br, p);
250 static void release_nbp(struct kobject *kobj)
252 struct net_bridge_port *p
253 = container_of(kobj, struct net_bridge_port, kobj);
257 static void brport_get_ownership(struct kobject *kobj, kuid_t *uid, kgid_t *gid)
259 struct net_bridge_port *p = kobj_to_brport(kobj);
261 net_ns_get_ownership(dev_net(p->dev), uid, gid);
264 static struct kobj_type brport_ktype = {
266 .sysfs_ops = &brport_sysfs_ops,
268 .release = release_nbp,
269 .get_ownership = brport_get_ownership,
272 static void destroy_nbp(struct net_bridge_port *p)
274 struct net_device *dev = p->dev;
280 kobject_put(&p->kobj);
283 static void destroy_nbp_rcu(struct rcu_head *head)
285 struct net_bridge_port *p =
286 container_of(head, struct net_bridge_port, rcu);
290 static unsigned get_max_headroom(struct net_bridge *br)
292 unsigned max_headroom = 0;
293 struct net_bridge_port *p;
295 list_for_each_entry(p, &br->port_list, list) {
296 unsigned dev_headroom = netdev_get_fwd_headroom(p->dev);
298 if (dev_headroom > max_headroom)
299 max_headroom = dev_headroom;
305 static void update_headroom(struct net_bridge *br, int new_hr)
307 struct net_bridge_port *p;
309 list_for_each_entry(p, &br->port_list, list)
310 netdev_set_rx_headroom(p->dev, new_hr);
312 br->dev->needed_headroom = new_hr;
315 /* Delete port(interface) from bridge is done in two steps.
316 * via RCU. First step, marks device as down. That deletes
317 * all the timers and stops new packets from flowing through.
319 * Final cleanup doesn't occur until after all CPU's finished
320 * processing packets.
322 * Protected from multiple admin operations by RTNL mutex
324 static void del_nbp(struct net_bridge_port *p)
326 struct net_bridge *br = p->br;
327 struct net_device *dev = p->dev;
329 sysfs_remove_link(br->ifobj, p->dev->name);
331 nbp_delete_promisc(p);
333 spin_lock_bh(&br->lock);
334 br_stp_disable_port(p);
335 spin_unlock_bh(&br->lock);
337 br_ifinfo_notify(RTM_DELLINK, NULL, p);
339 list_del_rcu(&p->list);
340 if (netdev_get_fwd_headroom(dev) == br->dev->needed_headroom)
341 update_headroom(br, get_max_headroom(br));
342 netdev_reset_rx_headroom(dev);
345 br_fdb_delete_by_port(br, p, 0, 1);
346 switchdev_deferred_process();
349 nbp_update_port_count(br);
351 netdev_upper_dev_unlink(dev, br->dev);
353 dev->priv_flags &= ~IFF_BRIDGE_PORT;
355 netdev_rx_handler_unregister(dev);
357 br_multicast_del_port(p);
359 kobject_uevent(&p->kobj, KOBJ_REMOVE);
360 kobject_del(&p->kobj);
362 br_netpoll_disable(p);
364 call_rcu(&p->rcu, destroy_nbp_rcu);
367 /* Delete bridge device */
368 void br_dev_delete(struct net_device *dev, struct list_head *head)
370 struct net_bridge *br = netdev_priv(dev);
371 struct net_bridge_port *p, *n;
373 list_for_each_entry_safe(p, n, &br->port_list, list) {
377 br_recalculate_neigh_suppress_enabled(br);
379 br_fdb_delete_by_port(br, NULL, 0, 1);
381 cancel_delayed_work_sync(&br->gc_work);
383 br_sysfs_delbr(br->dev);
384 unregister_netdevice_queue(br->dev, head);
387 /* find an available port number */
388 static int find_portno(struct net_bridge *br)
391 struct net_bridge_port *p;
392 unsigned long *inuse;
394 inuse = bitmap_zalloc(BR_MAX_PORTS, GFP_KERNEL);
398 set_bit(0, inuse); /* zero is reserved */
399 list_for_each_entry(p, &br->port_list, list) {
400 set_bit(p->port_no, inuse);
402 index = find_first_zero_bit(inuse, BR_MAX_PORTS);
405 return (index >= BR_MAX_PORTS) ? -EXFULL : index;
408 /* called with RTNL but without bridge lock */
409 static struct net_bridge_port *new_nbp(struct net_bridge *br,
410 struct net_device *dev)
412 struct net_bridge_port *p;
415 index = find_portno(br);
417 return ERR_PTR(index);
419 p = kzalloc(sizeof(*p), GFP_KERNEL);
421 return ERR_PTR(-ENOMEM);
426 p->path_cost = port_cost(dev);
427 p->priority = 0x8000 >> BR_PORT_BITS;
429 p->flags = BR_LEARNING | BR_FLOOD | BR_MCAST_FLOOD | BR_BCAST_FLOOD;
431 br_set_state(p, BR_STATE_DISABLED);
432 br_stp_port_timer_init(p);
433 err = br_multicast_add_port(p);
443 int br_add_bridge(struct net *net, const char *name)
445 struct net_device *dev;
448 dev = alloc_netdev(sizeof(struct net_bridge), name, NET_NAME_UNKNOWN,
454 dev_net_set(dev, net);
455 dev->rtnl_link_ops = &br_link_ops;
457 res = register_netdev(dev);
463 int br_del_bridge(struct net *net, const char *name)
465 struct net_device *dev;
469 dev = __dev_get_by_name(net, name);
471 ret = -ENXIO; /* Could not find device */
473 else if (!(dev->priv_flags & IFF_EBRIDGE)) {
474 /* Attempt to delete non bridge device! */
478 else if (dev->flags & IFF_UP) {
479 /* Not shutdown yet. */
484 br_dev_delete(dev, NULL);
490 /* MTU of the bridge pseudo-device: ETH_DATA_LEN or the minimum of the ports */
491 static int br_mtu_min(const struct net_bridge *br)
493 const struct net_bridge_port *p;
496 list_for_each_entry(p, &br->port_list, list)
497 if (!ret_mtu || ret_mtu > p->dev->mtu)
498 ret_mtu = p->dev->mtu;
500 return ret_mtu ? ret_mtu : ETH_DATA_LEN;
503 void br_mtu_auto_adjust(struct net_bridge *br)
507 /* if the bridge MTU was manually configured don't mess with it */
508 if (br_opt_get(br, BROPT_MTU_SET_BY_USER))
511 /* change to the minimum MTU and clear the flag which was set by
512 * the bridge ndo_change_mtu callback
514 dev_set_mtu(br->dev, br_mtu_min(br));
515 br_opt_toggle(br, BROPT_MTU_SET_BY_USER, false);
518 static void br_set_gso_limits(struct net_bridge *br)
520 unsigned int gso_max_size = GSO_MAX_SIZE;
521 u16 gso_max_segs = GSO_MAX_SEGS;
522 const struct net_bridge_port *p;
524 list_for_each_entry(p, &br->port_list, list) {
525 gso_max_size = min(gso_max_size, p->dev->gso_max_size);
526 gso_max_segs = min(gso_max_segs, p->dev->gso_max_segs);
528 br->dev->gso_max_size = gso_max_size;
529 br->dev->gso_max_segs = gso_max_segs;
533 * Recomputes features using slave's features
535 netdev_features_t br_features_recompute(struct net_bridge *br,
536 netdev_features_t features)
538 struct net_bridge_port *p;
539 netdev_features_t mask;
541 if (list_empty(&br->port_list))
545 features &= ~NETIF_F_ONE_FOR_ALL;
547 list_for_each_entry(p, &br->port_list, list) {
548 features = netdev_increment_features(features,
549 p->dev->features, mask);
551 features = netdev_add_tso_features(features, mask);
556 /* called with RTNL */
557 int br_add_if(struct net_bridge *br, struct net_device *dev,
558 struct netlink_ext_ack *extack)
560 struct net_bridge_port *p;
562 unsigned br_hr, dev_hr;
563 bool changed_addr, fdb_synced = false;
565 /* Don't allow bridging non-ethernet like devices, or DSA-enabled
566 * master network devices since the bridge layer rx_handler prevents
567 * the DSA fake ethertype handler to be invoked, so we do not strip off
568 * the DSA switch tag protocol header and the bridge layer just return
569 * RX_HANDLER_CONSUMED, stopping RX processing for these frames.
571 if ((dev->flags & IFF_LOOPBACK) ||
572 dev->type != ARPHRD_ETHER || dev->addr_len != ETH_ALEN ||
573 !is_valid_ether_addr(dev->dev_addr) ||
574 netdev_uses_dsa(dev))
577 /* No bridging of bridges */
578 if (dev->netdev_ops->ndo_start_xmit == br_dev_xmit) {
579 NL_SET_ERR_MSG(extack,
580 "Can not enslave a bridge to a bridge");
584 /* Device has master upper dev */
585 if (netdev_master_upper_dev_get(dev))
588 /* No bridging devices that dislike that (e.g. wireless) */
589 if (dev->priv_flags & IFF_DONT_BRIDGE) {
590 NL_SET_ERR_MSG(extack,
591 "Device does not allow enslaving to a bridge");
595 p = new_nbp(br, dev);
599 call_netdevice_notifiers(NETDEV_JOIN, dev);
601 err = dev_set_allmulti(dev, 1);
603 br_multicast_del_port(p);
604 kfree(p); /* kobject not yet init'd, manually free */
608 err = kobject_init_and_add(&p->kobj, &brport_ktype, &(dev->dev.kobj),
609 SYSFS_BRIDGE_PORT_ATTR);
613 err = br_sysfs_addif(p);
617 err = br_netpoll_enable(p);
621 err = netdev_rx_handler_register(dev, br_handle_frame, p);
625 dev->priv_flags |= IFF_BRIDGE_PORT;
627 err = netdev_master_upper_dev_link(dev, br->dev, NULL, NULL, extack);
631 err = nbp_switchdev_mark_set(p);
635 dev_disable_lro(dev);
637 list_add_rcu(&p->list, &br->port_list);
639 nbp_update_port_count(br);
640 if (!br_promisc_port(p) && (p->dev->priv_flags & IFF_UNICAST_FLT)) {
641 /* When updating the port count we also update all ports'
643 * A port leaving promiscuous mode normally gets the bridge's
644 * fdb synced to the unicast filter (if supported), however,
645 * `br_port_clear_promisc` does not distinguish between
646 * non-promiscuous ports and *new* ports, so we need to
647 * sync explicitly here.
649 fdb_synced = br_fdb_sync_static(br, p) == 0;
651 netdev_err(dev, "failed to sync bridge static fdb addresses to this port\n");
654 netdev_update_features(br->dev);
656 br_hr = br->dev->needed_headroom;
657 dev_hr = netdev_get_fwd_headroom(dev);
659 update_headroom(br, dev_hr);
661 netdev_set_rx_headroom(dev, br_hr);
663 if (br_fdb_insert(br, p, dev->dev_addr, 0))
664 netdev_err(dev, "failed insert local address bridge forwarding table\n");
666 if (br->dev->addr_assign_type != NET_ADDR_SET) {
667 /* Ask for permission to use this MAC address now, even if we
668 * don't end up choosing it below.
670 err = dev_pre_changeaddr_notify(br->dev, dev->dev_addr, extack);
675 err = nbp_vlan_init(p, extack);
677 netdev_err(dev, "failed to initialize vlan filtering on this port\n");
681 spin_lock_bh(&br->lock);
682 changed_addr = br_stp_recalculate_bridge_id(br);
684 if (netif_running(dev) && netif_oper_up(dev) &&
685 (br->dev->flags & IFF_UP))
686 br_stp_enable_port(p);
687 spin_unlock_bh(&br->lock);
689 br_ifinfo_notify(RTM_NEWLINK, NULL, p);
692 call_netdevice_notifiers(NETDEV_CHANGEADDR, br->dev);
694 br_mtu_auto_adjust(br);
695 br_set_gso_limits(br);
697 kobject_uevent(&p->kobj, KOBJ_ADD);
703 br_fdb_unsync_static(br, p);
704 list_del_rcu(&p->list);
705 br_fdb_delete_by_port(br, p, 0, 1);
706 nbp_update_port_count(br);
708 netdev_upper_dev_unlink(dev, br->dev);
710 dev->priv_flags &= ~IFF_BRIDGE_PORT;
711 netdev_rx_handler_unregister(dev);
713 br_netpoll_disable(p);
715 sysfs_remove_link(br->ifobj, p->dev->name);
717 br_multicast_del_port(p);
718 kobject_put(&p->kobj);
719 dev_set_allmulti(dev, -1);
725 /* called with RTNL */
726 int br_del_if(struct net_bridge *br, struct net_device *dev)
728 struct net_bridge_port *p;
731 p = br_port_get_rtnl(dev);
732 if (!p || p->br != br)
735 /* Since more than one interface can be attached to a bridge,
736 * there still maybe an alternate path for netconsole to use;
737 * therefore there is no reason for a NETDEV_RELEASE event.
741 br_mtu_auto_adjust(br);
742 br_set_gso_limits(br);
744 spin_lock_bh(&br->lock);
745 changed_addr = br_stp_recalculate_bridge_id(br);
746 spin_unlock_bh(&br->lock);
749 call_netdevice_notifiers(NETDEV_CHANGEADDR, br->dev);
751 netdev_update_features(br->dev);
756 void br_port_flags_change(struct net_bridge_port *p, unsigned long mask)
758 struct net_bridge *br = p->br;
760 if (mask & BR_AUTO_MASK)
761 nbp_update_port_count(br);
763 if (mask & BR_NEIGH_SUPPRESS)
764 br_recalculate_neigh_suppress_enabled(br);
767 bool br_port_flag_is_set(const struct net_device *dev, unsigned long flag)
769 struct net_bridge_port *p;
771 p = br_port_get_rtnl_rcu(dev);
775 return p->flags & flag;
777 EXPORT_SYMBOL_GPL(br_port_flag_is_set);