3 * Linux ethernet bridge
6 * Lennert Buytenhek <buytenh@gnu.org>
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version
11 * 2 of the License, or (at your option) any later version.
14 #include <linux/kernel.h>
15 #include <linux/netdevice.h>
16 #include <linux/etherdevice.h>
17 #include <linux/netpoll.h>
18 #include <linux/ethtool.h>
19 #include <linux/if_arp.h>
20 #include <linux/module.h>
21 #include <linux/init.h>
22 #include <linux/rtnetlink.h>
23 #include <linux/if_ether.h>
24 #include <linux/slab.h>
27 #include <linux/if_vlan.h>
28 #include <net/switchdev.h>
30 #include "br_private.h"
33 * Determine initial path cost based on speed.
34 * using recommendations from 802.1d standard
36 * Since driver might sleep need to not be holding any locks.
38 static int port_cost(struct net_device
*dev
)
40 struct ethtool_link_ksettings ecmd
;
42 if (!__ethtool_get_link_ksettings(dev
, &ecmd
)) {
43 switch (ecmd
.base
.speed
) {
55 /* Old silly heuristics based on name */
56 if (!strncmp(dev
->name
, "lec", 3))
59 if (!strncmp(dev
->name
, "plip", 4))
62 return 100; /* assume old 10Mbps */
66 /* Check for port carrier transitions. */
67 void br_port_carrier_check(struct net_bridge_port
*p
)
69 struct net_device
*dev
= p
->dev
;
70 struct net_bridge
*br
= p
->br
;
72 if (!(p
->flags
& BR_ADMIN_COST
) &&
73 netif_running(dev
) && netif_oper_up(dev
))
74 p
->path_cost
= port_cost(dev
);
76 if (!netif_running(br
->dev
))
79 spin_lock_bh(&br
->lock
);
80 if (netif_running(dev
) && netif_oper_up(dev
)) {
81 if (p
->state
== BR_STATE_DISABLED
)
82 br_stp_enable_port(p
);
84 if (p
->state
!= BR_STATE_DISABLED
)
85 br_stp_disable_port(p
);
87 spin_unlock_bh(&br
->lock
);
90 static void br_port_set_promisc(struct net_bridge_port
*p
)
94 if (br_promisc_port(p
))
97 err
= dev_set_promiscuity(p
->dev
, 1);
101 br_fdb_unsync_static(p
->br
, p
);
102 p
->flags
|= BR_PROMISC
;
105 static void br_port_clear_promisc(struct net_bridge_port
*p
)
109 /* Check if the port is already non-promisc or if it doesn't
110 * support UNICAST filtering. Without unicast filtering support
111 * we'll end up re-enabling promisc mode anyway, so just check for
114 if (!br_promisc_port(p
) || !(p
->dev
->priv_flags
& IFF_UNICAST_FLT
))
117 /* Since we'll be clearing the promisc mode, program the port
118 * first so that we don't have interruption in traffic.
120 err
= br_fdb_sync_static(p
->br
, p
);
124 dev_set_promiscuity(p
->dev
, -1);
125 p
->flags
&= ~BR_PROMISC
;
128 /* When a port is added or removed or when certain port flags
129 * change, this function is called to automatically manage
130 * promiscuity setting of all the bridge ports. We are always called
131 * under RTNL so can skip using rcu primitives.
133 void br_manage_promisc(struct net_bridge
*br
)
135 struct net_bridge_port
*p
;
136 bool set_all
= false;
138 /* If vlan filtering is disabled or bridge interface is placed
139 * into promiscuous mode, place all ports in promiscuous mode.
141 if ((br
->dev
->flags
& IFF_PROMISC
) || !br_vlan_enabled(br
->dev
))
144 list_for_each_entry(p
, &br
->port_list
, list
) {
146 br_port_set_promisc(p
);
148 /* If the number of auto-ports is <= 1, then all other
149 * ports will have their output configuration
150 * statically specified through fdbs. Since ingress
151 * on the auto-port becomes forwarding/egress to other
152 * ports and egress configuration is statically known,
153 * we can say that ingress configuration of the
154 * auto-port is also statically known.
155 * This lets us disable promiscuous mode and write
158 if (br
->auto_cnt
== 0 ||
159 (br
->auto_cnt
== 1 && br_auto_port(p
)))
160 br_port_clear_promisc(p
);
162 br_port_set_promisc(p
);
167 static void nbp_update_port_count(struct net_bridge
*br
)
169 struct net_bridge_port
*p
;
172 list_for_each_entry(p
, &br
->port_list
, list
) {
176 if (br
->auto_cnt
!= cnt
) {
178 br_manage_promisc(br
);
182 static void nbp_delete_promisc(struct net_bridge_port
*p
)
184 /* If port is currently promiscuous, unset promiscuity.
185 * Otherwise, it is a static port so remove all addresses
188 dev_set_allmulti(p
->dev
, -1);
189 if (br_promisc_port(p
))
190 dev_set_promiscuity(p
->dev
, -1);
192 br_fdb_unsync_static(p
->br
, p
);
195 static void release_nbp(struct kobject
*kobj
)
197 struct net_bridge_port
*p
198 = container_of(kobj
, struct net_bridge_port
, kobj
);
202 static struct kobj_type brport_ktype
= {
204 .sysfs_ops
= &brport_sysfs_ops
,
206 .release
= release_nbp
,
209 static void destroy_nbp(struct net_bridge_port
*p
)
211 struct net_device
*dev
= p
->dev
;
217 kobject_put(&p
->kobj
);
220 static void destroy_nbp_rcu(struct rcu_head
*head
)
222 struct net_bridge_port
*p
=
223 container_of(head
, struct net_bridge_port
, rcu
);
227 static unsigned get_max_headroom(struct net_bridge
*br
)
229 unsigned max_headroom
= 0;
230 struct net_bridge_port
*p
;
232 list_for_each_entry(p
, &br
->port_list
, list
) {
233 unsigned dev_headroom
= netdev_get_fwd_headroom(p
->dev
);
235 if (dev_headroom
> max_headroom
)
236 max_headroom
= dev_headroom
;
242 static void update_headroom(struct net_bridge
*br
, int new_hr
)
244 struct net_bridge_port
*p
;
246 list_for_each_entry(p
, &br
->port_list
, list
)
247 netdev_set_rx_headroom(p
->dev
, new_hr
);
249 br
->dev
->needed_headroom
= new_hr
;
252 /* Delete port(interface) from bridge is done in two steps.
253 * via RCU. First step, marks device as down. That deletes
254 * all the timers and stops new packets from flowing through.
256 * Final cleanup doesn't occur until after all CPU's finished
257 * processing packets.
259 * Protected from multiple admin operations by RTNL mutex
261 static void del_nbp(struct net_bridge_port
*p
)
263 struct net_bridge
*br
= p
->br
;
264 struct net_device
*dev
= p
->dev
;
266 sysfs_remove_link(br
->ifobj
, p
->dev
->name
);
268 nbp_delete_promisc(p
);
270 spin_lock_bh(&br
->lock
);
271 br_stp_disable_port(p
);
272 spin_unlock_bh(&br
->lock
);
274 br_ifinfo_notify(RTM_DELLINK
, NULL
, p
);
276 list_del_rcu(&p
->list
);
277 if (netdev_get_fwd_headroom(dev
) == br
->dev
->needed_headroom
)
278 update_headroom(br
, get_max_headroom(br
));
279 netdev_reset_rx_headroom(dev
);
282 br_fdb_delete_by_port(br
, p
, 0, 1);
283 switchdev_deferred_process();
285 nbp_update_port_count(br
);
287 netdev_upper_dev_unlink(dev
, br
->dev
);
289 dev
->priv_flags
&= ~IFF_BRIDGE_PORT
;
291 netdev_rx_handler_unregister(dev
);
293 br_multicast_del_port(p
);
295 kobject_uevent(&p
->kobj
, KOBJ_REMOVE
);
296 kobject_del(&p
->kobj
);
298 br_netpoll_disable(p
);
300 call_rcu(&p
->rcu
, destroy_nbp_rcu
);
303 /* Delete bridge device */
304 void br_dev_delete(struct net_device
*dev
, struct list_head
*head
)
306 struct net_bridge
*br
= netdev_priv(dev
);
307 struct net_bridge_port
*p
, *n
;
309 list_for_each_entry_safe(p
, n
, &br
->port_list
, list
) {
313 br_recalculate_neigh_suppress_enabled(br
);
315 br_fdb_delete_by_port(br
, NULL
, 0, 1);
317 cancel_delayed_work_sync(&br
->gc_work
);
319 br_sysfs_delbr(br
->dev
);
320 unregister_netdevice_queue(br
->dev
, head
);
323 /* find an available port number */
324 static int find_portno(struct net_bridge
*br
)
327 struct net_bridge_port
*p
;
328 unsigned long *inuse
;
330 inuse
= kcalloc(BITS_TO_LONGS(BR_MAX_PORTS
), sizeof(unsigned long),
335 set_bit(0, inuse
); /* zero is reserved */
336 list_for_each_entry(p
, &br
->port_list
, list
) {
337 set_bit(p
->port_no
, inuse
);
339 index
= find_first_zero_bit(inuse
, BR_MAX_PORTS
);
342 return (index
>= BR_MAX_PORTS
) ? -EXFULL
: index
;
345 /* called with RTNL but without bridge lock */
346 static struct net_bridge_port
*new_nbp(struct net_bridge
*br
,
347 struct net_device
*dev
)
349 struct net_bridge_port
*p
;
352 index
= find_portno(br
);
354 return ERR_PTR(index
);
356 p
= kzalloc(sizeof(*p
), GFP_KERNEL
);
358 return ERR_PTR(-ENOMEM
);
363 p
->path_cost
= port_cost(dev
);
364 p
->priority
= 0x8000 >> BR_PORT_BITS
;
366 p
->flags
= BR_LEARNING
| BR_FLOOD
| BR_MCAST_FLOOD
| BR_BCAST_FLOOD
;
368 br_set_state(p
, BR_STATE_DISABLED
);
369 br_stp_port_timer_init(p
);
370 err
= br_multicast_add_port(p
);
380 int br_add_bridge(struct net
*net
, const char *name
)
382 struct net_device
*dev
;
385 dev
= alloc_netdev(sizeof(struct net_bridge
), name
, NET_NAME_UNKNOWN
,
391 dev_net_set(dev
, net
);
392 dev
->rtnl_link_ops
= &br_link_ops
;
394 res
= register_netdev(dev
);
400 int br_del_bridge(struct net
*net
, const char *name
)
402 struct net_device
*dev
;
406 dev
= __dev_get_by_name(net
, name
);
408 ret
= -ENXIO
; /* Could not find device */
410 else if (!(dev
->priv_flags
& IFF_EBRIDGE
)) {
411 /* Attempt to delete non bridge device! */
415 else if (dev
->flags
& IFF_UP
) {
416 /* Not shutdown yet. */
421 br_dev_delete(dev
, NULL
);
427 /* MTU of the bridge pseudo-device: ETH_DATA_LEN or the minimum of the ports */
428 int br_min_mtu(const struct net_bridge
*br
)
430 const struct net_bridge_port
*p
;
435 if (list_empty(&br
->port_list
))
438 list_for_each_entry(p
, &br
->port_list
, list
) {
439 if (!mtu
|| p
->dev
->mtu
< mtu
)
446 static void br_set_gso_limits(struct net_bridge
*br
)
448 unsigned int gso_max_size
= GSO_MAX_SIZE
;
449 u16 gso_max_segs
= GSO_MAX_SEGS
;
450 const struct net_bridge_port
*p
;
452 list_for_each_entry(p
, &br
->port_list
, list
) {
453 gso_max_size
= min(gso_max_size
, p
->dev
->gso_max_size
);
454 gso_max_segs
= min(gso_max_segs
, p
->dev
->gso_max_segs
);
456 br
->dev
->gso_max_size
= gso_max_size
;
457 br
->dev
->gso_max_segs
= gso_max_segs
;
461 * Recomputes features using slave's features
463 netdev_features_t
br_features_recompute(struct net_bridge
*br
,
464 netdev_features_t features
)
466 struct net_bridge_port
*p
;
467 netdev_features_t mask
;
469 if (list_empty(&br
->port_list
))
473 features
&= ~NETIF_F_ONE_FOR_ALL
;
475 list_for_each_entry(p
, &br
->port_list
, list
) {
476 features
= netdev_increment_features(features
,
477 p
->dev
->features
, mask
);
479 features
= netdev_add_tso_features(features
, mask
);
484 /* called with RTNL */
485 int br_add_if(struct net_bridge
*br
, struct net_device
*dev
,
486 struct netlink_ext_ack
*extack
)
488 struct net_bridge_port
*p
;
490 unsigned br_hr
, dev_hr
;
493 /* Don't allow bridging non-ethernet like devices, or DSA-enabled
494 * master network devices since the bridge layer rx_handler prevents
495 * the DSA fake ethertype handler to be invoked, so we do not strip off
496 * the DSA switch tag protocol header and the bridge layer just return
497 * RX_HANDLER_CONSUMED, stopping RX processing for these frames.
499 if ((dev
->flags
& IFF_LOOPBACK
) ||
500 dev
->type
!= ARPHRD_ETHER
|| dev
->addr_len
!= ETH_ALEN
||
501 !is_valid_ether_addr(dev
->dev_addr
) ||
502 netdev_uses_dsa(dev
))
505 /* No bridging of bridges */
506 if (dev
->netdev_ops
->ndo_start_xmit
== br_dev_xmit
) {
507 NL_SET_ERR_MSG(extack
,
508 "Can not enslave a bridge to a bridge");
512 /* Device is already being bridged */
513 if (br_port_exists(dev
))
516 /* No bridging devices that dislike that (e.g. wireless) */
517 if (dev
->priv_flags
& IFF_DONT_BRIDGE
) {
518 NL_SET_ERR_MSG(extack
,
519 "Device does not allow enslaving to a bridge");
523 p
= new_nbp(br
, dev
);
527 call_netdevice_notifiers(NETDEV_JOIN
, dev
);
529 err
= dev_set_allmulti(dev
, 1);
533 err
= kobject_init_and_add(&p
->kobj
, &brport_ktype
, &(dev
->dev
.kobj
),
534 SYSFS_BRIDGE_PORT_ATTR
);
538 err
= br_sysfs_addif(p
);
542 err
= br_netpoll_enable(p
);
546 err
= netdev_rx_handler_register(dev
, br_handle_frame
, p
);
550 dev
->priv_flags
|= IFF_BRIDGE_PORT
;
552 err
= netdev_master_upper_dev_link(dev
, br
->dev
, NULL
, NULL
, extack
);
556 err
= nbp_switchdev_mark_set(p
);
560 dev_disable_lro(dev
);
562 list_add_rcu(&p
->list
, &br
->port_list
);
564 nbp_update_port_count(br
);
566 netdev_update_features(br
->dev
);
568 br_hr
= br
->dev
->needed_headroom
;
569 dev_hr
= netdev_get_fwd_headroom(dev
);
571 update_headroom(br
, dev_hr
);
573 netdev_set_rx_headroom(dev
, br_hr
);
575 if (br_fdb_insert(br
, p
, dev
->dev_addr
, 0))
576 netdev_err(dev
, "failed insert local address bridge forwarding table\n");
578 err
= nbp_vlan_init(p
);
580 netdev_err(dev
, "failed to initialize vlan filtering on this port\n");
584 spin_lock_bh(&br
->lock
);
585 changed_addr
= br_stp_recalculate_bridge_id(br
);
587 if (netif_running(dev
) && netif_oper_up(dev
) &&
588 (br
->dev
->flags
& IFF_UP
))
589 br_stp_enable_port(p
);
590 spin_unlock_bh(&br
->lock
);
592 br_ifinfo_notify(RTM_NEWLINK
, NULL
, p
);
595 call_netdevice_notifiers(NETDEV_CHANGEADDR
, br
->dev
);
597 dev_set_mtu(br
->dev
, br_min_mtu(br
));
598 br_set_gso_limits(br
);
600 kobject_uevent(&p
->kobj
, KOBJ_ADD
);
605 list_del_rcu(&p
->list
);
606 br_fdb_delete_by_port(br
, p
, 0, 1);
607 nbp_update_port_count(br
);
609 netdev_upper_dev_unlink(dev
, br
->dev
);
611 dev
->priv_flags
&= ~IFF_BRIDGE_PORT
;
612 netdev_rx_handler_unregister(dev
);
614 br_netpoll_disable(p
);
616 sysfs_remove_link(br
->ifobj
, p
->dev
->name
);
618 kobject_put(&p
->kobj
);
619 p
= NULL
; /* kobject_put frees */
621 dev_set_allmulti(dev
, -1);
628 /* called with RTNL */
629 int br_del_if(struct net_bridge
*br
, struct net_device
*dev
)
631 struct net_bridge_port
*p
;
634 p
= br_port_get_rtnl(dev
);
635 if (!p
|| p
->br
!= br
)
638 /* Since more than one interface can be attached to a bridge,
639 * there still maybe an alternate path for netconsole to use;
640 * therefore there is no reason for a NETDEV_RELEASE event.
644 dev_set_mtu(br
->dev
, br_min_mtu(br
));
645 br_set_gso_limits(br
);
647 spin_lock_bh(&br
->lock
);
648 changed_addr
= br_stp_recalculate_bridge_id(br
);
649 spin_unlock_bh(&br
->lock
);
652 call_netdevice_notifiers(NETDEV_CHANGEADDR
, br
->dev
);
654 netdev_update_features(br
->dev
);
659 void br_port_flags_change(struct net_bridge_port
*p
, unsigned long mask
)
661 struct net_bridge
*br
= p
->br
;
663 if (mask
& BR_AUTO_MASK
)
664 nbp_update_port_count(br
);
666 if (mask
& BR_NEIGH_SUPPRESS
)
667 br_recalculate_neigh_suppress_enabled(br
);